Slice is a definition of what data subset from the data source is going to be shown in the report. This object has the following properties:
columns – Array of objects. A list of hierarchies selected in the report slice for columns. Each object can have the following properties:
uniqueName – String, hierarchy unique name.caption (optional) – String, hierarchy caption;dimensionName (optional) – String, dimension name;filter (optional) – Filter Object. Contains filtering information.levelName (optional) – String. Used to specify the level of the hierarchy that is shown on the grid.sort (optional) – String, sorting type for the members ("asc", "desc" or "unsorted");sortOrder (optional) – Array. Using this property you can set custom sorting for hierarchy members. Only for "csv" and "json" data source types. You can specify sortOrder the following way: ["member_1", "member_2", etc.].drills (optional) – Object. Stores the information about drill-downs in multilevel hierarchies.
drillAll (optional) – Boolean. Indicates whether all levels of all hierarchies in slice will be drilled down (true) or drilled up (false).columns (optional) – Array of objects. It is used to save and restore drilled down columns.rows (optional) – Array of objects. It is used to save and restore drilled down rows.drillThrough (optional) – Array. It allows pre-defining slice for the drill-through view. Only for "csv" and "json" data source types. Can be specified the following way: ["Hierarchy name 1", "Hierarchy name 2", etc.] (see live demo).
expands (optional) – Object. Stores the information about expanded nodes.
expandAll (optional) – Boolean. Indicates whether all nodes in the data tree will be expanded (true) or collapsed (false) on the grid and on charts.columns (optional) – Array of objects. It is used to save and restore expanded columns.rows – Array of objects. It is used to save and restore expanded rows.measures – Array of objects. A list of selected measures and those which have different properties from default ones. Each object has the following properties:
uniqueName – String, measure unique name.active (optional) – Boolean value that defines whether the measure will be in the list of available values but not selected (false) or will be selected for the report (true).aggregation (optional) — String, unique name of aggregation that will be applied to the measure ("sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "percentofparentrowtotal", "percentofparentcolumntotal", "index", "difference", "%difference", "runningtotals", "stdevp", "stdevs"). If it is calculated measure, it will be "none".availableAggregations (optional) — Array of strings that represents the list of aggregation functions which can be applied to the current measure. If it is calculated measure, it will be [].availableAggregations property is considered deprecated. Use the Mapping object’s aggregations property instead.caption (optional) – String, measure caption.formula (optional) – String that represents the formula that can contain the following operations: +, -, *, / (check a full list); other measures can be addressed using measure unique name and aggregation function, for example sum("Price") or max("Order"). Pivot supports the following aggregation functions for CSV and JSON data sources: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "percentofparentrowtotal", "percentofparentcolumntotal", "index", "difference", "%difference", "runningtotals", "stdevp", "stdevs".individual (optional) – Boolean. Defines whether the formula is calculated using raw values (true) or using aggregated values (false). Default value: false.calculateNaN (optional) – Boolean. Defines whether the formula is calculated using the NaN values (true) or using the null values (false). Default value: true.format (optional) – String, name of number formatting.grandTotalCaption (optional) – String, measure grand total caption.flatOrder – Array of strings. Defines the order of the hierarchies for the "flat" grid type. flatOrder can be specified like this: [Hierarchy name 1", "Hierarchy name 2", etc.] (see live demo).memberProperties – Array of objects. Each object has the following properties:
levelName – String, hierarchy unique name.properties – Array of member properties, which will be shown on the grid. Other available member properties can be accessed through the context menu.reportFilters – Array of objects. A list of hierarchies selected in the report slice for Report Filters. Each object has the following properties:
uniqueName – String. Hierarchy unique name.caption (optional) – String, hierarchy caption;dimensionName (optional) – String, dimension name;filter (optional) – Filter Object. Contains filtering information.levelName (optional) – String. Used to specify the level of the hierarchy that is shown on the grid.sort (optional) – String. Sorting type for the members ("asc", "desc" or "unsorted");sortOrder (optional) – Array. Using this property you can set custom sorting for hierarchy members. Only for "csv" and "json" data source types. You can specify sortOrder the following way: [“member_1”, “member_2”, etc.].rows – Array of objects. A list of hierarchies selected in the report slice for rows. Each object can have the following properties:
uniqueName – String, hierarchy unique name.caption (optional) – String, hierarchy caption;dimensionName (optional) – String, dimension name;filter (optional) – Filter Object. Contains filtering information.levelName (optional) – String. Used to specify the level of the hierarchy that is shown on the grid.sort (optional) – String, sorting type for the members ("asc", "desc" or "unsorted");sortOrder (optional) – Array. Using this property you can set custom sorting for hierarchy members. Only for "csv" and "json" data source types. You can specify sortOrder the following way: [“member_1”, “member_2”, etc.].sorting (optional) – Object. Defines the sorting for numbers in a specific row and/or column in the pivot table.
column – Object. Defines the sorting for numbers in a specific column. Object has 3 properties:
tuple – Array. Consists of unique names that identifies the column in the table based on data in it.measure – Object. Identifies the measure on which sorting will be applied. Has the following properties:
uniqueName – String. Measure unique name.aggregation (optional) – String. Measure aggregation type.type – String. Sorting type ("asc" or "desc").row – Object. Defines the sorting for numbers in a specific row. Object has 3 properties:
tuple – Array. Consists of unique names that identifies the row in the table based on data in it;measure – Object. Identifies the measure on which sorting will be applied. Has the following properties:
uniqueName – String. Measure unique name.aggregation (optional) – String. Measure aggregation type.type – String. Sorting type ("asc" or "desc").Change the slice using runQuery() and setReport() API calls. Get the slice among with other report parts using getReport().
Find more details about Slice Object in this tutorial with examples.