Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcDataGridComponent

Hierarchy

Hierarchy

  • cons
    • IgcDataGridComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

Set when node and other are not in the same tree.

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: string

ariaAutoComplete

ariaAutoComplete: string

ariaBusy

ariaBusy: string

ariaChecked

ariaChecked: string

ariaColCount

ariaColCount: string

ariaColIndex

ariaColIndex: string

ariaColIndexText

ariaColIndexText: string

ariaColSpan

ariaColSpan: string

ariaCurrent

ariaCurrent: string

ariaDisabled

ariaDisabled: string

ariaExpanded

ariaExpanded: string

ariaHasPopup

ariaHasPopup: string

ariaHidden

ariaHidden: string

ariaInvalid

ariaInvalid: string

ariaKeyShortcuts

ariaKeyShortcuts: string

ariaLabel

ariaLabel: string

ariaLevel

ariaLevel: string

ariaLive

ariaLive: string

ariaModal

ariaModal: string

ariaMultiLine

ariaMultiLine: string

ariaMultiSelectable

ariaMultiSelectable: string

ariaOrientation

ariaOrientation: string

ariaPlaceholder

ariaPlaceholder: string

ariaPosInSet

ariaPosInSet: string

ariaPressed

ariaPressed: string

ariaReadOnly

ariaReadOnly: string

ariaRequired

ariaRequired: string

ariaRoleDescription

ariaRoleDescription: string

ariaRowCount

ariaRowCount: string

ariaRowIndex

ariaRowIndex: string

ariaRowIndexText

ariaRowIndexText: string

ariaRowSpan

ariaRowSpan: string

ariaSelected

ariaSelected: string

ariaSetSize

ariaSetSize: string

ariaSort

ariaSort: string

ariaValueMax

ariaValueMax: string

ariaValueMin

ariaValueMin: string

ariaValueNow

ariaValueNow: string

ariaValueText

ariaValueText: string

Readonly assignedSlot

assignedSlot: HTMLSlotElement

Readonly attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

Readonly baseURI

baseURI: string

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

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly 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.

Readonly clientHeight

clientHeight: number

Readonly clientLeft

clientLeft: number

Readonly clientTop

clientTop: number

Readonly clientWidth

clientWidth: number

combinedColumns

combinedColumns: IgcDataGridColumnComponent[]

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

contentColumns

contentColumns: IgcDataGridColumnComponent[]

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

Readonly firstChild

firstChild: ChildNode

Returns the first child.

Readonly firstElementChild

firstElementChild: Element

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.

inert

inert: boolean

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly isContentEditable

isContentEditable: boolean

lang

lang: string

Readonly lastChild

lastChild: ChildNode

Returns the last child.

Readonly lastElementChild

lastElementChild: Element

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

Readonly localName

localName: string

Returns the local name.

Readonly namespaceURI

namespaceURI: string

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: Element

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

Readonly nextSibling

nextSibling: ChildNode

Returns the next sibling.

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

Readonly nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: string

Optional nonce

nonce?: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: Element

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

onabort: ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

        The event.

      Returns any

onanimationcancel

onanimationcancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend

onanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration

onanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart

onanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick

onauxclick: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput

onbeforeinput: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onblur

onblur: ((this, ev) => any)

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

      Returns any

oncancel

oncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay

oncanplay: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

oncanplaythrough

oncanplaythrough: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange

onchange: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onclick

onclick: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onclose

onclose: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu

oncontextmenu: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

oncopy

oncopy: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange

oncuechange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut

oncut: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick

ondblclick: ((this, ev) => any)

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

ondrag

ondrag: ((this, ev) => any)

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragend

ondragend: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragenter

ondragenter: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragleave

ondragleave: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragover

ondragover: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragstart

ondragstart: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondrop

ondrop: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange

ondurationchange: ((this, ev) => any)

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onemptied

onemptied: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onended

onended: ((this, ev) => any)

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event

      Returns any

onerror

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

onfocus

onfocus: ((this, ev) => any)

Fires when the object receives focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

      Returns any

onformdata

onformdata: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

onfullscreenchange

onfullscreenchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror

onfullscreenerror: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

ongotpointercapture

ongotpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput

oninput: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid

oninvalid: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown

onkeydown: ((this, ev) => any)

Fires when the user presses a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onkeypress

onkeypress: ((this, ev) => any)

Fires when the user presses an alphanumeric key.

Deprecated

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

onkeyup

onkeyup: ((this, ev) => any)

Fires when the user releases a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onload

onload: ((this, ev) => any)

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadeddata

onloadeddata: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadedmetadata

onloadedmetadata: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadstart

onloadstart: ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onlostpointercapture

onlostpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown

onmousedown: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseenter

onmouseenter: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave

onmouseleave: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove

onmousemove: ((this, ev) => any)

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseout

onmouseout: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseover

onmouseover: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseup

onmouseup: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onpaste

onpaste: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause

onpause: ((this, ev) => any)

Occurs when playback is paused.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplay

onplay: ((this, ev) => any)

Occurs when the play method is requested.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplaying

onplaying: ((this, ev) => any)

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onpointercancel

onpointercancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown

onpointerdown: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter

onpointerenter: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave

onpointerleave: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove

onpointermove: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout

onpointerout: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover

onpointerover: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup

onpointerup: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress

onprogress: ((this, ev) => any)

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

      Returns any

onratechange

onratechange: ((this, ev) => any)

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onreset

onreset: ((this, ev) => any)

Fires when the user resets a form.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onresize

onresize: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll

onscroll: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsecuritypolicyviolation

onsecuritypolicyviolation: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked

onseeked: ((this, ev) => any)

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onseeking

onseeking: ((this, ev) => any)

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselect

onselect: ((this, ev) => any)

Fires when the current selection changes.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselectionchange

onselectionchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart

onselectstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange

onslotchange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled

onstalled: ((this, ev) => any)

Occurs when the download has stopped.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsubmit

onsubmit: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend

onsuspend: ((this, ev) => any)

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontimeupdate

ontimeupdate: ((this, ev) => any)

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontoggle

ontoggle: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Optional ontouchcancel

ontouchcancel?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchend

ontouchend?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchmove

ontouchmove?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchstart

ontouchstart?: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel

ontransitioncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend

ontransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun

ontransitionrun: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart

ontransitionstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange

onvolumechange: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwaiting

onwaiting: ((this, ev) => any)

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwebkitanimationend

onwebkitanimationend: ((this, ev) => any)

Deprecated

This is a legacy alias of onanimationend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationiteration

onwebkitanimationiteration: ((this, ev) => any)

Deprecated

This is a legacy alias of onanimationiteration.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationstart

onwebkitanimationstart: ((this, ev) => any)

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkittransitionend

onwebkittransitionend: ((this, ev) => any)

Deprecated

