Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcColumnComponent

A column in the data grid.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

COMMENT_NODE

COMMENT_NODE: number

DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

DOCUMENT_NODE

DOCUMENT_NODE: number

DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

ELEMENT_NODE

ELEMENT_NODE: number

ENTITY_NODE

ENTITY_NODE: number

ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

NOTATION_NODE

NOTATION_NODE: number

PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

TEXT_NODE

TEXT_NODE: number

accessKey

accessKey: string

accessKeyLabel

accessKeyLabel: string

assignedSlot

assignedSlot: HTMLSlotElement | null

attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

baseURI

baseURI: string

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

childElementCount

childElementCount: number

childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

children

children: HTMLCollection

Returns the child elements.

classList

classList: DOMTokenList

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

className

className: string

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

clientHeight

clientHeight: number

clientLeft

clientLeft: number

clientTop

clientTop: number

clientWidth

clientWidth: number

contentEditable

contentEditable: string

dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

firstChild

firstChild: ChildNode | null

Returns the first child.

firstElementChild

firstElementChild: Element | null

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

hidden

hidden: boolean

id

id: string

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

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable

isContentEditable: boolean

lang

lang: string

lastChild

lastChild: ChildNode | null

Returns the last child.

lastElementChild

lastElementChild: Element | null

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

localName

localName: string

Returns the local name.

namespaceURI

namespaceURI: string | null

Returns the namespace.

nextElementSibling

nextElementSibling: Element | null

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

nextSibling

nextSibling: Node | null

Returns the next sibling.

nodeName

nodeName: string

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

nodeType

nodeType: number

nodeValue

nodeValue: string | null

nonce

nonce: string

offsetHeight

offsetHeight: number

offsetLeft

offsetLeft: number

offsetParent

offsetParent: Element | null

offsetTop

offsetTop: number

offsetWidth

offsetWidth: number

onabort

onabort: function | null

Fires when the user aborts the download.

param

The event.

onanimationcancel

onanimationcancel: function | null

onanimationend

onanimationend: function | null

onanimationiteration

onanimationiteration: function | null

onanimationstart

onanimationstart: function | null

onauxclick

onauxclick: function | null

onblur

onblur: function | null

Fires when the object loses the input focus.

param

The focus event.

oncancel

oncancel: function | null

oncanplay

oncanplay: function | null

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

param

The event.

oncanplaythrough

oncanplaythrough: function | null

onchange

onchange: function | null

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

param

The event.

onclick

onclick: function | null

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

param

The mouse event.

onclose

onclose: function | null

oncontextmenu

oncontextmenu: function | null

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

param

The mouse event.

oncopy

oncopy: function | null

oncuechange

oncuechange: function | null

oncut

oncut: function | null

ondblclick

ondblclick: function | null

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

ondrag: function | null

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

ondragend: function | null

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

param

The event.

ondragenter

ondragenter: function | null

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

param

The drag event.

ondragexit

ondragexit: function | null

ondragleave

ondragleave: function | null

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

param

The drag event.

ondragover

ondragover: function | null

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

param

The event.

ondragstart

ondragstart: function | null

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

param

The event.

ondrop

ondrop: function | null

ondurationchange

ondurationchange: function | null

Occurs when the duration attribute is updated.

param

The event.

onemptied

onemptied: function | null

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

param

The event.

onended

onended: function | null

Occurs when the end of playback is reached.

param

The event

onerror

onerror: ErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

onfocus: function | null

Fires when the object receives focus.

param

The event.

onfullscreenchange

onfullscreenchange: function | null

onfullscreenerror

onfullscreenerror: function | null

ongotpointercapture

ongotpointercapture: function | null

oninput

oninput: function | null

oninvalid

oninvalid: function | null

onkeydown

onkeydown: function | null

Fires when the user presses a key.

param

The keyboard event

onkeypress

onkeypress: function | null

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

onkeyup: function | null

Fires when the user releases a key.

param

The keyboard event

onload

onload: function | null

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

onloadeddata: function | null

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

param

The event.

onloadedmetadata

onloadedmetadata: function | null

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

param

The event.

onloadend

onloadend: function | null

onloadstart

