Need a special offer?Find out if your project fits.
+
All documentation
  • 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,
    showReportFiltersArea: boolean,
    dragging: boolean,
    showAutoCalculationBar: boolean,
    autoSwitchToCompact: boolean
    }
    Property/TypeDescription
    type
    String
    optional The selected grid’s type. The following grid types are available: "compact", "classic", and "flat".
    Default value: "compact".
    title
    String
    optional The title of the grid.
    Default value: "".
    showFilter
    Boolean
    optional Specifies whether filter controls are visible on the grid (true) or not (false). These include rows and columns filter controls and report filter controls. See an example.
    To hide filter controls in the chart view, use the chart.showFilter option.
    Default value: true.
    showHeaders
    Boolean
    optional Specifies 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 Specifies where the grand totals are displayed: at the top of the table ("top") or at the bottom ("bottom"). Only for grid.type: "flat".
    Check out an example on JSFiddle.
    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). See an example on JSFiddle.
    Default value: true.
    showHierarchyCaptions
    Boolean
    optional Specifies whether the hierarchy captions on the grid are visible (true) or not (false). Check out an example on JSFiddle.
    Default value: true.
    showReportFiltersArea
    Boolean
    optional Specifies whether report filters on the grid are visible (true) or not (false). See an example.
    To hide report filters in the chart view, use the chart.showFilter option.
    Default value: true.
    dragging
    Boolean
    optional Specifies 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 Specifies whether the auto-calculation bar is turned on (true) or off (false).
    Default value: true.
    autoSwitchToCompact
    Boolean
    optional Specifies whether the component automatically switches from the classic (tabular) to the compact form (true) or not (false).
    By default, Flexmonster automatically switches to the compact form when there are too many header cells and value cells become inaccessible.
    Default value: true.

    See also

    Options guide
    OptionsObject
    ChartOptionsObject
    getOptions()
    setOptions()