This is a legacy alias of ontransitionend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwheel

onwheel: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML

outerHTML: string

outerText

outerText: string

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: ParentNode

Returns the parent.

Readonly part

part: DOMTokenList

Readonly prefix

prefix: string

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: Element

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

Readonly previousSibling

previousSibling: ChildNode

Returns the previous sibling.

role

role: string

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: ShadowRoot

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

Readonly style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string

title

title: string

translate

translate: boolean

Static htmlTagName

htmlTagName: string

Accessors

activationMode

  • get activationMode(): GridActivationMode

  • Sets or gets the grid selection mode.

    Returns GridActivationMode

  • set activationMode(v): void

  • Parameters

    Returns void

activeCell

  • get activeCell(): IgcGridCellPosition

  • Gets or sets the position of the active cell.

    Returns IgcGridCellPosition

  • set activeCell(v): void

  • Parameters

    Returns void

activeCellChanged

actualBorderWidth

  • get actualBorderWidth(): Thickness

  • Gets the actual border width.

    Returns Thickness

  • set actualBorderWidth(v): void

  • Parameters

    • v: Thickness

    Returns void

actualColumns

actualColumnsChanged

actualCornerRadiusBottomLeft

  • get actualCornerRadiusBottomLeft(): number

  • Returns number

  • set actualCornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusBottomRight

  • get actualCornerRadiusBottomRight(): number

  • Returns number

  • set actualCornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusTopLeft

  • get actualCornerRadiusTopLeft(): number

  • Returns number

  • set actualCornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

actualCornerRadiusTopRight

  • get actualCornerRadiusTopRight(): number

  • Returns number

  • set actualCornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

actualDataSource

  • get actualDataSource(): IDataSource

  • Returns IDataSource

actualHeaderHeight

  • get actualHeaderHeight(): number

  • Gets the height used for the header row.

    Returns number

  • set actualHeaderHeight(v): void

  • Parameters

    • v: number

    Returns void

actualPrimaryKey

  • get actualPrimaryKey(): 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.

    Returns string[]

  • set actualPrimaryKey(v): void

  • Parameters

    • v: string[]

    Returns void

actualPrimaryKeyChange

  • get actualPrimaryKeyChange(): ((s, e) => void)

  • Returns ((s, e) => void)

  • set actualPrimaryKeyChange(ev): void

  • Parameters

    Returns void

actualRowHeight

  • get actualRowHeight(): number

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

    Returns number

  • set actualRowHeight(v): void

  • Parameters

    • v: number

    Returns void

actualVisibleRegion

  • get actualVisibleRegion(): IgRect

  • Gets the region of the grid that is visible.

    Returns IgRect

allowCopyOperation

  • get allowCopyOperation(): boolean

  • Returns boolean

  • set allowCopyOperation(v): void

  • Parameters

    • v: boolean

    Returns void

animationSettings

  • get animationSettings(): IgcGridAnimationSettings

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

    Returns IgcGridAnimationSettings

  • set animationSettings(v): void

  • Parameters

    Returns void

autoAcceptEdits

  • get autoAcceptEdits(): boolean

  • Gets or sets whether to automatically accept edits or require explicit acceptance or rejections of edits when handling the CellValueChanging or DataCommitting events. When True, nothing is required on the part of the developer in order for edits to be accepted. In order to validate and reject a user cell edit you must explicitly handle the CellValueChanging event and call the RejectEdit method using the edit ID provided by the event. In order to reject a whole commit you need to handle the DataComitting event and explicitly call the RejectCommit method using the commit ID provided by the event. When False, cell edits are not immediately accepted until you explicitly call the AcceptEdit method using the edit ID provided by the CellValueChanging event. If you do not handle this event then edits will be auto accepted.

    Returns boolean

  • set autoAcceptEdits(v): void

  • Parameters

    • v: boolean

    Returns void

autoGenerateColumns

  • get autoGenerateColumns(): boolean

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

    Returns boolean

  • set autoGenerateColumns(v): void

  • Parameters

    • v: boolean

    Returns void

autoGenerateDesiredProperties

  • get autoGenerateDesiredProperties(): string[]

  • Gets or sets the desired properties the grid will automatically generate columns for.

    Returns string[]

  • set autoGenerateDesiredProperties(v): void

  • Parameters

    • v: string[]

    Returns void

border

  • get border(): string

  • Gets or sets the border color around the grid.

    Returns string

  • set border(v): void

  • Parameters

    • v: string

    Returns void

borderWidthBottom

  • get borderWidthBottom(): number

  • Returns number

  • set borderWidthBottom(v): void

  • Parameters

    • v: number

    Returns void

borderWidthLeft

  • get borderWidthLeft(): number

  • Returns number

  • set borderWidthLeft(v): void

  • Parameters

    • v: number

    Returns void

borderWidthRight

  • get borderWidthRight(): number

  • Returns number

  • set borderWidthRight(v): void

  • Parameters

    • v: number

    Returns void

borderWidthTop

  • get borderWidthTop(): number

  • Returns number

  • set borderWidthTop(v): void

  • Parameters

    • v: number

    Returns void

canCommit

  • get canCommit(): boolean

  • Gets whether a commit can be performed. False if there are any errors present on any pending transactions.

    Returns boolean

canRedo

  • get canRedo(): boolean

  • Gets whether a redo can be performed.

    Returns boolean

canUndo

  • get canUndo(): boolean

  • Gets whether an undo can be performed.

    Returns boolean

cellBackground

  • get cellBackground(): string

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

    Returns string

  • set cellBackground(v): void

  • Parameters

    • v: string

    Returns void

cellClicked

  • get cellClicked(): ((s, e) => void)

  • Called when a cell is clicked.

    Returns ((s, e) => void)

  • set cellClicked(ev): void

  • Parameters

    Returns void

cellDataLoadedAnimationMode

  • get cellDataLoadedAnimationMode(): CellDataLoadedAnimationMode

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

    Returns CellDataLoadedAnimationMode

  • set cellDataLoadedAnimationMode(v): void

  • Parameters

    Returns void

cellEditEnded

  • get cellEditEnded(): ((s, e) => void)

  • Called when a cell has finished editing.

    Returns ((s, e) => void)

  • set cellEditEnded(ev): void

  • Parameters

    Returns void

cellEditStarted

  • get cellEditStarted(): ((s, e) => void)

  • Called when a cell has started editing.

    Returns ((s, e) => void)

  • set cellEditStarted(ev): void

  • Parameters

    Returns void

cellPointerDown

  • get cellPointerDown(): ((s, e) => void)

  • Indicates a pointer is down on a cell.

    Returns ((s, e) => void)

  • set cellPointerDown(ev): void

  • Parameters

    Returns void

cellPointerUp

  • get cellPointerUp(): ((s, e) => void)

  • Indicates a pointer is up on a cell.

    Returns ((s, e) => void)

  • set cellPointerUp(ev): void

  • Parameters

    Returns void

