Ignite UI for Angular Column - Documentation

The Ignite UI Column is used within an igx-grid element to define what data the column will show. Features such as sorting, filtering & editing are enabled at the column level. You can also provide a template containing custom content inside the column using ng-template which will be used for all cells within the column.

Igx Parent

IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, IgxRowIslandComponent, IgxColumnGroupComponent, IgxColumnLayoutComponent

Hierarchy

Hierarchy (view full)

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

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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

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: ((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: ((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: ((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: ((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: ((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: ((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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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: ((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: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

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: ((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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

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: ((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: ((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: ((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: ((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: ((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: ((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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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: ((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: ((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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

      Returns any

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: ((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: ((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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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: ((this, ev) => any)

Fires when the current selection changes.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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: ((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.

Type declaration

    • (this, ev): any
    • 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.

Type declaration

    • (this, ev): any
    • 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
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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: ((this, ev) => any)

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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: ((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
translate: boolean

Accessors

  • get additionalTemplateContext(): any
  • Returns any

  • set additionalTemplateContext(value): void
  • Sets/gets custom properties provided in additional template context.

    <igx-column [additionalTemplateContext]="contextObject">
    <ng-template igxCell let-cell="cell" let-props="additionalTemplateContext">
    {{ props }}
    </ng-template>
    </igx-column>

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get autosizeHeader(): boolean
  • Returns boolean

  • set autosizeHeader(value): void
  • Sets/gets whether the column header is included in autosize logic. Useful when template for a column header is sized based on parent, for example a default div. Default value is false.

    let isResizable = this.column.resizable;
    
    <igx-column [resizable] = "true"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get cellClasses(): any
  • Returns any

  • set cellClasses(value): void
  • Sets a conditional class selector of the column cells. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean, like so:

    callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; }
    cellClasses = { 'className' : this.callback };
    <igx-column [cellClasses] = "cellClasses"></igx-column>
    <igx-column [cellClasses] = "{'class1' : true }"></igx-column>

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get cellStyles(): any
  • Returns any

  • set cellStyles(value): void
  • Sets conditional style properties on the column cells. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated. As with cellClasses it accepts a callback function.

    styles = {
    background: 'royalblue',
    color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit'
    }
    <igx-column [cellStyles]="styles"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get cells(): IgcCellType[]
  • Gets the cells of the column.

    let columnCells = this.column.cells;
    

    Returns IgcCellType[]

  • get colEnd(): number
  • Returns number

  • set colEnd(value): void
  • Column index where the current field should end. The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field

    <igx-column-layout>
    <igx-column [colEnd]="3" [rowStart]="1" [colStart]="1"></igx-column>
    </igx-column-layout>

    Memberof

    IgxColumnComponent

    Parameters

    • value: number

    Returns void

  • get colStart(): number
  • Returns number

  • set colStart(value): void
  • Column index from which the field is starting.

    <igx-column-layout>
    <igx-column [colStart]="1" [rowStart]="1"></igx-column>
    </igx-column-layout>

    Memberof

    IgxColumnComponent

    Parameters

    • value: number

    Returns void

  • get columnChildren(): IgcColumnComponent[]
  • Returns IgcColumnComponent[]

  • set columnChildren(value): void
  • Gets the children columns array.

    let columnChildren = this.column.columnChildren;
    

    Memberof

    IgxColumnComponent

    Parameters

    Returns void

  • get columnGroup(): boolean
  • Returns a boolean indicating if the column is a ColumnGroup.

    let columnGroup =  this.column.columnGroup;
    

    Memberof

    IgxColumnComponent

    Returns boolean

  • get columnLayout(): boolean
  • Returns a boolean indicating if the column is a ColumnLayout for multi-row layout.

    let columnGroup =  this.column.columnGroup;
    

    Memberof

    IgxColumnComponent

    Returns boolean

  • get columnLayoutChild(): any
  • Returns a boolean indicating if the column is a child of a ColumnLayout for multi-row layout.

    let columnLayoutChild =  this.column.columnLayoutChild;
    

    Memberof

    IgxColumnComponent

    Returns any

  • get dataType(): GridColumnDataType
  • Returns GridColumnDataType

  • set dataType(value): void
  • Sets/gets the data type of the column values. Default value is string.

    let columnDataType = this.column.dataType;
    
    <igx-column [dataType] = "'number'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    Returns void

  • get defaultMinWidth(): string
  • Gets the default minimum width of the column.

    let defaultMinWidth =  this.column.defaultMinWidth;
    

    Memberof

    IgxColumnComponent

    Returns string

  • get disableHiding(): boolean
  • Returns boolean

  • set disableHiding(value): void
  • Gets whether the hiding is disabled.

    let isHidingDisabled =  this.column.disableHiding;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get disablePinning(): boolean
  • Returns boolean

  • set disablePinning(value): void
  • Gets whether the pinning is disabled.

    let isPinningDisabled =  this.column.disablePinning;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get editable(): boolean
  • Returns boolean

  • set editable(value): void
  • Gets whether the column is editable. Default value is false.

    let isEditable = this.column.editable;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get field(): string
  • Returns string

  • set field(value): void
  • Sets/gets the field value.

    let columnField = this.column.field;
    
    <igx-column [field] = "'ID'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get filterCell(): IgcGridFilteringCellComponent
  • Returns a reference to the filter cell of the column.

    let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
    let filterell = column.filterell;

    Memberof

    IgxColumnComponent

    Returns IgcGridFilteringCellComponent

  • get filterable(): boolean
  • Returns boolean

  • set filterable(value): void
  • Sets/gets whether the column is filterable. Default value is true.

    let isFilterable = this.column.filterable;
    
    <igx-column [filterable] = "false"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get filteringExpressionsTree(): IgcFilteringExpressionsTree
  • Returns the filteringExpressionsTree of the column.

    let tree =  this.column.filteringExpressionsTree;
    

    Memberof

    IgxColumnComponent

    Returns IgcFilteringExpressionsTree

  • get filteringIgnoreCase(): boolean
  • Returns boolean

  • set filteringIgnoreCase(value): void
  • Sets/gets whether the column filtering should be case sensitive. Default value is true.

    let filteringIgnoreCase = this.column.filteringIgnoreCase;
    
    <igx-column [filteringIgnoreCase] = "false"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get filters(): IgcFilteringOperand
  • Returns IgcFilteringOperand

  • set filters(value): void
  • Gets the column filters.

    let columnFilters = this.column.filters'
    

    Memberof

    IgxColumnComponent

    Parameters

    Returns void

  • get formatter(): any
  • Returns any

  • set formatter(value): void
  • Applies display format to cell values in the column. Does not modify the underlying data.

    Remark

    Note: As the formatter is used in places like the Excel style filtering dialog, in certain scenarios (remote filtering for example), the row data argument can be undefined.

    In this example, we check to see if the column name is Salary, and then provide a method as the column formatter to format the value into a currency string.

    Example

    columnInit(column: IgxColumnComponent) {
    if (column.field == "Salary") {
    column.formatter = (salary => this.format(salary));
    }
    }

    format(value: number) : string {
    return formatCurrency(value, "en-us", "$");
    }

    Example

    const column = this.grid.getColumnByName('Address');
    const addressFormatter = (address: string, rowData: any) => data.privacyEnabled ? 'unknown' : address;
    column.formatter = addressFormatter;

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get gridColumnSpan(): number
  • Returns number

  • get gridRowSpan(): number
  • Returns number

  • get groupable(): boolean
  • Returns boolean

  • set groupable(value): void
  • Sets/gets whether the column is groupable. Default value is false.

    let isGroupable = this.column.groupable;
    
    <igx-column [groupable] = "true"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get hasSummary(): boolean
  • Returns boolean

  • set hasSummary(value): void
  • Gets a value indicating whether the summary for the column is enabled.

    let hasSummary = this.column.hasSummary;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get header(): string
  • Returns string

  • set header(value): void
  • Sets/gets the header value.

    let columnHeader = this.column.header;
    
    <igx-column [header] = "'ID'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get headerCell(): IgcGridHeaderComponent
  • Returns a reference to the header of the column.

    let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
    let headerCell = column.headerCell;

    Memberof

    IgxColumnComponent

    Returns IgcGridHeaderComponent

  • get headerClasses(): string
  • Returns string

  • set headerClasses(value): void
  • Sets/gets the class selector of the column header.

    let columnHeaderClass = this.column.headerClasses;
    
    <igx-column [headerClasses] = "'column-header'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get headerGroup(): IgcGridHeaderGroupComponent
  • Returns a reference to the header group of the column.

    Memberof

    IgxColumnComponent

    Returns IgcGridHeaderGroupComponent

  • get headerGroupClasses(): string
  • Returns string

  • set headerGroupClasses(value): void
  • Sets/gets the class selector of the column group header.

    let columnHeaderClass = this.column.headerGroupClasses;
    
    <igx-column [headerGroupClasses] = "'column-group-header'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get headerGroupStyles(): any
  • Returns any

  • set headerGroupStyles(value): void
  • Sets conditional style properties on the column header group wrapper. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

    styles = {
    background: 'royalblue',
    color: (column) => column.pinned ? 'red': 'inherit'
    }
    <igx-column [headerGroupStyles]="styles"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get headerStyles(): any
  • Returns any

  • set headerStyles(value): void
  • Sets conditional style properties on the column header. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

    styles = {
    background: 'royalblue',
    color: (column) => column.pinned ? 'red': 'inherit'
    }
    <igx-column [headerStyles]="styles"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get hidden(): boolean
  • Returns boolean

  • set hidden(value): void
  • Gets whether the column is hidden.

    let isHidden = this.column.hidden;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get index(): number
  • Gets the column index.

    let columnIndex = this.column.index;
    

    Memberof

    IgxColumnComponent

    Returns number

  • get level(): number
  • Returns the level of the column in a column group. Returns 0 if the column doesn't have a parent.

    let columnLevel =  this.column.level;
    

    Memberof

    IgxColumnComponent

    Returns number

  • get maxWidth(): string
  • Returns string

  • set maxWidth(value): void
  • Sets/gets the maximum width of the column.

    let columnMaxWidth = this.column.width;
    
    <igx-column [maxWidth] = "'150px'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get minWidth(): string
  • Returns string

  • set minWidth(value): void
  • Sets/gets the minimum width of the column. Default value is 88;

    let columnMinWidth = this.column.minWidth;
    
    <igx-column [minWidth] = "'100px'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get movable(): boolean
  • Returns boolean

  • set movable(value): void
  • Sets/gets whether the column is movable. Default value is false.

    let isMovable = this.column.movable;
    
    <igx-column [movable] = "true"></igx-column>
    

    Deprecated

    Use the Grid's moving property instead.

    Parameters

    • value: boolean

    Returns void

  • get parent(): any
  • Returns any

  • set parent(value): void
  • Sets/gets the parent column.

    let parentColumn = this.column.parent;
    
    this.column.parent = higherLevelColumn;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get pinned(): boolean
  • Returns boolean

  • set pinned(value): void
  • Gets whether the column is pinned.

    let isPinned = this.column.pinned;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get pipeArgs(): IgcColumnPipeArgs
  • Returns IgcColumnPipeArgs

  • set pipeArgs(value): void
  • Remarks

    Pass optional parameters for DatePipe and/or DecimalPipe to format the display value for date and numeric columns. Accepts an IColumnPipeArgs object with any of the format, timezone and digitsInfo properties. For more details see https://angular.io/api/common/DatePipe and https://angular.io/api/common/DecimalPipe

    Example

    const pipeArgs: IColumnPipeArgs = {
    format: 'longDate',
    timezone: 'UTC',
    digitsInfo: '1.1-2'
    }
    <igx-column dataType="date" [pipeArgs]="pipeArgs"></igx-column>
    <igx-column dataType="number" [pipeArgs]="pipeArgs"></igx-column>

    Memberof

    IgxColumnComponent

    Parameters

    Returns void

  • get resizable(): boolean
  • Returns boolean

  • set resizable(value): void
  • Sets/gets whether the column is resizable. Default value is false.

    let isResizable = this.column.resizable;
    
    <igx-column [resizable] = "true"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get rowEnd(): number
  • Returns number

  • set rowEnd(value): void
  • Row index where the current field should end. The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field

    <igx-column-layout>
    <igx-column [rowEnd]="2" [rowStart]="1" [colStart]="1"></igx-column>
    </igx-column-layout>

    Memberof

    IgxColumnComponent

    Parameters

    • value: number

    Returns void

  • get rowStart(): number
  • Returns number

  • set rowStart(value): void
  • Row index from which the field is starting.

    <igx-column-layout>
    <igx-column [rowStart]="1" [colStart]="1"></igx-column>
    </igx-column-layout>

    Memberof

    IgxColumnComponent

    Parameters

    • value: number

    Returns void

  • get searchable(): boolean
  • Returns boolean

  • set searchable(value): void
  • Sets/gets whether the column is searchable. Default value is true.

    let isSearchable =  this.column.searchable';
    
     <igx-column [searchable] = "false"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get selectable(): boolean
  • Returns boolean

  • set selectable(value): void
  • Returns if the column is selectable.

    let columnSelectable = this.column.selectable;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get selected(): boolean
  • Returns boolean

  • set selected(value): void
  • Returns if the column is selected.

    let isSelected = this.column.selected;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get sortStrategy(): IgcSortingStrategy
  • Returns IgcSortingStrategy

  • set sortStrategy(value): void
  • Gets the column sortStrategy.

    let sortStrategy = this.column.sortStrategy
    

    Memberof

    IgxColumnComponent

    Parameters

    Returns void

  • get sortable(): boolean
  • Returns boolean

  • set sortable(value): void
  • Sets/gets whether the column is sortable. Default value is false.

    let isSortable = this.column.sortable;
    
    <igx-column [sortable] = "true"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get sortingIgnoreCase(): boolean
  • Returns boolean

  • set sortingIgnoreCase(value): void
  • Sets/gets whether the column sorting should be case sensitive. Default value is true.

    let sortingIgnoreCase = this.column.sortingIgnoreCase;
    
    <igx-column [sortingIgnoreCase] = "false"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get summaries(): any
  • Returns any

  • set summaries(value): void
  • Gets the column summaries.

    let columnSummaries = this.column.summaries;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get summaryFormatter(): any
  • Returns any

  • set summaryFormatter(value): void
  • The summaryFormatter is used to format the display of the column summaries.

    In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.

    columnInit(column: IgxColumnComponent) {
    if (column.field == "OrderDate") {
    column.summaryFormatter = this.summaryFormat;
    }
    }

    summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string {
    const result = summary.summaryResult;
    if(summaryResult.key !== 'count' && result !== null && result !== undefined) {
    const pipe = new DatePipe('fr-FR');
    return pipe.transform(result,'mediumDate');
    }
    return result;
    }

    Memberof

    IgxColumnComponent

    Parameters

    • value: any

    Returns void

  • get title(): string
  • Returns string

  • set title(value): void
  • Sets/gets the title value.

    let title = this.column.title;
    
    <igx-column [title] = "'Some column tooltip'"></igx-column>
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

  • get topLevelParent(): any
  • Returns a reference to the top level parent column.

    let topLevelParent =  this.column.topLevelParent;
    

    Memberof

    IgxColumnComponent

    Returns any

  • get visibleIndex(): number
  • Gets the column visible index. If the column is not visible, returns -1.

    let visibleColumnIndex =  this.column.visibleIndex;
    

    Memberof

    IgxColumnComponent

    Returns number

  • get visibleWhenCollapsed(): boolean
  • Returns boolean

  • set visibleWhenCollapsed(value): void
  • Indicates whether the column will be visible when its parent is collapsed.

    <igx-column-group>
    <igx-column [visibleWhenCollapsed]="true"></igx-column>
    </igx-column-group>

    Memberof

    IgxColumnComponent

    Parameters

    • value: boolean

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Gets the width of the column.

    let columnWidth = this.column.width;
    

    Memberof

    IgxColumnComponent

    Parameters

    • value: string

    Returns void

Methods

  • 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

  • Autosize the column to the longest currently visible cell value, including the header cell.

    @ViewChild('grid') grid: IgxGridComponent;
    let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
    column.autosize();

    Memberof

    IgxColumnComponent

    Parameters

    • Optional byHeaderOnly: boolean

      Set if column should be autosized based only on the header content.

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

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

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

    Parameters

    • other: Node

    Returns number

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

    Parameters

    • other: Node

    Returns 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

  • Parameters

    • Optional options: FocusOptions

    Returns void

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

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

    Parameters

    • qualifiedName: string

    Returns 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

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

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

  • Returns DOMRect

  • Returns DOMRectList

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

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

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

    Parameters

    • qualifiedName: string

    Returns boolean

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

    Parameters

    • namespace: string
    • localName: string

    Returns boolean

  • Returns true if element has attributes, and false otherwise.

    Returns boolean

  • Returns whether node has children.

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: Node

    Returns T

  • Parameters

    • namespace: string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • prefix: string

    Returns string

  • Parameters

    • namespace: string

    Returns string

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

    Parameters

    • selectors: string

    Returns boolean

  • Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.

    Example

    column.move(index);
    

    Memberof

    IgxColumnComponent

    Parameters

    • index: number

    Returns void

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

  • Pins the column at the provided index in the pinned area. Defaults to index 0 if not provided, or to the initial index in the pinned area. Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. Column cannot be pinned if:

    • Is already pinned
    • index argument is out of range
    • The pinned area exceeds 80% of the grid width
    let success = this.column.pin();
    

    Memberof

    IgxColumnComponent

    Parameters

    • Optional index: number

    Returns boolean

  • 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

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

  • Returns all element descendants of node that match selectors.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

  • Parameters

    • pointerId: number

    Returns void

  • Removes node.

    Returns void

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

    Parameters

    • qualifiedName: string

    Returns void

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

    Parameters

    • namespace: string
    • localName: string

    Returns void

  • Parameters

    • attr: Attr

    Returns Attr

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

  • 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

  • Parameters

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

    Returns void

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

  • 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

  • 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

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

  • Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns 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

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • pointerId: number

    Returns void

  • 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

  • Unpins the column and place it at the provided index in the unpinned area. Defaults to index 0 if not provided, or to the initial index in the unpinned area. Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. Column cannot be unpinned if:

    • Is already unpinned
    • index argument is out of range
    let success = this.column.unpin();
    

    Memberof

    IgxColumnComponent

    Parameters

    • Optional index: number

    Returns boolean

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean