Class IgrDataGrid<S, SS, S>

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns IgrDataGrid

Properties

combinedColumns

combinedColumns: IgrColumn[] = []

The columns actually present in the grid. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing columns from the manual columns collection on the columns property.

contentColumns

contentColumns: IgrColumn[] = []

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<IIgrDataGridProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

activationMode

  • Sets or gets the grid selection mode.

    Returns GridActivationMode

  • Sets or gets the grid selection mode.

    Parameters

    Returns void

activeCell

  • Gets or sets the position of the active cell.

    Returns IgrGridCellPosition

  • Gets or sets the position of the active cell.

    Parameters

    Returns void

activeCellChanged

  • get activeCellChanged(): function
  • set activeCellChanged(ev: function): void

actualBorderWidth

  • get actualBorderWidth(): Thickness
  • set actualBorderWidth(v: Thickness): void
  • Gets the actual border width.

    Returns Thickness

  • Gets the actual border width.

    Parameters

    • v: Thickness

    Returns void

actualColumns

actualCornerRadius

  • get actualCornerRadius(): CornerRadius
  • set actualCornerRadius(v: CornerRadius): void
  • Gets the actual border corner radius around the grid.

    Returns CornerRadius

  • Gets the actual border corner radius around the grid.

    Parameters

    • v: CornerRadius

    Returns void

actualDataSource

  • get actualDataSource(): IDataSource
  • Returns IDataSource

actualHeaderHeight

  • get actualHeaderHeight(): number
  • set actualHeaderHeight(v: number): void
  • Gets the height used for the header row.

    Returns number

  • Gets the height used for the header row.

    Parameters

    • v: number

    Returns void

actualPrimaryKey

  • get actualPrimaryKey(): string[]
  • set actualPrimaryKey(v: string[]): void
  • Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

    Returns string[]

  • Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

    Parameters

    • v: string[]

    Returns void

actualRowHeight

  • get actualRowHeight(): number
  • set actualRowHeight(v: number): void
  • Gets the actual height for the rows in the grid.

    Returns number

  • Gets the actual height for the rows in the grid.

    Parameters

    • v: number

    Returns void

actualVisibleRegion

  • get actualVisibleRegion(): IgRect
  • Gets the region of the grid that is visible.

    Returns IgRect

animationSettings

  • Sets or gets the default animation settings for the grid.

    Returns IgrGridAnimationSettings

  • Sets or gets the default animation settings for the grid.

    Parameters

    Returns void

autoGenerateColumns

  • get autoGenerateColumns(): boolean
  • set autoGenerateColumns(v: boolean): void
  • Configures whether or not the grid will autogenerate columns when the data source is set.

    Returns boolean

  • Configures whether or not the grid will autogenerate columns when the data source is set.

    Parameters

    • v: boolean

    Returns void

border

  • get border(): string
  • set border(v: string): void
  • Gets or sets the border color around the grid.

    Returns string

  • Gets or sets the border color around the grid.

    Parameters

    • v: string

    Returns void

