Interface IGridOptions

Index

Properties

Properties

optional public afterSelectionChange?: (rowItem?: ngGrid.IRow, event?: any) => void

Callback for when you want to validate something after selection.

optional public aggregateTemplate?: string

Define an aggregate template to customize the rows when grouped. See github wiki for more details.

optional public beforeSelectionChange?: (rowItem?: ngGrid.IRow, event?: any) => boolean

Callback if you want to inspect something before selection, return false if you want to cancel the selection. return true otherwise. If you need to wait for an async call to proceed with selection you can use rowItem.changeSelection(event) method after returning false initially. Note: when shift+ Selecting multiple items in the grid this will only get called once and the rowItem will be an array of items that are queued to be selected.

optional public checkboxCellTemplate?: string

checkbox templates.

optional public checkboxHeaderTemplate?: string

checkbox templates.

optional public columnDefs?: IColumnDef[]

definitions of columns as an array [], if not defined columns are auto-generated. See github wiki for more details.

optional public data?: any

Data being displayed in the grid. This can be either a string of object ID or object reference. Using string is preferred, as this turns on change tracking in ng-grid

optional public dataUpdated?: Function

Data updated callback, fires every time the data is modified from outside the grid.

optional public enableCellEdit?: boolean

Enables cell editing.

optional public enableCellSelection?: boolean

Enables cell selection.

optional public enableColumnHeavyVirt?: boolean

Enable or disable HEAVY column virtualization. This turns off selection checkboxes and column pinning and is designed for spreadsheet-like data.

optional public enableColumnReordering?: boolean

Enable or disable reordering of columns

optional public enableColumnResize?: boolean

Enable or disable resizing of columns

optional public enableHighlighting?: boolean

Enables or disables text highlighting in grid by adding the "unselectable" class (See CSS file)

optional public enablePaging?: boolean

Enables the server-side paging feature

optional public enablePinning?: boolean

Enable column pinning

optional public enableRowReordering?: boolean

Enable drag and drop row reordering. Only works in HTML5 compliant browsers.

optional public enableRowSelection?: boolean

To be able to have selectable rows in grid.

optional public enableSorting?: boolean

Enables or disables sorting in grid.

optional public excludeProperties?: any

string list of properties to exclude when auto-generating columns.

optional public filterOptions?: IFilterOptions

filterOptions - filterText: The text bound to the built-in search box. useExternalFilter: Bypass internal filtering if you want to roll your own filtering mechanism but want to use builtin search box.

optional public footerRowHeight?: number

Defining the height of the footer in pixels.

optional public groups?: Array<string>

Initial fields to group data by. Array of field names, not displayName.

optional public headerRowHeight?: number

The height of the header row in pixels.

optional public headerRowTemplate?: string

Define a header row template for further customization. See github wiki for more details.

optional public i18n?: string

i18n language support. choose from the installed or included languages, en, fr, sp, etc...

optional public jqueryUIDraggable?: boolean

Enables the use of jquery UI reaggable/droppable plugin. requires jqueryUI to work if enabled. Useful if you want drag + drop but your users insist on crappy browsers.

optional public jqueryUITheme?: boolean

Enable the use jqueryUIThemes

optional public keepLastSelected?: boolean

Prevent unselections when in single selection mode.

optional public maintainColumnRatios?: boolean

Maintains the column widths while resizing. Defaults to true when using *'s or undefined widths. Can be ovverriden by setting to false.

optional public multiSelect?: boolean

Set this to false if you only want one item selected at a time

optional public pagingOptions?: IPagingOptions

pagingOptions -

optional public pinSelectionCheckbox?: boolean

Array of plugin functions to register in ng-grid

optional public plugins?: Array<any>

Array of plugin functions to register in ng-grid

optional public rowHeight?: number

Row height of rows in grid.

optional public rowTemplate?: string

Define a row template to customize output. See github wiki for more details.

optional public selectItem?: (idx: number, state: boolean) => any

Select deselect an item by index.

optional public selectWithCheckboxOnly?: boolean

Disable row selections by clicking on the row and only when the checkbox is clicked.

optional public selectedItems?: Array<any>

all of the items selected in the grid. In single select mode there will only be one item in the array.

optional public showColumnMenu?: boolean

Enables menu to choose which columns to display and group by. If both showColumnMenu and showFilter are false the menu button will not display.

optional public showFilter?: boolean

Enables display of the filterbox in the column menu. If both showColumnMenu and showFilter are false the menu button will not display.

optional public showFooter?: boolean

Show or hide the footer alltogether the footer is enabled by default

optional public showGroupPanel?: boolean

Show the dropzone for drag and drop grouping

optional public showSelectionCheckbox?: boolean

Row selection check boxes appear as the first column.

optional public sortInfo?: any

Define a sortInfo object to specify a default sorting state. You can also observe this variable to utilize server-side sorting (see useExternalSorting). Syntax is sortinfo: { fields: ['fieldName1',' fieldName2'], direction: 'ASC'/'asc' || 'desc'/'DESC'}

optional public tabIndex?: number

Set the tab index of the Vieport.

optional public useExternalSorting?: boolean

Prevents the internal sorting from executing. The sortInfo object will be updated with the sorting information so you can handle sorting (see sortInfo)

optional public virtualizationThreshold?: number

the threshold in rows to force virtualization on