cellPreviewPointerDown

  • get cellPreviewPointerDown(): ((s, e) => void)

  • Previews that a pointer is down on a cell.

    Returns ((s, e) => void)

  • set cellPreviewPointerDown(ev): void

  • Parameters

    Returns void

cellPreviewPointerUp

  • get cellPreviewPointerUp(): ((s, e) => void)

  • Previews that a pointer is up on a cell.

    Returns ((s, e) => void)

  • set cellPreviewPointerUp(ev): void

  • Parameters

    Returns void

cellSelectedBackground

  • get cellSelectedBackground(): string

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

    Returns string

  • set cellSelectedBackground(v): void

  • Parameters

    • v: string

    Returns void

cellSelectionAnimationMode

  • get cellSelectionAnimationMode(): CellSelectionAnimationMode

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

    Returns CellSelectionAnimationMode

  • set cellSelectionAnimationMode(v): void

  • Parameters

    Returns void

cellTextColor

  • get cellTextColor(): string

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

    Returns string

  • set cellTextColor(v): void

  • Parameters

    • v: string

    Returns void

cellTextStyle

  • get cellTextStyle(): string

  • Gets or sets the font to use for content cells

    Returns string

  • set cellTextStyle(v): void

  • Parameters

    • v: string

    Returns void

cellValueChanging

clearSelectionOnEscape

  • get clearSelectionOnEscape(): boolean

  • Gets or sets whether selection is cleared when pressing the Escape key.

    Returns boolean

  • set clearSelectionOnEscape(v): void

  • Parameters

    • v: boolean

    Returns void

columnAddingAnimationMode

  • get columnAddingAnimationMode(): ColumnShowingAnimationMode

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

    Returns ColumnShowingAnimationMode

  • set columnAddingAnimationMode(v): void

  • Parameters

    Returns void

columnExchangingAnimationMode

columnHiddenChanged

  • get columnHiddenChanged(): ((s, e) => void)

  • Called when a column is hidden or unhidden.

    Returns ((s, e) => void)

  • set columnHiddenChanged(ev): void

  • Parameters

    Returns void

columnHidingAnimationMode

  • get columnHidingAnimationMode(): ColumnHidingAnimationMode

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

    Returns ColumnHidingAnimationMode

  • set columnHidingAnimationMode(v): void

  • Parameters

    Returns void

columnMovingAnimationMode

  • get columnMovingAnimationMode(): ColumnMovingAnimationMode

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

    Returns ColumnMovingAnimationMode

  • set columnMovingAnimationMode(v): void

  • Parameters

    Returns void

columnMovingMode

  • get columnMovingMode(): ColumnMovingMode

  • Gets or sets the type column moving to use.

    Returns ColumnMovingMode

  • set columnMovingMode(v): void

  • Parameters

    Returns void

columnMovingSeparator

columnMovingSeparatorBackground

  • get columnMovingSeparatorBackground(): string

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

    Returns string

  • set columnMovingSeparatorBackground(v): void

  • Parameters

    • v: string

    Returns void

columnMovingSeparatorOpacity

  • get columnMovingSeparatorOpacity(): number

  • Gets or sets the opacity of the column moving separator.

    Returns number

  • set columnMovingSeparatorOpacity(v): void

  • Parameters

    • v: number

    Returns void

columnMovingSeparatorWidth

  • get columnMovingSeparatorWidth(): number

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

    Returns number

  • set columnMovingSeparatorWidth(v): void

  • Parameters

    • v: number

    Returns void

columnOptionsIconAlignment

  • get columnOptionsIconAlignment(): ColumnOptionsIconAlignment

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

    Returns ColumnOptionsIconAlignment

  • set columnOptionsIconAlignment(v): void

  • Parameters

    Returns void

columnOptionsIconBehavior

  • get columnOptionsIconBehavior(): ColumnOptionsIconBehavior

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

    Returns ColumnOptionsIconBehavior

  • set columnOptionsIconBehavior(v): void

  • Parameters

    Returns void

columnOptionsIconColor

  • get columnOptionsIconColor(): string

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

    Returns string

  • set columnOptionsIconColor(v): void

  • Parameters

    • v: string

    Returns void

columnPinnedChanged

  • get columnPinnedChanged(): ((s, e) => void)

  • Called when a column is pinned or unpinned.

    Returns ((s, e) => void)

  • set columnPinnedChanged(ev): void

  • Parameters

    Returns void

columnPropertyUpdatingAnimationMode

columnResizingAnimationMode

  • get columnResizingAnimationMode(): ColumnResizingAnimationMode

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

    Returns ColumnResizingAnimationMode

  • set columnResizingAnimationMode(v): void

  • Parameters

    Returns void

columnResizingMode

  • get columnResizingMode(): ColumnResizingMode

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

    Returns ColumnResizingMode

  • set columnResizingMode(v): void

  • Parameters

    Returns void

columnResizingSeparator

columnResizingSeparatorBackground

  • get columnResizingSeparatorBackground(): string

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

    Returns string

  • set columnResizingSeparatorBackground(v): void

  • Parameters

    • v: string

    Returns void

columnResizingSeparatorOpacity

  • get columnResizingSeparatorOpacity(): number

  • Gets or sets the opacity of the column Resizing separator.

    Returns number

  • set columnResizingSeparatorOpacity(v): void

  • Parameters

    • v: number

    Returns void

columnResizingSeparatorWidth

  • get columnResizingSeparatorWidth(): number

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

    Returns number

  • set columnResizingSeparatorWidth(v): void

  • Parameters

    • v: number

    Returns void

columnShowingAnimationMode

  • get columnShowingAnimationMode(): ColumnShowingAnimationMode

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

    Returns ColumnShowingAnimationMode

  • set columnShowingAnimationMode(v): void

  • Parameters

    Returns void

columnWidthChanged

  • get columnWidthChanged(): ((s, e) => void)

  • Called when a column's Width property has changed.

    Returns ((s, e) => void)

  • set columnWidthChanged(ev): void

  • Parameters

    Returns void

columns

columnsAutoGenerated