onloadstart: function | null

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

onlostpointercapture: function | null

onmousedown

onmousedown: function | null

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

param

The mouse event.

onmouseenter

onmouseenter: function | null

onmouseleave

onmouseleave: function | null

onmousemove

onmousemove: function | null

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

onmouseout: function | null

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

param

The mouse event.

onmouseover

onmouseover: function | null

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

param

The mouse event.

onmouseup

onmouseup: function | null

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

param

The mouse event.

onpaste

onpaste: function | null

onpause

onpause: function | null

Occurs when playback is paused.

param

The event.

onplay

onplay: function | null

Occurs when the play method is requested.

param

The event.

onplaying

onplaying: function | null

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: function | null

onpointerdown

onpointerdown: function | null

onpointerenter

onpointerenter: function | null

onpointerleave

onpointerleave: function | null

onpointermove

onpointermove: function | null

onpointerout

onpointerout: function | null

onpointerover

onpointerover: function | null

onpointerup

onpointerup: function | null

onprogress

onprogress: function | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

onratechange: function | null

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

onreset: function | null

Fires when the user resets a form.

param

The event.

onresize

onresize: function | null

onscroll

onscroll: function | null

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

param

The event.

onsecuritypolicyviolation

onsecuritypolicyviolation: function | null

onseeked

onseeked: function | null

Occurs when the seek operation ends.

param

The event.

onseeking

onseeking: function | null

Occurs when the current playback position is moved.

param

The event.

onselect

onselect: function | null

Fires when the current selection changes.

param

The event.

onstalled

onstalled: function | null

Occurs when the download has stopped.

param

The event.

onsubmit

onsubmit: function | null

onsuspend

onsuspend: function | null

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

ontimeupdate: function | null

Occurs to indicate the current playback position.

param

The event.

ontoggle

ontoggle: function | null

ontouchcancel

ontouchcancel: function | null

ontouchend

ontouchend: function | null

ontouchmove

ontouchmove: function | null

ontouchstart

ontouchstart: function | null

ontransitioncancel

ontransitioncancel: function | null

ontransitionend

ontransitionend: function | null

ontransitionrun

ontransitionrun: function | null

ontransitionstart

ontransitionstart: function | null

onvolumechange

onvolumechange: function | null

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

param

The event.

onwaiting

onwaiting: function | null

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

param

The event.

onwheel

onwheel: function | null

outerHTML

outerHTML: string

ownerDocument

ownerDocument: Document | null

Returns the node document. Returns null for documents.

parentElement

parentElement: HTMLElement | null

Returns the parent element.

parentNode

parentNode: Node & ParentNode | null

Returns the parent.

prefix

prefix: string | null

Returns the namespace prefix.

previousElementSibling

previousElementSibling: Element | null

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

previousSibling

previousSibling: Node | null

Returns the previous sibling.

scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

scrollWidth

scrollWidth: number

shadowRoot

shadowRoot: ShadowRoot | null

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

slot

slot: string

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

spellcheck

spellcheck: boolean

style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string | null

title

title: string

translate

translate: boolean

Accessors

activationBorder

  • get activationBorder(): string
  • set activationBorder(v: string): void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number
  • set activationBorderBottomWidth(v: number): void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number
  • set activationBorderLeftWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

activationBorderRightWidth

  • get activationBorderRightWidth(): number
  • set activationBorderRightWidth(v: number): void

activationBorderTopWidth

  • get activationBorderTopWidth(): number
  • set activationBorderTopWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

actualActivationBorder

  • get actualActivationBorder(): string
  • set actualActivationBorder(v: string): void

actualBackground

  • get actualBackground(): string
  • set actualBackground(v: string): void

actualBorder

  • get actualBorder(): string
  • set actualBorder(v: string): void

  • Gets the actual border color that will be used.

    Returns string

  • Gets the actual border color that will be used.

    Parameters

    • v: string

    Returns void

actualColumnOptionsIconAlignment

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

    Returns ColumnOptionsIconAlignment

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

    Parameters

    Returns void

actualColumnOptionsIconBehavior

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

    Returns ColumnOptionsIconBehavior

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

    Parameters

    Returns void

