Menu
Download Free Trial
Table of contents

Slice Object

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) – object with the information on filtering:
      • members – Array of hierarchy’s members to be reflected/shown according to the applied filter;
      • negation – Boolean. Represents the filter on hierarchy’s members. It tells the component to show the members of hierarchy specified in items (true) or to show all the members of hierarchy except the items (false).
      • measure – Represents the filter on values. The name of the measure on which Top X or Bottom X filter will be applied.
      • quantity – Represents the filter on values. Number of elements to choose for the Top X filter if type is 'top' or for the Bottom X filter if type is 'bottom'.
      • type – Represents the filter type applied to the hierarchy. It can be: 'none' – filter is not applied to the hierarchy, 'members' – the filter on hierarchy’s members is applied, 'top' – the filter Top X is applied on values, 'bottom' – the filter Bottom X is applied on values.
    • 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 "ocsv", "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.
  • 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", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "difference", "%difference"). 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 [].
    • caption (optional) – String, measure caption.
    • formula (optional) – String that represents the formula that can contain the following operations: +, -, *, /; 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, OCSV and JSON data sources: "sum", "count", "distinctcount", "average", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "difference", "%difference".
    • individual (optional) – Boolean. Defines whether the formula is calculated using raw values (true) or using aggregated values (false). Default value is false.
    • format (optional) – String, name of number formatting.
    • grandTotalCaption (optional) – String, measure grand total caption.
  • 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) – object with the information on filtering:
      • members – Array of hierarchy’s members to be reflected/shown according to the applied filter;
      • negation – Boolean. It tells the component to show the members of hierarchy specified in items (true) or to show all the members of hierarchy except the items (false).
    • 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 "ocsv", "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) – object with the information on filtering:
      • members – Array of hierarchy’s members to be reflected/shown according to the applied filter;
      • negation – Boolean. Represents the filter on hierarchy’s members. It tells the component to show the members of hierarchy specified in items (true) or to show all the members of hierarchy except the items (false).
      • measure – Represents the filter on values. The name of the measure on which Top X or Bottom X filter will be applied.
      • quantity – Represents the filter on values. Number of elements to choose for the Top X filter if type is 'top' or for the Bottom X filter if type is 'bottom'.
      • type – Represents the filter type applied to the hierarchy. It can be: 'none' – filter is not applied to the hierarchy, 'members' – the filter on hierarchy’s members is applied, 'top' – the filter Top X is applied on values, 'bottom' – the filter Bottom X is applied on values.
    • 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 "ocsv", "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 – String. Measure unique name on which sorting will be applied;
      • 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 – String. Measure unique name on which sorting will be applied;
      • 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().