cornerRadiusBottomLeft

  • get cornerRadiusBottomLeft(): number

  • Returns number

  • set cornerRadiusBottomLeft(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusBottomRight

  • get cornerRadiusBottomRight(): number

  • Returns number

  • set cornerRadiusBottomRight(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusTopLeft

  • get cornerRadiusTopLeft(): number

  • Returns number

  • set cornerRadiusTopLeft(v): void

  • Parameters

    • v: number

    Returns void

cornerRadiusTopRight

  • get cornerRadiusTopRight(): number

  • Returns number

  • set cornerRadiusTopRight(v): void

  • Parameters

    • v: number

    Returns void

customFilterRequested

dataCommitted

  • get dataCommitted(): ((s, e) => void)

  • Called when edits have been committed to the datasource.

    Returns ((s, e) => void)

  • set dataCommitted(ev): void

  • Parameters

    Returns void

dataCommitting

  • get dataCommitting(): ((s, e) => void)

  • Called when edits are about to be committed to the datasource.

    Returns ((s, e) => void)

  • set dataCommitting(ev): void

  • Parameters

    Returns void

dataSource

  • get dataSource(): any

  • Returns any

  • set dataSource(value): void

  • Parameters

    • value: any

    Returns void

dataSourceDesiredProperties

  • get dataSourceDesiredProperties(): 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.

    Returns string[]

  • set dataSourceDesiredProperties(v): void

  • Parameters

    • v: string[]

    Returns void

defaultColumnMinWidth

  • get defaultColumnMinWidth(): number

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

    Returns number

  • set defaultColumnMinWidth(v): void

  • Parameters

    • v: number

    Returns void

defaultColumnWidth

  • get defaultColumnWidth(): IgcColumnWidth

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

    Returns IgcColumnWidth

  • set defaultColumnWidth(value): void

  • Parameters

    Returns void

deferEventForRowDragSelection

  • get deferEventForRowDragSelection(): boolean

  • Gets or sets whether to defer the SelectedItemsChanged and SelectedKeysChanged events till after the drag selection has completed.

    Returns boolean

  • set deferEventForRowDragSelection(v): void

  • Parameters

    • v: boolean

    Returns void

deletedTextColor

  • get deletedTextColor(): string

  • Gets or sets the text color for unsaved deleted rows.

    Returns string

  • set deletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

density

  • get density(): ControlDisplayDensity

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

    Returns ControlDisplayDensity

  • set density(v): void

  • Parameters

    • v: ControlDisplayDensity

    Returns void

editMode

  • get editMode(): EditModeType

  • Gets or sets the type of edit mode

    Returns EditModeType

  • set editMode(v): void

  • Parameters

    Returns void

editModeClickAction

  • get editModeClickAction(): EditModeClickAction

  • Gets or sets the type of click action required to enter edit mode.

    Returns EditModeClickAction

  • set editModeClickAction(v): void

  • Parameters

    Returns void

editOnKeyPress

  • get editOnKeyPress(): boolean

  • Gets or sets whether edit mode will begin as soon as you start typing while a cell is active.

    Returns boolean

  • set editOnKeyPress(v): void

  • Parameters

    • v: boolean

    Returns void

editOpacity

  • get editOpacity(): number

  • Gets or sets the default opacity for unsaved cell edits.

    Returns number

  • set editOpacity(v): void

  • Parameters

    • v: number

    Returns void

editRowBorder

  • get editRowBorder(): string

  • Gets or sets the border color for rows being edited.

    Returns string

  • set editRowBorder(v): void

  • Parameters

    • v: string

    Returns void

editRowBorderWidthBottom

  • get editRowBorderWidthBottom(): number

  • Returns number

  • set editRowBorderWidthBottom(v): void

  • Parameters

    • v: number

    Returns void

editRowBorderWidthLeft

  • get editRowBorderWidthLeft(): number

  • Returns number

  • set editRowBorderWidthLeft(v): void

  • Parameters

    • v: number

    Returns void

editRowBorderWidthRight

  • get editRowBorderWidthRight(): number

  • Returns number

  • set editRowBorderWidthRight(v): void

  • Parameters

    • v: number

    Returns void

editRowBorderWidthTop

  • get editRowBorderWidthTop(): number

  • Returns number

  • set editRowBorderWidthTop(v): void

  • Parameters

    • v: number

    Returns void

editTextStyle

  • get editTextStyle(): string

  • Gets or sets the font to use for cells that have been edited.

    Returns string

  • set editTextStyle(v): void

  • Parameters

    • v: string

    Returns void

enterBehavior

  • get enterBehavior(): EnterKeyBehaviors

  • Gets or sets the behavior of the Enter key.

    Returns EnterKeyBehaviors

  • set enterBehavior(v): void

  • Parameters

    Returns void

enterBehaviorAfterEdit

  • get enterBehaviorAfterEdit(): EnterKeyBehaviorAfterEdit

  • Gets or sets the behavior of the enter key when exiting edit mode.

    Returns EnterKeyBehaviorAfterEdit

  • set enterBehaviorAfterEdit(v): void

  • Parameters

    Returns void

filterComparisonType

  • get filterComparisonType(): FilterComparisonType

  • Gets or sets whether UI filters are case sensitive or not.

    Returns FilterComparisonType

  • set filterComparisonType(v): void

  • Parameters

    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

filterExpressionsChanging

filterLogicalOperator

  • get filterLogicalOperator(): FilterLogicalOperator

  • Gets or sets how filters set through the filter UI are combined.

    Returns FilterLogicalOperator

  • set filterLogicalOperator(v): void

  • Parameters

    Returns void

filterUIType

  • get filterUIType(): FilterUIType

  • Gets or sets which filter UI type to use.

    Returns FilterUIType

  • set filterUIType(v): void

  • Parameters

    Returns void

groupDescriptions

  • get groupDescriptions(): IgcColumnGroupDescriptionCollection

  • 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

groupHeaderDisplayMode

  • get groupHeaderDisplayMode(): GroupHeaderDisplayMode

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

    Returns GroupHeaderDisplayMode

  • set groupHeaderDisplayMode(v): void

  • Parameters

    Returns void

groupSummaryDisplayMode

  • get groupSummaryDisplayMode(): GroupSummaryDisplayMode

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

    Returns GroupSummaryDisplayMode

  • set groupSummaryDisplayMode(v): void

  • Parameters

    Returns void

headerBackground

  • get headerBackground(): string

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

    Returns string

  • set headerBackground(v): void

  • Parameters

    • v: string

    Returns void

headerClickAction

  • get headerClickAction(): HeaderClickAction

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

    Returns HeaderClickAction

  • set headerClickAction(v): void

  • Parameters

    Returns void

headerHeight

  • get headerHeight(): number

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

    Returns number

  • set headerHeight(v): void

  • Parameters

    • v: number

    Returns void

headerRowSeparator

headerRowSeparatorBackground

  • get headerRowSeparatorBackground(): string

  • Returns string

  • set headerRowSeparatorBackground(v): void

  • Parameters

    • v: string

    Returns void

headerSeparator

headerSeparatorBackground

  • get headerSeparatorBackground(): string

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

    Returns string

  • set headerSeparatorBackground(v): void

  • Parameters

    • v: string

    Returns void

headerSeparatorWidth

  • get headerSeparatorWidth(): number

  • Gets or sets the width of the header separators.

    Returns number

  • set headerSeparatorWidth(v): void

  • Parameters

    • v: number

    Returns void

headerSortIndicatorColor

  • get headerSortIndicatorColor(): string

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

    Returns string

  • set headerSortIndicatorColor(v): void

  • Parameters

    • v: string

    Returns void

headerSortIndicatorStyle

  • get headerSortIndicatorStyle(): SortIndicatorStyle

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

    Returns SortIndicatorStyle

  • set headerSortIndicatorStyle(v): void

  • Parameters

    Returns void

headerTextColor

  • get headerTextColor(): string

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

    Returns string

  • set headerTextColor(v): void

  • Parameters

    • v: string

    Returns void

headerTextStyle

  • get headerTextStyle(): string

  • Gets or sets the font to use for header cells

    Returns string

  • set headerTextStyle(v): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value): void

  • Parameters

    • value: string

    Returns void

i

  • get i(): DataGrid

  • Returns DataGrid

initialGroupDescriptions

  • get initialGroupDescriptions(): IgcColumnGroupDescriptionCollection

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

initialGroups

  • get initialGroups(): string

  • Returns string

  • set initialGroups(v): void

  • Parameters

    • v: string

    Returns void

initialSortDescriptions

  • get initialSortDescriptions(): IgcColumnSortDescriptionCollection

  • 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

initialSorts

  • get initialSorts(): string

  • Returns string

  • set initialSorts(v): void

  • Parameters

    • v: string

    Returns void

initialSummaries

  • get initialSummaries(): string

  • Returns string

  • set initialSummaries(v): void

  • Parameters

    • v: string

    Returns void

initialSummaryDescriptions

insetBottom

  • get insetBottom(): number

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

    Returns number

  • set insetBottom(v): void

  • Parameters

    • v: number

    Returns void

insetLeft

  • get insetLeft(): number

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

    Returns number

  • set insetLeft(v): void

  • Parameters

    • v: number

    Returns void

insetRight

  • get insetRight(): number

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

    Returns number

  • set insetRight(v): void

  • Parameters

    • v: number

    Returns void

insetTop

  • get insetTop(): number

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

    Returns number

  • set insetTop(v): void

  • Parameters

    • v: number

    Returns void

isActiveCellStyleEnabled

  • get isActiveCellStyleEnabled(): boolean

  • Gets or sets whether the active cell style will be applied to cells when made active.

    Returns boolean

  • set isActiveCellStyleEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isColumnOptionsEnabled

  • get isColumnOptionsEnabled(): boolean

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

    Returns boolean

  • set isColumnOptionsEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isColumnOptionsGroupingEnabled

  • get isColumnOptionsGroupingEnabled(): boolean

  • Gets or sets whether to show the grouping option in the column options menu.

    Returns boolean

  • set isColumnOptionsGroupingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isColumnOptionsSummariesEnabled

  • get isColumnOptionsSummariesEnabled(): boolean

  • Gets or sets whether to show the summaries option in the column options menu.

    Returns boolean

  • set isColumnOptionsSummariesEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isGroupByAreaVisible

  • get isGroupByAreaVisible(): boolean

  • Gets or sets if the Column Grouping Area should be shown and enabled

    Returns boolean

  • set isGroupByAreaVisible(value): void

  • Parameters

    • value: boolean

    Returns void

isGroupCollapsable

  • get isGroupCollapsable(): boolean

  • Gets or sets whether group headers are collapsable.

    Returns boolean

  • set isGroupCollapsable(v): void

  • Parameters

    • v: boolean

    Returns void

isGroupExpandedDefault

  • get isGroupExpandedDefault(): boolean

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

    Returns boolean

  • set isGroupExpandedDefault(v): void

  • Parameters

    • v: boolean

    Returns void

isGroupRowSticky

  • get isGroupRowSticky(): boolean

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

    Returns boolean

  • set isGroupRowSticky(v): void

  • Parameters

    • v: boolean

    Returns void

isHeaderSeparatorVisible

  • get isHeaderSeparatorVisible(): boolean

  • Gets or sets if header separators are rendered.

    Returns boolean

  • set isHeaderSeparatorVisible(v): void

  • Parameters

    • v: boolean

    Returns void

isPagerVisible

  • get isPagerVisible(): string | boolean

  • Gets or sets whether to show the pager or not.

    Returns string | boolean

  • set isPagerVisible(value): void

  • Parameters

    • value: string | boolean

    Returns void

isPlaceholderRenderingEnabled

  • get isPlaceholderRenderingEnabled(): boolean

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

    Returns boolean

  • set isPlaceholderRenderingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isRowHoverEnabled

  • get isRowHoverEnabled(): boolean

  • Gets or sets whether the row will highlight when hovered.

    Returns boolean

  • set isRowHoverEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isToolbarColumnChooserVisible

  • get isToolbarColumnChooserVisible(): boolean

  • Gets or sets whether to show the column chooser button in the toolbar.

    Returns boolean

  • set isToolbarColumnChooserVisible(v): void

  • Parameters

    • v: boolean

    Returns void

isToolbarColumnPinningVisible

  • get isToolbarColumnPinningVisible(): boolean

  • Gets or sets whether to show the column pinning button in the toolbar.

    Returns boolean

  • set isToolbarColumnPinningVisible(v): void

  • Parameters

    • v: boolean

    Returns void

isToolbarVisible

  • get isToolbarVisible(): string | boolean

  • Gets or sets whether to show the toolbar.

    Returns string | boolean

  • set isToolbarVisible(value): void

  • Parameters

    • value: string | boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string

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

    Returns string

  • set lastStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

mergedCellEvaluationCriteria

mergedCellMode

  • get mergedCellMode(): MergedCellMode

  • Gets or sets if and how cell merging is performed for all fields.

    Returns MergedCellMode

  • set mergedCellMode(v): void

  • Parameters

    Returns void

mergedCellVerticalAlignment

  • get mergedCellVerticalAlignment(): CellContentVerticalAlignment

  • Gets or sets the vertical alignment to use for the merged cell content.

    Returns CellContentVerticalAlignment

  • set mergedCellVerticalAlignment(v): void

  • Parameters

    Returns void

mouseDragSelectionEnabled

  • get mouseDragSelectionEnabled(): boolean

  • Gets or sets the ability to select rows or cells via mouse dragging. Currently only applies when SelectionMode is MultipleRow or RangeCell.

    Returns boolean

  • set mouseDragSelectionEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

notifyOnAllSelectionChanges

  • get notifyOnAllSelectionChanges(): boolean

  • Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.

    Returns boolean

  • set notifyOnAllSelectionChanges(v): void

  • Parameters

    • v: boolean

    Returns void

pageSize

  • get pageSize(): number

  • Gets or sets the size of each page when the pager is visible.

    Returns number

  • set pageSize(v): void

  • Parameters

    • v: number

    Returns void

pinnedAreaSeparator

pinnedAreaSeparatorWidth

  • get pinnedAreaSeparatorWidth(): number

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

    Returns number

  • set pinnedAreaSeparatorWidth(v): void

  • Parameters

    • v: number

    Returns void

pinnedItems

pinnedKeys

  • get pinnedKeys(): IgcGridSelectedKeysCollection

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

    Returns IgcGridSelectedKeysCollection

  • set pinnedKeys(v): void

  • Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string

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

    Returns string

  • set pinnedRowBackground(v): void

  • Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number

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

    Returns number

  • set pinnedRowOpacity(v): void

  • Parameters

    • v: number

    Returns void

primaryKey

  • get primaryKey(): 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.

    Returns string[]

  • set primaryKey(v): void

  • Parameters

    • v: string[]

    Returns void

reactsToFilterChanges

  • get reactsToFilterChanges(): boolean

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

    Returns boolean

  • set reactsToFilterChanges(v): void

  • Parameters

    • v: boolean

    Returns void

reactsToGroupChanges

  • get reactsToGroupChanges(): boolean

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

    Returns boolean

  • set reactsToGroupChanges(v): void

  • Parameters

    • v: boolean

    Returns void

reactsToSortChanges

  • get reactsToSortChanges(): boolean

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

    Returns boolean

  • set reactsToSortChanges(v): void

  • Parameters

    • v: boolean

    Returns void

responsiveStates

rowEditEnded

  • get rowEditEnded(): ((s, e) => void)

  • Called when a row has finished editing.

    Returns ((s, e) => void)

  • set rowEditEnded(ev): void

  • Parameters

    Returns void

rowEditStarted

  • get rowEditStarted(): ((s, e) => void)

  • Called when a row has started editing.

    Returns ((s, e) => void)

  • set rowEditStarted(ev): void

  • Parameters

    Returns void

rowHeight

  • get rowHeight(): 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.

    Returns number

  • set rowHeight(v): void

  • Parameters

    • v: number

    Returns void

rowHoverAnimationMode

  • get rowHoverAnimationMode(): RowHoverAnimationMode

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

    Returns RowHoverAnimationMode

  • set rowHoverAnimationMode(v): void

  • Parameters

    Returns void

rowHoverBackground

  • get rowHoverBackground(): string

  • Gets or sets the background color for rows when hovered.

    Returns string

  • set rowHoverBackground(v): void

  • Parameters

    • v: string

    Returns void

rowHoverTextColor

  • get rowHoverTextColor(): string

  • Gets or sets the text color for rows when hovered.

    Returns string

  • set rowHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

rowSelectionAnimationMode

  • get rowSelectionAnimationMode(): RowSelectionAnimationMode

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

    Returns RowSelectionAnimationMode

  • set rowSelectionAnimationMode(v): void

  • Parameters

    Returns void

rowSeparator

rowSeparatorBackground

  • get rowSeparatorBackground(): string

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

    Returns string

  • set rowSeparatorBackground(v): void

  • Parameters

    • v: string

    Returns void

rowSeparatorHeight

  • get rowSeparatorHeight(): number

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

    Returns number

  • set rowSeparatorHeight(v): void

  • Parameters

    • v: number

    Returns void

rowSeparatorLastStickyRowBackground

  • get rowSeparatorLastStickyRowBackground(): string

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

    Returns string

  • set rowSeparatorLastStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

rowSeparatorPinnedRowBackground

  • get rowSeparatorPinnedRowBackground(): string

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

    Returns string

  • set rowSeparatorPinnedRowBackground(v): void

  • Parameters

    • v: string

    Returns void

rowSeparatorStickyRowBackground

  • get rowSeparatorStickyRowBackground(): string

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

    Returns string

  • set rowSeparatorStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

scrollbarBackground

  • get scrollbarBackground(): string

  • Gets or sets the scrollbar background color.

    Returns string

  • set scrollbarBackground(v): void

  • Parameters

    • v: string

    Returns void

scrollbarStyle

  • get scrollbarStyle(): ScrollbarStyle

  • Gets or sets the style of scrollbar.

    Returns ScrollbarStyle

  • set scrollbarStyle(v): void

  • Parameters

    • v: ScrollbarStyle

    Returns void

sectionHeader

  • get sectionHeader(): IgcSectionHeaderComponent

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

    Returns IgcSectionHeaderComponent

  • set sectionHeader(v): void

  • Parameters

    Returns void

sectionHeaderBackground

  • get sectionHeaderBackground(): string

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

    Returns string

  • set sectionHeaderBackground(v): void

  • Parameters

    • v: string

    Returns void

sectionHeaderSelectedBackground

  • get sectionHeaderSelectedBackground(): string

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

    Returns string

  • set sectionHeaderSelectedBackground(v): void

  • Parameters

    • v: string

    Returns void

sectionHeaderTextColor

  • get sectionHeaderTextColor(): string

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

    Returns string

  • set sectionHeaderTextColor(v): void

  • Parameters

    • v: string

    Returns void

sectionHeaderTextStyle

  • get sectionHeaderTextStyle(): string

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

    Returns string

  • set sectionHeaderTextStyle(v): void

  • Parameters

    • v: string

    Returns void

selectedCellRanges

selectedCellRangesChanged

selectedCells

selectedCellsChanged

selectedItems

selectedItemsChanged

selectedKeys

  • get selectedKeys(): IgcGridSelectedKeysCollection

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

    Returns IgcGridSelectedKeysCollection

  • set selectedKeys(v): void

  • Parameters

    Returns void

selectedKeysChanged

selectionBehavior

  • get selectionBehavior(): GridSelectionBehavior

  • Sets or gets how selection behaves in the grid.

    Returns GridSelectionBehavior

  • set selectionBehavior(v): void

  • Parameters

    Returns void

selectionChanged

  • get selectionChanged(): ((s, e) => void)

  • Called when an individual selection operation has been made.

    Returns ((s, e) => void)

  • set selectionChanged(ev): void

  • Parameters

    Returns void

selectionMode

  • get selectionMode(): DataGridSelectionMode

  • Sets or gets the grid selection mode.

    Returns DataGridSelectionMode

  • set selectionMode(v): void

  • Parameters

    Returns void

shiftSectionContent

  • get shiftSectionContent(): boolean

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

    Returns boolean

  • set shiftSectionContent(v): void

  • Parameters

    • v: boolean

    Returns void

sizeChanged

  • get sizeChanged(): ((s, e) => void)

  • Called when the grids size has changed.

    Returns ((s, e) => void)

  • set sizeChanged(ev): void

  • Parameters

    Returns void

sortDescriptions

  • get sortDescriptions(): IgcColumnSortDescriptionCollection

  • 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

stickyRowBackground

  • get stickyRowBackground(): string

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

    Returns string

  • set stickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

summaryDescriptions

summaryDescriptionsChanged

summaryRootBackground

  • get summaryRootBackground(): string

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

    Returns string

  • set summaryRootBackground(v): void

  • Parameters

    • v: string

    Returns void

summaryRootLabelTextColor

  • get summaryRootLabelTextColor(): string

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

    Returns string

  • set summaryRootLabelTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryRootLabelTextStyle

  • get summaryRootLabelTextStyle(): string

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

    Returns string

  • set summaryRootLabelTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summaryRootSelectedBackground

  • get summaryRootSelectedBackground(): string

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

    Returns string

  • set summaryRootSelectedBackground(v): void

  • Parameters

    • v: string

    Returns void

summaryRootValueTextColor

  • get summaryRootValueTextColor(): string

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

    Returns string

  • set summaryRootValueTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryRootValueTextStyle

  • get summaryRootValueTextStyle(): string

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

    Returns string

  • set summaryRootValueTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summaryRowRoot

  • get summaryRowRoot(): IgcSummaryRowRootComponent

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

    Returns IgcSummaryRowRootComponent

  • set summaryRowRoot(v): void

  • Parameters

    Returns void

summaryRowSection

summaryScope

  • get summaryScope(): SummaryScope

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

    Returns SummaryScope

  • set summaryScope(v): void

  • Parameters

    Returns void

summarySectionBackground

  • get summarySectionBackground(): string

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

    Returns string

  • set summarySectionBackground(v): void

  • Parameters

    • v: string

    Returns void

summarySectionLabelTextColor

  • get summarySectionLabelTextColor(): string

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

    Returns string

  • set summarySectionLabelTextColor(v): void

  • Parameters

    • v: string

    Returns void

summarySectionLabelTextStyle

  • get summarySectionLabelTextStyle(): string

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

    Returns string

  • set summarySectionLabelTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summarySectionSelectedBackground

  • get summarySectionSelectedBackground(): string

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

    Returns string

  • set summarySectionSelectedBackground(v): void

  • Parameters

    • v: string

    Returns void

summarySectionValueTextColor

  • get summarySectionValueTextColor(): string

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

    Returns string

  • set summarySectionValueTextColor(v): void

  • Parameters

    • v: string

    Returns void

summarySectionValueTextStyle

  • get summarySectionValueTextStyle(): string

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

    Returns string

  • set summarySectionValueTextStyle(v): void

  • Parameters

    • v: string

    Returns void

todayOverride

  • get todayOverride(): Date

  • Returns Date

  • set todayOverride(v): void

  • Parameters

    • v: Date

    Returns void

toolbarColumnChooserText

  • get toolbarColumnChooserText(): string

  • Gets or sets the column chooser button text to use in the toolbar.

    Returns string

  • set toolbarColumnChooserText(v): void

  • Parameters

    • v: string

    Returns void

toolbarColumnChooserTitle

  • get toolbarColumnChooserTitle(): string

  • Gets or sets the column chooser title text to use in the toolbar.

    Returns string

  • set toolbarColumnChooserTitle(v): void

  • Parameters

    • v: string

    Returns void

toolbarColumnPinningText

  • get toolbarColumnPinningText(): string

  • Gets or sets the column pinning button text to use in the toolbar.

    Returns string

  • set toolbarColumnPinningText(v): void

  • Parameters

    • v: string

    Returns void

toolbarColumnPinningTitle

  • get toolbarColumnPinningTitle(): string

  • Gets or sets the column pinning title text to use in the toolbar.

    Returns string

  • set toolbarColumnPinningTitle(v): void

  • Parameters

    • v: string

    Returns void

toolbarTitle

  • get toolbarTitle(): string

  • Gets or sets the title text to use in the toolbar.

    Returns string

  • set toolbarTitle(v): void

  • Parameters

    • v: string

    Returns void

useAccessibility

  • get useAccessibility(): boolean

  • Returns boolean

  • set useAccessibility(value): void

  • Parameters

    • value: boolean

    Returns void

useCanvas

  • get useCanvas(): boolean

  • Returns boolean

  • set useCanvas(value): void

  • Parameters

    • value: boolean

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value): void

  • Parameters

    • value: string

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

  • Returns string[]

