- Preparing search index...
- The search index is not available
IGridOptions Interface
Heirarchy
- IGridOptions
Properties
- allow
Async Render - allow
Auto Add Row - allow
Cell Merging - allow
Column Reorder - allow
Column Resize - allow
Editing - allow
Focus - allow
Grouping - allow
Header Select - allow
Row Reorder - allow
Sorting - allow
Swipe - auto
Add Row Position - auto
Row Height - cell
Merging Settings - col
Header Height - col
Header Template - col
Min Width - col
Width - column
Menu - default
Grouping Info - edit
Mode - edit
Row Template - edit
Unit - filter
Expression - filtering
- footer
Row - group
Strategy - grouping
- header
Row - hierarchy
- load
OnDemand - locale
Resource - page
Size - pinned
Left Col Header Template - pinned
Left Row Template - pinned
Right Col Header Template - pinned
Right Row Template - right
ToLeft - row
Header - row
Header Width - row
Height - row
Template - selection
Mode - selection
Unit - show
Col Header - show
Row Header - show
Tool Panel - sorting
- start
Page Index
Methods
Properties
Optional allowAsyncRender
Indicates whether to run asyncRender method in column. Default value is false
Optional allowAutoAddRow
Specifies whether support allow user add new row by UI action. Default value is false
Optional allowCellMerging
Globally enable the cell merging. Default value is false
Optional allowColumnReorder
Specifies whether the user can reorder columns at run time. Default value is true
Optional allowColumnResize
Specifies whether the user can resize columns at run time. Default value is true
Optional allowEditing
Globally allows all columns to be editable. Default value is false
Optional allowFocus
Specifies whether the layout engine can get focus. Default value is true
Optional allowGrouping
Specifies whether to show a group drag panel to help the user group the rows manually at run time. Default value is false
Optional allowHeaderSelect
Specifies whether to show checkboxes on the row header. If true, the row can only be selected by checking the checkbox. Default value is false
Optional allowRowReorder
Specifies whether the user can reorder rows at run time. Default value is false
Optional allowSorting
Globally allows all columns to be sortable. Default value is false
Optional allowSwipe
Specifies whether to support the touch swipe action. Default value is false
Optional autoAddRowPosition
Specifies the new row position. Default value is 'top'
Optional autoRowHeight
Specifies whether layout engine should automatically measure height of the rows
Optional cellMergingSettings
Specifies how to merge grid cells
Optional colHeaderHeight
Specifies the height of the column header cell. Default value is 24 for GridLayout and 80 for HorizontalLayout
Optional colHeaderTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of column header row
Optional colMinWidth
Specifies the default minimum column width. Default value is 8
Optional colWidth
Specifies the default column width. Default value is '*'
Optional columnMenu
Allows customization of column menu
Optional defaultGroupingInfo
Specifies default group setting object, settings in group descriptor has higher priority
Optional editMode
Specifies which editing mode grid is used for editing. There are three modes 'inline', 'popup', and 'editForm'. Default value is 'inline'
Optional editRowTemplate
Specifies the edit row template is used to customize the appearance of 'popup' mode and 'editForm' mode
Optional editUnit
Specifies editing a cell or row in one time. There are two modes 'row' and 'cell'. Default value is 'row'
Optional filterExpression
Specifies a string filter expression used to filter the data collection
Optional filtering
Specifies how to filter bound data set
Optional footerRow
Specifies the footer row configuration
Optional groupStrategy
Specifies a group strategy object used to define the group layout strategy
Optional grouping
Specifies how to group bound data set
Optional headerRow
Specifies the header row configuration
Optional hierarchy
Specifies hierarchical grouping
Optional loadOnDemand
Enables infinite scrolling mode.
Optional localeResource
Specifies localization strings that can be overridden
Optional pageSize
Show how many items in one page, this property only take effect if the paging plugin is referenced
Optional pinnedLeftColHeaderTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a pinned-left column header row
Optional pinnedLeftRowTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a pinned-left row
Optional pinnedRightColHeaderTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a pinned-right column header row
Optional pinnedRightRowTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a pinned-right row
Optional rightToLeft
Indicates whether to lay out elements from right to left. Default value is false
Optional rowHeader
Specifies the row header configuration
Optional rowHeaderWidth
Specifies the width of the row header cell. Default value is 40 for GridLayout and 24 for HorizontalLayout
Optional rowHeight
Specifies the default row height. Default value is 24 for GridLayout and 80 for HorizontalLayout
Optional rowTemplate
Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a row
Optional selectionMode
Specifies the selection mode. The value can be 'single','multiple', or 'none'. Default value is 'single'
Optional selectionUnit
Specifies selection unit. The value can be 'row' or 'cell'. Default value is 'row'
Optional showColHeader
Specifies whether to show the column header. Default value is true
Optional showRowHeader
Specifies whether to show the row header. Default value is true
Optional showToolPanel
Specifies whether to show tool panel where user can specify visible columns and groupings at run time
Optional sorting
Specifies how to sort bound data set
Optional startPageIndex
Specifies the initial start page index, this property only take effect is the paging plugin is referenced
Methods
Optional updateOverlayStatusCallback
-
Specifies the update overlay callback. This callback will be called when loading data from remote server if exist, otherwise, the control will call built-in showLoadingOverlay before loading data and call hideLoadingOverlay after loading data
Parameters
-
args: Object
the argument the callback function will take with the newStatus of the overlay will change to with value 'show' or 'hide'
Returns void
-
Specifies options of the grid view