Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcNumericColumnComponent

Represents a Numeric grid column, used to allow the developer to display a formatted number in a cell.

Hierarchy

Hierarchy (view full)

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

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

activationBorder

  • get activationBorder(): string

  • Gets or sets the background color to use.

    Returns string

  • set activationBorder(v): void

  • Parameters

    • v: string

    Returns void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number

  • Gets or sets the amount of bottom activation border to use for the cell content of this column.

    Returns number

  • set activationBorderBottomWidth(v): void

  • Parameters

    • v: number

    Returns void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number

  • Gets or sets the amount of left activation border to use for the cell content for this column.

    Returns number

  • set activationBorderLeftWidth(v): void

  • Parameters

    • v: number

    Returns void

activationBorderRightWidth

  • get activationBorderRightWidth(): number

  • Gets or sets the amount of right activation border to use for the cell content of this column.

    Returns number

  • set activationBorderRightWidth(v): void

  • Parameters

    • v: number

    Returns void

activationBorderTopWidth

  • get activationBorderTopWidth(): number

  • Gets or sets the amount of top activation border to use for the cell content for this column.

    Returns number

  • set activationBorderTopWidth(v): void

  • Parameters

    • v: number

    Returns void

actualActivationBorder

  • get actualActivationBorder(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualActivationBorder(v): void

  • Parameters

    • v: string

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualBackground(v): void

  • Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string

  • Gets the actual border color that will be used.

    Returns string

  • set actualBorder(v): void

  • Parameters

    • v: string

    Returns void

actualColumnOptionsIconAlignment

  • get actualColumnOptionsIconAlignment(): ColumnOptionsIconAlignment

  • Gets the actual column options icon alignment for this column.

    Returns ColumnOptionsIconAlignment

  • set actualColumnOptionsIconAlignment(v): void

  • Parameters

    Returns void

actualColumnOptionsIconBehavior

  • get actualColumnOptionsIconBehavior(): ColumnOptionsIconBehavior

  • Gets or sets how the column option icon will behave in the column header.

    Returns ColumnOptionsIconBehavior

  • set actualColumnOptionsIconBehavior(v): void

  • Parameters

    Returns void

actualColumnOptionsIconColor

  • get actualColumnOptionsIconColor(): string

  • Gets the actual column options icon color for this column.

    Returns string

  • set actualColumnOptionsIconColor(v): void

  • Parameters

    • v: string

    Returns void

actualDeletedTextColor

  • get actualDeletedTextColor(): string

  • Gets the actual text color used for deleted rows.

    Returns string

  • set actualDeletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualEditFontInfo

  • get actualEditFontInfo(): string

  • Gets the actual font style used for unsaved cell edits.

    Returns string

  • set actualEditFontInfo(v): void

  • Parameters

    • v: string

    Returns void

actualEditOpacity

  • get actualEditOpacity(): number

  • Gets the actual opacity for unsaved edited cell values.

    Returns number

  • set actualEditOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualErrorBorder

  • get actualErrorBorder(): string

  • Gets the actual error border color that will be used.

    Returns string

  • set actualErrorBorder(v): void

  • Parameters

    • v: string

    Returns void

actualHeaderText

  • get actualHeaderText(): string

  • Gets the actual text displayed in the header of the column

    Returns string

  • set actualHeaderText(v): void

  • Parameters

    • v: string

    Returns void

actualHeaderTextChange

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

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

  • set actualHeaderTextChange(ev): void

  • Parameters

    Returns void

actualHoverBackground

  • get actualHoverBackground(): string

  • Gets the actual background color that is used for the cells when they are hovered.

    Returns string

  • set actualHoverBackground(v): void

  • Parameters

    • v: string

    Returns void

actualIsColumnOptionsEnabled

  • get actualIsColumnOptionsEnabled(): boolean

  • Gets the actual state of the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

actualIsColumnOptionsGroupingEnabled

  • get actualIsColumnOptionsGroupingEnabled(): boolean

  • Gets the actual state of grouping menu in the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsGroupingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

actualIsColumnOptionsSummariesEnabled

  • get actualIsColumnOptionsSummariesEnabled(): boolean

  • Gets the actual state of summaries menu in the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsSummariesEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

actualLastStickyRowBackground

  • get actualLastStickyRowBackground(): string

  • Gets the actual color for the last row in the sticky row area.

    Returns string

  • set actualLastStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

actualLineBreakMode

  • get actualLineBreakMode(): TextCellLineBreakMode

  • Gets the actual line break mode which will be used if text is present in the cell.

    Returns TextCellLineBreakMode

  • set actualLineBreakMode(v): void

  • Parameters

    Returns void

actualPinnedRowBackground

  • get actualPinnedRowBackground(): string

  • Gets the actual background color for cells belonging to rows marked as pinned.

    Returns string

  • set actualPinnedRowBackground(v): void

  • Parameters

    • v: string

    Returns void

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number

  • Gets or sets the color to use for displaying text.

    Returns number

  • set actualPinnedRowOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualRowHoverTextColor

  • get actualRowHoverTextColor(): string

  • Gets the actual text color that is used for the cells when they are hovered.

    Returns string

  • set actualRowHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualSelectedBackground

  • get actualSelectedBackground(): string

  • Gets the actual background color that is used for the cells when they are selected

    Returns string

  • set actualSelectedBackground(v): void

  • Parameters

    • v: string

    Returns void

actualStickyRowBackground

  • get actualStickyRowBackground(): string

  • Gets the actual background color for content that sticks to the top of the grid.

    Returns string

  • set actualStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

actualTextColor

  • get actualTextColor(): string

  • Gets the actual color used for displaying text.

    Returns string

  • set actualTextColor(v): void

  • Parameters

    • v: string

    Returns void

animationSettings

  • get animationSettings(): IgcGridColumnAnimationSettings

  • Gets or sets the animation settings to use for this column.

    Returns IgcGridColumnAnimationSettings

  • set animationSettings(v): void

  • Parameters

    Returns void

background

  • get background(): string

  • Gets or sets the background color to use.

    Returns string

  • set background(v): void

  • Parameters

    • v: string

    Returns void

border

  • get border(): string

  • Gets or sets the background color to use.

    Returns string

  • set border(v): void

  • Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number

  • Gets or sets the amount of bottom border to use for the cell content of this column.

    Returns number

  • set borderBottomWidth(v): void

  • Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number

  • Gets or sets the amount of left border to use for the cell content for this column.

    Returns number

  • set borderLeftWidth(v): void

  • Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number

  • Gets or sets the amount of right border to use for the cell content of this column.

    Returns number

  • set borderRightWidth(v): void

  • Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number

  • Gets or sets the amount of top border to use for the cell content for this column.

    Returns number

  • set borderTopWidth(v): void

  • Parameters

    • v: number

    Returns void

cellStyleKeyRequested

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

  • Called when the style key for a cell is needed. Used for recycling the cell.

    Returns ((s, e) => void)

  • set cellStyleKeyRequested(ev): void

  • Parameters

    Returns void

columnOptionsIconAlignment

  • get columnOptionsIconAlignment(): ColumnOptionsIconAlignment

  • Gets or sets whether the column options icon is aligned opposite the header text or not.

    Returns ColumnOptionsIconAlignment

  • set columnOptionsIconAlignment(v): void

  • Parameters

    Returns void

columnOptionsIconBehavior

  • get columnOptionsIconBehavior(): ColumnOptionsIconBehavior

  • Gets or sets how the column option icon will behave in the column header.

    Returns ColumnOptionsIconBehavior

  • set columnOptionsIconBehavior(v): void

  • Parameters

    Returns void

columnOptionsIconColor

  • get columnOptionsIconColor(): string

  • Gets or sets the column options icon color for this column.

    Returns string

  • set columnOptionsIconColor(v): void

  • Parameters

    • v: string

    Returns void

contentOpacity

  • get contentOpacity(): number

  • Gets or sets the opacity of the content.

    Returns number

  • set contentOpacity(v): void

  • Parameters

    • v: number

    Returns void

dataBinding

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

  • Called when a cell is data binding.

    Returns ((s, e) => void)

  • set dataBinding(ev): void

  • Parameters

    Returns void

dataBound

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

  • Called when a cell has been data bound.

    Returns ((s, e) => void)

  • set dataBound(ev): void

  • Parameters

    Returns void

deletedTextColor

  • get deletedTextColor(): string

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

    Returns string

  • set deletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

editOpacity

  • get editOpacity(): number

  • Gets or sets the opacity to use for unsaved edited cell values.

    Returns number

  • set editOpacity(v): void

  • Parameters

    • v: number

    Returns void

editorDataSource

  • get editorDataSource(): any

  • Gets or sets the ComboBox data source.

    Returns any

  • set editorDataSource(v): void

  • Parameters

    • v: any

    Returns void

editorTextField

  • get editorTextField(): string

  • Gets or sets the ComboBox text field.

    Returns string

  • set editorTextField(v): void

  • Parameters

    • v: string

    Returns void

editorType

  • get editorType(): EditorType

  • Gets or sets the editor type used for editing cells in this column.

    Returns EditorType

  • set editorType(v): void

  • Parameters

    Returns void

editorValueField

  • get editorValueField(): string

  • Gets or sets the ComboBox value field.

    Returns string

  • set editorValueField(v): void

  • Parameters

    • v: string

    Returns void

errorBorder

  • get errorBorder(): string

  • Gets or sets the error border color to use.

    Returns string

  • set errorBorder(v): void

  • Parameters

    • v: string

    Returns void

errorBorderBottomWidth

  • get errorBorderBottomWidth(): number

  • Returns number

  • set errorBorderBottomWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderLeftWidth

  • get errorBorderLeftWidth(): number

  • Returns number

  • set errorBorderLeftWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderRightWidth

  • get errorBorderRightWidth(): number

  • Returns number

  • set errorBorderRightWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderTopWidth

  • get errorBorderTopWidth(): number

  • Returns number

  • set errorBorderTopWidth(v): void

  • Parameters

    • v: number

    Returns void

field

  • get field(): string

  • Gets or sets the key used for the column binding

    Returns string

  • set field(v): void

  • Parameters

    • v: string

    Returns void

filter

  • get filter(): ColumnFilterCondition

  • Gets or sets a filter to apply on the values of this column

    Returns ColumnFilterCondition

  • set filter(v): void

  • Parameters

    • v: ColumnFilterCondition

    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

filterExpression

  • get filterExpression(): IFilterExpression

  • Gets or sets a filter to apply to the values of this column.

    Returns IFilterExpression

  • set filterExpression(v): void

  • Parameters

    • v: IFilterExpression

    Returns void

filterOperands

  • get filterOperands(): IgcGridFilterOperandsCollection

  • Gets a list of the current custom filters for this column.

    Returns IgcGridFilterOperandsCollection

  • set filterOperands(v): void

  • Parameters

    Returns void

formatOverride

  • get formatOverride(): any

  • Gets or sets the INTL NumericFormat object to use for formatting the date values.

    Returns any

  • set formatOverride(v): void

  • Parameters

    • v: any

    Returns void

formatSpecifiers

  • get formatSpecifiers(): any[]

  • Returns any[]

  • set formatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

formatString

  • get formatString(): string

  • Gets or sets the format string to apply to the value. If set, the other value formatting properties on this column are ignored.

    Returns string

  • set formatString(v): void

  • Parameters

    • v: string

    Returns void

header

  • get header(): IgcHeaderComponent

  • Gets or sets the header definition for this column.

    Returns IgcHeaderComponent

  • set header(v): void

  • Parameters

    Returns void

headerText

  • get headerText(): string

  • Gets or sets the text displayed in the header of the column

    Returns string

  • set headerText(v): void

  • Parameters

    • v: string

    Returns void

horizontalAlignment

  • get horizontalAlignment(): CellContentHorizontalAlignment

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

    Returns CellContentHorizontalAlignment

  • set horizontalAlignment(v): void

  • Parameters

    Returns void

isAutoGenerated

  • get isAutoGenerated(): boolean

  • Gets whether this column was auto generated.

    Returns boolean

  • set isAutoGenerated(v): void

  • Parameters

    • v: boolean

    Returns void

isColumnOptionsEnabled

  • get isColumnOptionsEnabled(): boolean

  • Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to.

    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 for this column.

    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 for this column.

    Returns boolean

  • set isColumnOptionsSummariesEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isEditable

  • get isEditable(): boolean

  • Gets or sets if the column is editable.

    Returns boolean

  • set isEditable(v): void

  • Parameters

    • v: boolean

    Returns void

isFilteringEnabled

  • get isFilteringEnabled(): boolean

  • Gets or sets whether filtering is enabled for this column.

    Returns boolean

  • set isFilteringEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isFromMarkup

  • get isFromMarkup(): boolean

  • Gets whether this column was projected from markup/templates and is constrained.

    Returns boolean

  • set isFromMarkup(v): void

  • Parameters

    • v: boolean

    Returns void

isHidden

  • get isHidden(): boolean

  • Gets or sets whether or not a column is hidden from the grid

    Returns boolean

  • set isHidden(v): void

  • Parameters

    • v: boolean

    Returns void

isResizingEnabled

  • get isResizingEnabled(): boolean

  • Gets or sets whether resizing is enabled for this column.

    Returns boolean

  • set isResizingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string

  • Gets or sets the color for the last row in the sticky row area.

    Returns string

  • set lastStickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

lineBreakMode

  • get lineBreakMode(): TextCellLineBreakMode

  • Gets or sets the line breaking mode to use if text is present in the cell.

    Returns TextCellLineBreakMode

  • set lineBreakMode(v): void

  • Parameters

    Returns void

maxFractionDigits

  • get maxFractionDigits(): number

  • Gets or sets the maximum fraction digits. If FormatString is specificied this value is ignored.

    Returns number

  • set maxFractionDigits(v): void

  • Parameters

    • v: number

    Returns void

mergedCellEvaluationCriteria

  • get mergedCellEvaluationCriteria(): MergedCellEvaluationCriteria

  • Gets or sets how cells are evaluated for merging.

    Returns MergedCellEvaluationCriteria

  • set mergedCellEvaluationCriteria(v): void

  • Parameters

    Returns void

mergedCellMode

  • get mergedCellMode(): MergedCellMode

  • Gets or sets if and how cell merging is performed for this field.

    Returns MergedCellMode

  • set mergedCellMode(v): void

  • Parameters

    Returns void

mergedCellPaddingBottom

  • get mergedCellPaddingBottom(): number

  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Returns number

  • set mergedCellPaddingBottom(v): void

  • Parameters

    • v: number

    Returns void

mergedCellPaddingLeft

  • get mergedCellPaddingLeft(): number

  • Gets or sets the amount of left padding to use for the cell content for this column.

    Returns number

  • set mergedCellPaddingLeft(v): void

  • Parameters

    • v: number

    Returns void

mergedCellPaddingRight

  • get mergedCellPaddingRight(): number

  • Gets or sets the amount of right padding to use for the cell content of this column.

    Returns number

  • set mergedCellPaddingRight(v): void

  • Parameters

    • v: number

    Returns void

mergedCellPaddingTop

  • get mergedCellPaddingTop(): number

  • Gets or sets the amount of top padding to use for the cell content for this column.

    Returns number

  • set mergedCellPaddingTop(v): void

  • Parameters

    • v: number

    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

minFractionDigits

  • get minFractionDigits(): number

  • Gets or sets the minimum fraction digits. If FormatString is specificied this value is ignored.

    Returns number

  • set minFractionDigits(v): void

  • Parameters

    • v: number

    Returns void

minIntegerDigits

  • get minIntegerDigits(): number

  • Gets or sets the minimum integer digits. If FormatString is specificied this value is ignored.

    Returns number

  • set minIntegerDigits(v): void

  • Parameters

    • v: number

    Returns void

minWidth

  • get minWidth(): number

  • Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

    Returns number

  • set minWidth(v): void

  • Parameters

    • v: number

    Returns void

name

  • get name(): string

  • Gets or sets an unique name of the Column

    Returns string

  • set name(v): void

  • Parameters

    • v: string

    Returns void

negativePrefix

  • get negativePrefix(): string

  • Gets or sets the string to prefix a negative value. If FormatString is specificied this value is ignored.

    Returns string

  • set negativePrefix(v): void

  • Parameters

    • v: string

    Returns void

negativeSuffix

  • get negativeSuffix(): string

  • Gets or sets the string to suffix a negative value. If FormatString is specificied this value is ignored.

    Returns string

  • set negativeSuffix(v): void

  • Parameters

    • v: string

    Returns void

paddingBottom

  • get paddingBottom(): number

  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Returns number

  • set paddingBottom(v): void

  • Parameters

    • v: number

    Returns void

paddingLeft

  • get paddingLeft(): number

  • Gets or sets the amount of left padding to use for the cell content for this column.

    Returns number

  • set paddingLeft(v): void

  • Parameters

    • v: number

    Returns void

paddingRight

  • get paddingRight(): number

  • Gets or sets the amount of right padding to use for the cell content of this column.

    Returns number

  • set paddingRight(v): void

  • Parameters

    • v: number

    Returns void

paddingTop

  • get paddingTop(): number

  • Gets or sets the amount of top padding to use for the cell content for this column.

    Returns number

  • set paddingTop(v): void

  • Parameters

    • v: number

    Returns void

pinned

  • get pinned(): PinnedPositions

  • Gets or sets the current fixed position for this column.

    Returns PinnedPositions

  • set pinned(v): void

  • Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string

  • Gets or sets the background color for cells belonging to rows marked as pinned.

    Returns string

  • set pinnedRowBackground(v): void

  • Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number

  • Gets or sets the color to use for displaying text.

    Returns number

  • set pinnedRowOpacity(v): void

  • Parameters

    • v: number

    Returns void

positivePrefix

  • get positivePrefix(): string

  • Gets or sets the string to prefix a positive value. If FormatString is specificied this value is ignored.

    Returns string

  • set positivePrefix(v): void

  • Parameters

    • v: string

    Returns void

positiveSuffix

  • get positiveSuffix(): string

  • Gets or sets the string to suffix a positive value. If FormatString is specificied this value is ignored.

    Returns string

  • set positiveSuffix(v): void

  • Parameters

    • v: string

    Returns void

rowHoverBackground

  • get rowHoverBackground(): string

  • Gets or sets the background color to use for the cells when the row is hovered.

    Returns string

  • set rowHoverBackground(v): void

  • Parameters

    • v: string

    Returns void

rowHoverTextColor

  • get rowHoverTextColor(): string

  • Gets or sets the text color to use for the cells when the row is hovered.

    Returns string

  • set rowHoverTextColor(v): void

  • Parameters

    • v: string

    Returns void

selectedBackground

  • get selectedBackground(): string

  • Gets or sets the background color to use for the cells when they are selected

    Returns string

  • set selectedBackground(v): void

  • Parameters

    • v: string

    Returns void

shouldRemoveWhenHidden

  • get shouldRemoveWhenHidden(): boolean

  • Gets or sets if a column should be removed from the grid when it is fully hidden

    Returns boolean

  • set shouldRemoveWhenHidden(v): void

  • Parameters

    • v: boolean

    Returns void

showGroupingSeparator

  • get showGroupingSeparator(): boolean

  • Gets or sets whether to show a grouping separator. If FormatString is specificied this value is ignored.

    Returns boolean

  • set showGroupingSeparator(v): void

  • Parameters

    • v: boolean

    Returns void

sortDirection

  • get sortDirection(): ColumnSortDirection

  • Gets the current sort direction (None, Ascending, Descending) for this column.

    Returns ColumnSortDirection

  • set sortDirection(v): void

  • Parameters

    Returns void

stickyRowBackground

  • get stickyRowBackground(): string

  • Gets or sets the background color for content that sticks to the top of the grid.

    Returns string

  • set stickyRowBackground(v): void

  • Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string

  • Gets or sets the color to use for displaying text.

    Returns string

  • set textColor(v): void

  • Parameters

    • v: string

    Returns void

textEditStyle

  • get textEditStyle(): string

  • Gets or sets the font style to use for unsaved cell edits.

    Returns string

  • set textEditStyle(v): void

  • Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string

  • Returns string

  • set textStyle(v): void

  • Parameters

    • v: string

    Returns void

verticalAlignment

  • get verticalAlignment(): CellContentVerticalAlignment

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

    Returns CellContentVerticalAlignment

  • set verticalAlignment(v): void

  • Parameters

    Returns void

width

  • get width(): IgcColumnWidth

  • Gets or sets the width to use for this column.

    Returns IgcColumnWidth

  • set width(v): void

  • Parameters

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

  • Returns string[]

Methods

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

applyCustomFilter

  • applyCustomFilter(filterID, index, value): void

  • Parameters

    • filterID: string
    • index: number
    • value: any

    Returns void

attachInternals

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

click

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

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    Parameters

    • other: Node

    Returns number

connectedCallback

contains

  • contains(other): boolean

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

    Parameters

    • other: Node

    Returns boolean

createShadow

disconnectedCallback

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

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

focus

  • focus(options?): void

  • Parameters

    • Optional options: FocusOptions

    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

getAttributeNodeNS

getBoundingClientRect

getClientRects

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>

getNamedHeaderValue

  • getNamedHeaderValue(valueName): any

  • Gets the value of a named header value for this column by name.

    Parameters

    • valueName: string
      • Name of the named header value to retrieve.

    Returns any

getNamedValue

  • getNamedValue(valueName): any

  • Gets the value for a named value from this definition.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns any

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

getUniqueKey

  • getUniqueKey(): string

  • Get the unique key used to identify this column.

    Returns string

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

hasNamedHeaderValue

  • hasNamedHeaderValue(valueName): boolean

  • Returns if there is a named header value with a given name.

    Parameters

    • valueName: string
      • The named value to check for.

    Returns boolean

hasNamedHeaderValues

  • hasNamedHeaderValues(): boolean

  • Returns if the column has named header values.

    Returns boolean

hasNamedValue

  • hasNamedValue(valueName): boolean

  • Returns if this definition has a named value with a given name.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns boolean

hasNamedValues

  • hasNamedValues(): boolean

  • Returns if this definition has named value.

    Returns boolean

hasPointerCapture

insertAdjacentElement

insertAdjacentHTML

insertAdjacentText

insertBefore

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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: Node

    Returns T

isDefaultNamespace

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node

    Returns boolean

isSameNode

lookupNamespaceURI

lookupPrefix

matches

  • matches(selectors): boolean

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

    Parameters

    • selectors: string

    Returns boolean

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

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>

releasePointerCapture

remove

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

removeChild

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

removeNamedHeaderValue

  • removeNamedHeaderValue(valueName): void

  • Removes a named header value with the given name from the named header values for this column.

    Parameters

    • valueName: string
      • The named header value to remove.

    Returns void

removeNamedValue

  • removeNamedValue(valueName): void

  • Removes the named value from this definition by name.

    Parameters

    • valueName: string
      • The named value name to remove.

    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

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

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

setAttributeNodeNS

setNamedHeaderValue

setNamedValue

setPointerCapture

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

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Static _createFromInternal

Static register

  • register(): void

  • Returns void