Methods

_scrollTo

  • _scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

acceptCommit

  • acceptCommit(commitID): void

  • Accepts a specific commit to the datasource.

    Parameters

    • commitID: number
      • The ID of the commit provided by the Committing event.

    Returns void

acceptEdit

  • acceptEdit(editID): void

  • Accept a pending edit turning it into a real edit.

    Parameters

    • editID: number
      • The ID of the edit. Provided by the CellValueChanging event.

    Returns void

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

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

    Returns void

after

  • after(...nodes): 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, options?): Animation

  • Parameters

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

    Returns Animation

append

  • append(...nodes): 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>(node): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

attachInternals

  • attachInternals(): ElementInternals

  • Returns ElementInternals

attachShadow

  • attachShadow(init): ShadowRoot

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name, oldValue, newValue): void

  • Parameters

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

    Returns void

before

  • before(...nodes): 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): 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): 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

cancelEdits

  • cancelEdits(): void

  • Cancels any edits that may exist in the datasource.

    Returns void

click

  • click(): void

  • Returns void

cloneNode

  • cloneNode(deep?): 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): HTMLElementTagNameMap[K]

  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K]

  • closest<K>(selector): SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • closest<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

commitEdits

  • commitEdits(): void

  • Commits any edits that may exist in the datasource.

    Returns void

