Slice is a definition of what data subset from the data source is going to be shown in the report. Learn more in this tutorial with examples: Slice.
Change the slice using runQuery() and setReport() API calls. Get the slice among other report parts using getReport().
slice: {
columns: FieldObject[],
drills: DrillsObject,
drillThrough: string[],
expands: ExpandsObject,
flatSort: FlatSortObject[],
flatOrder: string[],
measures: MeasureObject[],
memberProperties: MemberPropertyObject[],
reportFilters: FieldObject[],
rows: FieldObject[],
sorting: SortingObject
}
| Property/Type | Description |
|---|---|
| columns FieldObject[] | A list of fields selected for columns. |
| drills DrillsObject | optional Stores information about drilled-down multilevel hierarchies. |
| drillThrough String[] | optional Allows you to predefine a slice for the drill-through view
Live example. Only for "json", "csv", "elasticsearch", and "api" data source types. |
| expands ExpandsObject | optional Stores information about expanded fields. |
| flatSort FlatSortObject[] | optional Defines sorting for columns in the flat form. Only for "json", "csv", and "api" data source types.Note Columns are sorted in the order they were specified (i.e., the first column is sorted first, and so on). Therefore, take the columns’ order into account when sorting multiple columns Live example. To sort multiple columns via UI, press Ctrl and click a sorting arrow on each column to be sorted. |
| flatOrder String[] | optional Defines the order of the fields for the "flat" grid type. flatOrder can be specified like this: ["Field name 1", "Field name 2", etc.]
Live example.Only for "json", "csv", and "api" data source types. |
| measures MeasureObject[] | A list of the selected measures and those which have non-default properties. |
| memberProperties MemberPropertyObject[] | optional Allows showing attribute hierarchies (also known as member properties) on the grid. Only for the "microsoft analysis services" data source type. |
| reportFilters FieldObject[] | optional A list of fields selected for report filters. |
| rows FieldObject[] | A list of fields selected for rows. |
| sorting SortingObject | optional Defines the sorting for numbers in a specific row and/or column in the pivot table. To clear the sorting, use the sortValues API call. |