Need a special offer?Find out if your project fits.
+
All documentation
API reference
  • API Reference for older versions
  • CellDataObject

    Object which contains information about the cell. It is used in such methods as getCell(), getSelectedCell(), and customizeCell().

    Use getCell() API call to get information about the cell by row and column indexes or getSelectedCell() to get the selected cell.

    Properties

    {
      collapsed: boolean,
      columnIndex: number,
      columns: object[],
      conditions: string[],
      escapedLabel: string,
      expanded: boolean,
      drilledUp: boolean,
      drilledDown: boolean,
      height: number,
      hierarchy: object,
      isClassicTotalRow: boolean,
      isDrillThrough: boolean,
      isGrandTotal: boolean,
      isGrandTotalColumn: boolean,
      isGrandTotalRow: boolean,
      isTotal: boolean,
      isTotalColumn: boolean,
      isTotalRow: boolean,
      label: string,
      level: number,
      measure: object,
      member: object,
      recordId: any | any[],
      rowData: CellDataObject[],
      rowIndex: number,
      rows: object[],
      type: string,
      value: number,
      width: number,
      x: number,
      y: number
    }
    Property/Type Description
    collapsed
    Boolean
    Indicates whether the cell is collapsed (true) or not (false).
    Only for cells with the "header" type.
    columnIndex
    Number
    Index of the cell column.
    columns
    Object[]
    Cell column tuple. Each object contains information about column hierarchies. Can also contain member properties for "json" and "microsoft analysis services" data source types.
    conditions
    String[]
    optional Contains the ids of conditional formatting rules that apply to this cell.
    See how this property is used to customize cells to which conditional formatting is applied.
    escapedLabel
    String
    Cell label where certain characters, such as <, >, ", ', or /, are replaced by a hexadecimal escape sequence.
    expanded
    Boolean
    Indicates whether the cell is expanded (true) or not (false).
    Only for cells with the "header" type.
    drilledUp
    Boolean
    Indicates whether the cell is drilled up (true) or not (false).
    Only for cells with the "header" type.
    drilledDown
    Boolean
    Indicates the cell is drilled down (true) or not (false).
    Only for cells with the "header" type.
    height
    Number
    Cell height in pixels.
    hierarchy
    Object
    Hierarchy connected with the cell.
    isClassicTotalRow
    Boolean
    Indicates whether the cell contains the total value from the classic form.
    isDrillThrough
    Boolean
    Indicates whether the cell is from the grid (false) or from the drill through pop-up (true).
    isGrandTotal
    Boolean
    Indicates whether the cell contains the grand total value.
    isGrandTotalColumn
    Boolean
    Indicates whether the cell contains the column grand total value.
    isGrandTotalRow
    Boolean
    Indicates whether the cell contains the row grand total value.
    isTotal
    Boolean
    Identifies whether the cell contains the total value.
    isTotalColumn
    Boolean
    Indicates whether the cell contains the column total value.
    isTotalRow
    Boolean
    Indicates whether the cell contains the row total value.
    label
    String
    Cell label.
    level
    Number
    The level of the hierarchy.
    measure
    Object
    Measure connected with the cell.
    member
    Object
    Member connected with the cell.
    recordId
    Any | Any[]
    Contains the ids of data records that compose the cell.
    For the flat form, only one id is returned.
    For the compact and classic forms, an array of ids is returned.
    If there is no id field in the mapping, the recordId is null.
    Only for "json" and "csv" data source types.
    rowData
    CellDataObject[]
    The property is defined when the cell is double-clicked in the drill-through view. Contains the array of cells from the underlying data row.
    Only for "json" and "csv" data source types.
    rowIndex
    Number
    Index of the cell row.
    rows
    Object[]
    Cell row tuple. Each object contains information about row hierarchies. For JSON and SSAS can also contain member properties.
    type
    String
    Type of the cell. Can be "header" or "value".
    value
    Number
    Cell value.
    width
    Number
    Cell width in pixels.
    x
    Number
    Absolute X position of the cell on the page.
    y
    Number
    Absolute Y position of the cell on the page.

    See also

    getCell()
    getSelectedCell()