compareDocumentPosition

  • compareDocumentPosition(other): number

  • Returns a bitmask indicating the position of other relative to node.

    Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void

  • Returns void

contains

  • contains(other): boolean

  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: Node

    Returns boolean

createShadow

  • createShadow(): ShadowRoot

  • Returns ShadowRoot

dataIndexOfItem

  • dataIndexOfItem(item): 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): number

  • Parameters

    • key: any[]

    Returns number

deselectAllRows

  • deselectAllRows(): void

  • Deselects all currently selected rows.

    Returns void

disconnectedCallback

  • disconnectedCallback(): void

  • Returns void

dispatchEvent

  • dispatchEvent(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

endEditMode

  • endEditMode(commit): void

  • Parameters

    • commit: boolean

    Returns void

ensureActualCornerRadius

  • ensureActualCornerRadius(): void

  • Returns void

ensureBorderWidth

  • ensureBorderWidth(): void

  • Returns void

ensureCornerRadius

  • ensureCornerRadius(): void

  • Returns void

ensureEditRowBorderWidth

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

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

flush

  • flush(): void

  • Makes sure pending work has completed if the grid need to be synchronously examined.

    Returns void

focus

  • focus(options?): void

  • Parameters

    • Optional options: FocusOptions

    Returns void

forColumnsWithPropertyPath

  • forColumnsWithPropertyPath(propertyPath, callback): void

  • Parameters

    Returns void

getAnimations

  • getAnimations(options?): Animation[]

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName): string

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns string

