Class IgcDataGridComponent

Hierarchy

  • HTMLElement
    • IgcDataGridComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

COMMENT_NODE

COMMENT_NODE: number

DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

DOCUMENT_NODE

DOCUMENT_NODE: number

DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

ELEMENT_NODE

ELEMENT_NODE: number

ENTITY_NODE

ENTITY_NODE: number

ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

NOTATION_NODE

NOTATION_NODE: number

PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

TEXT_NODE

TEXT_NODE: number

accessKey

accessKey: string

accessKeyLabel

accessKeyLabel: string

assignedSlot

assignedSlot: HTMLSlotElement | null

attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

baseURI

baseURI: string

Returns node's node document's document base URL.

childElementCount

childElementCount: number

childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

children

children: HTMLCollection

Returns the child elements.

classList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

clientHeight

clientHeight: number

clientLeft

clientLeft: number

clientTop

clientTop: number

clientWidth

clientWidth: number

combinedColumns

combinedColumns: IgcColumnComponent[] = []

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

contentColumns

contentColumns: IgcColumnComponent[] = []

contentEditable

contentEditable: string

dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

firstChild

firstChild: ChildNode | null

Returns the first child.

firstElementChild

firstElementChild: Element | null

Returns the first child that is an element, and null otherwise.

hidden

hidden: boolean

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable

isContentEditable: boolean

lang

lang: string

lastChild

lastChild: ChildNode | null

Returns the last child.

lastElementChild

lastElementChild: Element | null

Returns the last child that is an element, and null otherwise.

localName

localName: string

Returns the local name.

namespaceURI

namespaceURI: string | null

Returns the namespace.

nextElementSibling

nextElementSibling: Element | null

Returns the first following sibling that is an element, and null otherwise.

nextSibling

nextSibling: Node | null

Returns the next sibling.

nodeName

nodeName: string

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".

nodeType

nodeType: number

nodeValue

nodeValue: string | null

nonce

nonce: string

offsetHeight

offsetHeight: number

offsetLeft

offsetLeft: number

offsetParent

offsetParent: Element | null

offsetTop

offsetTop: number

offsetWidth

offsetWidth: number

onabort

onabort: function | null

Fires when the user aborts the download.

param

The event.

onanimationcancel

onanimationcancel: function | null

onanimationend

onanimationend: function | null

onanimationiteration

onanimationiteration: function | null

onanimationstart

onanimationstart: function | null

onauxclick

onauxclick: function | null

onblur

onblur: function | null

Fires when the object loses the input focus.

param

The focus event.

oncancel

oncancel: function | null

oncanplay

oncanplay: function | null

Occurs when playback is possible, but would require further buffering.

param

The event.

oncanplaythrough

oncanplaythrough: function | null

onchange

onchange: function | null

Fires when the contents of the object or selection have changed.

param

The event.

onclick

onclick: function | null

Fires when the user clicks the left mouse button on the object

param

The mouse event.

onclose

onclose: function | null

oncontextmenu

oncontextmenu: function | null

Fires when the user clicks the right mouse button in the client area, opening the context menu.

param

The mouse event.

oncopy

oncopy: function | null

oncuechange

oncuechange: function | null

oncut

oncut: function | null

ondblclick

ondblclick: function | null

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

ondrag: function | null

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

ondragend: function | null

Fires on the source object when the user releases the mouse at the close of a drag operation.

param

The event.

ondragenter

ondragenter: function | null

Fires on the target element when the user drags the object to a valid drop target.

param

The drag event.

ondragexit

ondragexit: function | null

ondragleave

ondragleave: function | null

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

param

The drag event.

ondragover

ondragover: function | null

Fires on the target element continuously while the user drags the object over a valid drop target.

param

The event.

ondragstart

ondragstart: function | null

Fires on the source object when the user starts to drag a text selection or selected object.

param

The event.

ondrop

ondrop: function | null

ondurationchange

ondurationchange: function | null

Occurs when the duration attribute is updated.

param

The event.

onemptied

onemptied: function | null

Occurs when the media element is reset to its initial state.

param

The event.

onended

onended: function | null

Occurs when the end of playback is reached.

param

The event

onerror

onerror: ErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

onfocus: function | null

Fires when the object receives focus.

param

The event.

onfullscreenchange

onfullscreenchange: function | null

onfullscreenerror

onfullscreenerror: function | null

ongotpointercapture

ongotpointercapture: function | null

oninput

oninput: function | null

oninvalid

oninvalid: function | null

onkeydown

onkeydown: function | null

Fires when the user presses a key.

param

The keyboard event

onkeypress

onkeypress: function | null

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

onkeyup: function | null

Fires when the user releases a key.

param

The keyboard event

onload

onload: function | null

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

onloadeddata: function | null

Occurs when media data is loaded at the current playback position.

param

The event.

onloadedmetadata

onloadedmetadata: function | null

Occurs when the duration and dimensions of the media have been determined.

param

The event.

onloadend

onloadend: function | null

