Menu
Download Free Trial
Table of contents

Report Object

All the possible aspects of pivot tables and pivot charts configuration can be set via report object. The component supports saving reports and loading of previously saved ones.

Report object has the following properties:

  • dataSource – Object. Contains information about data source:
    • browseForFile – Boolean. Defines whether you want to load CSV file from the local file system (true) or not (false). Default value is false. Only for CSV and JSON data source type.
    • catalog – String. The data source catalog name of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types).
    • cube – String. Given catalog’s cube’s name of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types).
    • data (starting from v2.2) – Property to set JSON data if it is already on the page. See example in addJSON().
    • dataSourceInfo – String. The service info of the OLAP data source (only for "microsoft analysis services", "mondrian", "iccube" data source types).
    • dataSourceType – String. Type of data source. The component supports the following types: "microsoft analysis services", "mondrian", "iccube", "csv", "ocsv" and "json".
    • fieldSeparator – String. Defines specific fields separator to split CSV row (only for CSV data source type). There is no need to define it if CSV fields are separated by , or ;. This property is used if another char separates fields. For example, if you use TSV, where tab char is used to separate fields in row, fieldSeparator parameter should be defined as "\t".
    • filename – String. The URL to CSV or JSON file or to server-side script which generates CSV data or JSON data (only for CSV and JSON data source type).
    • ignoreQuotedLineBreaks (starting from v2.1) – Boolean. Indicates whether the line breaks in quotes will be ignored (true) in CSV files or not (false). Default value is true, which makes CSV parsing faster. Set it to false only if your data source has valuable for you line breaks in quotes. Please note that this might slow down CSV parsing a little bit.
    • proxyUrl – String. The path to proxy URL to the OLAP data source, such as Microsoft Analysis Services, Mondrian, icCube (only for "microsoft analysis services", "mondrian", "iccube" data source types).
    • recordsetDelimiter – String. Defines which char is used in CSV to denote the end of CSV row (only for CSV data source type). Default value is "↵".
    • subquery – String. The parameter to set the server-side filter which helps to decrease the size of the response from the OLAP cube (only for "microsoft analysis services" and "iccube" data source types). For example, to show reports only for one specific year set subquery the following way: "subquery": "select {[Delivery Date].[Calendar].[Calendar Year].&[2008]} on columns from [Adventure Works]".

  • sliceSlice Object. There you can define fields that go to rows, go to columns and go to measures, add filtering, sorting, report filtering, expands and drills.

  • options – Object. Contains information about options:
    • chart – Object. Contains information about charts:
      • activeMeasure – String. Selected measure on charts view.
      • activeTupleIndex – Number. Selected tuple index on the Pie chart.
      • autoRange – Boolean. Indicates whether the range of values on the charts is selected automatically or not.
      • multipleMeasures – Boolean. Starting from v1.9. Indicates whether to show multiple measures on charts. Default value is false.
      • oneLevel (starting from v2.1) – Boolean. In case of drillable chart, defines whether chart shows elements only for the lowest hierarchy (true). Default value is false. Bar, Line, Scatter, Bar stack and Bar line charts support this feature.
      • showFilter (starting from v2.2) – Boolean. Indicates whether the opening columns and rows filter controls are visible (true) or not (false) on the charts. Default value is true.
      • showLegendButton (starting from v2.2) – Boolean. Indicates whether the button to show/hide the legend on charts is visible. Default value is false which means that the legend is always visible, without the button that hides it.
      • showMeasures (starting from v2.2) – Boolean. Hides all dropdowns on the top of charts if you want to show simple chart without controls or you want to save space. Default value is true – the dropdowns are visible by default, as it was in previous versions.
      • showWarning – Boolean. Indicates whether the warning are shown if data is too big for charts.
      • title – String. Title of the chart.
      • type – String. Selected chart type. The following chart types are supported: "bar", "line", "scatter", "pie", "bar_stack" and "bar_line" (starting from v1.9).
    • configuratorActive – Boolean. Indicates whether the Fields List is opened (true) or closed (false).
    • configuratorButton – Boolean. Indicates whether the Fields List toggle button is visible (true) or not (false).
    • configuratorMatchHeight (starting from v2.1) – Boolean. Indicates whether the Fields List will be the same height as the component (true) or it’s height will be defined by its content amount (false). Default value is false.
    • datePattern – String. It is used to format “date string” date fields ("type":"date string" in JSON, "ds+" prefix in CSV). A default pattern string is dd/MM/yyyy.
    • dateTimePattern – String. It is used to format “datetime” date fields ("type":"datetime" in JSON, "dt+" prefix in CSV). A default pattern string is dd/MM/yyyy HH:mm:ss.
    • defaultHierarchySortName (starting from v2.0) – String. Sorting type for hierarchies’ members ("asc", "desc" or "unsorted"). Default value is "asc".
    • drillThrough (starting from v2.1) – Boolean. Indicates whether the drill through feature is enabled (true) or disabled (false). User can drill through by double-clicking the cell with value. This feature is available for all data sources except icCube. Default value is true.
    • editing (starting from v2.1) – Boolean. Indicates whether the editing feature is enabled (true) or disabled (false) on the Drill Through popup for CSV, OCSV and JSON data sources. User will be able to double-click the cell and enter new value in it if the editing feature is enabled.
    • grid – Object. Contains information about grid:
      • fitGridlines – Boolean. Indicates whether the gridlines are shown for all cells (false) or only non-empty (true).
      • pagesFilterLayout (starting from v2.3) – String. Allows to choose the layout for the report filters. Possible values: "horizontal" and "vertical". Default value is "horizontal".
      • showFilter – Boolean. Indicates whether the opening columns/rows filter controls and page filter controls are visible (true) or not (false) on the grid. Default value is true.
      • showGrandTotals – String. Specifies how to show grand totals: in rows ("rows"), in columns ("columns"), in rows and columns ("on") or hide them ("off"). Default value is "on".
      • showHeaders – Boolean. Indicates whether the spreadsheet headers are visible (true) or not (false).
      • showHierarchies – Boolean. Specifies how to show drillable hierarchy cells on the grid: with link on the right (true) or with icon on the left (false). Default value is true.
      • showHierarchyCaptions – Boolean. Indicates whether the hierarchy captions are visible (true) or not (false) on the grid. Default value is true.
      • showReportFiltersArea (starting from v2.2) – Boolean. Indicates whether the reports filtering cells on the grid should be visible (true) or not (false). Default value is true.
      • showTotals – Boolean. Indicates whether the totals are visible (true) or not (false).
      • title – String. Title of the grid.
      • type – String. Selected grid type. The following grid types are supported: "compact", "classic" and "flat".
    • selectEmptyCells (starting from v2.3) – Boolean. Indicates whether it is possible to select cells outside of the table. Default value is true.
    • showAggregations (starting from v2.0) – Boolean. Indicates whether the aggregation selection control is visible (true) or not (false) for measures on Fields List. Default value is true.
    • showCalculatedValuesButton (starting from v2.2) – Boolean. Controls the visibility of “Add calculated value” in Fields List. Default value is true.
    • showDefaultSlice (starting from v2.2) – Boolean. Defines whether the component selects a default slice for the report with empty slice (when nothing is set in rows, columns, pages and measures). If true, the first hierarchy from data goes to rows and the first measure goes to columns in the default slice. To avoid this default behavior, please set this property to false. Default value is true. This feature is available for JSON, CSV and OCSV data sources.
    • showMemberProperties – Boolean. Indicates whether the member properties for OLAP data source are available in the component (true) or not (false). Default value is false. This feature is only for "microsoft analysis services" and "mondrian" data source types.
    • sorting (starting from v2.0) – String. Indicates whether the sorting controls are visible in rows ("rows"), in columns ("columns"), in rows and columns ("on" or true) on the grid cells or not visible ("off" or false). Default value is "on".
    • useOlapFormatting (starting from version 2.1) – Boolean. It works for MSAS data source (XMLA and Accelerator) and for Mondrian (only Accelerator). Indicates whether the values from data source will be formatted according to the format defined in the cube (true) or not (false). Default value is false.
    • viewType – String. Type of view to show: "grid" or "charts" or "grid_charts" (starting from v1.9).

  • conditions – Array of Conditional Format Objects.

  • formats – Array of Format Objects.

  • tableSizes – Object. Contains information about table sizes:
    • columns – Array of objects. Each object is used to save and restore width of some column in report:
      • width – Number. Column width in pixels.
      • idx – Number. Index of the column, starts from 0.
      • tuple – Array. Consists of unique names that identifies the column in the table based on data in it.
      • measure(optional) – String. Measure unique name (this property is defined only if “[Measures]” is selected for columns in the slice). measure is used with tuple and is not set when idx is used.

      Please note, it’s necessary to use either idx or tuple, not both.

    • rows – Array of objects. Each object is used to save and restore height of some row in report:
      • height – Number. Row height in pixels.
      • idx – Number. Index of the row, starts from 0.
      • tuple – Array. Consists of unique names that identifies the row in the table based on data in it.
      • measure(optional) – String. Measure unique name (this property is defined only if “[Measures]” is selected for rows in the slice). measure is used with tuple and is not set when idx is used.

      Please note, it’s necessary to use either idx or tuple, not both.

  • localization – Property to set a localization. It can be inline JSON or URL to localization JSON file.