getAttributeNS

  • getAttributeNS(namespace, localName): string

  • 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
    • localName: string

    Returns string

getAttributeNames

  • getAttributeNames(): string[]

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName): Attr

  • Parameters

    • qualifiedName: string

    Returns Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace, localName): Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

  • Returns DOMRect

getClientRects

  • getClientRects(): DOMRectList

  • Returns DOMRectList

getColumnAtRenderedIndex

  • getColumnAtRenderedIndex(index): IgcDataGridColumnComponent

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

getElementsByClassName

  • getElementsByClassName(classNames): HTMLCollectionOf<Element>

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getFirstVisibleIndex

  • getFirstVisibleIndex(): number

  • Gets the first visible index in the grid.

    Returns number

getHitCell

  • getHitCell(x, y): IgcCellInfo

  • Get the cell that contains the provided coordinates.

    Parameters

    • x: number
    • y: number

    Returns IgcCellInfo

getLastVisibleIndex

  • getLastVisibleIndex(): number

  • Gets the last visible index in the grid.

    Returns number

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

getRootSummaryResults

  • getRootSummaryResults(): ISummaryResult[]

  • Gets the summary results for root level.

    Returns ISummaryResult[]

getSectionSummaryResults

  • getSectionSummaryResults(sectionIndex): ISummaryResult[][]

  • Gets the summary results for a specific section.

    Parameters

    • sectionIndex: number

    Returns ISummaryResult[][]