onloadstart

onloadstart: function | null

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

onlostpointercapture: function | null

onmousedown

onmousedown: function | null

Fires when the user clicks the object with either mouse button.

param

The mouse event.

onmouseenter

onmouseenter: function | null

onmouseleave

onmouseleave: function | null

onmousemove

onmousemove: function | null

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

onmouseout: function | null

Fires when the user moves the mouse pointer outside the boundaries of the object.

param

The mouse event.

onmouseover

onmouseover: function | null

Fires when the user moves the mouse pointer into the object.

param

The mouse event.

onmouseup

onmouseup: function | null

Fires when the user releases a mouse button while the mouse is over the object.

param

The mouse event.

onpaste

onpaste: function | null

onpause

onpause: function | null

Occurs when playback is paused.

param

The event.

onplay

onplay: function | null

Occurs when the play method is requested.

param

The event.

onplaying

onplaying: function | null

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: function | null

onpointerdown

onpointerdown: function | null

onpointerenter

onpointerenter: function | null

onpointerleave

onpointerleave: function | null

onpointermove

onpointermove: function | null

onpointerout

onpointerout: function | null

onpointerover

onpointerover: function | null

onpointerup

onpointerup: function | null

onprogress

onprogress: function | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

onratechange: function | null

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

onreset: function | null

Fires when the user resets a form.

param

The event.

onresize

onresize: function | null

onscroll

onscroll: function | null

Fires when the user repositions the scroll box in the scroll bar on the object.

param

The event.

onsecuritypolicyviolation

onsecuritypolicyviolation: function | null

onseeked

onseeked: function | null

Occurs when the seek operation ends.

param

The event.

onseeking

onseeking: function | null

Occurs when the current playback position is moved.

param

The event.

onselect

onselect: function | null

Fires when the current selection changes.

param

The event.

onstalled

onstalled: function | null

Occurs when the download has stopped.

param

The event.

onsubmit

onsubmit: function | null

onsuspend

onsuspend: function | null

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

ontimeupdate: function | null

Occurs to indicate the current playback position.

param

The event.

ontoggle

ontoggle: function | null

ontouchcancel

ontouchcancel: function | null

ontouchend

ontouchend: function | null

ontouchmove

ontouchmove: function | null

ontouchstart

ontouchstart: function | null

ontransitioncancel

ontransitioncancel: function | null

ontransitionend

ontransitionend: function | null

ontransitionrun

ontransitionrun: function | null

ontransitionstart

ontransitionstart: function | null

onvolumechange

onvolumechange: function | null

Occurs when the volume is changed, or playback is muted or unmuted.

param

The event.

onwaiting

onwaiting: function | null

Occurs when playback stops because the next frame of a video resource is not available.

param

The event.

onwheel

onwheel: function | null

outerHTML

outerHTML: string

ownerDocument

ownerDocument: Document | null

Returns the node document. Returns null for documents.

parentElement

parentElement: HTMLElement | null

Returns the parent element.

parentNode

parentNode: Node & ParentNode | null

Returns the parent.

prefix

prefix: string | null

Returns the namespace prefix.

previousElementSibling

previousElementSibling: Element | null

Returns the first preceding sibling that is an element, and null otherwise.

previousSibling

previousSibling: Node | null

Returns the previous sibling.

scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

scrollWidth

scrollWidth: number

shadowRoot

shadowRoot: ShadowRoot | null

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

spellcheck

spellcheck: boolean

style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string | null

title

title: string

translate

translate: boolean

Static HTMLElement

HTMLElement: object

Type declaration

Static htmlTagName

htmlTagName: string = "igc-data-grid"

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 IgcGridCellPosition

  • 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 IgcGridAnimationSettings

  • 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 IgcColumnMovingSeparatorComponent

  • 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

  • Sets or gets the Column Property Updating Animation mode to use.

    Returns ColumnPropertyUpdatingAnimationMode

  • Sets or gets the Column Property Updating Animation mode to use.

    Parameters

    Returns void

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

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 IgcGridColumnCollection

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 IgcColumnWidth

  • 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(): IgcFilterExpressionCollection
  • 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 IgcFilterExpressionCollection

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 IgcColumnGroupDescriptionCollection

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 IgcHeaderRowSeparatorComponent

  • 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 IgcHeaderSeparatorComponent

  • 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 IgcPinnedAreaSeparatorComponent

  • 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 IgcGridSelectedItemsCollection

  • 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 IgcGridSelectedKeysCollection

  • 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 IgcResponsiveStatesCollection

  • 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 IgcRowSeparatorComponent

  • 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 IgcSectionHeaderComponent

  • 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 IgcGridSelectedCellRangesCollection

  • 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 IgcGridSelectedCellsCollection

  • 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 IgcGridSelectedItemsCollection

  • 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 IgcGridSelectedKeysCollection

  • 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 IgcColumnSortDescriptionCollection

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 IgcSummaryRowRootComponent

  • 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 IgcSummaryRowSectionComponent

  • 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