actualColumnOptionsIconColor

  • get actualColumnOptionsIconColor(): string
  • set actualColumnOptionsIconColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualDeletedTextColor

  • get actualDeletedTextColor(): string
  • set actualDeletedTextColor(v: string): void

  • Gets the actual text color used for deleted rows.

    Returns string

  • Gets the actual text color used for deleted rows.

    Parameters

    • v: string

    Returns void

actualEditFontInfo

  • get actualEditFontInfo(): string
  • set actualEditFontInfo(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualEditOpacity

  • get actualEditOpacity(): number
  • set actualEditOpacity(v: number): void

  • Gets the actual opacity for unsaved edited cell values.

    Returns number

  • Gets the actual opacity for unsaved edited cell values.

    Parameters

    • v: number

    Returns void

actualErrorBorder

  • get actualErrorBorder(): string
  • set actualErrorBorder(v: string): void

actualHeaderText

  • get actualHeaderText(): string
  • set actualHeaderText(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualHeaderTextChange

  • get actualHeaderTextChange(): function
  • set actualHeaderTextChange(ev: function): void

  • Returns function

  • Parameters

    Returns void

actualHoverBackground

  • get actualHoverBackground(): string
  • set actualHoverBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualIsColumnOptionsEnabled

  • get actualIsColumnOptionsEnabled(): boolean
  • set actualIsColumnOptionsEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

actualIsColumnOptionsSummariesEnabled

  • get actualIsColumnOptionsSummariesEnabled(): boolean
  • set actualIsColumnOptionsSummariesEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

actualLastStickyRowBackground

  • get actualLastStickyRowBackground(): string
  • set actualLastStickyRowBackground(v: string): void

actualLineBreakMode

actualPinnedRowBackground

  • get actualPinnedRowBackground(): string
  • set actualPinnedRowBackground(v: string): void

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number
  • set actualPinnedRowOpacity(v: number): void

actualRowHoverTextColor

  • get actualRowHoverTextColor(): string
  • set actualRowHoverTextColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualSelectedBackground

  • get actualSelectedBackground(): string
  • set actualSelectedBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualStickyRowBackground

  • get actualStickyRowBackground(): string
  • set actualStickyRowBackground(v: string): void

actualTextColor

  • get actualTextColor(): string
  • set actualTextColor(v: string): void

animationSettings

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

    Returns IgcGridColumnAnimationSettings

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

    Parameters

    Returns void

background

  • get background(): string
  • set background(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

border

  • get border(): string
  • set border(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number
  • set borderBottomWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number
  • set borderLeftWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number
  • set borderRightWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number
  • set borderTopWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

cellStyleKeyRequested

  • get cellStyleKeyRequested(): function
  • set cellStyleKeyRequested(ev: function): void

columnOptionsIconAlignment

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

    Returns ColumnOptionsIconAlignment

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

    Parameters

    Returns void

columnOptionsIconBehavior

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

    Returns ColumnOptionsIconBehavior

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

    Parameters

    Returns void

columnOptionsIconColor

  • get columnOptionsIconColor(): string
  • set columnOptionsIconColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

contentOpacity

  • get contentOpacity(): number
  • set contentOpacity(v: number): void

dataBinding

  • get dataBinding(): function
  • set dataBinding(ev: function): void

dataBound

  • get dataBound(): function
  • set dataBound(ev: function): void

deletedTextColor

  • get deletedTextColor(): string
  • set deletedTextColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

editOpacity

  • get editOpacity(): number
  • set editOpacity(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

errorBorder

  • get errorBorder(): string
  • set errorBorder(v: string): void

  • Gets or sets the error border color to use.

    Returns string

  • Gets or sets the error border color to use.

    Parameters

    • v: string

    Returns void

errorBorderBottomWidth

  • get errorBorderBottomWidth(): number
  • set errorBorderBottomWidth(v: number): void

errorBorderLeftWidth

  • get errorBorderLeftWidth(): number
  • set errorBorderLeftWidth(v: number): void

errorBorderRightWidth

  • get errorBorderRightWidth(): number
  • set errorBorderRightWidth(v: number): void

errorBorderTopWidth

  • get errorBorderTopWidth(): number
  • set errorBorderTopWidth(v: number): void

field

  • get field(): string
  • set field(v: string): void

  • Gets or sets the key used for the column binding

    Returns string

  • Gets or sets the key used for the column binding

    Parameters

    • v: string

    Returns void

filter

  • get filter(): ColumnFilterCondition
  • set filter(v: ColumnFilterCondition): void

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

    Returns ColumnFilterCondition

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

    Parameters

    • v: ColumnFilterCondition

    Returns void

header

  • Gets or sets the header definition for this column.

    Returns IgcHeaderComponent

  • Gets or sets the header definition for this column.

    Parameters

    Returns void

headerText

  • get headerText(): string
  • set headerText(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

horizontalAlignment

isAutoGenerated

  • get isAutoGenerated(): boolean
  • set isAutoGenerated(v: boolean): void

  • Gets whether this column was auto generated.

    Returns boolean

  • Gets whether this column was auto generated.

    Parameters

    • v: boolean

    Returns void

isColumnOptionsEnabled

  • get isColumnOptionsEnabled(): boolean
  • set isColumnOptionsEnabled(v: boolean): void

  • 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

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

    Parameters

    • v: boolean

    Returns void

isColumnOptionsSummariesEnabled

  • get isColumnOptionsSummariesEnabled(): boolean
  • set isColumnOptionsSummariesEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isEditable

  • get isEditable(): boolean
  • set isEditable(v: boolean): void

  • Gets or sets if the column is editable.

    Returns boolean

  • Gets or sets if the column is editable.

    Parameters

    • v: boolean

    Returns void

isFilteringEnabled

  • get isFilteringEnabled(): boolean
  • set isFilteringEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isFromMarkup

  • get isFromMarkup(): boolean
  • set isFromMarkup(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isResizingEnabled

  • get isResizingEnabled(): boolean
  • set isResizingEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string
  • set lastStickyRowBackground(v: string): void

lineBreakMode

minWidth

  • get minWidth(): number
  • set minWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

name

  • get name(): string
  • set name(v: string): void

  • Gets or sets an unique name of the Column

    Returns string

  • Gets or sets an unique name of the Column

    Parameters

    • v: string

    Returns void

paddingBottom

  • get paddingBottom(): number
  • set paddingBottom(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingLeft

  • get paddingLeft(): number
  • set paddingLeft(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingRight

  • get paddingRight(): number
  • set paddingRight(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingTop

  • get paddingTop(): number
  • set paddingTop(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

pinned

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

    Returns PinnedPositions

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

    Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string
  • set pinnedRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number
  • set pinnedRowOpacity(v: number): void

rowHoverBackground

  • get rowHoverBackground(): string
  • set rowHoverBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

rowHoverTextColor

  • get rowHoverTextColor(): string
  • set rowHoverTextColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

selectedBackground

  • get selectedBackground(): string
  • set selectedBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

shouldRemoveWhenHidden

  • get shouldRemoveWhenHidden(): boolean
  • set shouldRemoveWhenHidden(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

sortDirection

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

    Returns ColumnSortDirection

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

    Parameters

    Returns void

stickyRowBackground

  • get stickyRowBackground(): string
  • set stickyRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string
  • set textColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

textEditStyle

  • get textEditStyle(): string
  • set textEditStyle(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string
  • set textStyle(v: string): void

verticalAlignment

width

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

    Returns IgcColumnWidth

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

    Parameters

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

Methods

addEventListener

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

  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

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

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

after

  • after(...nodes: (string | Node)[]): void

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

animate

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

  • Parameters

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

    Returns Animation

append

  • append(...nodes: (string | Node)[]): void

  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

appendChild

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

  • Type parameters

    • T: Node

    Parameters

    • newChild: T

    Returns T

attachShadow

  • attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot

  • Creates a shadow root for element and returns it.

    Parameters

    • shadowRootInitDict: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

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

before

  • before(...nodes: (string | Node)[]): void

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

blur

  • blur(): void

  • Returns void

click

  • click(): void

  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node

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

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector: K): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest(selector: string): Element | null

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

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Parameters

    • selector: string

    Returns Element | null

compareDocumentPosition

  • compareDocumentPosition(other: Node): number

  • Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void

contains

  • contains(other: Node | null): boolean

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

    Parameters

    • other: Node | null

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): boolean

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

    Parameters

    • event: Event

    Returns boolean

findByName

  • findByName(name: string): any

focus

  • focus(options?: FocusOptions): void

  • Parameters

    • Optional options: FocusOptions

    Returns void

getAnimations

  • getAnimations(): Animation[]

  • Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): string | null

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

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

  • getAttributeNS(namespace: string | null, localName: string): string | null

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    Parameters

    • namespace: string | null
    • localName: string

    Returns string | null

getAttributeNames

  • getAttributeNames(): string[]

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

    Returns string[]

getAttributeNode

  • getAttributeNode(name: string): Attr | null

  • Parameters

    • name: string

    Returns Attr | null

getAttributeNodeNS

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

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • getBoundingClientRect(): ClientRect | DOMRect

  • Returns ClientRect | DOMRect

getClientRects

  • getClientRects(): ClientRectList | DOMRectList

  • Returns ClientRectList | DOMRectList

getElementsByClassName

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

  • Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

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

  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

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

  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getNamedHeaderValue

  • getNamedHeaderValue(valueName: string): 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: string): 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?: GetRootNodeOptions): Node

  • Returns node's shadow-including root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

getUniqueKey

  • getUniqueKey(): string

  • Get the unique key used to identify this column.

    Returns string

hasAttribute

  • hasAttribute(qualifiedName: string): boolean

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

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: string | null, localName: string): boolean

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

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

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

hasNamedHeaderValue

  • hasNamedHeaderValue(valueName: string): 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: string): 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

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean

  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

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

  • Parameters

    • position: InsertPosition
    • insertedElement: Element

    Returns Element | null

insertAdjacentHTML

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

  • Parameters

    • where: InsertPosition
    • html: string

    Returns void

insertAdjacentText

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

  • Parameters

    • where: InsertPosition
    • text: string

    Returns void

insertBefore

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

  • Type parameters

    • T: Node

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: string | null): boolean

  • Parameters

    • namespace: string | null

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: Node | null): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

  • isSameNode(otherNode: Node | null): boolean

  • Parameters

    • otherNode: Node | null

    Returns boolean

lookupNamespaceURI

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

  • Parameters

    • prefix: string | null

    Returns string | null

lookupPrefix

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

  • Parameters

    • namespace: string | null

    Returns string | null

matches

  • matches(selectors: string): boolean

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

    Parameters

    • selectors: string

    Returns boolean

msGetRegionContent

  • msGetRegionContent(): any

  • Returns any

normalize

  • normalize(): void

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

    Returns void

prepend

  • prepend(...nodes: (string | Node)[]): void

  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

querySelector

  • querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null

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

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

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

  • Returns all element descendants of node that match selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void

  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace: string | null, localName: string): void

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

removeChild

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

  • Type parameters

    • T: Node

    Parameters

    • oldChild: T

    Returns T

removeEventListener

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

  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

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

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

removeNamedHeaderValue

  • removeNamedHeaderValue(valueName: string): 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: string): void

  • Removes the named value from this definition by name.

    Parameters

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

    Returns void

replaceChild

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

  • Type parameters

    • T: Node

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • replaceWith(...nodes: (string | Node)[]): void

  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

requestFullscreen

  • requestFullscreen(): Promise<void>

  • Displays element fullscreen and resolves promise when done.

    Returns Promise<void>

scroll

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

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

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

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

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

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

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

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName: string, value: string): void

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

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void

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

    Parameters

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

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): Attr | null

  • Parameters

    • attr: Attr

    Returns Attr | null

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): Attr | null

  • Parameters

    • attr: Attr

    Returns Attr | null

setNamedHeaderValue

  • Parameters

    Returns void

setNamedValue

setPointerCapture

  • setPointerCapture(pointerId: number): void

  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean

  • Parameters

    • selectors: string

    Returns boolean

Static _createFromInternal