Menu
Download Free Trial
Table of contents

Options Object

Options object is used to specify appearance and functionality available for customers. It has the following properties:

  • chart – Object. Contains information about charts:
    • autoRange – Boolean. Indicates whether the range of values on the charts is selected automatically or not. Default value is false.
    • multipleMeasures – Boolean. Starting from v1.9. Indicates whether to show multiple measures on charts. Default value is false.
    • oneLevel – Boolean. Starting from v2.1. 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 is shown if data is too big for charts. Default value is true.
    • title – String. Title of the chart.
    • type – String. Selected chart type: "bar", "line", "scatter", "pie", "bar_stack" and "bar_line" (starting from v1.9). Default value is "bar".
  • configuratorActive – Boolean. Indicates whether the Fields List is opened (true) or closed (false). Default value is false.
  • configuratorButton – Boolean. Indicates whether the Fields List toggle button is visible (true) or not (false). Default value is true.
  • 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.
  • defaultHierarchySortName – String. Sets default sorting for hierarchy members. Possible values: "asc", "desc" and "unsorted" (starting from v2.3). 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). Default value is false.
    • 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). 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). Default value is true.
    • title – String. Title of the grid.
    • type – String. Selected grid type: "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).

Get Options Object via getOptions() API call. Set this object via setOptions().