Get Free Trial
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Slice Object
    5. Options Object
    6. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    7. Format Object
    8. Conditional Format Object
    9. Cell Data Object
    10. Toolbar 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. getFilter
    25. getFormat
    26. getMeasures
    27. getMembers
    28. getOptions
    29. getReport
    30. getReportFilters
    31. getRows
    32. getSelectedCell
    33. getSort
    34. getXMLACatalogs
    35. getXMLACubes
    36. getXMLADataSources
    37. getXMLAProviderName
    38. load
    39. off
    40. on
    41. open
    42. openCalculatedValueEditor
    43. openFieldsList
    44. openFilter
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setFilter
    55. setFormat
    56. setOptions
    57. setReport
    58. setSort
    59. showCharts
    60. showGrid
    61. showGridAndCharts
    62. sortingMethod
    63. sortValues
    64. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. datachanged
    9. dataerror
    10. datafilecancelled
    11. dataloaded
    12. exportcomplete
    13. exportstart
    14. fieldslistclose
    15. fieldslistopen
    16. filterclose
    17. filteropen
    18. loadingdata
    19. loadinglocalization
    20. loadingolapstructure
    21. loadingreportfile
    22. localizationerror
    23. localizationloaded
    24. olapstructureerror
    25. olapstructureloaded
    26. openingreportfile
    27. printcomplete
    28. printstart
    29. querycomplete
    30. queryerror
    31. ready
    32. reportchange
    33. reportcomplete
    34. reportfilecancelled
    35. reportfileerror
    36. runningquery
    37. 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) – 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 "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", "median", "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: +, -, *, / (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, OCSV and JSON data sources: "sum", "count", "distinctcount", "average", "median", "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.
  • 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 "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) – 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 "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.