Interface IIgrGridBaseDirectiveProps

Hierarchy

Hierarchy

Properties

Properties

activeNodeChange?: ((s, e) => void)

Type declaration

addRowEmptyTemplate?: FunctionComponent<{
    dataContext: any;
}> | Component<{
    dataContext: any;
}, {}, any>
advancedFilteringExpressionsTree?: IgrFilteringExpressionsTree

Gets/Sets the advanced filtering state.

Example

let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;
this.grid.advancedFilteringExpressionsTree = logic;
advancedFilteringExpressionsTreeChange?: ((s, e) => void)

Type declaration

allowAdvancedFiltering?: string | boolean
allowFiltering?: string | boolean
autoGenerate?: string | boolean
autoGenerateExclude?: string[]
batchEditing?: string | boolean
cellClick?: ((s, e) => void)

Type declaration

cellEdit?: ((s, e) => void)

Type declaration

cellEditDone?: ((s, e) => void)

Type declaration

cellEditEnter?: ((s, e) => void)

Type declaration

cellEditExit?: ((s, e) => void)

Type declaration

cellSelection?: string | GridSelectionMode

Gets/Sets cell selection mode.

Remarks

By default the cell selection mode is multiple selectionMode: GridSelectionMode

children?: ReactNode
className?: string
clipboardOptions?: IgrClipboardOptions

Controls the copy behavior of the grid.

columnInit?: ((s, e) => void)

Type declaration

columnMoving?: ((s, e) => void)

Type declaration

columnMovingEnd?: ((s, e) => void)

Type declaration

columnMovingStart?: ((s, e) => void)

Type declaration

columnPin?: ((s, e) => void)

Type declaration

columnPinned?: ((s, e) => void)

Type declaration

    • (s, e): void
    • Emitted after IgxColumnComponent is pinned.

      Remarks

      The index that the column is inserted at may be changed through the insertAtIndex property.

      Example

      public columnPinning(event) {
      if (event.column.field === "Name") {
      event.insertAtIndex = 0;
      }
      }

      Parameters

      Returns void

columnResized?: ((s, e) => void)

Type declaration

columnSelection?: string | GridSelectionMode

Gets/Sets column selection mode

Remarks

By default the row selection mode is none selectionMode: GridSelectionMode

columnSelectionChanging?: ((s, e) => void)

Type declaration

columnVisibilityChanged?: ((s, e) => void)

Type declaration

columnVisibilityChanging?: ((s, e) => void)

Type declaration

columnWidth?: string
contextMenu?: ((s, e) => void)

Type declaration

dataChanged?: ((s, e) => void)

Type declaration

dataChanging?: ((s, e) => void)

Type declaration

dataCloneStrategy?: IgrDataCloneStrategy
doubleClick?: ((s, e) => void)

Type declaration

dragGhostCustomTemplate?: FunctionComponent<{
    dataContext: IgrGridRowDragGhostContext;
}> | Component<{
    dataContext: IgrGridRowDragGhostContext;
}, {}, any>

Gets the custom template, if any, used for row drag ghost.

dragIndicatorIconTemplate?: FunctionComponent<{
    dataContext: IgrGridEmptyTemplateContext;
}> | Component<{
    dataContext: IgrGridEmptyTemplateContext;
}, {}, any>

The custom template, if any, that should be used when rendering the row drag indicator icon

emptyFilteredGridMessage?: string
emptyGridMessage?: string
emptyGridTemplate?: FunctionComponent<{
    dataContext: any;
}> | Component<{
    dataContext: any;
}, {}, any>
excelStyleHeaderIconTemplate?: FunctionComponent<{
    dataContext: IgrGridHeaderTemplateContext;
}> | Component<{
    dataContext: IgrGridHeaderTemplateContext;
}, {}, any>

Gets the excel style header icon.

filterMode?: string | FilterMode
filterStrategy?: IgrFilteringStrategy
filtering?: ((s, e) => void)

Type declaration

filteringDone?: ((s, e) => void)

Type declaration

filteringExpressionsTree?: IgrFilteringExpressionsTree
filteringExpressionsTreeChange?: ((s, e) => void)

Type declaration

filteringLogic?: string | FilteringLogic
formGroupCreated?: ((s, e) => void)

Type declaration

gridCopy?: ((s, e) => void)

Type declaration

gridKeydown?: ((s, e) => void)

Type declaration

gridScroll?: ((s, e) => void)

Type declaration

headSelectorTemplate?: FunctionComponent<{
    dataContext: IgrHeadSelectorTemplateContext;
}> | Component<{
    dataContext: IgrHeadSelectorTemplateContext;
}, {}, any>

Gets the header row selector template.

headerCollapsedIndicatorTemplate?: FunctionComponent<{
    dataContext: IgrGridTemplateContext;
}> | Component<{
    dataContext: IgrGridTemplateContext;
}, {}, any>

Gets the row collapse indicator template.

headerExpandedIndicatorTemplate?: FunctionComponent<{
    dataContext: IgrGridTemplateContext;
}> | Component<{
    dataContext: IgrGridTemplateContext;
}, {}, any>

Gets the header expand indicator template.

height?: string
hideRowSelectors?: string | boolean

Gets/Sets if the row selectors are hidden.

Remarks

By default row selectors are shown

id?: string
isLoading?: string | boolean
loadingGridTemplate?: FunctionComponent<{
    dataContext: any;
}> | Component<{
    dataContext: any;
}, {}, any>
locale?: string

Gets/Sets the locale.