You can get the report using getReport() API call. To set the report use setReport() API call.

Example

Example of report object:

{
    "dataSource": {
        "dataSourceType": "microsoft analysis services",
        "proxyUrl": "http://olap.flexmonster.com/olap/msmdpump.dll",
        "dataSourceInfo": "WIN-IA9HPVD1RU5",
        "catalog": "Adventure Works DW Standard Edition",
        "cube": "Adventure Works",
        "binary": false
    },
    "slice": {
        "rows": [
            {
                "uniqueName": "[Geography].[Geography]",
                "levelName": "[Geography].[Geography].[State-Province]",
                "filter": {
                    "members": [
                        "[Geography].[Geography].[City].&[Malabar]&[NSW]",
                        "[Geography].[Geography].[City].&[Lavender Bay]&[NSW]",
                        "[Geography].[Geography].[City].&[Matraville]&[NSW]",
                        "[Geography].[Geography].[City].&[Milsons Point]&[NSW]"
                    ],
                    "negation": true
                },
                "sort": "asc"
            },
            {
                "uniqueName": "[Sales Channel].[Sales Channel]",
                "sort": "asc"
            }
        ],
        "columns": [
            {
                "uniqueName": "[Measures]"
            }
        ],
        "measures": [
            {
                "uniqueName": "[Measures].[Reseller Order Count]",
                "aggregation": "none",
                "active": true,
                "format": "29mvnel3"
            }
        ],
        "expands": {
            "expandAll": false,
            "rows": [
                {
                    "tuple": [
                        "[Geography].[Geography].[Country].&[Australia]"
                    ]
                },
                {
                    "tuple": [
                        "[Geography].[Geography].[City].&[Lane Cove]&[NSW]"
                    ]
                }
            ]
        },
        "drills": {
            "drillAll": false,
            "rows": [
                {
                    "tuple": [
                        "[Geography].[Geography].[Country].&[Australia]"
                    ]
                },
                {
                    "tuple": [
                        "[Geography].[Geography].[State-Province].&[NSW]&[AU]"
                    ]
                },
                {
                    "tuple": [
                        "[Geography].[Geography].[City].&[Darlinghurst]&[NSW]"
                    ]
                }
            ]
        }
    },
    "options": {
        "viewType": "grid",
        "grid": {
            "type": "compact",
            "title": "",
            "showFilter": true,
            "showHeaders": true,
            "fitGridlines": false,
            "showTotals": true,
            "showGrandTotals": "on",
            "showExtraTotalLabels": false,
            "showHierarchies": true,
            "showHierarchyCaptions": true,
            "showReportFiltersArea": true,
            "pagesFilterLayout": "horizontal"
        },
        "chart": {
            "type": "bar",
            "title": "",
            "showFilter": true,
            "multipleMeasures": false,
            "oneLevel": false,
            "autoRange": false,
            "reversedAxes": false,
            "showLegendButton": false,
            "showAllLabels": false,
            "showMeasures": true,
            "showOneMeasureSelection": true,
            "showWarning": true,
            "activeMeasure": ""
        },
        "configuratorActive": true,
        "configuratorButton": true,
        "configuratorMatchHeight": false,
        "showAggregations": true,
        "showCalculatedValuesButton": true,
        "editing": false,
        "drillThrough": true,
        "showDrillThroughConfigurator": true,
        "sorting": "on",
        "datePattern": "dd/MM/yyyy",
        "dateTimePattern": "dd/MM/yyyy HH:mm:ss",
        "saveAllFormats": false,
        "showDefaultSlice": true,
        "showEmptyData": false,
        "defaultHierarchySortName": "asc",
        "selectEmptyCells": true,
        "showOutdatedDataAlert": false
    },
    "conditions": [
        {
            "formula": "if(#value < 40, 'trueStyle')",
            "trueStyle": {
                "backgroundColor": "#FFCCFF",
                "color": "#000033",
                "fontFamily": "Arial",
                "fontSize": 12
            },
            "falseStyle": {}
        }
    ],
    "formats": [
        {
            "name": "29mvnel3",
            "thousandsSeparator": " ",
            "decimalSeparator": ".",
            "decimalPlaces": -1,
            "maxDecimalPlaces": -1,
            "maxSymbols": 20,
            "currencySymbol": "$",
            "currencySymbolAlign": "left",
            "nullValue": "",
            "infinityValue": "Infinity",
            "divideByZeroValue": "Infinity",
            "textAlign": "right",
            "isPercent": false
        }
    ],
    "tableSizes": {
        "columns": [
            {
                "tuple": [],
                "measure": "[Measures].[Reseller Order Count]",
                "width": 182
            }
        ]
    },
    "localization": "loc-ua.json"
}