Hierarchy

Hierarchy

  • cons
    • IgcDataGridComponent

Constructors

Properties

Accessors

Methods

Constructors

Properties

ATTRIBUTE_NODE: number
CDATA_SECTION_NODE: number

node is a CDATASection node.

COMMENT_NODE: number

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

DOCUMENT_NODE: number

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: number

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

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

DOCUMENT_TYPE_NODE: number

node is a doctype.

ELEMENT_NODE: number

node is an element.

ENTITY_NODE: number
ENTITY_REFERENCE_NODE: number
NOTATION_NODE: number
PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

TEXT_NODE: number

node is a Text node.

accessKey: string
accessKeyLabel: string
ariaAtomic: string
ariaAutoComplete: string
ariaBusy: string
ariaChecked: string
ariaColCount: string
ariaColIndex: string
ariaColIndexText: string
ariaColSpan: string
ariaCurrent: string
ariaDisabled: string
ariaExpanded: string
ariaHasPopup: string
ariaHidden: string
ariaInvalid: string
ariaKeyShortcuts: string
ariaLabel: string
ariaLevel: string
ariaLive: string
ariaModal: string
ariaMultiLine: string
ariaMultiSelectable: string
ariaOrientation: string
ariaPlaceholder: string
ariaPosInSet: string
ariaPressed: string
ariaReadOnly: string
ariaRequired: string
ariaRoleDescription: string
ariaRowCount: string
ariaRowIndex: string
ariaRowIndexText: string
ariaRowSpan: string
ariaSelected: string
ariaSetSize: string
ariaSort: string
ariaValueMax: string
ariaValueMin: string
ariaValueNow: string
ariaValueText: string
assignedSlot: HTMLSlotElement
attributes: NamedNodeMap
autocapitalize: string
autofocus: boolean
baseURI: string

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

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

children: HTMLCollection

Returns the child elements.

classList: DOMTokenList

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

className: string

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

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
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: IgcDataGridColumnComponent[]
contentEditable: string
dataset: DOMStringMap
dir: string
draggable: boolean
enterKeyHint: string
firstChild: ChildNode

Returns the first child.

firstElementChild: Element

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

hidden: boolean
id: string

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

inert: boolean
innerHTML: string
innerText: string
inputMode: string
isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable: boolean
lang: string
lastChild: ChildNode

Returns the last child.

lastElementChild: Element

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

localName: string

Returns the local name.

namespaceURI: string

Returns the namespace.

nextElementSibling: Element

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

nextSibling: ChildNode

Returns the next sibling.

nodeName: string

Returns a string appropriate for the type of node.

nodeType: number

Returns the type of node.

nodeValue: string
nonce?: string
offsetHeight: number
offsetLeft: number
offsetParent: Element
offsetTop: number
offsetWidth: number
onabort: ((this, ev) => any)

Fires when the user aborts the download.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the user aborts the download.

      Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

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

Fires when the object loses the input focus.

Param: ev

The focus event.

Type declaration

    • (this, ev): any
    • Fires when the object loses the input focus.

      Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when playback is possible, but would require further buffering.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the contents of the object or selection have changed.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user clicks the left mouse button on the object

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user clicks the right mouse button in the client area, opening the context menu.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Fires when the user double-clicks the object.

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user double-clicks the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

Fires on the source object continuously during a drag operation.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires on the source object continuously during a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires on the source object when the user releases the mouse at the close of a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

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

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

Param: ev

The drag event.

Type declaration

    • (this, ev): any
    • Fires on the target element when the user drags the object to a valid drop target.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

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.

Param: ev

The drag event.

Type declaration

    • (this, ev): any
    • Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires on the target element continuously while the user drags the object over a valid drop target.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires on the source object when the user starts to drag a text selection or selected object.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

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

Occurs when the duration attribute is updated.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the duration attribute is updated.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the media element is reset to its initial state.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs when the end of playback is reached.

Param: ev

The event

Type declaration

    • (this, ev): any
    • Occurs when the end of playback is reached.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event

      Returns any

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

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

Fires when the object receives focus.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the object receives focus.

      Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Fires when the user presses a key.