Remarks

If not set, returns browser's language.

moving?: string | boolean

Controls whether columns moving is enabled in the grid.

Gets/Sets the outlet used to attach the grid's overlays to.

Remark

If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.

pagingMode?: string | GridPagingMode
primaryKey?: string
rangeSelected?: ((s, e) => void)

Type declaration

rendered?: ((s, e) => void)

Type declaration

resourceStrings?: IgrGridResourceStrings

Gets/Sets the resource strings.

Remarks

By default it uses EN resources.

rowAdd?: ((s, e) => void)

Type declaration

rowAddTextTemplate?: FunctionComponent<{
    dataContext: IgrGridEmptyTemplateContext;
}> | Component<{
    dataContext: IgrGridEmptyTemplateContext;
}, {}, any>

Gets the row add text template.

rowAdded?: ((s, e) => void)

Type declaration

rowClasses?: any
rowClick?: ((s, e) => void)

Type declaration

rowCollapsedIndicatorTemplate?: FunctionComponent<{
    dataContext: IgrGridRowTemplateContext;
}> | Component<{
    dataContext: IgrGridRowTemplateContext;
}, {}, any>

Gets the row collapse indicator template.

rowDelete?: ((s, e) => void)

Type declaration

rowDeleted?: ((s, e) => void)

Type declaration

rowDragEnd?: ((s, e) => void)

Type declaration

rowDragStart?: ((s, e) => void)

Type declaration

rowDraggable?: string | boolean
rowEdit?: ((s, e) => void)

Type declaration

rowEditActionsTemplate?: FunctionComponent<{
    dataContext: IgrGridRowEditActionsTemplateContext;
}> | Component<{
    dataContext: IgrGridRowEditActionsTemplateContext;
}, {}, any>

Gets the row edit actions template.

rowEditDone?: ((s, e) => void)

Type declaration

rowEditEnter?: ((s, e) => void)

Type declaration

rowEditExit?: ((s, e) => void)

Type declaration

rowEditTextTemplate?: FunctionComponent<{
    dataContext: IgrGridRowEditTextTemplateContext;
}> | Component<{
    dataContext: IgrGridRowEditTextTemplateContext;
}, {}, any>

Gets the row edit text template.

rowEditable?: string | boolean
rowExpandedIndicatorTemplate?: FunctionComponent<{
    dataContext: IgrGridRowTemplateContext;
}> | Component<{
    dataContext: IgrGridRowTemplateContext;
}, {}, any>

Gets the row expand indicator template.

rowHeight?: string | number
rowPinned?: ((s, e) => void)

Type declaration

rowPinning?: ((s, e) => void)

Type declaration

rowSelection?: string | GridSelectionMode

Gets/Sets row selection mode

Remarks

By default the row selection mode is 'none' Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple'

rowSelectionChanging?: ((s, e) => void)

Type declaration

rowSelectorTemplate?: FunctionComponent<{
    dataContext: IgrRowSelectorTemplateContext;
}> | Component<{
    dataContext: IgrRowSelectorTemplateContext;
}, {}, any>

Gets the row selector template.

rowStyles?: any
rowToggle?: ((s, e) => void)

Type declaration

selectRowOnClick?: string | boolean

Gets/Sets whether clicking over a row should select/deselect it

Remarks

By default it is set to true enabled: boolean

selected?: ((s, e) => void)

Type declaration

selectedRows?: any[]
shouldGenerate?: string | boolean

Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid

Remarks

This will allow to bind the grid to remote data and having auto-generated columns at the same time. Note that after generating the columns, this property would be disabled to avoid re-creating columns each time a new data is assigned.

Example

this.grid.shouldGenerate = true;
showSummaryOnCollapse?: string | boolean
snackbarDisplayTime?: string | number

Gets/Sets the display time for the row adding snackbar notification.

Remarks

By default it is 6000ms.

sortAscendingHeaderIconTemplate?: FunctionComponent<{
    dataContext: IgrGridHeaderTemplateContext;
}> | Component<{
    dataContext: IgrGridHeaderTemplateContext;
}, {}, any>

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.

sortDescendingHeaderIconTemplate?: FunctionComponent<{
    dataContext: IgrGridHeaderTemplateContext;
}> | Component<{
    dataContext: IgrGridHeaderTemplateContext;
}, {}, any>

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.

sortHeaderIconTemplate?: FunctionComponent<{
    dataContext: IgrGridHeaderTemplateContext;
}> | Component<{
    dataContext: IgrGridHeaderTemplateContext;
}, {}, any>

Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.

sortStrategy?: IgrGridSortingStrategy
sorting?: ((s, e) => void)

Type declaration

sortingDone?: ((s, e) => void)

Type declaration

sortingExpressions?: IgrSortingExpression[]
sortingExpressionsChange?: ((s, e) => void)

Type declaration

sortingOptions?: IgrSortingOptions
style?: CSSProperties
summaryCalculationMode?: string | GridSummaryCalculationMode
summaryPosition?: string | GridSummaryPosition
summaryRowHeight?: string | number

Get/Set IgxSummaryRow height

toolbarExporting?: ((s, e) => void)

Type declaration

totalRecords?: string | number

Returns the total number of records.

Remarks

Only functions when paging is enabled.

Example

const totalRecords = this.grid.totalRecords;
validationStatusChange?: ((s, e) => void)

Type declaration

validationTrigger?: string | GridValidationTrigger
width?: string

Gets/Sets the width of the grid.

Example

let gridWidth = this.grid.width;