Need a special offer?Find out if your project fits.
+
All documentation
API reference
  • API Reference for older versions
  • GridOptionsObject

    This object allows setting options for the grid view.

    Properties

    grid: {
      type: string,
      title: string,
      showFilter: boolean,
      showHeaders: boolean,
      showTotals: string,
      showGrandTotals: string,
      grandTotalsPosition: string,
      showHierarchies: boolean,
      showHierarchyCaptions: boolean,
      drillThroughMaxRows: number,
      showReportFiltersArea: boolean,
      dragging: boolean,
      showAutoCalculationBar: boolean,
      autoSwitchToCompact: boolean
    }
    Property/Type Description
    type
    String
    optional The selected grid’s type. The following grid types are supported: "compact", "classic", and "flat".
    Default value: "compact".
    title
    String
    optional The title of the grid.
    Default value: "".
    showFilter
    Boolean
    optional Indicates whether column/row filter controls and report filter controls are visible on the grid (true) or not (false).
    Default value: true.
    showHeaders
    Boolean
    optional Indicates whether the spreadsheet headers are visible (true) or not (false).
    Default value: true.
    showTotals
    String
    optional 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
    optional 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
    optional Indicates whether the grand totals are displayed at the top of the table ("top") or at the bottom ("bottom").
    Only for the flat form.
    Default value: "top".
    showHierarchies
    Boolean
    optional 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
    optional Indicates whether the hierarchy captions are visible (true) on the grid or not (false).
    Default value: true.
    drillThroughMaxRows
    Number
    optional Sets the maximum number of rows for the drill-through view.
    When set to 0, the maximum number of rows is unlimited for the Data Server.
    Only for "api", "microsoft analysis services", and "elasticsearch" data source types.
    Default value: 1000.
    showReportFiltersArea
    Boolean
    optional Indicates whether report filter controls are visible on the grid (true) or not (false).
    Default value: true.
    dragging
    Boolean
    optional Indicates whether fields on the grid are draggable (true) or not (false). When set to true, fields can be dragged:
    • Between columns, rows, and report filters.
    • Out of the grid.
    Default value: true.
    showAutoCalculationBar
    Boolean
    optional Indicates whether the auto-calculation bar is turned on (true) or not (false).
    Default value: true.
    autoSwitchToCompact
    Boolean
    optional Indicates whether the automatic switch from the classic to the compact form is enabled (true) or not (false).
    Flexmonster automatically switches from the classic to the compact form when there are too many header cells and value cells become inaccessible. Set autoSwitchToCompact to false to disable this feature. 
    Default value: true.

    See also

    Options guide
    OptionsObject
    ChartOptionsObject
    getOptions()
    setOptions()