Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Table Sizes Object
    11. Cell Data Object
    12. Chart Data Object
    13. Toolbar Object
    14. Chart Legend 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. customizeAPIRequest
    13. customizeCell
    14. customizeChartElement
    15. customizeContextMenu
    16. dispose
    17. expandAllData
    18. expandData
    19. exportTo
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getCondition
    26. getFilter
    27. getFlatSort
    28. getFormat
    29. getMeasures
    30. getMembers
    31. getOptions
    32. getReport
    33. getReportFilters
    34. getRows
    35. getSelectedCell
    36. getSort
    37. getTableSizes
    38. getXMLACatalogs
    39. getXMLACubes
    40. getXMLADataSources
    41. getXMLAProviderName
    42. load
    43. off
    44. on
    45. open
    46. openCalculatedValueEditor
    47. openFieldsList
    48. openFilter
    49. print
    50. refresh
    51. removeAllCalculatedMeasures
    52. removeAllConditions
    53. removeCalculatedMeasure
    54. removeCondition
    55. removeSelection
    56. runQuery
    57. save
    58. setFilter
    59. setFlatSort
    60. setFormat
    61. setOptions
    62. setReport
    63. setSort
    64. setTableSizes
    65. showCharts
    66. showGrid
    67. showGridAndCharts
    68. sortingMethod
    69. sortValues
    70. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. unauthorizederror
    41. update
  5. Custom data source API
    1. All requests
    2. /handshake request
    3. /fields request
    4. /members request
    5. /select request for the pivot table
    6. /select request for the flat table
    7. /select request for the drill-through view
    8. Field Object
    9. Filter Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
  7. Flexmonster Connector for amCharts
    1. All methods
    2. amcharts.getData
    3. amcharts.getCategoryName
    4. amcharts.getMeasureNameByIndex
    5. amcharts.getNumberOfMeasures
    6. amcharts.getNumberFormatPattern
Table of contents