hasAttribute

  • hasAttribute(qualifiedName): boolean

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace, localName): boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string
    • 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): boolean

  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(where, element): Element

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

insertAdjacentHTML

  • insertAdjacentHTML(position, text): void

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where, data): void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

  • insertBefore<T>(node, child): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: Node

    Returns T

invalidateVisibleRows

  • invalidateVisibleRows(): void

  • Invalidates the bound data for the rows currently visible.

    Returns void

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • Parameters

    • namespace: string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • Parameters

    • otherNode: Node

    Returns boolean

loadLayout

  • loadLayout(json): void

  • Loads the layout chnages that have been made to the grid

    Parameters

    • json: string

    Returns void

lookupNamespaceURI

  • lookupNamespaceURI(prefix): string

  • Parameters

    • prefix: string

    Returns string

lookupPrefix

  • lookupPrefix(namespace): string

  • Parameters

    • namespace: string

    Returns string

matches

  • matches(selectors): boolean

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

moveColumn

  • moveColumn(oldIndex, newIndex): void

  • Parameters

    • oldIndex: number
    • newIndex: number

    Returns void

moveColumnLeft

  • moveColumnLeft(columnIndex): void

  • Moves a column to the left, if possible.

    Parameters

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

    Returns void

moveColumnRight

  • moveColumnRight(columnIndex): void

  • Moves a column to the right, if possible.

    Parameters

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

    Returns void

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, newItem): void

  • Parameters

    • index: number
    • newItem: any

    Returns void

notifyRemoveItem

  • notifyRemoveItem(index, oldItem): void

  • Parameters

    • index: number
    • oldItem: any

    Returns void

notifyScrollStart

  • notifyScrollStart(): void

  • Returns void

notifyScrollStop

  • notifyScrollStop(): void

  • Returns void

notifySetItem

  • notifySetItem(index, oldItem, newItem): void

  • Parameters

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

    Returns void

onScroll

  • onScroll(): void

  • Returns void

onScrollStart

  • onScrollStart(): void

  • Returns void

onScrollStop

  • onScrollStop(): void

  • Returns void

pinColumn

prepend

  • prepend(...nodes): 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): HTMLElementTagNameMap[K]

  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K]

  • querySelector<K>(selectors): SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • querySelector<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

querySelectorAll

  • querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

  • Returns all element descendants of node that match selectors.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • querySelectorAll<E>(selectors): NodeListOf<E>

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

redo

  • redo(): void

  • Redo the last edit.

    Returns void

refresh

  • refresh(): void

  • Forces a refresh of the grid content.

    Returns void

rejectCommit

  • rejectCommit(commitID): void

  • Rejects a specific commit.

    Parameters

    • commitID: number
      • The ID of the commit provided by the Committing event.

    Returns void

rejectEdit

  • rejectEdit(editID): void

  • Reject a pending edit.

    Parameters

    • editID: number
      • The ID of the edit. Provided by the CellValueChanging event.

    Returns void

releasePointerCapture

  • releasePointerCapture(pointerId): void

  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName): void

  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace, localName): void

  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(child): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

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

    Returns void

removeItem

  • removeItem(item): void

  • Removes an item by its instance.

    Parameters

    • item: any
      • The item instance to remove.

    Returns void

removeItemByKey

  • removeItemByKey(key): void

  • Parameters

    • key: any[]

    Returns void

replaceChild

  • replaceChild<T>(node, child): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes): void

  • Replace all children of 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

replaceWith

  • replaceWith(...nodes): 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(options?): Promise<void>

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(): void

  • Returns void

resolveCellValue

  • resolveCellValue(cellKey): any

  • Resolves the value of a specific cell.

    Parameters

    Returns any

resolveCellValueFromPosition

  • resolveCellValueFromPosition(row, column): any

  • Parameters

    • row: number
    • column: number

    Returns any

saveLayout

  • saveLayout(): string

  • Saves the layout chnages that have been made to the grid

    Returns string

scroll

  • scroll(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?): void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollToColumnByIndex

  • scrollToColumnByIndex(columnNumber): void

  • Scrolls the grid to given column, by index

    Parameters

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

    Returns void

scrollToItem

  • scrollToItem(item): boolean

  • Scrolls to an item, if found.

    Parameters

    • item: any
      • The item to scroll to.

    Returns boolean

scrollToLastRowByIndex

  • scrollToLastRowByIndex(rowNumber): 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): boolean

  • Parameters

    • key: any[]

    Returns boolean

scrollToRowByIndex

  • scrollToRowByIndex(rowNumber): void

  • Scrolls the grid to given row, by index

    Parameters

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

    Returns void

selectAllRows

  • selectAllRows(): void

  • Selects all of the rows in the grid.

    Returns void

setActiveResponsiveState

  • setActiveResponsiveState(name): void

  • Manually set the active responsive state of the grid.

    Parameters

    • name: string

    Returns void

setAttribute

  • setAttribute(qualifiedName, value): 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, qualifiedName, value): void

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: string
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

setEditError

  • setEditError(editID, errorMessage): void

  • Parameters

    • editID: number
    • errorMessage: string

    Returns void

setPointerCapture

  • setPointerCapture(pointerId): void

  • Parameters

    • pointerId: number

    Returns void

startEditMode

  • startEditMode(): void

  • Start edit mode on the active cell.

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName, force?): 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

undo

  • undo(): void

  • Undo the last edit.

    Returns void

updatePropertyAtKey

  • updatePropertyAtKey(key, propertyPath, value): void

  • Parameters

    • key: any[]
    • propertyPath: string
    • value: any

    Returns void

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Static register

  • register(): void

  • Returns void