Param: ev

The keyboard event

Type declaration

    • (this, ev): any
    • Fires when the user presses a key.

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

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

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

Type declaration

    • (this, ev): any
    • Fires when the user presses an alphanumeric key.

      Deprecated

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

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

Fires when the user releases a key.

Param: ev

The keyboard event

Type declaration

    • (this, ev): any
    • Fires when the user releases a key.

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

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

Fires immediately after the browser loads the object.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires immediately after the browser loads the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when media data is loaded at the current playback position.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the duration and dimensions of the media have been determined.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when Internet Explorer begins looking for media data.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user clicks the object with either mouse button.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse over the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse pointer outside the boundaries of the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse pointer into the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

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

Param: ev

The mouse event.

Type declaration

    • (this, ev): any
    • Fires when the user releases a mouse button while the mouse is over the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Occurs when playback is paused.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when playback is paused.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs when the play method is requested.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the play method is requested.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs when the audio or video has started playing.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the audio or video has started playing.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Occurs to indicate progress while downloading media data.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs to indicate progress while downloading media data.

      Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

      Returns any

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

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the playback rate is increased or decreased.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Fires when the user resets a form.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the user resets a form.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the user repositions the scroll box in the scroll bar on the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

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

Occurs when the seek operation ends.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the seek operation ends.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs when the current playback position is moved.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the current playback position is moved.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Fires when the current selection changes.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Fires when the current selection changes.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Occurs when the download has stopped.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the download has stopped.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

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

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs if the load operation has been intentionally halted.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Occurs to indicate the current playback position.

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs to indicate the current playback position.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when the volume is changed, or playback is muted or unmuted.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

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

Param: ev

The event.

Type declaration

    • (this, ev): any
    • Occurs when playback stops because the next frame of a video resource is not available.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Deprecated

This is a legacy alias of onanimationend.

Type declaration

    • (this, ev): any
    • Deprecated

      This is a legacy alias of onanimationend.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Deprecated

This is a legacy alias of onanimationiteration.

Type declaration

    • (this, ev): any
    • Deprecated

      This is a legacy alias of onanimationiteration.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any
    • Deprecated

      This is a legacy alias of onanimationstart.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Deprecated

This is a legacy alias of ontransitionend.

Type declaration

    • (this, ev): any
    • Deprecated

      This is a legacy alias of ontransitionend.

      Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML: string
outerText: string
ownerDocument: Document
parentElement: HTMLElement

Returns the parent element.

parentNode: ParentNode

Returns the parent.

part: DOMTokenList
prefix: string

Returns the namespace prefix.

previousElementSibling: Element

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

previousSibling: ChildNode

Returns the previous sibling.

role: string
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: ShadowRoot

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

slot: string

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

spellcheck: boolean
style: CSSStyleDeclaration
tabIndex: number
tagName: string

Returns the HTML-uppercased qualified name.

textContent: string
title: string
translate: boolean
htmlTagName: string