borderWidthBottom

  • get borderWidthBottom(): number
  • set borderWidthBottom(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

borderWidthLeft

  • get borderWidthLeft(): number
  • set borderWidthLeft(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

borderWidthRight

  • get borderWidthRight(): number
  • set borderWidthRight(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

borderWidthTop

  • get borderWidthTop(): number
  • set borderWidthTop(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

cellBackground

  • get cellBackground(): string
  • set cellBackground(v: string): void
  • Gets or sets the default background color to use for content cells

    Returns string

  • Gets or sets the default background color to use for content cells

    Parameters

    • v: string

    Returns void

cellClicked

  • get cellClicked(): function
  • set cellClicked(ev: function): void

cellDataLoadedAnimationMode

  • Sets or gets the cell data loaded animation mode to use.

    Returns CellDataLoadedAnimationMode

  • Sets or gets the cell data loaded animation mode to use.

    Parameters

    Returns void

cellPointerDown

  • get cellPointerDown(): function
  • set cellPointerDown(ev: function): void

cellPointerUp

  • get cellPointerUp(): function
  • set cellPointerUp(ev: function): void

cellPreviewPointerDown

  • get cellPreviewPointerDown(): function
  • set cellPreviewPointerDown(ev: function): void

cellPreviewPointerUp

  • get cellPreviewPointerUp(): function
  • set cellPreviewPointerUp(ev: function): void

cellSelectedBackground

  • get cellSelectedBackground(): string
  • set cellSelectedBackground(v: string): void
  • Gets or sets the default background color to use for content cells when a row is in a selected state

    Returns string

  • Gets or sets the default background color to use for content cells when a row is in a selected state

    Parameters

    • v: string

    Returns void

cellSelectionAnimationMode

  • Sets or gets the cell selection animation mode to use.

    Returns CellSelectionAnimationMode

  • Sets or gets the cell selection animation mode to use.

    Parameters

    Returns void

cellTextColor

  • get cellTextColor(): string
  • set cellTextColor(v: string): void
  • Gets or sets the default text color to use for content cells

    Returns string

  • Gets or sets the default text color to use for content cells

    Parameters

    • v: string

    Returns void

cellTextStyle

  • get cellTextStyle(): string
  • set cellTextStyle(v: string): void
  • Gets or sets the font to use for content cells

    Returns string

  • Gets or sets the font to use for content cells

    Parameters

    • v: string

    Returns void

columnAddingAnimationMode

  • Sets or gets the Column Adding Animation mode to use.

    Returns ColumnShowingAnimationMode

  • Sets or gets the Column Adding Animation mode to use.

    Parameters

    Returns void

columnExchangingAnimationMode

  • Sets or gets the column exchanging animation mode to use.

    Returns ColumnExchangingAnimationMode

  • Sets or gets the column exchanging animation mode to use.

    Parameters

    Returns void

columnHiddenChanged

  • get columnHiddenChanged(): function
  • set columnHiddenChanged(ev: function): void

columnHidingAnimationMode

  • Sets or gets the column hiding animation mode to use.

    Returns ColumnHidingAnimationMode

  • Sets or gets the column hiding animation mode to use.

    Parameters

    Returns void

columnMovingAnimationMode

  • Sets or gets the column moving animation mode to use.

    Returns ColumnMovingAnimationMode

  • Sets or gets the column moving animation mode to use.

    Parameters

    Returns void

columnMovingMode

  • Gets or sets the type column moving to use.

    Returns ColumnMovingMode

  • Gets or sets the type column moving to use.

    Parameters

    Returns void

columnMovingSeparator

  • Gets or sets the column resizing seperator settings.

    Returns IgrColumnMovingSeparator

  • Gets or sets the column resizing seperator settings.

    Parameters

    Returns void

columnMovingSeparatorBackground

  • get columnMovingSeparatorBackground(): string
  • set columnMovingSeparatorBackground(v: string): void
  • Gets or sets the default background color to use for column moving separator.

    Returns string

  • Gets or sets the default background color to use for column moving separator.

    Parameters

    • v: string

    Returns void

columnMovingSeparatorWidth

  • get columnMovingSeparatorWidth(): number
  • set columnMovingSeparatorWidth(v: number): void
  • Sets or gets the width to use for the column resizing separator.

    Returns number

  • Sets or gets the width to use for the column resizing separator.

    Parameters

    • v: number

    Returns void

columnOptionsIconAlignment

  • Gets or sets the column options icon alignment in header cells.

    Returns ColumnOptionsIconAlignment

  • Gets or sets the column options icon alignment in header cells.

    Parameters

    Returns void

columnOptionsIconBehavior

  • Gets or sets how the column options icon will behave inside header cells.

    Returns ColumnOptionsIconBehavior

  • Gets or sets how the column options icon will behave inside header cells.

    Parameters

    Returns void

columnOptionsIconColor

  • get columnOptionsIconColor(): string
  • set columnOptionsIconColor(v: string): void
  • Gets or sets the column options icon color in header cells.

    Returns string

  • Gets or sets the column options icon color in header cells.

    Parameters

    • v: string

    Returns void

columnPinnedChanged

  • get columnPinnedChanged(): function
  • set columnPinnedChanged(ev: function): void

columnPropertyUpdatingAnimationMode

columnResizingAnimationMode

  • Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode.

    Returns ColumnResizingAnimationMode

  • Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode.

    Parameters

    Returns void

columnResizingMode

  • Gets or sets the type of column resizing to use.

    Returns ColumnResizingMode

  • Gets or sets the type of column resizing to use.

    Parameters

    Returns void

columnResizingSeparator

  • Gets or sets the column resizing seperator settings.

    Returns IgrColumnResizingSeparator

  • Gets or sets the column resizing seperator settings.

    Parameters

    Returns void

columnResizingSeparatorBackground

  • get columnResizingSeparatorBackground(): string
  • set columnResizingSeparatorBackground(v: string): void
  • Gets or sets the default background color to use for column resizing separator.

    Returns string

  • Gets or sets the default background color to use for column resizing separator.

    Parameters

    • v: string

    Returns void

columnResizingSeparatorWidth

  • get columnResizingSeparatorWidth(): number
  • set columnResizingSeparatorWidth(v: number): void
  • Sets or gets the width to use for the column resizing separator.

    Returns number

  • Sets or gets the width to use for the column resizing separator.

    Parameters

    • v: number

    Returns void

columnShowingAnimationMode

  • Sets or gets the column showing animation mode to use.

    Returns ColumnShowingAnimationMode

  • Sets or gets the column showing animation mode to use.

    Parameters

    Returns void

columns

  • A collection or manually added columns for the grid.

    Returns IgrGridColumnCollection

columnsAutoGenerated

  • get columnsAutoGenerated(): function
  • set columnsAutoGenerated(ev: function): void

cornerRadiusBottomLeft

  • get cornerRadiusBottomLeft(): number
  • set cornerRadiusBottomLeft(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

cornerRadiusBottomRight

  • get cornerRadiusBottomRight(): number
  • set cornerRadiusBottomRight(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

cornerRadiusTopLeft

  • get cornerRadiusTopLeft(): number
  • set cornerRadiusTopLeft(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

cornerRadiusTopRight

  • get cornerRadiusTopRight(): number
  • set cornerRadiusTopRight(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

dataSource

  • get dataSource(): any
  • set dataSource(value: any): void
  • Returns any

  • Parameters

    • value: any

    Returns void

dataSourceDesiredProperties

  • get dataSourceDesiredProperties(): string[]
  • set dataSourceDesiredProperties(v: string[]): void
  • Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.

    Returns string[]

  • Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.

    Parameters

    • v: string[]

    Returns void

defaultColumnMinWidth

  • get defaultColumnMinWidth(): number
  • set defaultColumnMinWidth(v: number): void
  • Gets or sets the default minimum width to use on all columns. Ignored if NaN.

    Returns number

  • Gets or sets the default minimum width to use on all columns. Ignored if NaN.

    Parameters

    • v: number

    Returns void

defaultColumnWidth

  • Gets or sets the default column width to use if a column as no local width.

    Returns IgrColumnWidth

  • Gets or sets the default column width to use if a column as no local width.

    Parameters

    Returns void

density

  • get density(): ControlDisplayDensity
  • set density(v: ControlDisplayDensity): void
  • Gets or sets the display density to use for the grid.

    Returns ControlDisplayDensity

  • Gets or sets the display density to use for the grid.

    Parameters

    • v: ControlDisplayDensity

    Returns void

filterExpressions

  • get filterExpressions(): IgrFilterExpressionCollection
  • Gets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties.

    Returns IgrFilterExpressionCollection

filterExpressionsChanged

  • get filterExpressionsChanged(): function
  • set filterExpressionsChanged(ev: function): void

filterExpressionsChanging

  • get filterExpressionsChanging(): function
  • set filterExpressionsChanging(ev: function): void

groupDescriptions

  • Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.

    Returns IgrColumnGroupDescriptionCollection

groupDescriptionsChanged

  • get groupDescriptionsChanged(): function
  • set groupDescriptionsChanged(ev: function): void

groupHeaderDisplayMode

  • get groupHeaderDisplayMode(): DataSourceSectionHeaderDisplayMode
  • set groupHeaderDisplayMode(v: DataSourceSectionHeaderDisplayMode): void
  • Gets or sets how group headers are displayed when there are multiple groups defined in the grid.

    Returns DataSourceSectionHeaderDisplayMode

  • Gets or sets how group headers are displayed when there are multiple groups defined in the grid.

    Parameters

    • v: DataSourceSectionHeaderDisplayMode

    Returns void

groupSummaryDisplayMode

  • Gets or sets the display mode summaries will use inside groups.

    Returns GroupSummaryDisplayMode

  • Gets or sets the display mode summaries will use inside groups.

    Parameters

    Returns void

headerBackground

  • get headerBackground(): string
  • set headerBackground(v: string): void
  • Gets or sets the default background color to use for header cells

    Returns string

  • Gets or sets the default background color to use for header cells

    Parameters

    • v: string

    Returns void

headerClickAction

  • Returns/sets the action to take when a column header is clicked.

    Returns HeaderClickAction

  • Returns/sets the action to take when a column header is clicked.

    Parameters

    Returns void

headerHeight

  • get headerHeight(): number
  • set headerHeight(v: number): void
  • Gets or sets the height to use for the header row.

    Returns number

  • Gets or sets the height to use for the header row.

    Parameters

    • v: number

    Returns void

headerRowSeparator

  • Gets or sets the header row seperator settings.

    Returns IgrHeaderRowSeparator

  • Gets or sets the header row seperator settings.

    Parameters

    Returns void

headerRowSeparatorBackground

  • get headerRowSeparatorBackground(): string
  • set headerRowSeparatorBackground(v: string): void
  • Returns string

  • Parameters

    • v: string

    Returns void

headerSeparator

  • Gets or sets the header seperator settings.

    Returns IgrHeaderSeparator

  • Gets or sets the header seperator settings.

    Parameters

    Returns void

headerSeparatorBackground

  • get headerSeparatorBackground(): string
  • set headerSeparatorBackground(v: string): void
  • Gets or sets the default background color to use for header separators.

    Returns string

  • Gets or sets the default background color to use for header separators.

    Parameters

    • v: string

    Returns void

headerSeparatorWidth

  • get headerSeparatorWidth(): number
  • set headerSeparatorWidth(v: number): void
  • Gets or sets the width of the header separators.

    Returns number

  • Gets or sets the width of the header separators.

    Parameters

    • v: number

    Returns void

headerSortIndicatorColor

  • get headerSortIndicatorColor(): string
  • set headerSortIndicatorColor(v: string): void
  • Gets or sets the default text color to use for content cells

    Returns string

  • Gets or sets the default text color to use for content cells

    Parameters

    • v: string

    Returns void

headerSortIndicatorStyle

  • Gets or sets the default render style for sort indicators in header cells.

    Returns SortIndicatorStyle

  • Gets or sets the default render style for sort indicators in header cells.

    Parameters

    Returns void

headerTextColor

  • get headerTextColor(): string
  • set headerTextColor(v: string): void
  • Gets or sets the default text color to use for header cells

    Returns string

  • Gets or sets the default text color to use for header cells

    Parameters

    • v: string

    Returns void

headerTextStyle

  • get headerTextStyle(): string
  • set headerTextStyle(v: string): void
  • Gets or sets the font to use for header cells

    Returns string

  • Gets or sets the font to use for header cells

    Parameters

    • v: string

    Returns void

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

i

  • get i(): Grid
  • Returns Grid

insetBottom

  • get insetBottom(): number
  • set insetBottom(v: number): void
  • Gets or sets the amount of bottom inset space to use around the grid content.

    Returns number

  • Gets or sets the amount of bottom inset space to use around the grid content.

    Parameters

    • v: number

    Returns void

insetLeft

  • get insetLeft(): number
  • set insetLeft(v: number): void
  • Gets or sets the amount of left inset space to use around the grid content.

    Returns number

  • Gets or sets the amount of left inset space to use around the grid content.

    Parameters

    • v: number

    Returns void

insetRight

  • get insetRight(): number
  • set insetRight(v: number): void
  • Gets or sets the amount of right inset space to use around the grid content.

    Returns number

  • Gets or sets the amount of right inset space to use around the grid content.

    Parameters

    • v: number

    Returns void

insetTop

  • get insetTop(): number
  • set insetTop(v: number): void
  • Gets or sets the amount of top inset space to use around the grid content.

    Returns number

  • Gets or sets the amount of top inset space to use around the grid content.

    Parameters

    • v: number

    Returns void

isColumnOptionsEnabled

  • get isColumnOptionsEnabled(): boolean
  • set isColumnOptionsEnabled(v: boolean): void
  • Gets or sets whether to show the column options UI in the headers for columns.

    Returns boolean

  • Gets or sets whether to show the column options UI in the headers for columns.

    Parameters

    • v: boolean

    Returns void

isGroupCollapsable

  • get isGroupCollapsable(): boolean
  • set isGroupCollapsable(v: boolean): void
  • Gets or sets whether group headers are collapsable.

    Returns boolean

  • Gets or sets whether group headers are collapsable.

    Parameters

    • v: boolean

    Returns void

isGroupExpandedDefault

  • get isGroupExpandedDefault(): boolean
  • set isGroupExpandedDefault(v: boolean): void
  • Gets or sets whether groups are expanded or collapsed by default.

    Returns boolean

  • Gets or sets whether groups are expanded or collapsed by default.

    Parameters

    • v: boolean

    Returns void

isGroupRowSticky

  • get isGroupRowSticky(): boolean
  • set isGroupRowSticky(v: boolean): void
  • Gets or sets if group rows will stick to the top of the grid.

    Returns boolean

  • Gets or sets if group rows will stick to the top of the grid.

    Parameters

    • v: boolean

    Returns void

isHeaderSeparatorVisible

  • get isHeaderSeparatorVisible(): boolean
  • set isHeaderSeparatorVisible(v: boolean): void
  • Gets or sets if header separators are rendered.

    Returns boolean

  • Gets or sets if header separators are rendered.

    Parameters

    • v: boolean

    Returns void

isPlaceholderRenderingEnabled

  • get isPlaceholderRenderingEnabled(): boolean
  • set isPlaceholderRenderingEnabled(v: boolean): void
  • Configures whether or not place holders are used for cells who do not have their data yet.

    Returns boolean

  • Configures whether or not place holders are used for cells who do not have their data yet.

    Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string
  • set lastStickyRowBackground(v: string): void
  • Gets or sets the default color to use for the last sticky row

    Returns string

  • Gets or sets the default color to use for the last sticky row

    Parameters

    • v: string

    Returns void

pinnedAreaSeparator

  • Gets or sets the pinned area separator settings.

    Returns IgrPinnedAreaSeparator

  • Gets or sets the pinned area separator settings.

    Parameters

    Returns void

pinnedAreaSeparatorWidth

  • get pinnedAreaSeparatorWidth(): number
  • set pinnedAreaSeparatorWidth(v: number): void
  • Gets or sets the width of the pinned area separators.

    Returns number

  • Gets or sets the width of the pinned area separators.

    Parameters

    • v: number

    Returns void

pinnedItems

  • Gets which items are currently pinned in the grid. Collection can be updated to programatically pin items.

    Returns IgrGridSelectedItemsCollection

  • Gets which items are currently pinned in the grid. Collection can be updated to programatically pin items.

    Parameters

    Returns void

pinnedKeys

  • Gets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items.

    Returns IgrGridSelectedKeysCollection

  • Gets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items.

    Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string
  • set pinnedRowBackground(v: string): void
  • Gets or sets the default color to use for pinned rows

    Returns string

  • Gets or sets the default color to use for pinned rows

    Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number
  • set pinnedRowOpacity(v: number): void
  • Gets or sets the default opacity to use for pinned rows

    Returns number

  • Gets or sets the default opacity to use for pinned rows

    Parameters

    • v: number

    Returns void

primaryKey

  • get primaryKey(): string[]
  • set primaryKey(v: string[]): void
  • Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

    Returns string[]

  • Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

    Parameters

    • v: string[]

    Returns void

reactsToFilterChanges

  • get reactsToFilterChanges(): boolean
  • set reactsToFilterChanges(v: boolean): void
  • Sets or gets whether the grid will react to filter changes.

    Returns boolean

  • Sets or gets whether the grid will react to filter changes.

    Parameters

    • v: boolean

    Returns void

reactsToGroupChanges

  • get reactsToGroupChanges(): boolean
  • set reactsToGroupChanges(v: boolean): void
  • Sets or gets whether the grid will react to group changes.

    Returns boolean

  • Sets or gets whether the grid will react to group changes.

    Parameters

    • v: boolean

    Returns void

reactsToSortChanges

  • get reactsToSortChanges(): boolean
  • set reactsToSortChanges(v: boolean): void
  • Sets or gets whether the grid will react to sort changes.

    Returns boolean

  • Sets or gets whether the grid will react to sort changes.

    Parameters

    • v: boolean

    Returns void

responsiveStates

  • A set of states that can be applied to the columns of the grid based on available space.

    Returns IgrResponsiveStatesCollection

  • A set of states that can be applied to the columns of the grid based on available space.

    Parameters

    Returns void

rowHeight

  • get rowHeight(): number
  • set rowHeight(v: number): void
  • Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density.

    Returns number

  • Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density.

    Parameters

    • v: number

    Returns void

rowSelectionAnimationMode

  • Sets or gets the row selection animation mode to use.

    Returns RowSelectionAnimationMode

  • Sets or gets the row selection animation mode to use.

    Parameters

    Returns void

rowSeparator

  • Gets or sets the row seperator settings.

    Returns IgrRowSeparator

  • Gets or sets the row seperator settings.

    Parameters

    Returns void

rowSeparatorBackground

  • get rowSeparatorBackground(): string
  • set rowSeparatorBackground(v: string): void
  • Gets or sets the default background color to use for row separators

    Returns string

  • Gets or sets the default background color to use for row separators

    Parameters

    • v: string

    Returns void

rowSeparatorHeight

  • get rowSeparatorHeight(): number
  • set rowSeparatorHeight(v: number): void
  • Sets or gets the height to use for the row separators.

    Returns number

  • Sets or gets the height to use for the row separators.

    Parameters

    • v: number

    Returns void

rowSeparatorLastStickyRowBackground

  • get rowSeparatorLastStickyRowBackground(): string
  • set rowSeparatorLastStickyRowBackground(v: string): void
  • Gets or sets the default last sticky row background color to use for row separators

    Returns string

  • Gets or sets the default last sticky row background color to use for row separators

    Parameters

    • v: string

    Returns void

rowSeparatorPinnedRowBackground

  • get rowSeparatorPinnedRowBackground(): string
  • set rowSeparatorPinnedRowBackground(v: string): void
  • Gets or sets the pinned row background color to use for row separators

    Returns string

  • Gets or sets the pinned row background color to use for row separators

    Parameters

    • v: string

    Returns void

rowSeparatorStickyRowBackground

  • get rowSeparatorStickyRowBackground(): string
  • set rowSeparatorStickyRowBackground(v: string): void
  • Gets or sets the default sticky row background color to use for row separators

    Returns string

  • Gets or sets the default sticky row background color to use for row separators

    Parameters

    • v: string

    Returns void

scrollbarStyle

  • get scrollbarStyle(): ScrollbarStyle
  • set scrollbarStyle(style: ScrollbarStyle): void
  • Returns ScrollbarStyle

  • Parameters

    • style: ScrollbarStyle

    Returns void

sectionHeader

  • Gets or sets the header type used for sectioning off groups of rows.

    Returns IgrSectionHeader

  • Gets or sets the header type used for sectioning off groups of rows.

    Parameters

    Returns void

sectionHeaderBackground

  • get sectionHeaderBackground(): string
  • set sectionHeaderBackground(v: string): void
  • Gets or sets the default background color to use for section header cells

    Returns string

  • Gets or sets the default background color to use for section header cells

    Parameters

    • v: string

    Returns void

sectionHeaderSelectedBackground

  • get sectionHeaderSelectedBackground(): string
  • set sectionHeaderSelectedBackground(v: string): void
  • Gets or sets the default background color to use for section header cells when a row is in a selected state

    Returns string

  • Gets or sets the default background color to use for section header cells when a row is in a selected state

    Parameters

    • v: string

    Returns void

sectionHeaderTextColor

  • get sectionHeaderTextColor(): string
  • set sectionHeaderTextColor(v: string): void
  • Gets or sets the default text color to use for section header cells

    Returns string

  • Gets or sets the default text color to use for section header cells

    Parameters

    • v: string

    Returns void

sectionHeaderTextStyle

  • get sectionHeaderTextStyle(): string
  • set sectionHeaderTextStyle(v: string): void
  • Gets or sets the font to use for section header cells

    Returns string

  • Gets or sets the font to use for section header cells

    Parameters

    • v: string

    Returns void

selectedCellRanges

  • Gets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells.

    Returns IgrGridSelectedCellRangesCollection

  • Gets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells.

    Parameters

    Returns void

selectedCellRangesChanged

  • get selectedCellRangesChanged(): function
  • set selectedCellRangesChanged(ev: function): void

selectedCells

  • Gets which cells are currently selected in the grid. Collection can be updated to programatically select cells.

    Returns IgrGridSelectedCellsCollection

  • Gets which cells are currently selected in the grid. Collection can be updated to programatically select cells.

    Parameters

    Returns void

selectedCellsChanged

  • get selectedCellsChanged(): function
  • set selectedCellsChanged(ev: function): void

selectedItems

  • Gets which items are currently selected in the grid. Collection can be updated to programatically select items.

    Returns IgrGridSelectedItemsCollection

  • Gets which items are currently selected in the grid. Collection can be updated to programatically select items.

    Parameters

    Returns void

selectedItemsChanged

  • get selectedItemsChanged(): function
  • set selectedItemsChanged(ev: function): void

selectedKeys

  • Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.

    Returns IgrGridSelectedKeysCollection

  • Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.

    Parameters

    Returns void

selectedKeysChanged

  • get selectedKeysChanged(): function
  • set selectedKeysChanged(ev: function): void

selectionBehavior

  • Sets or gets how selection behaves in the grid.

    Returns GridSelectionBehavior

  • Sets or gets how selection behaves in the grid.

    Parameters

    Returns void

selectionMode

  • Sets or gets the grid selection mode.

    Returns GridSelectionMode

  • Sets or gets the grid selection mode.

    Parameters

    Returns void

shiftSectionContent

  • get shiftSectionContent(): boolean
  • set shiftSectionContent(v: boolean): void
  • Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns

    Returns boolean

  • Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns

    Parameters

    • v: boolean

    Returns void

sortDescriptions

  • Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

    Returns IgrColumnSortDescriptionCollection

sortDescriptionsChanged

  • get sortDescriptionsChanged(): function
  • set sortDescriptionsChanged(ev: function): void

stickyRowBackground

  • get stickyRowBackground(): string
  • set stickyRowBackground(v: string): void
  • Gets or sets the default color to use for sticky rows

    Returns string

  • Gets or sets the default color to use for sticky rows

    Parameters

    • v: string

    Returns void

summaryDescriptions

summaryRootBackground

  • get summaryRootBackground(): string
  • set summaryRootBackground(v: string): void
  • Gets or sets the default background color to use for summary cells at the root level.

    Returns string

  • Gets or sets the default background color to use for summary cells at the root level.

    Parameters

    • v: string

    Returns void

summaryRootLabelTextColor

  • get summaryRootLabelTextColor(): string
  • set summaryRootLabelTextColor(v: string): void
  • Gets or sets the default text color to use for summary labels in summary cells at the root level.

    Returns string

  • Gets or sets the default text color to use for summary labels in summary cells at the root level.

    Parameters

    • v: string

    Returns void

summaryRootLabelTextStyle

  • get summaryRootLabelTextStyle(): string
  • set summaryRootLabelTextStyle(v: string): void
  • Gets or sets the font to use for summary labels at the root level.

    Returns string

  • Gets or sets the font to use for summary labels at the root level.

    Parameters

    • v: string

    Returns void

summaryRootSelectedBackground

  • get summaryRootSelectedBackground(): string
  • set summaryRootSelectedBackground(v: string): void
  • Gets or sets the default background color to use for summary cells at the root level.

    Returns string

  • Gets or sets the default background color to use for summary cells at the root level.

    Parameters

    • v: string

    Returns void

summaryRootValueTextColor

  • get summaryRootValueTextColor(): string
  • set summaryRootValueTextColor(v: string): void
  • Gets or sets the default text color to use for summary cells at the root level.

    Returns string

  • Gets or sets the default text color to use for summary cells at the root level.

    Parameters

    • v: string

    Returns void

summaryRootValueTextStyle

  • get summaryRootValueTextStyle(): string
  • set summaryRootValueTextStyle(v: string): void
  • Gets or sets the font to use for summary values at the root level.

    Returns string

  • Gets or sets the font to use for summary values at the root level.

    Parameters

    • v: string

    Returns void

summaryRowRoot

  • Gets or sets the cell definition used for summary rows at the root level.

    Returns IgrSummaryRowRoot

  • Gets or sets the cell definition used for summary rows at the root level.

    Parameters

    Returns void

summaryRowSection

  • Gets or sets the cell definition used for summary rows at the section level.

    Returns IgrSummaryRowSection

  • Gets or sets the cell definition used for summary rows at the section level.

    Parameters

    Returns void

summaryScope

  • get summaryScope(): DataSourceSummaryScope
  • set summaryScope(v: DataSourceSummaryScope): void
  • Gets or sets the scope which summaries are calculated for.

    Returns DataSourceSummaryScope

  • Gets or sets the scope which summaries are calculated for.

    Parameters

    • v: DataSourceSummaryScope

    Returns void

summarySectionBackground

  • get summarySectionBackground(): string
  • set summarySectionBackground(v: string): void
  • Gets or sets the default background color to use for summary cells at the section level.

    Returns string

  • Gets or sets the default background color to use for summary cells at the section level.

    Parameters

    • v: string

    Returns void

summarySectionLabelTextColor

  • get summarySectionLabelTextColor(): string
  • set summarySectionLabelTextColor(v: string): void
  • Gets or sets the default text color to use for summary labels in summary cells at the section level.

    Returns string

  • Gets or sets the default text color to use for summary labels in summary cells at the section level.

    Parameters

    • v: string

    Returns void

summarySectionLabelTextStyle

  • get summarySectionLabelTextStyle(): string
  • set summarySectionLabelTextStyle(v: string): void
  • Gets or sets the font to use for summary labels at the section level.

    Returns string

  • Gets or sets the font to use for summary labels at the section level.

    Parameters

    • v: string

    Returns void

summarySectionSelectedBackground

  • get summarySectionSelectedBackground(): string
  • set summarySectionSelectedBackground(v: string): void
  • Gets or sets the default background color to use for summary cells at the section level.

    Returns string

  • Gets or sets the default background color to use for summary cells at the section level.

    Parameters

    • v: string

    Returns void

summarySectionValueTextColor

  • get summarySectionValueTextColor(): string
  • set summarySectionValueTextColor(v: string): void
  • Gets or sets the default text color to use for summary cells at the section level.

    Returns string

  • Gets or sets the default text color to use for summary cells at the section level.

    Parameters

    • v: string

    Returns void

summarySectionValueTextStyle

  • get summarySectionValueTextStyle(): string
  • set summarySectionValueTextStyle(v: string): void
  • Gets or sets the font to use for summary values at the section level.

    Returns string

  • Gets or sets the font to use for summary values at the section level.

    Parameters

    • v: string

    Returns void

useCanvas

  • get useCanvas(): boolean
  • set useCanvas(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IIgrDataGridProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrDataGridProps>, nextState: Readonly<S>, nextContext: any): void

canMoveColumnLeft

  • canMoveColumnLeft(columnIndex: number): boolean
  • Returns true if a column can be moved to the left of it's current position; otherwise false.

    Parameters

    • columnIndex: number
      • The index of the column.

    Returns boolean

canMoveColumnRight

  • canMoveColumnRight(columnIndex: number): boolean
  • Returns true if a column can be moved to the right of it's current position; otherwise false.

    Parameters

    • columnIndex: number
      • The index of the column.

    Returns boolean

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrDataGridProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IIgrDataGridProps>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IIgrDataGridProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrDataGridProps>, nextState: Readonly<S>, nextContext: any): void

dataIndexOfItem

  • dataIndexOfItem(item: any): number
  • Returns the data index of an item within the bound data source.

    Parameters

    • item: any
      • The item from which to get the index.

    Returns number

dataIndexOfPrimaryKey

  • dataIndexOfPrimaryKey(key: any[]): number
  • Parameters

    • key: any[]

    Returns number

ensureBorderWidth

  • ensureBorderWidth(): void
  • Returns void

ensureCornerRadius

  • ensureCornerRadius(): void
  • Returns void

exchangeColumn

  • Parameters

    Returns void

exportSerializedVisualModel

  • exportSerializedVisualModel(): string
  • Returns a serialized copy of the exported visual model

    Returns string

exportVisualModel

  • exportVisualModel(): any
  • Exports visual information about the current state of the grid.

    Returns any

flush

  • flush(): void
  • Makes sure pending work has completed if the grid need to be synchronously examined.

    Returns void

forColumnsWithPropertyPath

  • forColumnsWithPropertyPath(propertyPath: string, callback: function): void
  • Parameters

    • propertyPath: string
    • callback: function

    Returns void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

getColumnAtRenderedIndex

  • getColumnAtRenderedIndex(index: number): IgrColumn
  • Gets the column that appears at the index specified. This is not the columns actual index in the column's collection but the index for how it appears visually in the grid.

    Parameters

    • index: number
      • The rendered index of the column.

    Returns IgrColumn

getFirstVisibleIndex

  • getFirstVisibleIndex(): number
  • Gets the first visible index in the grid.

    Returns number

getHitCell

  • Parameters

    • x: number
    • y: number

    Returns IgrCellInfo

getLastVisibleIndex

  • getLastVisibleIndex(): number
  • Gets the last visible index in the grid.

    Returns number

getRootSummaryResults

  • getRootSummaryResults(): ISummaryResult[]
  • Gets the summary results for root level.

    Returns ISummaryResult[]

getSectionSummaryResults

  • getSectionSummaryResults(sectionIndex: number): ISummaryResult[][]
  • Gets the summary results for a specific section.

    Parameters

    • sectionIndex: number

    Returns ISummaryResult[][]

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrDataGridProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

initializeContent

  • initializeContent(): void
  • Returns void

invalidateVisibleRows

  • invalidateVisibleRows(): void
  • Invalidates the bound data for the rows currently visible.

    Returns void

moveColumn

  • moveColumn(oldIndex: number, newIndex: number): void
  • Parameters

    • oldIndex: number
    • newIndex: number

    Returns void

moveColumnLeft

  • moveColumnLeft(columnIndex: number): void
  • Moves a column to the left, if possible.

    Parameters

    • columnIndex: number
      • The index of the column to move.

    Returns void

moveColumnRight

  • moveColumnRight(columnIndex: number): void
  • Moves a column to the right, if possible.

    Parameters

    • columnIndex: number
      • The index of the column to move.

    Returns void

ngOnInit

  • ngOnInit(): void
  • Returns void

notifyClearItems

  • notifyClearItems(): void
  • Manually notifies the grid's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable.

    Returns void

notifyInsertItem

  • notifyInsertItem(index: number, newItem: any): void
  • Parameters

    • index: number
    • newItem: any

    Returns void

notifyRemoveItem

  • notifyRemoveItem(index: number, oldItem: any): void
  • Parameters

    • index: number
    • oldItem: any

    Returns void

notifySetItem

  • notifySetItem(index: number, oldItem: any, newItem: any): void
  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

onScroll

  • onScroll(): void
  • Returns void

pinColumn

  • Parameters

    Returns void

refresh

  • refresh(): void
  • Forces a refresh of the grid content.

    Returns void

render

  • render(): DetailedReactHTMLElement<object, any>
  • Returns DetailedReactHTMLElement<object, any>

resolveCellValue

  • Resolves the value of a specific cell.

    Parameters

    Returns any

resolveCellValueFromPosition

  • resolveCellValueFromPosition(row: number, column: number): any
  • Parameters

    • row: number
    • column: number

    Returns any

scrollTo

  • scrollTo(x: number, y: number): void
  • Parameters

    • x: number
    • y: number

    Returns void

scrollToColumnByIndex

  • scrollToColumnByIndex(columnNumber: number): void
  • Scrolls the grid to given column, by index

    Parameters

    • columnNumber: number
      • The column number to scroll to.

    Returns void

scrollToItem

  • scrollToItem(item: any): boolean
  • Scrolls to an item, if found.

    Parameters

    • item: any
      • The item to scroll to.

    Returns boolean

scrollToLastRowByIndex

  • scrollToLastRowByIndex(rowNumber: number): void
  • Scrolls the grid so that a row is the last visible, by index.

    Parameters

    • rowNumber: number
      • The row index to scroll to.

    Returns void

scrollToPrimaryKey

  • scrollToPrimaryKey(key: any[]): boolean
  • Parameters

    • key: any[]

    Returns boolean

scrollToRowByIndex

  • scrollToRowByIndex(rowNumber: number): void
  • Scrolls the grid to given row, by index

    Parameters

    • rowNumber: number
      • The row index to scroll to.

    Returns void

setActiveResponsiveState

  • setActiveResponsiveState(name: string): void
  • Manually set the active responsive state of the grid.

    Parameters

    • name: string

    Returns void

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean