Interface TableProps

Props of the Table component.

Properties

Data

dataSet

dataSet?: Data | DataSource

Data set for a chart using one of the following options. If neither option is specified, the chart will use the defaultDataSource specified in the parent SisenseContextProvider component.

(1) Sisense data source name as a string. For example, 'Sample ECommerce'. Typically, you retrieve the data source name from a data model you create using the get-data-modelcommand of the Compose SDK CLI. The chart connects to the data source, executes a query, and loads the data as specified in dataOptions, filters, and highlights.

To learn more about using data from a Sisense data source, see the Compose SDK Charts Guide.

(2) Explicit Data, which is made up of an array of Column objects and a two-dimensional array of row data. This approach allows the chart component to be used with any data you provide.

To learn more about using data from an external data source, see the Compose SDK Charts Guide.

Example data in the proper format:

const sampleData = {
  columns: [
    { name: 'Years', type: 'date' },
    { name: 'Quantity', type: 'number' },
    { name: 'Units', type: 'number' },
  ],
  rows: [
    ['2019', 5500, 1500],
    ['2020', 4471, 7000],
    ['2021', 1812, 5000],
    ['2022', 5001, 6000],
    ['2023', 2045, 4000],
  ],
};

filters

filters?: FilterRelations | Filter[]

Filters that will slice query results

includeTotalRows Beta

includeTotalRows?: boolean

Boolean flag whether to request the total row count of the table's query, ignoring the count/offset paging used to load table pages.

When enabled, the total is shown next to the pagination control and used to render accurate page-number links, including direct links to the last pages.

Row count feature requires a Sisense instance version of 2026.3.0 or greater. On older versions, the table still loads and paginates as before, and the total-rows label is not shown.

If not specified, the default value is false

Callbacks

onDataReady

onDataReady?: (data) => Data

A callback that allows to modify data immediately after it has been retrieved. It can be used to inject modification of queried data.

Parameters

Parameter	Type
`data`	`Data`

dataOptions: TableDataOptions

Configurations for how to interpret and present the data passed to the component

styleOptions

styleOptions?: TableStyleOptions

Configurations for how to style and present a table's data.