Static observedAttributes

  • get observedAttributes(): string[]
  • Returns string[]

Methods

_scrollTo

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

    • x: number
    • y: number

    Returns void

addEventListener

  • addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

after

  • after(...nodes: (string | Node)[]): void
  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

animate

  • animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation
  • Parameters

    • keyframes: Keyframe[] | PropertyIndexedKeyframes | null
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes: (string | Node)[]): void
  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • appendChild<T>(newChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T

    Returns T

attachShadow

  • attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot
  • Creates a shadow root for element and returns it.

    Parameters

    • shadowRootInitDict: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name: string, oldValue: string, newValue: string): void
  • Parameters

    • name: string
    • oldValue: string
    • newValue: string

    Returns void

before

  • before(...nodes: (string | Node)[]): void
  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

blur

  • blur(): void
  • Returns 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

click

  • click(): void
  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node
  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector: K): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest(selector: string): Element | null
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Parameters

    • selector: string

    Returns Element | null

compareDocumentPosition

  • compareDocumentPosition(other: Node): number
  • Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void
  • Returns void

contains

  • contains(other: Node | null): boolean
  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: Node | null

    Returns boolean

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

disconnectedCallback

  • disconnectedCallback(): void
  • Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

ensureBorderWidth

  • ensureBorderWidth(): void
  • Returns void

ensureCornerRadius

  • ensureCornerRadius(): void
  • Returns void

exchangeColumn

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

focus

  • focus(options?: FocusOptions): void
  • Parameters

    • Optional options: FocusOptions

    Returns void

forColumnsWithPropertyPath

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

    Returns void

getAnimations

  • getAnimations(): Animation[]
  • Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): string | null
  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

  • getAttributeNS(namespace: string | null, localName: string): string | null
  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    Parameters

    • namespace: string | null
    • localName: string

    Returns string | null

getAttributeNames

  • getAttributeNames(): string[]
  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

getAttributeNode

  • getAttributeNode(name: string): Attr | null
  • Parameters

    • name: string

    Returns Attr | null

getAttributeNodeNS

  • getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null
  • Parameters

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • getBoundingClientRect(): ClientRect | DOMRect
  • Returns ClientRect | DOMRect

getClientRects

  • getClientRects(): ClientRectList | DOMRectList
  • Returns ClientRectList | DOMRectList

getColumnAtRenderedIndex

  • 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 IgcColumnComponent

getElementsByClassName

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
  • Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
  • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getFirstVisibleIndex

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

    Returns number

getHitCell

  • Parameters

    • x: number
    • y: number

    Returns IgcCellInfo

getLastVisibleIndex

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

    Returns number

getRootNode

  • getRootNode(options?: GetRootNodeOptions): Node
  • Returns node's shadow-including root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

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[][]

hasAttribute

  • hasAttribute(qualifiedName: string): boolean
  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: string | null, localName: string): boolean
  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean
  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null
  • Parameters

    • position: InsertPosition
    • insertedElement: Element

    Returns Element | null

insertAdjacentHTML

  • insertAdjacentHTML(where: InsertPosition, html: string): void
  • Parameters

    • where: InsertPosition
    • html: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where: InsertPosition, text: string): void
  • Parameters

    • where: InsertPosition
    • text: string

    Returns void

insertBefore

  • insertBefore<T>(newChild: T, refChild: Node | null): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

invalidateVisibleRows

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

    Returns void

isDefaultNamespace

  • isDefaultNamespace(namespace: string | null): boolean
  • Parameters

    • namespace: string | null

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: Node | null): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

  • isSameNode(otherNode: Node | null): boolean
  • Parameters

    • otherNode: Node | null

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix: string | null): string | null
  • Parameters

    • prefix: string | null

    Returns string | null

lookupPrefix

  • lookupPrefix(namespace: string | null): string | null
  • Parameters

    • namespace: string | null

    Returns string | null

matches

  • matches(selectors: string): boolean
  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

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

msGetRegionContent

  • msGetRegionContent(): any
  • Returns any

normalize

  • normalize(): void
  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    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

prepend

  • prepend(...nodes: (string | Node)[]): void
  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

querySelector

  • querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>
  • Returns all element descendants of node that match selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

refresh

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

    Returns void

releasePointerCapture

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void
  • Removes node.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void
  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace: string | null, localName: string): void
  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr
  • Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • oldChild: T

    Returns T

removeEventListener

  • removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

replaceChild

  • replaceChild<T>(newChild: Node, oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • replaceWith(...nodes: (string | Node)[]): void
  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

requestFullscreen

  • requestFullscreen(): Promise<void>
  • Displays element fullscreen and resolves promise when done.

    Returns Promise<void>

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

scroll

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns 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

setAttribute

  • setAttribute(qualifiedName: string, value: string): void
  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: string | null
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setPointerCapture

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean
  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean
  • Parameters

    • selectors: string

    Returns boolean

Static register

  • register(): void
  • Returns void