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,
  disableExpandAndCollapse: boolean,
  showAutoCalculationBar: boolean,
  autoSwitchToCompact: boolean
}

Property/Type	Description
type String	optional The selected grid’s type. The following grid types are available: `"compact"`, `"classic"`, and `"flat"`. Live example Default value: `"compact"`.
title String	optional The title of the grid. Live example 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 Live 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`) Live example. 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"`). Live example 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"`). Live example 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"`. Live example 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`) Live example. Default value: `true`.
showHierarchyCaptions Boolean	optional Specifies whether the field captions on the grid are visible (`true`) or not (`false`) Live example. Default value: `true`.
showReportFiltersArea Boolean	optional Specifies whether report filters on the grid are visible (`true`) or not (`false`) Live 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. Live example Default value: `true`.
disableExpandAndCollapse Boolean	optional When set to `true`, controls to expand and collapse inner field values on the grid are disabled. Live example Default value: `false`.
showAutoCalculationBar Boolean	optional Specifies whether the auto-calculation bar is turned on (`true`) or off (`false`) Live example. 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`.

GridOptionsObject

Properties

See also