☝️Small business or a startup? See if you qualify for our special offer.
+
All documentation

SliceObject

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().

Properties

slice: {
  columns: FieldObject[],
  drills: DrillsObject,
  drillThrough: string[],
  expands: ExpandsObject,
  flatSort: FlatSortObject[],
  flatOrder: string[],
  measures: MeasureObject[],
  memberProperties: MemberPropertyObject[],
  reportFilters: FieldObject[],
  rows: FieldObject[],
  sorting: SortingObject
}
Property/TypeDescription
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.
 When sorting multiple columns, the columns are sorted in the order they were specified (i.e., the first column is sorted first, and so on Live example.
To learn more about sorting in the flat form, check out the Sorting guide.
Only for "json", "csv", and "api" data source types.
flatOrder
String[]
optional Defines the order of the fields in the flat form 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 A list of member properties (also known as attribute relationships) that should be shown on the grid Live example.
Note Set options.showMemberProperties to true to enable member properties in the component.
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 values in a specific row and/or column in the pivot table.
To clear the sorting, use the sortValues API call.

See also

Slice guide
runQuery()
setReport()
getReport()