1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeCell
    13. customizeContextMenu
    14. dispose
    15. expandAllData
    16. expandData
    17. exportTo
    18. getAllConditions
    19. getAllHierarchies
    20. getAllMeasures
    21. getCell
    22. getColumns
    23. getCondition
    24. getData
    25. getFilter
    26. getFilterProperties
    27. getFormat
    28. getMeasures
    29. getMembers
    30. getOptions
    31. getReport
    32. getReportFilters
    33. getRows
    34. getSelectedCell
    35. getSort
    36. getXMLACatalogs
    37. getXMLACubes
    38. getXMLADataSources
    39. getXMLAProviderName
    40. load
    41. off
    42. on
    43. open
    44. openFieldsList
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setBottomX
    55. setFilter
    56. setFormat
    57. setOptions
    58. setReport
    59. setSort
    60. setTopX
    61. showCharts
    62. showGrid
    63. showGridAndCharts
    64. sortingMethod
    65. sortValues
    66. updateData
  4. Events
    1. All events
    2. aftergriddraw
    3. beforegriddraw
    4. beforetoolbarcreated
    5. cellclick
    6. celldoubleclick
    7. datachanged
    8. dataerror
    9. datafilecancelled
    10. dataloaded
    11. exportcomplete
    12. exportstart
    13. fieldslistclose
    14. fieldslistopen
    15. filteropen
    16. loadingdata
    17. loadinglocalization
    18. loadingolapstructure
    19. loadingreportfile
    20. localizationerror
    21. localizationloaded
    22. olapstructureerror
    23. olapstructureloaded
    24. openingreportfile
    25. printcomplete
    26. printstart
    27. querycomplete
    28. queryerror
    29. ready
    30. reportchange
    31. reportcomplete
    32. reportfilecancelled
    33. reportfileerror
    34. runningquery
    35. update
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 – Object. Represents the filter on values. Identifies the measure on which Top X or Bottom X filter will be applied. Has the following properties:
        • uniqueName – String. Measure unique name.
        • aggregation (optional) – String. Measure aggregation type.
      • 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.
  • drillThrough (optional) – Array. It allows pre-defining slice for the drill-through view. Only for "ocsv", "csv" and "json" data source types. Can be specified the following way: ["Hierarhy name 1", "Hierarhy 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", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "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 [].
    • 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", "runningtotals", "stdevp", "stdevs".
    • individual (optional) – Boolean. Defines whether the formula is calculated using raw values (true) or using aggregated values (false). Default value is false.
    • calculateNaN (optional) – Boolean. Defines whether the formula is calculated using the NaN values (true) or using the null values (false). Default value is true.
    • 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 – Object. Represents the filter on values. Identifies the measure on which Top X or Bottom X filter will be applied. Has the following properties:
        • uniqueName – String. Measure unique name.
        • aggregation (optional) – String. Measure aggregation type.
      • 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 – 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.