public class GxOptions
The class holds the grid configuration properties
Every property and method has one or more tag attached.
The following is the meaning for each tag :
| Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
| Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
| API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
| ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
| GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
| Modifier and Type | Field and Description | ||||||
|---|---|---|---|---|---|---|---|
BBjNumber | AccentedSort!Set to true to specify that the sort should take into account accented characters, if this feature is turned on the sort will perform slower.
| ||||||
BBjNumber | AlwaysShowVerticalScroll!Set to true to always show the vertical scrollbar.
| ||||||
BBjNumber | AnimateRows!Set to true to enable Row Animation.
| ||||||
GxAutoGroupColumn | AutoGroupColumnDefinition!Allows specifying the group 'auto column' if you are not happy with the default.
If grouping, this column def is included as the first column definition in the grid.
If not grouping, this column is not included.
| ||||||
BBjNumber | AutoSizePadding!How many pixels to add to a column width after the auto-sizing calculation. The default is 4 pixels. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
| ||||||
JsonObject | ClientContext!A json object which is used as context to configure the grid and it various components on the client | ||||||
BBjNumber | ColumnHoverHighlight!Set to true to highlight columns by adding the | ||||||
GxContextMenu | ContextMenu!The grid context menu
| ||||||
BBjString | DataPathTemplate!A string template which will be compiled on the client to return an array for the tree hierarchy.
| ||||||
GxDefaultColumnDefinition | DefaultColumnDefinition!Contains column properties all columns will inherit.
| ||||||
GxDefaultColumnGroup | DefaultColumnGroupDefinition!Contains column group properties all column groups will inherit.
| ||||||
BBjNumber | DeltaColumnMode!By default when new columns are loaded into the grid, the following properties (Order, Aggregation Function, Width, Pivot, Row Group, Pinned ) are not used To change this behaviour and have column attributes above take effect each time the grid updates the columns, then set this option to true
| ||||||
BBjString | EditType!Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
| ||||||
BBjNumber | EnableBrowserTooltips!Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
| ||||||
BBjNumber | EnableCharts!Set to true to enable charting
| ||||||
BBjNumber | EnableFloatingFilter!When true enables the floating filters, disable otherwise
| ||||||
BBjNumber | EnableRangeSelection!Set to true to enable Range Selection
| ||||||
BBjNumber | EnableRtl!Set to true to operate grid in RTL (Right to Left) mode.
| ||||||
BBjNumber | EnterMovesDown!Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.
| ||||||
BBjNumber | EnterMovesDownAfterEdit!Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.
| ||||||
BBjNumber | FloatingFiltersHeight!The height for the row containing the floating filters. If not specified the default is 20px.
| ||||||
BBjNumber | FunctionsReadOnly!If true, then row group, pivot and value aggregation will be read only from the UI.
The grid will display what values are used for each, but will not allow the use to change the selection
| ||||||
BBjNumber | GroupDefaultExpanded!If grouping, set to the number of levels to expand by default. Eg 0 for none, 1 first level only, etc. Default is 0 (expand none). Set to -1 for expand everything
| ||||||
BBjString | GroupDisplayType!Specifies how the results of row grouping should be displayed. The options are:
| ||||||
BBjNumber | GroupHeaderHeight!The height for the rows containing header column groups. If not specified, it uses headerHeight
| ||||||
BBjNumber | GroupHideOpenParents!Set to true to hide parents that are open. When used with multiple columns for showing groups, it can give more pleasing user experience
| ||||||
BBjNumber | GroupIncludeFooter!If grouping, whether to show a group footer when the group is expanded.
If true, then by default, the footer will contain aggregate data (if any)
when shown and the header will be blank.
When closed, the header will contain the aggregate data regardless
of this setting (as footer is hidden anyway).
This is handy for 'total' rows, that are displayed below the data when
the group is open, and alongside the group when it is closed
| ||||||
BBjNumber | GroupIncludeTotalFooter!Set to true to show a 'grand' total group footer across all groups.
| ||||||
BBjNumber | GroupMultiAutoColumn!If using auto column, set to true to have each group in its own column separate column, eg if group by Country then Year, two auto columns will be created, one for country and one for year
| ||||||
BBjNumber | GroupRemoveLowestSingleChildren!Set to true to collapse lowest level groups that only have one child.
| ||||||
BBjNumber | GroupRemoveSingleChildren!Set to true to collapse groups that only have one child.
| ||||||
BBjNumber | GroupSelectsChildren!When true, selecting a group will have the impact of selecting all its children
When false, then the group is selectable independently of the child nodes.
| ||||||
BBjNumber | GroupSelectsFiltered!If using groupSelectsChildren, then only the children that pass the current filter will get selected
| ||||||
BBjNumber | GroupSuppressAutoColumn!If true, the grid will not swap in the grouping column when grouping is enabled.
Use this if you want complete control on the column displayed and don't want the grids help.
In other words, you already have a column in your column definitions that is responsible for displaying the groups
| ||||||
BBjNumber | GroupSuppressBlankHeader!If true, and showing footer, aggregate data will be displayed at both the header and footer levels always.
This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
| ||||||
BBjNumber | GroupSuppressRow!If true, the group row won't be displayed and the groups will be expanded by default with no ability to expand / contract the groups. Useful when you want to just 'group' the rows, but not add parent group row to each group
| ||||||
BBjNumber | GroupUseEntireRow!If grouping, set to true or false (default is false).
If true, a group row will span all columns across the entire width of the table.
If false, the cells will be rendered as normal and you will have the opportunity to include
a grouping column (normally the first on the left) to show the group
| ||||||
BBjNumber | HeaderHeight!The height for the row containing the column label header. If not specified the default is 25px.
| ||||||
JsonObject | Icons!Icons to use inside the grid instead of the grid's default icons. The icons can either be set on the grid options (all icons) or on the column definition (all except group).
If defined in both the grid options and column definitions, the column definition will get used.
This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
and just the simple arrow for other columns.
| ||||||
BBjNumber | ImmutableColumns!Puts the grid into Immutable Column mode, so that setting new columns keeps column state. Default: false
| ||||||
GxLanguageManager | LanguageManager!The grid language manager | ||||||
BBjNumber | MultipleSelection!Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
| ||||||
BBjString | NavigationBehavior!Defines how users can move between rows using arrow keys.
| ||||||
BBjString | OverlayLoadingTemplate!Provide a template for 'loading' overlay if not happy with the default one.
| ||||||
BBjString | OverlayNoRowsTemplate!Provide a template for 'no rows' overlay if not happy with the provided.
| ||||||
ResultSet | PinnedBottomRows!The ResultSet instance which contains the bottom pinned rows | ||||||
ResultSet | PinnedTopRows!The ResultSet instance which contains the top pinned rows | ||||||
BBjNumber | PivotGroupHeaderHeight!The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
| ||||||
BBjNumber | PivotHeaderHeight!The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
| ||||||
BBjNumber | PivotMode!Set to true to enable pivot mode
| ||||||
BBjNumber | PivotPanelShow!When to show the 'pivot panel' (where you drag rows to pivot) at the top.
Default is never. Set to either 'always' or 'onlyWhenPivoting'.
Note that the pivot panel will never show if pivotMode is off.
| ||||||
BBjNumber | RememberGroupStateWhenNewData!When true, if you set new data into the grid and have groups open, the grid will keep groups open if they exist in the new dataset
| ||||||
ArrayList | RowClass!Property to set CSS class for all rows
| ||||||
JsonObject | RowClassRules!Rules which can be applied to include certain CSS classes for rows. These rules are provided as a JavaScript map where the keys are class names and the values are expressions that
if evaluated to true, the class gets used. The expression is a string which is treated as a shorthand for a
function by the grid. The expression has the following attributes available:
| ||||||
BBjNumber | RowDeselection!Set to true or false. If true, then rows will be deselected if you
hold down ctrl + click the row. Normal behaviour with the grid disallows
deselection of nodes (ie once a row is selected, it remains selected until
another row is selected in its place).
| ||||||
BBjString | RowGroupPanelShow!When to show the 'row group panel' (where you drag rows to group) at the top. Default is never. Set to either 'always' or 'onlyWhenGrouping'
| ||||||
BBjNumber | RowHeight!Default Row Height in pixels. Default is 25 pixels.
| ||||||
BBjNumber | RowMultiSelectWithClick!Set to true to allow multiple rows to be selected with a single click. E.g. if you click select one row, then click select another row, the first row will keep it's selection.
Clicking a selected row in this mode will deselect the row.
This is useful for touch devices where ctrl and shift clicking is
not an option.
| ||||||
JsonObject | RowStyle!Property to set style for all rows. Set to an object of key (style names) and values (style values)
| ||||||
BBjNumber | ShowHeaderSelectionCheckbox!When true, selection box will be show on the first column's header
When false, no checkbox will be displayed.
| ||||||
BBjNumber | ShowSelectionCheckbox!When true, A selection box will be shown on the first column
When false, no checkbox will be displayed.
| ||||||
GxSidebar | Sidebar!The grid sidebar | ||||||
BBjNumber | SingleClickEdit!Set to true to enable Single Click Editing for cells, to start editing with a single click.
| ||||||
BBjNumber | SkipHeaderOnAutoSize!Set this to true to skip the headerName when autoSize is called by default
| ||||||
GxStatusBar | Statusbar!The grid statusbar | ||||||
BBjNumber | StopEditingWhenGridLosesFocus!Set this to true to stop cell editing when grid loses focus. The default is the grid stays editing until focus goes onto another cell. For inline (non-popup) editors only.
| ||||||
BBjNumber | SuppressAggAtRootLevel!When true, the aggregations won't be computed for root node of the grid
| ||||||
BBjNumber | SuppressAggFuncInHeader!When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
| ||||||
BBjNumber | SuppressAnimationFrame!When true, the grid will not use animation frames when drawing rows while scrolling.
Use this if the grid is working fast enough that you don't need animations frame and you don't want the grid to flicker.
| ||||||
BBjNumber | SuppressAutoSize!Suppresses auto-sizing columns for columns. In other words, double-clicking a column header's edge will not auto-size.Default is false
| ||||||
BBjNumber | SuppressCellSelection!If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. Default: false | ||||||
BBjNumber | SuppressClickEdit!Set to true so that neither single or double-click starts editing.
| ||||||
BBjNumber | SuppressColumnMoveAnimation!If true, the ag-column-moving class is not added to the grid while columns are moving. In the default themes, this transpires to no animation for moving columns.
| ||||||
BBjNumber | SuppressColumnVirtualisation!Set to true so that the grid doesn't virtualize the columns. S o if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
| ||||||
BBjNumber | SuppressContextMenu!Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
| ||||||
BBjNumber | SuppressDragLeaveHidesColumns!If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
| ||||||
BBjNumber | SuppressHorizontalScroll!Set to true to never show the horizontal scroll.
| ||||||
BBjNumber | SuppressLoadingOverlay!Disables the 'loading' overlay.
| ||||||
BBjNumber | SuppressMaintainUnsortedOrder!Set to true to suppress sorting of un-sorted data to match original row data
| ||||||
BBjNumber | SuppressMakeVisibleAfterUnGroup!By default when a column is un-grouped, it is made visible.
This property stops the column becoming visible again when un-grouping.
| ||||||
BBjNumber | SuppressMenuHide!Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
| ||||||
BBjNumber | SuppressMiddleClickScrolls!If true, then middle clicks will result in 'click' events for cell and row. Otherwise the browser will use middle click to scroll the grid.
| ||||||
BBjNumber | SuppressMovableColumns!Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
| ||||||
BBjNumber | SuppressMultiRangeSelection!Enable / disable one range selection even if ctrl key is held down
| ||||||
BBjNumber | SuppressMultiSort!Set to true to suppress multi-sort when the user shift-clicks a column header.
| ||||||
BBjNumber | SuppressNoRowsOverlay!Disables the 'no rows' overlay.
| ||||||
BBjNumber | SuppressRowClickSelection!If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
| ||||||
BBjNumber | SuppressRowDeselection!If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
| ||||||
BBjNumber | SuppressRowHoverHighlight!Set to true to not highlight rows by adding the | ||||||
BBjNumber | SuppressRowTransform!Uses CSS top instead of CSS transform for positioning rows. Useful if the transform function is causing issues such as used in row spanning. Default: false
| ||||||
BBjNumber | SuppressScrollOnNewData!When true, the grid will not scroll to the top when new row data is provided.
Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
| ||||||
BBjNumber | SuppressSetColumnStateEvents!Set to true to suppress column events being raised when state is changed throw the API methods
| ||||||
BBjNumber | SuppressTouch!Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
| ||||||
BBjString | Theme!Set the grid theme
| ||||||
BBjNumber | TooltipShowDelay!The delay in milliseconds that it takes for tooltips to show up once an element is hovered. Note: This property does not work if enableBrowserTooltips is true.
| ||||||
BBjNumber | TreeData!Enable / Disable Tree Data mode
| ||||||
BBjNumber | UnSortIcon!Set to true to show the 'no sort' icon.
| ||||||
BBjNumber | UseCtrlForMultiSort!When true , then the user will be able to sort by multiple columns by holding down the |
| Constructor and Description |
|---|
GxOptions(BBjGridExWidget widget!)Construct new GxOptions instance |
| Modifier and Type | Method and Description |
|---|---|
JsonObject | getAsJsonObject()Build the grid json configuration object |
BBjNumber | getDeltaColumnMode()Get DeltaColumn Mode value |
BBjNumber | getDeltaColumnMode()Get DeltaColumn Mode value |
BBjString | getPinnedBottomRowsAsJson()Get the bottom pinned rows as json String |
JsonArray | getPinnedBottomRowsAsJsonArray()Get the bottom pinned rows as Json Array |
BBjString | getPinnedTopRowsAsJson()Get the top pinned rows as json String |
JsonArray | getPinnedTopRowsAsJsonArray()Get the top pinned rows as Json Array |
BBjNumber | getRowDeselection() _break_ |
static BBjString | GROUP_DISPLAY_CUSTOM()Specifies the results of row grouping should be displayed as custom: informs the grid that group columns will be provided. |
static BBjString | GROUP_DISPLAY_GROUP_ROWS()Specifies the results of row grouping should be displayed as group rows: group rows are automatically added instead of group columns. |
static BBjString | GROUP_DISPLAY_MULTIPLE_COLUMNS()Specifies the results of row grouping should be displayed as multiple columns: a group column per row group is added automatically. |
static BBjString | GROUP_DISPLAY_SINGLE_COLUMN()Specifies the results of row grouping should be displayed as single column: single group column automatically added by the grid. |
void | setColumnWidth(BBjNumber width!)Sets the default column width for all columns
|
void | setDeltaColumnMode(BBjNumber enabled!)Enable/disable DeltaColumn Mode |
void | setEditable(BBjNumber editable!)Enable / disable column editing
|
void | setEnableFilter(BBjNumber enable!, BBjNumber enableFiltersToolpanel!)Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
|
void | setEnableFilter(BBjNumber enable!)Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
|
void | setGroupColumnLabel(BBjString label!)Set the default label used when a new group is created
|
void | setIcons(BBjString json!)Set the grid icons
|
void | setImmutableColumns(BBjNumber enabled!)Enable/disable DeltaColumn Mode |
void | setPinnedBottomRows(ResultSet rs!)Set a result set of pinned rows on bottom |
void | setPinnedTopRows(ResultSet rs!)Set a result set of pinned rows on top |
void | setRowDeselection(BBjNumber value!) _break_ |
void | setShowGroupChildCount(BBjNumber enabled!)Enable / disable showing row counts beside group labels
|
void | setShowGroupSelectionCheckbox(BBjNumber enabled!)Enable/ disable checkbox selection on groups
|
public BBjNumber AccentedSort!Set to true to specify that the sort should take into account accented characters, if this feature is turned on the sort will perform slower.
#Configuration
#GridRenderer
public BBjNumber AlwaysShowVerticalScroll!Set to true to always show the vertical scrollbar.
#Configuration
#GridRenderer
public BBjNumber AnimateRows!Set to true to enable Row Animation.
#Configuration
#GridRenderer
public GxAutoGroupColumn AutoGroupColumnDefinition!Allows specifying the group 'auto column' if you are not happy with the default.
If grouping, this column def is included as the first column definition in the grid.
If not grouping, this column is not included.
#Configuration
#GridRenderer
public BBjNumber AutoSizePadding!How many pixels to add to a column width after the auto-sizing calculation. The default is 4 pixels. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
#Configuration
#GridRenderer
public JsonObject ClientContext!A json object which is used as context to configure the grid and it various components on the client
public BBjNumber ColumnHoverHighlight!Set to true to highlight columns by adding the ag-column-hover CSS class.
#Configuration
#GridRenderer
public GxContextMenu ContextMenu!The grid context menu
#Configuration
#GridRenderer
public BBjString DataPathTemplate!A string template which will be compiled on the client to return an array for the tree hierarchy.
#Enterprise
#Configuration
#GridRenderer
public GxDefaultColumnDefinition DefaultColumnDefinition!Contains column properties all columns will inherit.
#Configuration
#GridRenderer
public GxDefaultColumnGroup DefaultColumnGroupDefinition!Contains column group properties all column groups will inherit.
#Configuration
#GridRenderer
public BBjNumber DeltaColumnMode!By default when new columns are loaded into the grid, the following properties (Order, Aggregation Function, Width, Pivot, Row Group, Pinned ) are not used
To change this behaviour and have column attributes above take effect each time the grid updates the columns, then set this option to true
#Configuration
#GridRenderer
use `GxOptions.ImmutableColumns` insteadpublic BBjString EditType!Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
#Configuration
#GridRenderer
BBjGridExWidget.GRID_EDITTYPE_ROW() BBjGridExWidget.GRID_EDITTYPE_CELL()public BBjNumber EnableBrowserTooltips!Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
#Configuration
#GridRenderer
public BBjNumber EnableCharts!Set to true to enable charting
#Enterprise
#Configuration
public BBjNumber EnableFloatingFilter!When true enables the floating filters, disable otherwise
#Configuration
#GridRenderer
enabling/disabling the floatingFilter on the Options level is deprecated. Use `GxColumn.FloatingFilter` on the column level instead.public BBjNumber EnableRangeSelection!Set to true to enable Range Selection
#Enterprise
#Configuration
public BBjNumber EnableRtl!Set to true to operate grid in RTL (Right to Left) mode.
#Configuration
#GridRenderer
public BBjNumber EnterMovesDown!Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.
#Configuration
#GridRenderer
public BBjNumber EnterMovesDownAfterEdit!Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.
#Configuration
#GridRenderer
public BBjNumber FloatingFiltersHeight!The height for the row containing the floating filters. If not specified the default is 20px.
#Configuration
#GridRenderer
public BBjNumber FunctionsReadOnly!If true, then row group, pivot and value aggregation will be read only from the UI.
The grid will display what values are used for each, but will not allow the use to change the selection
#Configuration
#API
public BBjNumber GroupDefaultExpanded!If grouping, set to the number of levels to expand by default. Eg 0 for none, 1 first level only, etc. Default is 0 (expand none). Set to -1 for expand everything
#Configuration
#GridRenderer
public BBjString GroupDisplayType!Specifies how the results of row grouping should be displayed.
The options are:
#Configuration
#GridRenderer
public BBjNumber GroupHeaderHeight!The height for the rows containing header column groups. If not specified, it uses headerHeight
#Configuration
#GridRenderer
public BBjNumber GroupHideOpenParents!Set to true to hide parents that are open. When used with multiple columns for showing groups, it can give more pleasing user experience
#Configuration
#GridRenderer
public BBjNumber GroupIncludeFooter!If grouping, whether to show a group footer when the group is expanded.
If true, then by default, the footer will contain aggregate data (if any)
when shown and the header will be blank.
When closed, the header will contain the aggregate data regardless
of this setting (as footer is hidden anyway).
This is handy for 'total' rows, that are displayed below the data when
the group is open, and alongside the group when it is closed
#Configuration
#GridRenderer
public BBjNumber GroupIncludeTotalFooter!Set to true to show a 'grand' total group footer across all groups.
#Configuration
#GridRenderer
public BBjNumber GroupMultiAutoColumn!If using auto column, set to true to have each group in its own column separate column, eg if group by Country then Year, two auto columns will be created, one for country and one for year
#Configuration
#GridRenderer
since v1.7.0 - use `GroupDisplayType! = GxOptions.GROUP_DISPLAY_MULTIPLE_COLUMNS()` insteadpublic BBjNumber GroupRemoveLowestSingleChildren!Set to true to collapse lowest level groups that only have one child.
#Configuration
#GridRenderer
public BBjNumber GroupRemoveSingleChildren!Set to true to collapse groups that only have one child.
#Configuration
#GridRenderer
public BBjNumber GroupSelectsChildren!When true, selecting a group will have the impact of selecting all its children
When false, then the group is selectable independently of the child nodes.
#Configuration
#GridRenderer
NoteThat this settings has no effect if MultipleSelection is disabled
public BBjNumber GroupSelectsFiltered!If using groupSelectsChildren, then only the children that pass the current filter will get selected
#Configuration
#GridRenderer
public BBjNumber GroupSuppressAutoColumn!If true, the grid will not swap in the grouping column when grouping is enabled.
Use this if you want complete control on the column displayed and don't want the grids help.
In other words, you already have a column in your column definitions that is responsible for displaying the groups
#Configuration
#GridRenderer
since v1.7.0 - use `GroupDisplayType! = GxOptions.GROUP_DISPLAY_CUSTOM()` insteadpublic BBjNumber GroupSuppressBlankHeader!If true, and showing footer, aggregate data will be displayed at both the header and footer levels always.
This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
#Configuration
#GridRenderer
public BBjNumber GroupSuppressRow!If true, the group row won't be displayed and the groups will be expanded by default with no ability to expand / contract the groups. Useful when you want to just 'group' the rows, but not add parent group row to each group
#Configuration
#GridRenderer
since v1.7.0 - There is no replacement for this functionality.public BBjNumber GroupUseEntireRow!If grouping, set to true or false (default is false).
If true, a group row will span all columns across the entire width of the table.
If false, the cells will be rendered as normal and you will have the opportunity to include
a grouping column (normally the first on the left) to show the group
#Configuration
#GridRenderer
since v1.7.0 - use `GroupDisplayType! = GxOptions.GROUP_DISPLAY_GROUP_ROWS() ` insteadpublic BBjNumber HeaderHeight!The height for the row containing the column label header. If not specified the default is 25px.
#Configuration
#GridRenderer
public JsonObject Icons!Icons to use inside the grid instead of the grid's default icons.
The icons can either be set on the grid options (all icons) or on the column definition (all except group).
If defined in both the grid options and column definitions, the column definition will get used.
This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
and just the simple arrow for other columns.
#Configuration
#GridRenderer.
The icons are set as follows:
// column header items
menu
filter
columns
sortAscending
sortDescending
sortUnSort
// expand / contract row group
groupExpanded
groupContracted
// expand / contract column group
columnGroupOpened
columnGroupClosed
// tool panel column group open / close
columnSelectOpen
columnSelectClosed
// row checkbox selection and tool panel column selection
checkboxChecked
checkboxUnchecked
checkboxIndeterminate
// tool panel column selection, when read only (ie disabled checkboxes)
checkboxCheckedReadOnly
checkboxUncheckedReadOnly
checkboxIndeterminateReadOnly
// when moving columns
columnMovePin // when column is to the left, before it gets pinned
columnMoveAdd // when adding a column
columnMoveHide // when removing a column
columnMoveMove // when moving a column
columnMoveLeft // when moving and scrolling left
columnMoveRight // when moving and scrolling right
columnMoveGroup // when about to drop into group panel
columnMoveValue // when about to drop into value panel
columnMovePivot // when about to drop into pivot panel
dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
// menu
menuPin // beside the column pin menu item
menuValue // beside the column value menu item
menuAddRowGroup // beside the column row group menu item
menuRemoveRowGroup // beside the column row group menu item
clipboardCopy // beside the copy to clipboard menu item
clipboardPaste // beside the paste from clipboard menu item
// column drop panels
rowGroupPanel // beside where to drop columns for row group
pivotPanel // beside where to drop columns for pivot
valuePanel // beside where to drop columns for value
public BBjNumber ImmutableColumns!Puts the grid into Immutable Column mode, so that setting new columns keeps column state. Default: false
#Configuration
#GridRenderer
public GxLanguageManager LanguageManager!The grid language manager
public BBjNumber MultipleSelection!Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
#Configuration
#GridRenderer
public BBjString NavigationBehavior!Defines how users can move between rows using arrow keys.
#Configuration
#GridRenderer
BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_ROW() BBjGridExWidget.GRID_NAVIGATION_BEHAVIOUR_NEXT_CELL()public BBjString OverlayLoadingTemplate!Provide a template for 'loading' overlay if not happy with the default one.
#Configuration
#GridRenderer
public BBjString OverlayNoRowsTemplate!Provide a template for 'no rows' overlay if not happy with the provided.
#Configuration
#GridRenderer
public ResultSet PinnedBottomRows!The ResultSet instance which contains the bottom pinned rows
public ResultSet PinnedTopRows!The ResultSet instance which contains the top pinned rows
public BBjNumber PivotGroupHeaderHeight!The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
#Configuration
#GridRenderer
public BBjNumber PivotHeaderHeight!The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
#Configuration
#GridRenderer
public BBjNumber PivotMode!Set to true to enable pivot mode
#Configuration
#API
public BBjNumber PivotPanelShow!When to show the 'pivot panel' (where you drag rows to pivot) at the top.
Default is never. Set to either 'always' or 'onlyWhenPivoting'.
Note that the pivot panel will never show if pivotMode is off.
#Configuration
#GridRenderer
GRID_GROUPPANEL_SHOW_HIDDEN() GRID_GROUPPANEL_SHOW_VISIBLE() GRID_GROUPPANEL_SHOW_ONGROUPING()public BBjNumber RememberGroupStateWhenNewData!When true, if you set new data into the grid and have groups open, the grid will keep groups open if they exist in the new dataset
#Configuration
#GridRenderer
public ArrayList RowClass!Property to set CSS class for all rows
#Configuration
#GridRenderer
public JsonObject RowClassRules!Rules which can be applied to include certain CSS classes for rows.
These rules are provided as a JavaScript map where the keys are class names and the values are expressions that
if evaluated to true, the class gets used. The expression is a string which is treated as a shorthand for a
function by the grid.
#Configuration
#GridRenderer.
The expression has the following attributes available:
| rowIndex | Maps the current row index |
| data | Mapped from the DataRow |
| ctx | The grid client context |
public BBjNumber RowDeselection!Set to true or false. If true, then rows will be deselected if you
hold down ctrl + click the row. Normal behaviour with the grid disallows
deselection of nodes (ie once a row is selected, it remains selected until
another row is selected in its place).
#Configuration
#GridRenderer
since v1.7.0 - use `SuppressRowDeselection` insteadpublic BBjString RowGroupPanelShow!When to show the 'row group panel' (where you drag rows to group) at the top. Default is never. Set to either 'always' or 'onlyWhenGrouping'
#Configuration
#GridRenderer
BBjGridExWidget.GRID_GROUPPANEL_SHOW_HIDDEN() BBjGridExWidget.GRID_GROUPPANEL_SHOW_VISIBLE() BBjGridExWidget.GRID_GROUPPANEL_SHOW_ONGROUPING()public BBjNumber RowHeight!Default Row Height in pixels. Default is 25 pixels.
#Configuration
#API
public BBjNumber RowMultiSelectWithClick!Set to true to allow multiple rows to be selected with a single click.
E.g. if you click select one row, then click select another row, the first row will keep it's selection.
Clicking a selected row in this mode will deselect the row.
This is useful for touch devices where ctrl and shift clicking is
not an option.
#Configuration
#GridRenderer
Note that Despite the setting name, it works when MultipleSelection is enabled or disabled
public JsonObject RowStyle!Property to set style for all rows. Set to an object of key (style names) and values (style values)
#Configuration
#GridRenderer
public BBjNumber ShowHeaderSelectionCheckbox!When true, selection box will be show on the first column's header
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the tHeaderCheckboxSelection to true
Note This option will ignore multi row selection option by default so it is always enabled
public BBjNumber ShowSelectionCheckbox!When true, A selection box will be shown on the first column
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the CheckboxSelection to true
public GxSidebar Sidebar!The grid sidebar
public BBjNumber SingleClickEdit!Set to true to enable Single Click Editing for cells, to start editing with a single click.
#Configuration
#GridRenderer
public BBjNumber SkipHeaderOnAutoSize!Set this to true to skip the headerName when autoSize is called by default
#Configuration
#GridRenderer
public GxStatusBar Statusbar!The grid statusbar
public BBjNumber StopEditingWhenGridLosesFocus!Set this to true to stop cell editing when grid loses focus. The default is the grid stays editing until focus goes onto another cell. For inline (non-popup) editors only.
#Configuration
#GridRenderer
public BBjNumber SuppressAggAtRootLevel!When true, the aggregations won't be computed for root node of the grid
#Configuration
#GridRenderer
public BBjNumber SuppressAggFuncInHeader!When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
#Configuration
#GridRenderer
public BBjNumber SuppressAnimationFrame!When true, the grid will not use animation frames when drawing rows while scrolling.
Use this if the grid is working fast enough that you don't need animations frame and you don't want the grid to flicker.
#Configuration
#GridRenderer
public BBjNumber SuppressAutoSize!Suppresses auto-sizing columns for columns. In other words, double-clicking a column header's edge will not auto-size.Default is false
#Configuration
#GridRenderer
public BBjNumber SuppressCellSelection!If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. Default: false
public BBjNumber SuppressClickEdit!Set to true so that neither single or double-click starts editing.
#Configuration
#GridRenderer
public BBjNumber SuppressColumnMoveAnimation!If true, the ag-column-moving class is not added to the grid while columns are moving. In the default themes, this transpires to no animation for moving columns.
#Configuration
#GridRenderer
public BBjNumber SuppressColumnVirtualisation!Set to true so that the grid doesn't virtualize the columns. S o if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
#Configuration
#GridRenderer
public BBjNumber SuppressContextMenu!Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
#Configuration
#GridRenderer
public BBjNumber SuppressDragLeaveHidesColumns!If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
#Configuration
#GridRenderer
public BBjNumber SuppressHorizontalScroll!Set to true to never show the horizontal scroll.
#Configuration
#GridRenderer
public BBjNumber SuppressLoadingOverlay!Disables the 'loading' overlay.
#Configuration
#GridRenderer
public BBjNumber SuppressMaintainUnsortedOrder!Set to true to suppress sorting of un-sorted data to match original row data
#Configuration
#GridRenderer
public BBjNumber SuppressMakeVisibleAfterUnGroup!By default when a column is un-grouped, it is made visible.
This property stops the column becoming visible again when un-grouping.
#Configuration
#GridRenderer
public BBjNumber SuppressMenuHide!Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
#Configuration
#GridRenderer
public BBjNumber SuppressMiddleClickScrolls!If true, then middle clicks will result in 'click' events for cell and row. Otherwise the browser will use middle click to scroll the grid.
#Configuration
#GridRenderer
public BBjNumber SuppressMovableColumns!Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
#Configuration
#GridRenderer
public BBjNumber SuppressMultiRangeSelection!Enable / disable one range selection even if ctrl key is held down
#Enterprise
#Configuration
public BBjNumber SuppressMultiSort!Set to true to suppress multi-sort when the user shift-clicks a column header.
#Configuration
#GridRenderer
public BBjNumber SuppressNoRowsOverlay!Disables the 'no rows' overlay.
#Configuration
#GridRenderer
public BBjNumber SuppressRowClickSelection!If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
public BBjNumber SuppressRowDeselection!If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
public BBjNumber SuppressRowHoverHighlight!Set to true to not highlight rows by adding the ag-row-hover CSS class.
#Configuration
#GridRenderer
public BBjNumber SuppressRowTransform!Uses CSS top instead of CSS transform for positioning rows.
Useful if the transform function is causing issues such as used in row spanning. Default: false
#Configuration
#GridRenderer
public BBjNumber SuppressScrollOnNewData!When true, the grid will not scroll to the top when new row data is provided.
Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
#Configuration
#GridRenderer
public BBjNumber SuppressSetColumnStateEvents!Set to true to suppress column events being raised when state is changed throw the API methods
#Configuration
#GridRenderer
since version 1.7.0 - no longer requiredpublic BBjNumber SuppressTouch!Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
#Configuration
#GridRenderer
public BBjString Theme!Set the grid theme
#Configuration
#API
public BBjNumber TooltipShowDelay!The delay in milliseconds that it takes for tooltips to show up once an element is hovered.
Note: This property does not work if enableBrowserTooltips is true.
#Configuration
#GridRenderer
public BBjNumber TreeData!Enable / Disable Tree Data mode
#Enterprise
#Configuration
#GridRenderer
public BBjNumber UnSortIcon!Set to true to show the 'no sort' icon.
#Configuration
#GridRenderer
public BBjNumber UseCtrlForMultiSort!When true , then the user will be able to sort by multiple columns by holding down the ctrl
key (or Command key on Apple) while clicking the column header. By default this action is possible using the shift key.
public GxOptions(BBjGridExWidget widget!)Construct new GxOptions instance
BBjGridExWidget widget! widget instancepublic JsonObject getAsJsonObject()Build the grid json configuration object
public BBjNumber getDeltaColumnMode()Get DeltaColumn Mode value
Columns are immutable by default.public BBjNumber getDeltaColumnMode()Get DeltaColumn Mode value
use `GxOptions.getImmutableColumns` insteadpublic BBjString getPinnedBottomRowsAsJson()Get the bottom pinned rows as json String
public JsonArray getPinnedBottomRowsAsJsonArray()Get the bottom pinned rows as Json Array
public BBjString getPinnedTopRowsAsJson()Get the top pinned rows as json String
public JsonArray getPinnedTopRowsAsJsonArray()Get the top pinned rows as Json Array
public BBjNumber getRowDeselection() _break_ since v1.7.0 - use `GxOptions.setSuppressRowDeselection(BBjNumber value!)` insteadpublic static BBjString GROUP_DISPLAY_CUSTOM()Specifies the results of row grouping should be displayed as custom: informs the grid that group columns will be provided.
public static BBjString GROUP_DISPLAY_GROUP_ROWS()Specifies the results of row grouping should be displayed as group rows: group rows are automatically added instead of group columns.
public static BBjString GROUP_DISPLAY_MULTIPLE_COLUMNS()Specifies the results of row grouping should be displayed as multiple columns: a group column per row group is added automatically.
public static BBjString GROUP_DISPLAY_SINGLE_COLUMN()Specifies the results of row grouping should be displayed as single column: single group column automatically added by the grid.
public void setColumnWidth(BBjNumber width!)Sets the default column width for all columns
#Configuration
#ColumnsRenderer
BBjNumber width! The column widthpublic void setDeltaColumnMode(BBjNumber enabled!)Enable/disable DeltaColumn Mode
BBjNumber enabled! true to enable , false to disable use `GxOptions.setImmutableColumns` insteadpublic void setEditable(BBjNumber editable!)Enable / disable column editing
#Configuration
#ColumnsRenderer
BBjNumber editable! When true all columns will be editable, otherwise disable editingpublic void setEnableFilter(BBjNumber enable!, BBjNumber enableFiltersToolpanel!)
Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
BBjNumber enable! When true enable on added columns, disable otherwiseBBjNumber enableFiltersToolpanel! When true the filters toolpanel will be enabled in the sidebar, disabled otherwisepublic void setEnableFilter(BBjNumber enable!)Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
BBjNumber enable! When true enable on added columns, disable otherwisepublic void setGroupColumnLabel(BBjString label!)Set the default label used when a new group is created
#Configuration
#ColumnsRenderer
BBjString label! The column labelpublic void setIcons(BBjString json!)Set the grid icons
#Configuration
#GridRenderer
BBjString json! The icons as a json objectpublic void setImmutableColumns(BBjNumber enabled!)Enable/disable DeltaColumn Mode
BBjNumber enabled! true to enable , false to disable Columns are immutable by default.public void setPinnedBottomRows(ResultSet rs!)Set a result set of pinned rows on bottom
ResultSet rs! A ResultSet instancepublic void setPinnedTopRows(ResultSet rs!)Set a result set of pinned rows on top
ResultSet rs! A ResultSet instancepublic void setRowDeselection(BBjNumber value!) _break_ since v1.7.0 - use `GxOptions.setSuppressRowDeselection(BBjNumber value!)` insteadpublic void setShowGroupChildCount(BBjNumber enabled!)Enable / disable showing row counts beside group labels
#Configuration
#ColumnsRenderer
BBjNumber enabled! When true show row counts, hide otherwisepublic void setShowGroupSelectionCheckbox(BBjNumber enabled!)Enable/ disable checkbox selection on groups
#Configuration
#ColumnsRenderer
BBjNumber enabled! When true enable checkbox selection, disable otherwise