Version 1
DataManagerGroup GrapeCity DataViewsJS Class

DataManagerGroup Class

Represents DataManagerGroup.

Heirarchy

  • DataManagerGroup

Constructors

constructor

  • Initializes a new instance of DataManagerGroup.

    memberof

    GC.DataViews.DataView.DataManager

    constructor

    Parameters

    • dataManager: DataManager

      The DataManager that owns this DataManagerGroup.

    • groupDescriptor: IGroupDescriptor

      The group descriptor that generates this DataManagerGroup.

    • calcGroup: CalcGroup_

      The CalcGroup that generates this DataManagerGroup.

    • parentGroup: DataManagerGroup

      The parent group of this DataManagerGroup.

    Returns DataManagerGroup

Methods

evaluate

  • evaluate(formula: string): any
  • Evaluates the formula with the current group context.

    Parameters

    • formula: string

      The string formula to be evaluated.

    Returns any

    The evaluated result.

findChildGroupByPath

  • Gets the child group from the relative path of this group.

    Parameters

    • path: number[]

      A array of number which indicate relative path of the child group.

    Returns DataManagerGroup

    The child group.

getCalculatedColumnValues

  • getCalculatedColumnValues(name: string): any[]
  • Gets all values in this group of a specified calculated column.

    Parameters

    • name: string

      The name of the calculated column.

    Returns any[]

    Return array of column values.

getItem

  • getItem(itemIndex: number, getAllInGroup?: boolean, getAllInTree?: boolean): IDataItem
  • Gets the data item in this group at a specified relative index.

    Parameters

    • itemIndex: number

      Relative index for item in this group.

    • Default value getAllInGroup: boolean = false

      If false, the item in the collapsed group is not counted.

    • Default value getAllInTree: boolean = false

      If false, the item in the collapsed tree node is not counted.

    Returns IDataItem

    The data item at the specified index.

getItems

  • getItems(): IDataItem[]
  • Gets all items in this group.

    Returns IDataItem[]

    Array of data items.

getSourceRowIndex

  • getSourceRowIndex(itemIndex: number): number
  • Maps the relative view index to the index in the data source.

    Parameters

    • itemIndex: number

      Relative index in this group.

    Returns number

    The index in the data source.