Get Free Trial
API reference
Table of contents

TableSizesObject

The TableSizesObject contains information about table sizes. It is used to set table sizes in the ReportObject or via the setTableSizes() method.

The TableSizesObject has the following properties:

  • columns – Array of objects. Each object is used to save and restore the width of some column in the report:
    • width – Number. Column width in pixels.
    • idx – Number. Column’s index, starts from 0. It is necessary to use either idx or tuple, not both.
    • tuple – Array. Consists of unique names that identify the column in the table based on data in it. It is necessary to use either idx or tuple, not both.
    • measure optional – Object. Identifies the measure. This property is defined only if "[Measures]" is selected for columns in the slice. The measure property is used with tuple and is not set when idx is used. Has the following properties:
      • uniqueName – String. The measure’s unique name.
      • aggregation optional – String. The measure’s aggregation type.
  • rows – Array of objects. Each object is used to save and restore the height of some row in the report:
    • height – Number. Row height in pixels.
    • idx – Number. Row’s index, starts from 0. It is necessary to use either idx or tuple, not both.
    • tuple – Array. Consists of unique names that identify the row in the table based on data in it. It is necessary to use either idx or tuple, not both.
    • measure optional – Object. Identifies the measure. This property is defined only if "[Measures]" is selected for rows in the slice. The measure property is used with tuple and is not set when idx is used. Has the following properties:
      • uniqueName – String. The measure’s unique name.
      • aggregation optional – String. The measure’s aggregation type.

To set table sizes for the component, use the setTableSizes() method.

To get table sizes, use the getTableSizes() method.

See also

setTableSizes()
getTableSizes()