Gijgo Grid configuration

autoGenerateColumns Base

Auto generate column for each field in the datasource when set to true.

autoLoad Base

When this setting is enabled the content of the grid will be loaded automatically after the creation of the grid.

column.align Base

This setting control the alignment of the text in the cell.

column.cssClass Base

The name(s) of css class(es) that are going to be applied to all cells inside that column, except the header cell.

column.decimalDigits Base

Number of decimal digits after the decimal point.

column.editor Inline Editing

Provides a way to specify a custom editing UI for the column.

column.events Base

Configuration object with event names as keys and functions as values that are going to be bind to each cell from the column. Each function is going to receive event information as a parameter with info in the "data" field for id, field name and record data.

column.field Base

The field name to which the column is bound. If the column.title is not defined this value is used as column.title.

column.filter Base

Function which can be used to customize filtering with local data (javascript sourced data).

column.filterable Header Filter

Indicates if the column is sortable. If set to false the header filter is hidden.

column.format Base

Format the date when the type of the column is date.

column.headerCssClass Base

The name(s) of css class(es) that are going to be applied to the header cell of that column.

column.hidden Base

If set to true the column will not be displayed in the grid. By default all columns are displayed.

column.icon Base

Css class for icon that is going to be in use for the cell. This setting can be in use only with combination of type icon.

column.minWidth Responsive Design

The minimum width of the column. The column is getting invisible when there is not enough space in the grid for this minimum width. This setting is working only when the responsive setting is set to true and the column priority setting is set.

column.mode Inline Editing

Provides a way to specify a display mode for the column.

column.priority Responsive Design

The priority of the column compared to other columns in the grid. The columns are hiding based on the priorities. This setting is working only when the responsive setting is set to true.

column.renderer Base

A renderer is an 'interceptor' function which can be used to transform data (value, appearance, etc.) before it is rendered.

column.sortable Base

Indicates if the column is sortable. If set to true the user can click the column header and sort the grid by the column source field.

column.stopPropagation Base

If set to true stop event propagation when event occur.

column.title Base

The caption that is going to be displayed in the header of the grid.

column.tmpl Base

Template for the content in the column. Use curly brackets "{}" to wrap the names of data source columns from server response.

column.tooltip Base

The text for the cell tooltip.

column.type Base

Indicates the type of the column.

column.width Base

The width of the column. Numeric values are treated as pixels. If the width is undefined the width of the column is not set and depends on the with of the table(grid).

columnReorder Column Reorder

If set to true, enable column reordering with drag and drop.

columns Base

An array that holds the configurations of each column from the grid.

dataSource Base

The data source for the grid.

defaultColumnSettings Base

An object that holds the default configuration settings of each column from the grid.

detailTemplate Expand Collapse Rows

Template for the content in the detail section of the row. Automatically add expand collapse column as a first column in the grid during initialization.

fixedHeader Fixed Header

If set to true, add scroll to the table body

fontSize Base

The size of the font in the grid.

grouping.groupBy Grouping

The name of the field that needs to be in use for grouping.

headerFilter Header Filter

If set to true, add filters for each column

headerFilter.type Header Filter

Type of the header filter

icons.collapseGroup Grouping

Collapse row icon definition.

icons.collapseRow Expand Collapse Rows

Collapse row icon definition.

icons.expandGroup Grouping

Expand row icon definition.

icons.expandRow Expand Collapse Rows

Expand row icon definition.

iconsLibrary Base

The name of the icons library that is going to be in use. Currently we support Material Icons, Font Awesome and Glyphicons.

inlineEditing.managementColumn Inline Editing

If set to true, add column with buttons for edit, delete, update and cancel at the end of the grid.

inlineEditing.mode Inline Editing

Inline editing mode.

keepExpandedRows Expand Collapse Rows

If set try to persist the state of expanded rows. You need to specify primaryKey on the initialization of the grid in order to enable this feature.

locale Base

The language that needs to be in use.

mapping.dataField Base

The name of the object in the server response, that contains array with records, that needs to be display in the grid.

mapping.totalRecordsField Base

The name of the object in the server response, that contains the number of all records on the server.

minWidth Base

Minimum width of the grid.

notFoundText Base

The text that is going to be displayed if the grid is empty.

optimisticPersistence.localStorage Optimistic Persistence

Array that contains a list with param names that needs to be saved in the localStorage. You need to specify guid on the initialization of the grid in order to enable this feature.

optimisticPersistence.sessionStorage Optimistic Persistence

Array that contains a list with param names that needs to be saved in the sessionStorage. You need to specify guid on the initialization of the grid in order to enable this feature.

orderNumberField Row Reorder

If set, update the value in the field for all records. Accept only field names of columns.

pager.leftControls Pagination

Array that contains a list with jquery objects that are going to be used on the left side of the pager.

pager.limit Pagination

The maximum number of records that can be show by page.

pager.rightControls Pagination

Array that contains a list with jquery objects that are going to be used on the right side of the pager.

pager.sizes Pagination

Array that contains the possible page sizes of the grid. When this setting is set, then a drop down with the options for each page size is visualized in the pager.

paramNames.direction Base

The name of the parameter that is going to send the direction for sorting. The "sortable" setting for at least one column should be enabled in order this parameter to be in use.

paramNames.groupBy Grouping

The name of the parameter that is going to send the name of the column for grouping. The grouping should be enabled in order this parameter to be in use.

paramNames.groupByDirection Grouping

The name of the parameter that is going to send the direction for grouping. The grouping should be enabled in order this parameter to be in use.

paramNames.limit Pagination

The name of the parameter that is going to send the maximum number of records per page. The pager should be enabled in order this parameter to be in use.

paramNames.page Pagination

The name of the parameter that is going to send the number of the page. The pager should be enabled in order this parameter to be in use.

paramNames.sortBy Base

The name of the parameter that is going to send the name of the column for sorting. The "sortable" setting for at least one column should be enabled in order this parameter to be in use.

primaryKey Base

Name of column that contains the record id.

resizableColumns Resizable Columns

If set to true, users can resize columns by dragging the edges (resize handles) of their header cells.

resizeCheckInterval Responsive Design

The interval in milliseconds for checking if the grid is resizing. This setting is in use only if the resizeMonitoring setting is set to true.

responsive Responsive Design

This setting enables responsive behaviour of the grid where some column are invisible when there is not enough space on the screen for them. The visibility of the columns in this mode is driven by the column minWidth and priority settings. The columns without priority setting are always visible and can't hide in small screen resolutions.

rowReorder Row Reorder

If set to true, enable row reordering with drag and drop.

rowReorderColumn Row Reorder

If set, enable row reordering only when you try to drag cell from the configured column. Accept only field names of columns.

selectionMethod Base

The type of the row selection mechanism.

selectionType Base

The type of the row selection.
If the type is set to multiple the user will be able to select more then one row from the grid.

showHiddenColumnsAsDetails Responsive Design

Automatically adds hidden columns to the details section of the row. This setting works only if the responsive setting is set to true and the detailTemplate is set. You need to set priority and minWidth on the colums, that needs to be hidden in smaller screens.

title Toolbar

The title of the grid. Appears in a separate row on top of the grid.

toolbarTemplate Toolbar

Template for the content in the toolbar. Appears in a separate row on top of the grid.

uiLibrary Base

The name of the UI library that is going to be in use. Currently we support Bootstrap 3, Bootstrap 4 and Material Design.

width Base

Width of the grid.