Version 1
IGridOptions GrapeCity DataViewsJS Interface

IGridOptions Interface

Specifies options of the grid view

Heirarchy

  • IGridOptions

Properties

Optional allowAsyncRender

allowAsyncRender: boolean

Indicates whether to run asyncRender method in column. Default value is false

Optional allowAutoAddRow

allowAutoAddRow: boolean

Specifies whether support allow user add new row by UI action. Default value is false

Optional allowCellMerging

allowCellMerging: boolean

Globally enable the cell merging. Default value is false

Optional allowColumnReorder

allowColumnReorder: boolean

Specifies whether the user can reorder columns at run time. Default value is true

Optional allowColumnResize

allowColumnResize: boolean

Specifies whether the user can resize columns at run time. Default value is true

Optional allowEditing

allowEditing: boolean

Globally allows all columns to be editable. Default value is false

Optional allowFocus

allowFocus: boolean

Specifies whether the layout engine can get focus. Default value is true

Optional allowGrouping

allowGrouping: boolean

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

allowHeaderSelect: boolean

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 allowSorting

allowSorting: boolean

Globally allows all columns to be sortable. Default value is false

Optional allowSwipe

allowSwipe: boolean

Specifies whether to support the touch swipe action. Default value is false

Optional autoAddRowPosition

autoAddRowPosition: AddRowPosition

Specifies the new row position. Default value is 'top'

Optional autoRowHeight

autoRowHeight: boolean

Specifies whether layout engine should automatically measure height of the rows

Optional cellMergingSettings

cellMergingSettings: ICellMergingSettings

Specifies how to merge grid cells

Optional colHeaderHeight

colHeaderHeight: number

Specifies the height of the column header cell. Default value is 24 for GridLayout and 80 for HorizontalLayout

Optional colHeaderTemplate

colHeaderTemplate: string

Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of column header row

Optional colMinWidth

colMinWidth: number

Specifies the default minimum column width. Default value is 8

Optional colWidth

colWidth: number | string

Specifies the default column width. Default value is '*'

Optional defaultGroupingInfo

defaultGroupingInfo: Partial<IGroupDescriptor>

Specifies default group setting object, settings in group descriptor has higher priority

Optional editMode

editMode: EditMode

Specifies which editing mode grid is used for editing. There are three modes 'inline', 'popup', and 'editForm'. Default value is 'inline'

Optional editRowTemplate

editRowTemplate: string

Specifies the edit row template is used to customize the appearance of 'popup' mode and 'editForm' mode

Optional editUnit

editUnit: EditUnit

Specifies editing a cell or row in one time. There are two modes 'row' and 'cell'. Default value is 'row'

Optional filterExpression

filterExpression: string

Specifies a string filter expression used to filter the data collection

Optional filtering

filtering: IFilterDescriptor[] | string

Specifies how to filter bound data set

Optional footerRow

Specifies the footer row configuration

Optional groupStrategy

groupStrategy: IGroupStrategy

Specifies a group strategy object used to define the group layout strategy

Optional grouping

grouping: IGroupDescriptor[]

Specifies how to group bound data set

Optional headerRow

Specifies the header row configuration

Optional hierarchy

Specifies hierarchical grouping

Optional loadOnDemand

loadOnDemand: boolean

Enables infinite scrolling mode.

Optional localeResource

localeResource: ILocaleResource

Specifies localization strings that can be overridden

Optional pageSize

pageSize: number

Show how many items in one page, this property only take effect if the paging plugin is referenced

Optional pinnedLeftColHeaderTemplate

pinnedLeftColHeaderTemplate: string

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

pinnedLeftRowTemplate: string

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

pinnedRightColHeaderTemplate: string

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

pinnedRightRowTemplate: string

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

rightToLeft: boolean

Indicates whether to lay out elements from right to left. Default value is false

Optional rowHeaderWidth

rowHeaderWidth: number

Specifies the width of the row header cell. Default value is 40 for GridLayout and 24 for HorizontalLayout

Optional rowHeight

rowHeight: number

Specifies the default row height. Default value is 24 for GridLayout and 80 for HorizontalLayout

Optional rowTemplate

rowTemplate: string

Specifies a string that starts with '#'+templateID or a raw html string that represents the structure and layout of a row

Optional selectionMode

selectionMode: SelectionMode

Specifies the selection mode. The value can be 'single','multiple', or 'none'. Default value is 'single'

Optional selectionUnit

selectionUnit: SelectionUnit

Specifies selection unit. The value can be 'row' or 'cell'. Default value is 'row'

Optional showColHeader

showColHeader: boolean

Specifies whether to show the column header. Default value is true

Optional showRowHeader

showRowHeader: boolean

Specifies whether to show the row header. Default value is true

Optional showToolPanel

showToolPanel: boolean

Specifies whether to show tool panel where user can specify visible columns and groupings at run time

Optional sorting

sorting: ISortDescriptor[]

Specifies how to sort bound data set

Optional startPageIndex

startPageIndex: number

Specifies the initial start page index, this property only take effect is the paging plugin is referenced

Methods

Optional updateOverlayStatusCallback

  • updateOverlayStatusCallback(args: Object): void
  • 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