Get Free Trial
API reference
Table of contents

CellDataObject

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

The CellDataObject has the following properties:

  • 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 – Array of objects. Cell column tuple. Each object contains information about column hierarchies. For JSON and SSAS can also contain member properties.
  • 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 px.
  • hierarchy – Object. Hierarchy connected with the cell.
  • isClassicTotalRow – Boolean. Indicates whether the cell contains the total value from the classic view.
  • 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 – String | Array of strings. The property contains the values of the id field of records that were used to compose a cell. For the flat form, only one id is returned as a string. For the compact and classic forms, an array of such ids is returned. Only for CSV and JSON data sources.
  • rowData – Array of CellDataObjects. 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 CSV and JSON data sources.
  • rowIndex – Number. Index of the cell row.
  • rows – Array of objects. 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 px.
  • x – Number. Absolute X position of the cell on the page.
  • y – Number. Absolute Y position of the cell on the page.

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

See also

getCell()
getSelectedCell()