Options Object

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

  • viewType – String. The type of view to show: "grid" or "charts" or "grid_charts" (starting from v1.9). Default value: "grid" .
  • grid – Object. Contains information about grid:
    • type – String. The selected grid’s type. The following grid types are supported: "compact", "classic", and "flat". Default value: "compact".
    • title – String. The title of the grid. Default value: "".
    • showFilter – Boolean. Indicates whether column/row filter controls and report filter controls are visible on the grid (true) or not (false). Default value: true.
    • showHeaders – Boolean. Indicates whether the spreadsheet headers are visible (true) or not (false). Default value: true.
    • showTotals – String. Specifies where to show totals: in rows ("rows"), in columns ("columns"), in rows and columns ("on") or not at all ("off"). Default value: "on".
    • showGrandTotals – String. Specifies where to show grand totals: in rows ("rows"), in columns ("columns"), in rows and columns ("on") or not at all ("off"). Default value: "on".
    • grandTotalsPosition – String. Indicates whether the grand totals are displayed at the top of the table ("top") or at the bottom ("bottom"). Only available for the flat view. Default value: "top".
    • showHierarchies – Boolean. Specifies how to show drillable hierarchy cells on the grid: with a link on the right (true) or with an icon on the left (false). Default value: true.
    • showHierarchyCaptions – Boolean. Indicates whether the hierarchy captions are visible (true) on the grid or not (false). Default value: true.
    • drillthroughMaxRows – Number. Sets the maximum number of rows for the SSAS drill-through pop-up window. Default value: 1000.
    • showReportFiltersArea (starting from v2.2) – Boolean. Indicates whether the reports filtering cells on the grid should be visible (true) or not (false). Default value: true.
    • dragging – Boolean. Indicates whether the hierarchies on the grid can be dragged (true) or not (false). Default value: true.
    • showAutoCalculationBar – Boolean. Indicates whether the autoCalculationBar feature is turned on (true) or not (false). Default value: true.
  • chart – Object. Contains information about charts:
    • type – String. The selected chart type. The following chart types are supported: "column", "bar_h", "line", "scatter", "pie", "stacked_column", and "column_line". Default value: "column".
    • title – String. The title of the chart. Default value: "".
    • showFilter – Boolean. Indicates whether column/row filter controls and report filter controls are visible on the charts (true) or not (false). Default value: true.
    • multipleMeasures – Boolean. Available from v1.9. Indicates whether to show multiple measures on charts. Default value: false.
    • oneLevel – Boolean. In a drillable chart, defines whether the chart shows all nodes on the x-axis and the legend (false) or only the lowest expanded node on the x-axis and the legend (true). Default value: false.
    • autoRange – Boolean. Indicates whether the range of values in the charts is selected automatically or not. Default value: false.
    • reversedAxes – Boolean. Reverses the columns and rows when drawing charts. Default value: false.
    • showLegend – Boolean. Indicates whether the legend for the charts is visible (true) or not (false). Default value: true.
    • showLegendButton – Boolean. Indicates whether the button to show/hide the legend for the charts is visible. When set to false, the legend is visible, without a button to hide it. Default value: false.
    • showDataLabels – Boolean. Setting this value to true allows showing labels in charts. If the value is false, the labels will be hidden. Use showAllLabels to configure the labels in a pie сhart. Default value: false.
    • showAllLabels – Boolean. Setting this value to true allows showing all the labels in a pie сhart. If the value is false then only the labels that can be shown without overlapping will be shown. Default value: false.
    • showMeasures – Boolean. Hides all dropdowns on the tops of the charts. This is useful if you want to show a simple chart without any controls or if you want to save space. When set to true, the dropdowns are visible. Default value: true.
    • showOneMeasureSelection – Boolean. When set to true, the measures dropdown is always visible – regardless of the number of measures in it. If the value is set to false, the measures dropdown on charts will be hidden if there is only one measure in the list and visible if there are two or more measures. Default value: true.
    • showWarning – Boolean. Indicates whether warnings are shown if the data is too big for charts. Default value: true.
    • position – String. The positions of the charts in relation to the grid. It can be "bottom", "top", "left", or "right". Default value: "bottom".
    • activeMeasure – Object. Identifies the selected measure in the charts view. Has the following properties:
      • uniqueName – String. The unique measure name. This measure must be present in the slice.measures property.
      • aggregation – String. The measure aggregation type. This aggregation must be defined for the measure in the slice.measures.aggregation property.
    • pieDataIndex – String. The selected column member index. Learn more about the pie chart structure.
      Indexes start from "0" (the first member of a column field). If pieDataIndex is set to a non-existing index, the default index will be used. Default value: "0".
    • axisShortNumberFormat – Boolean. Indicates whether axes labels on charts are displayed in short number format like 10K, 10M, 10B, 10T (true) or not (false). Default value: undefined (show short format if max value > 10M).
  • filter – Object. Filtering options:
    • timezoneOffset – Number. The difference (in minutes) between UTC and user’s local time zone. Used to adjust the dates in the filter. Default value: user’s local time.
    • weekOffset – Number. Sets amount of days to be added to the start of the week (Sunday). Used to adjust the first day of the week in the filter’s calendar. Default value: 1 (Monday is the first day of the week).
    • dateFormat – String. Date pattern to format dates in filter’s date inputs. Has two possible values: "dd/MM/yyyy" and "MM/dd/yyyy". Default value: "dd/MM/yyyy".
    • liveSearch – Boolean. Indicates whether the search in the filter pop-up window is performed while the user types (true) or requires the Enter button to start searching (false). Default value: true.
  • configuratorActive – Boolean. Indicates whether the Field List is opened (true) or closed (false) after the component is initialized. Default value: false.
  • configuratorButton – Boolean. Indicates whether the Field List toggle button is visible (true) or not (false). Default value: true.
  • showAggregations – Boolean. Indicates whether the aggregation selection control is visible (true) or not (false) for measures on the Field List. Default value: true.
  • showCalculatedValuesButton – Boolean. Controls the visibility of “Add calculated value” in the Field List. Default value: true.
  • showEmptyValues – Boolean | String. Specifies where to show members with empty values on the grid and charts: in rows ("rows"), in columns ("columns"), in rows and columns (true), or not at all (false). Only for "csv" and "json" data source types. Default value: false.
  • grouping – Boolean. Indicates whether grouping is enabled. This feature allows customers to group chosen elements using a filter window. For example, if the customer has shops in different cities and wants to analyze sales information, it would be possible to combine several cities in one group by geography, by sales numbers, etc. Only available for "csv"and "json" data source types. Default value: false.
  • editing – Boolean. Indicates whether the editing feature is enabled (true) or disabled (false) on the drill-through pop-up window for CSV and JSON data sources. The user will be able to double-click the cell and enter a new value into it if the editing feature is enabled. Default value: false.
  • drillThrough – Boolean. Indicates whether the drill-through feature is enabled (true) or disabled (false). The user can drill through by double-clicking the cell with a value. Default value: true.
  • showDrillThroughConfigurator – Boolean. Indicates whether the Field List toggle button is visible in the drill-through view. Only for "csv", "json", "api","microsoft analysis services" (for Flexmonster Accelerator), and "elasticsearch" data source types. Default value: true.
  • sorting – 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 at all ("off" or false). Default value: "on".
  • defaultDateType – String. Used to specify which data types should be applied to date fields by default ("date", "date string", "year/month/day", "year/quarter/month/day" or "datetime") for CSV and JSON data sources. Default value: "date".
  • strictDataTypes – Boolean. Allows increasing data analyzing speed. Only for "json" data source type. Setting strictDataTypes to true will make the component treat numeric values (or any other marked as a measure) only as measures and won’t allow using them as hierarchies. To enable this feature, add isMeasure: true to the necessary numeric fields (check out an example). Default value: false.
  • distinguishNullUndefinedEmpty – Boolean. Allows distinguishing null, undefined, and empty values. When set to false, the component treats null, undefined, and empty values as the same value. When set to true, there are three different values. Default value: false.
  • datePattern – String. Allows specifying how the component displays “date string” date fields ("type": "date string" in JSON, "ds+" prefix in CSV). Default pattern string: "dd/MM/yyyy".
  • dateTimePattern – String. Allows specifying how the component displays “datetime” date fields ("type": "datetime" in JSON, "dt+" prefix in CSV). Default pattern string: "dd/MM/yyyy HH:mm:ss".
  • timePattern – String. Allows specifying how the component displays “time” date fields ("type": "time" in JSON, "t+" prefix in CSV). Default pattern string:"HH:mm:ss".
  • dateTimezoneOffset – Number. It allows setting the timezone for hierarchical dates (for JSON: "date", "year/month/day" and "year/quarter/month/day"; for CSV: "d+", "D+" and "D4+"). See an example.
  • saveAllFormats – Boolean. If there are more than 5 formats defined, only the formats that are used for "active: true" measures will be saved in the report. In order to save all the formats, set the saveAllFormats property to true. Default value: false.
  • showDefaultSlice – Boolean. Defines whether the component selects a default slice for a report with an empty slice (when nothing is set in rows, columns, report filters, 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, set this property to false. Only available for "csv" and "json" data source types. Default value: true.
  • useOlapFormatting  – Boolean. Indicates whether the values from data source will be formatted according to the format defined in the cube (true) or not (false). Default value: false.
  • showMemberProperties – Boolean. Indicates whether the member properties for an OLAP data source are available in the component (true) or not (false). This feature is only for "microsoft analysis services" and "mondrian" data source types. Default value: false.
  • showEmptyData – Boolean. It defines the component’s behavior in case of an empty data source. Flexomontser handles the empty data in two ways:
    • when showEmptyData is set to true, the component will show an empty grid for an empty CSV/JSON file, a JSON file with an empty array, or an empty inline JSON array. For an empty CSV data source with the defined header, the component will show the slice with empty data cells.
    • when showEmptyData is set to false, the component will show a message “Data source is empty” and trigger a dataerror event for all mentioned types of the empty data source. See an example on JSFiddle.
    Default value: true.
  • defaultHierarchySortName – String. The sorting type for hierarchies’ members ("asc", "desc", or "unsorted"). Default value: "asc".
  • showOutdatedDataAlert – Boolean. Setting this value to true will show a warning to the user before automatic reloading of data from the cube. When set to false, there is no warnings. Only for Flexmonster Accelerator. Default value: false.
  • showAggregationLabels – Boolean. Indicates whether aggregation labels like "Total Sum of", "Sum of", etc. are shown in the column/row titles. Default value: true.
  • showAllFieldsDrillThrough – Boolean. Indicates whether prefiltering the drill-through view columns is enabled (false) or the drill-through view displays all the available columns (true) when using SSAS with Flexmonster Accelerator. Default value: false.
  • liveFiltering – Boolean. Indicates whether the live filtering for hierarchies’ members is enabled (true) or disabled (false). Default value: false.
  • showFieldListSearch – Boolean. Indicates whether the search bar in the Field List is shown (true) or hidden (false). When the search bar is hidden, it will be shown only in case the number of the hierarchies exceeds 50 (40 for the flat form). Default value: false.
  • useCaptionsInCalculatedValueEditor – Boolean. By default, Flexmonster uses field unique names in the calculated value editor. If useCaptionsInCalculatedValueEditor is set to true, the component will use field captions instead of unique names. Default value: false.
  • validateFormulas – Boolean. Indicates whether the validation is performed for calculated values (true) or not (false). In case the validation is turned on and the report contains invalid formula, the “Wrong formula format” alert message is shown. To turn off the “Wrong formula format” alert message, set the validateFormulas property to false. Default value: true.
  • caseSensitiveMembers – Boolean. Indicates whether the hierarchies’ members are case-sensitive (true) or not (false). Default value: false.
  • simplifyFieldListFolders – Boolean. Indicates whether the folders containing one field should show this field in the root (true) or not (false). Only for Elasticsearch and SSAS data sources. Default value: false.
  • validateReportFiles – Boolean. Indicates whether validation of report files is turned on (true) or turned off (false). Setting this value to false allows loading report files in the old format without an error message. Should be used in global options. Default value: true.
  • fieldListPosition – String. Indicates whether the Field List is always shown on the right ("right") or in the pop-up window (undefined). Default value: undefined.
  • allowBrowsersCache – Boolean. Indicates whether browsers are allowed to cache the data (true) or not (false). When allowBrowsersCache is set to false, caching is not allowed, and Flexmonster appends a unique id to the data source’s URL to ensure that the URL stays unique. The unique URL prevents the browser from loading the data from its cache, so the data is updated every time it is requested. Setting allowBrowsersCache to true allows caching, and the URL remains unmodified (check out an example). Default value: false.

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

More information about options is available in article about Options Object.