Accessors

  • get activationMode(): GridActivationMode
  • Sets or gets the grid selection mode.

    Returns GridActivationMode

  • set activationMode(v): void
  • Parameters

    Returns void

  • get activeCell(): IgcGridCellPosition
  • Gets or sets the position of the active cell.

    Returns IgcGridCellPosition

  • set activeCell(v): void
  • Parameters

    Returns void

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

    Returns Thickness

  • set actualBorderWidth(v): void
  • Parameters

    • v: Thickness

    Returns void

  • get actualCornerRadiusBottomLeft(): number
  • Returns number

  • set actualCornerRadiusBottomLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusBottomRight(): number
  • Returns number

  • set actualCornerRadiusBottomRight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopLeft(): number
  • Returns number

  • set actualCornerRadiusTopLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get actualCornerRadiusTopRight(): number
  • Returns number

  • set actualCornerRadiusTopRight(v): void
  • Parameters

    • v: number

    Returns void

  • get actualDataSource(): IDataSource
  • Returns IDataSource

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

    Returns number

  • set actualHeaderHeight(v): void
  • Parameters

    • v: number

    Returns void

  • 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

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

  • set actualPrimaryKeyChange(ev): void
  • Parameters

    Returns void

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

    Returns number

  • set actualRowHeight(v): void
  • Parameters

    • v: number

    Returns void

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

    Returns IgRect

  • get allowCopyOperation(): boolean
  • Returns boolean

  • set allowCopyOperation(v): void
  • Parameters

    • v: boolean

    Returns void

  • get animationSettings(): IgcGridAnimationSettings
  • Sets or gets the default animation settings for the grid.

    Returns IgcGridAnimationSettings

  • set animationSettings(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

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

    Returns string

  • set border(v): void
  • Parameters

    • v: string

    Returns void

  • get borderWidthBottom(): number
  • Returns number

  • set borderWidthBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get borderWidthLeft(): number
  • Returns number

  • set borderWidthLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get borderWidthRight(): number
  • Returns number

  • set borderWidthRight(v): void
  • Parameters

    • v: number

    Returns void

  • get borderWidthTop(): number
  • Returns number

  • set borderWidthTop(v): void
  • Parameters

    • v: number

    Returns void

  • get canCommit(): boolean
  • Gets whether a commit can be performed. False if there are any errors present on any pending transactions.

    Returns boolean

  • get canRedo(): boolean
  • Gets whether a redo can be performed.

    Returns boolean

  • get canUndo(): boolean
  • Gets whether an undo can be performed.

    Returns boolean

  • 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

  • get cellClicked(): ((s, e) => void)
  • Called when a cell is clicked.

    Returns ((s, e) => void)

  • set cellClicked(ev): void
  • Parameters

    Returns void

  • get cellDataLoadedAnimationMode(): CellDataLoadedAnimationMode
  • Sets or gets the cell data loaded animation mode to use.

    Returns CellDataLoadedAnimationMode

  • set cellDataLoadedAnimationMode(v): void
  • Parameters

    Returns void

  • get cellEditEnded(): ((s, e) => void)
  • Called when a cell has finished editing.

    Returns ((s, e) => void)

  • set cellEditEnded(ev): void
  • Parameters

    Returns void

  • get cellEditStarted(): ((s, e) => void)
  • Called when a cell has started editing.

    Returns ((s, e) => void)

  • set cellEditStarted(ev): void
  • Parameters

    Returns void

  • get cellPointerDown(): ((s, e) => void)
  • Indicates a pointer is down on a cell.

    Returns ((s, e) => void)

  • set cellPointerDown(ev): void
  • Parameters

    Returns void

  • get cellPointerUp(): ((s, e) => void)
  • Indicates a pointer is up on a cell.

    Returns ((s, e) => void)

  • set cellPointerUp(ev): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • get cellSelectionAnimationMode(): CellSelectionAnimationMode
  • Sets or gets the cell selection animation mode to use.

    Returns CellSelectionAnimationMode

  • set cellSelectionAnimationMode(v): void
  • Parameters

    Returns void

  • 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

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

    Returns string

  • set cellTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • get columnAddingAnimationMode(): ColumnShowingAnimationMode
  • Sets or gets the Column Adding Animation mode to use.

    Returns ColumnShowingAnimationMode

  • set columnAddingAnimationMode(v): void
  • Parameters

    Returns void

  • get columnHiddenChanged(): ((s, e) => void)
  • Called when a column is hidden or unhidden.

    Returns ((s, e) => void)

  • set columnHiddenChanged(ev): void
  • Parameters

    Returns void

  • get columnHidingAnimationMode(): ColumnHidingAnimationMode
  • Sets or gets the column hiding animation mode to use.

    Returns ColumnHidingAnimationMode

  • set columnHidingAnimationMode(v): void
  • Parameters

    Returns void

  • get columnMovingAnimationMode(): ColumnMovingAnimationMode
  • Sets or gets the column moving animation mode to use.

    Returns ColumnMovingAnimationMode

  • set columnMovingAnimationMode(v): void
  • Parameters

    Returns void

  • get columnMovingMode(): ColumnMovingMode
  • Gets or sets the type column moving to use.

    Returns ColumnMovingMode

  • set columnMovingMode(v): void
  • Parameters

    Returns void

  • 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

  • get columnMovingSeparatorOpacity(): number
  • Gets or sets the opacity of the column moving separator.

    Returns number

  • set columnMovingSeparatorOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • get columnOptionsIconAlignment(): ColumnOptionsIconAlignment
  • Gets or sets the column options icon alignment in header cells.

    Returns ColumnOptionsIconAlignment

  • set columnOptionsIconAlignment(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • get columnPinnedChanged(): ((s, e) => void)
  • Called when a column is pinned or unpinned.

    Returns ((s, e) => void)

  • set columnPinnedChanged(ev): void
  • Parameters

    Returns void

  • 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

  • get columnResizingMode(): ColumnResizingMode
  • Gets or sets the type of column resizing to use.

    Returns ColumnResizingMode

  • set columnResizingMode(v): void
  • Parameters

    Returns void

  • 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

  • get columnResizingSeparatorOpacity(): number
  • Gets or sets the opacity of the column Resizing separator.

    Returns number

  • set columnResizingSeparatorOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • get columnShowingAnimationMode(): ColumnShowingAnimationMode
  • Sets or gets the column showing animation mode to use.

    Returns ColumnShowingAnimationMode

  • set columnShowingAnimationMode(v): void
  • Parameters

    Returns void

  • 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

  • get cornerRadiusBottomLeft(): number
  • Returns number

  • set cornerRadiusBottomLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusBottomRight(): number
  • Returns number

  • set cornerRadiusBottomRight(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopLeft(): number
  • Returns number

  • set cornerRadiusTopLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get cornerRadiusTopRight(): number
  • Returns number

  • set cornerRadiusTopRight(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • 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

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

  • 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

  • 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

  • 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

  • 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

  • get deletedTextColor(): string
  • Gets or sets the text color for unsaved deleted rows.

    Returns string

  • set deletedTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • get editMode(): EditModeType
  • Gets or sets the type of edit mode

    Returns EditModeType

  • set editMode(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • get editOpacity(): number
  • Gets or sets the default opacity for unsaved cell edits.

    Returns number

  • set editOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get editRowBorder(): string
  • Gets or sets the border color for rows being edited.

    Returns string

  • set editRowBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get editRowBorderWidthBottom(): number
  • Returns number

  • set editRowBorderWidthBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get editRowBorderWidthLeft(): number
  • Returns number

  • set editRowBorderWidthLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get editRowBorderWidthRight(): number
  • Returns number

  • set editRowBorderWidthRight(v): void
  • Parameters

    • v: number

    Returns void

  • get editRowBorderWidthTop(): number
  • Returns number

  • set editRowBorderWidthTop(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • get enterBehavior(): EnterKeyBehaviors
  • Gets or sets the behavior of the Enter key.

    Returns EnterKeyBehaviors

  • set enterBehavior(v): void
  • Parameters

    Returns void

  • 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

  • get filterComparisonType(): FilterComparisonType
  • Gets or sets whether UI filters are case sensitive or not.

    Returns FilterComparisonType

  • set filterComparisonType(v): void
  • Parameters

    Returns void

  • 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

  • get filterLogicalOperator(): FilterLogicalOperator
  • Gets or sets how filters set through the filter UI are combined.

    Returns FilterLogicalOperator

  • set filterLogicalOperator(v): void
  • Parameters

    Returns void

  • get filterUIType(): FilterUIType
  • Gets or sets which filter UI type to use.

    Returns FilterUIType

  • set filterUIType(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • get groupSummaryDisplayMode(): GroupSummaryDisplayMode
  • Gets or sets the display mode summaries will use inside groups.

    Returns GroupSummaryDisplayMode

  • set groupSummaryDisplayMode(v): void
  • Parameters

    Returns void

  • 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

  • get headerClickAction(): HeaderClickAction
  • Returns/sets the action to take when a column header is clicked.

    Returns HeaderClickAction

  • set headerClickAction(v): void
  • Parameters

    Returns void

  • 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

  • get headerRowSeparatorBackground(): string
  • Returns string

  • set headerRowSeparatorBackground(v): void
  • Parameters

    • v: string

    Returns void

  • 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

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

    Returns number

  • set headerSeparatorWidth(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • 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

  • 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

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

    Returns string

  • set headerTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get i(): DataGrid
  • Returns DataGrid

  • 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

  • get initialGroups(): string
  • Returns string

  • set initialGroups(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • get initialSorts(): string
  • Returns string

  • set initialSorts(v): void
  • Parameters

    • v: string

    Returns void

  • get initialSummaries(): string
  • Returns string

  • set initialSummaries(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

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

    Returns boolean

  • set isGroupCollapsable(v): void
  • Parameters

    • v: boolean

    Returns void

  • 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

  • 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

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

    Returns boolean

  • set isHeaderSeparatorVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • 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

  • 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

  • get isRowHoverEnabled(): boolean
  • Gets or sets whether the row will highlight when hovered.

    Returns boolean

  • set isRowHoverEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

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

    Returns number

  • set pinnedAreaSeparatorWidth(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get rowEditEnded(): ((s, e) => void)
  • Called when a row has finished editing.

    Returns ((s, e) => void)

  • set rowEditEnded(ev): void
  • Parameters

    Returns void

  • get rowEditStarted(): ((s, e) => void)
  • Called when a row has started editing.

    Returns ((s, e) => void)

  • set rowEditStarted(ev): void
  • Parameters

    Returns void

  • 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

  • get rowHoverAnimationMode(): RowHoverAnimationMode
  • Sets or gets the row hover animation mode to use.

    Returns RowHoverAnimationMode

  • set rowHoverAnimationMode(v): void
  • Parameters

    Returns void

  • get rowHoverBackground(): string
  • Gets or sets the background color for rows when hovered.

    Returns string

  • set rowHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get rowHoverTextColor(): string
  • Gets or sets the text color for rows when hovered.

    Returns string

  • set rowHoverTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get rowSelectionAnimationMode(): RowSelectionAnimationMode
  • Sets or gets the row selection animation mode to use.

    Returns RowSelectionAnimationMode

  • set rowSelectionAnimationMode(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • get scrollbarBackground(): string
  • Gets or sets the scrollbar background color.

    Returns string

  • set scrollbarBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get scrollbarStyle(): ScrollbarStyle
  • Gets or sets the style of scrollbar.

    Returns ScrollbarStyle

  • set scrollbarStyle(v): void
  • Parameters

    • v: ScrollbarStyle

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get selectionBehavior(): GridSelectionBehavior
  • Sets or gets how selection behaves in the grid.

    Returns GridSelectionBehavior

  • set selectionBehavior(v): void
  • Parameters

    Returns void

  • 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

  • get selectionMode(): DataGridSelectionMode
  • Sets or gets the grid selection mode.

    Returns DataGridSelectionMode

  • set selectionMode(v): void
  • Parameters

    Returns void

  • 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

  • get sizeChanged(): ((s, e) => void)
  • Called when the grids size has changed.

    Returns ((s, e) => void)

  • set sizeChanged(ev): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get summaryScope(): SummaryScope
  • Gets or sets the scope which summaries are calculated for.

    Returns SummaryScope

  • set summaryScope(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get todayOverride(): Date
  • Returns Date

  • set todayOverride(v): void
  • Parameters

    • v: Date

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • get useAccessibility(): boolean
  • Returns boolean

  • set useAccessibility(value): void
  • Parameters

    • value: boolean

    Returns void

  • get useCanvas(): boolean
  • Returns boolean

  • set useCanvas(value): void
  • Parameters

    • value: boolean

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

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

Methods

  • Parameters

    • x: number
    • y: number

    Returns void

  • Accepts a specific commit to the datasource.

    Parameters

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

    Returns 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

  • 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

  • Parameters

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

    Returns 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

  • Parameters

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

    Returns Animation

  • 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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

  • Returns ElementInternals

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Parameters

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

    Returns 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

  • Returns void

  • 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

  • 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

  • Cancels any edits that may exist in the datasource.

    Returns void

  • Returns void

  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]