Class IgcSpreadsheetComponent

Custom control that displays one or more worksheets.

Hierarchy

cons
- IgcSpreadsheetComponent

Constructors

Properties

Methods

Constructors

constructor

new IgcSpreadsheetComponent(): IgcSpreadsheetComponent
Overrides IgcHTMLElement.constructor
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:46
Returns IgcSpreadsheetComponent

Properties

`Readonly` ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

`Readonly` CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

`Readonly` COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

`Readonly` DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

`Readonly` DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

`Readonly` DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

`Readonly` DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

`Readonly` DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

`Readonly` DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

`Readonly` DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

`Readonly` ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

`Readonly` ENTITY_NODE

ENTITY_NODE: number

`Readonly` ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

`Readonly` NOTATION_NODE

NOTATION_NODE: number

`Readonly` PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

`Readonly` TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

`Readonly` accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: string

ariaAutoComplete

ariaAutoComplete: string

ariaBusy

ariaBusy: string

ariaChecked

ariaChecked: string

ariaColCount

ariaColCount: string

ariaColIndex

ariaColIndex: string

ariaColIndexText

ariaColIndexText: string

ariaColSpan

ariaColSpan: string

ariaCurrent

ariaCurrent: string

ariaDisabled

ariaDisabled: string

ariaExpanded

ariaExpanded: string

ariaHasPopup

ariaHasPopup: string

ariaHidden

ariaHidden: string

ariaInvalid

ariaInvalid: string

ariaKeyShortcuts

ariaKeyShortcuts: string

ariaLabel

ariaLabel: string

ariaLevel

ariaLevel: string

ariaLive

ariaLive: string

ariaModal

ariaModal: string

ariaMultiLine

ariaMultiLine: string

ariaMultiSelectable

ariaMultiSelectable: string

ariaOrientation

ariaOrientation: string

ariaPlaceholder

ariaPlaceholder: string

ariaPosInSet

ariaPosInSet: string

ariaPressed

ariaPressed: string

ariaReadOnly

ariaReadOnly: string

ariaRequired

ariaRequired: string

ariaRoleDescription

ariaRoleDescription: string

ariaRowCount

ariaRowCount: string

ariaRowIndex

ariaRowIndex: string

ariaRowIndexText

ariaRowIndexText: string

ariaRowSpan

ariaRowSpan: string

ariaSelected

ariaSelected: string

ariaSetSize

ariaSetSize: string

ariaSort

ariaSort: string

ariaValueMax

ariaValueMax: string

ariaValueMin

ariaValueMin: string

ariaValueNow

ariaValueNow: string

ariaValueText

ariaValueText: string

`Readonly` assignedSlot

assignedSlot: HTMLSlotElement

`Readonly` attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

`Readonly` baseURI

baseURI: string

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

`Readonly` childElementCount

childElementCount: number

`Readonly` childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

`Readonly` children

children: HTMLCollection

Returns the child elements.

`Readonly` classList

classList: DOMTokenList

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

className

className: string

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

`Readonly` clientHeight

clientHeight: number

`Readonly` clientLeft

clientLeft: number

`Readonly` clientTop

clientTop: number

`Readonly` clientWidth

clientWidth: number

contentEditable

contentEditable: string

`Readonly` dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

`Readonly` firstChild

firstChild: ChildNode

Returns the first child.

`Readonly` firstElementChild

firstElementChild: Element

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

hidden

hidden: boolean

id

id: string

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

inert

inert: boolean

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

`Readonly` isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

`Readonly` isContentEditable

isContentEditable: boolean

lang

lang: string

`Readonly` lastChild

lastChild: ChildNode

Returns the last child.

`Readonly` lastElementChild

lastElementChild: Element

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

`Readonly` localName

localName: string

Returns the local name.

`Readonly` namespaceURI

namespaceURI: string

Returns the namespace.

`Readonly` nextElementSibling

nextElementSibling: Element

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

`Readonly` nextSibling

nextSibling: ChildNode

Returns the next sibling.

`Readonly` nodeName

nodeName: string

Returns a string appropriate for the type of node.

`Readonly` nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: string

`Optional` nonce

nonce?: string

`Readonly` offsetHeight

offsetHeight: number

`Readonly` offsetLeft

offsetLeft: number

`Readonly` offsetParent

offsetParent: Element

`Readonly` offsetTop

offsetTop: number

`Readonly` offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: UIEvent
    The event.
  Returns any

onanimationcancel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationend

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationiteration

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationstart

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onauxclick

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onbeforeinput

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: InputEvent
  Returns any

onblur

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

Fires when the object loses the input focus.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FocusEvent
    The focus event.
  Returns any

oncancel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncanplay

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

oncanplaythrough

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onchange

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onclick

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onclose

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncontextmenu

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

oncopy

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

Type declaration

- (this, ev): any
- Parameters
  - this: DocumentAndElementEventHandlers
  - ev: ClipboardEvent
  Returns any

oncuechange

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncut

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

Type declaration

- (this, ev): any
- Parameters
  - this: DocumentAndElementEventHandlers
  - ev: ClipboardEvent
  Returns any

ondblclick

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

Fires when the user double-clicks the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

ondrag

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

Fires on the source object continuously during a drag operation.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The event.
  Returns any

ondragend

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The event.
  Returns any

ondragenter

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The drag event.
  Returns any

ondragleave

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The drag event.
  Returns any

ondragover

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The event.
  Returns any

ondragstart

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
    The event.
  Returns any

ondrop

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

ondurationchange

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

Occurs when the duration attribute is updated.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onemptied

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onended

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

Occurs when the end of playback is reached.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event
  Returns any

onerror

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

onfocus

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

Fires when the object receives focus.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FocusEvent
    The event.
  Returns any

onformdata

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FormDataEvent
  Returns any

onfullscreenchange

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

Type declaration

- (this, ev): any
- Parameters
  - this: Element
  - ev: Event
  Returns any

onfullscreenerror

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

Type declaration

- (this, ev): any
- Parameters
  - this: Element
  - ev: Event
  Returns any

ongotpointercapture

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

oninput

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oninvalid

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onkeydown

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

Fires when the user presses a key.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
    The keyboard event
  Returns any

onkeypress

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

Fires when the user presses an alphanumeric key.

Deprecated

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
    The event.
  Returns any

onkeyup

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

Fires when the user releases a key.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
    The keyboard event
  Returns any

onload

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

Fires immediately after the browser loads the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onloadeddata

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onloadedmetadata

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onlostpointercapture

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onmousedown

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onmouseenter

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onmouseleave

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onmousemove

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

Fires when the user moves the mouse over the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onmouseout

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onmouseover

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onmouseup

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
    The mouse event.
  Returns any

onpaste

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

Type declaration

- (this, ev): any
- Parameters
  - this: DocumentAndElementEventHandlers
  - ev: ClipboardEvent
  Returns any

onpause

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

Occurs when playback is paused.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onplay

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

Occurs when the play method is requested.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onplaying

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

Occurs when the audio or video has started playing.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onpointercancel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerdown

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerenter

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerleave

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointermove

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerout

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerover

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerup

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onprogress

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

Occurs to indicate progress while downloading media data.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: ProgressEvent<EventTarget>
    The event.
  Returns any

onratechange

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

Occurs when the playback rate is increased or decreased.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onreset

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

Fires when the user resets a form.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onresize

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: UIEvent
  Returns any

onscroll

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onsecuritypolicyviolation

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: SecurityPolicyViolationEvent
  Returns any

onseeked

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

Occurs when the seek operation ends.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onseeking

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

Occurs when the current playback position is moved.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onselect

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

Fires when the current selection changes.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onselectionchange

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onselectstart

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onslotchange

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onstalled

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

Occurs when the download has stopped.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onsubmit

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: SubmitEvent
  Returns any

onsuspend

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

Occurs if the load operation has been intentionally halted.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

ontimeupdate

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

Occurs to indicate the current playback position.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

ontoggle

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

`Optional` ontouchcancel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchend

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchmove

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchstart

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

ontransitioncancel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionend

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionrun

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionstart

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

onvolumechange

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onwaiting

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

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
    The event.
  Returns any

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onwheel

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

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: WheelEvent
  Returns any

outerHTML

outerHTML: string

outerText

outerText: string

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` parentElement

parentElement: HTMLElement

Returns the parent element.

`Readonly` parentNode

parentNode: ParentNode

Returns the parent.

`Readonly` part

part: DOMTokenList

`Readonly` prefix

prefix: string

Returns the namespace prefix.

`Readonly` previousElementSibling

previousElementSibling: Element

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

`Readonly` previousSibling

previousSibling: ChildNode

Returns the previous sibling.

role

role: string

`Readonly` scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

`Readonly` scrollWidth

scrollWidth: number

`Readonly` shadowRoot

shadowRoot: ShadowRoot

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

slot

slot: string

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

spellcheck

spellcheck: boolean

`Readonly` style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

`Readonly` tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string

title

title: string

translate

translate: boolean

`Static` htmlTagName

htmlTagName: string

Accessors

CommandExecuted

get CommandExecuted(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:321
Invoked when an action is executed on the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that was executed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActionExecutedEventArgs
    Returns void
set CommandExecuted(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:322
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActionExecutedEventArgs
      Returns void
Returns void

CommandExecuting

get CommandExecuting(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:332
Invoked when an action is about to be executed by the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that is about to be executed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActionExecutingEventArgs
    Returns void
set CommandExecuting(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:333
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActionExecutingEventArgs
      Returns void
Returns void

activeCell

get activeCell(): SpreadsheetCell
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:97
Returns or sets the active cell within the selected worksheet.

Returns SpreadsheetCell
set activeCell(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:98
Parameters
- v: SpreadsheetCell
Returns void

activeCellChanged

get activeCellChanged(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:345
Invoked when the activeCell of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldValue" argType="string" Gets the previous active cell. eventArgument="ui.newValue" argType="string" Gets the current active cell.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActiveCellChangedEventArgs
    Returns void
set activeCellChanged(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:346
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActiveCellChangedEventArgs
      Returns void
Returns void

activePane

get activePane(): SpreadsheetPane
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:102
Returns an object that represents the pane with the focus.

Returns SpreadsheetPane
set activePane(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:103
Parameters
- v: SpreadsheetPane
Returns void

activePaneChanged

get activePaneChanged(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:360
Invoked when the activePane of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActivePane" argType="object" Gets the previous active pane. eventArgument="ui.newActivePane" argType="object" Gets the current active pane. eventArgument="ui.activeCell" argType="string" Gets the active cell of the new active pane or null if there is no active pane. eventArgument="ui.visibleRange" argType="string" Gets the current visible range of the new active pane or null if there is no active pane.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActivePaneChangedEventArgs
    Returns void
set activePaneChanged(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:361
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActivePaneChangedEventArgs
      Returns void
Returns void

activeSelection

get activeSelection(): SpreadsheetSelection
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:108
Returns an object that represents the current selection of the activePane.

Returns SpreadsheetSelection
set activeSelection(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:109
Parameters
- v: SpreadsheetSelection
Returns void

activeSelectionCellRangeFormat

get activeSelectionCellRangeFormat(): SpreadsheetCellRangeFormat
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:119
Returns an object used to get the formatting of the activeCell and where modifications are applied to the entire activeSelection. Any changes made to this object will affect all the objects in the selection. So for example, the Font.Name may return "Arial" because the active cell has that as its resolved font name even though the other cells are using a different font but if you set the Font.Name of this object to "Arial" then all the objects affected by the selection will have their Font.Name updated to that value.

Returns SpreadsheetCellRangeFormat

activeTable

get activeTable(): WorksheetTable
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:126
Returns the ig.excel.WorksheetTable associated with the activeCell of the activeWorksheet.

Returns WorksheetTable
set activeTable(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:127
Parameters
- v: WorksheetTable
Returns void

activeTableChanged

get activeTableChanged(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:373
Invoked when the activeTable of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveTable" argType="object" Gets the previous active Table. eventArgument="ui.newActiveTable" argType="object" Gets the current active Table.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActiveTableChangedEventArgs
    Returns void
set activeTableChanged(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:374
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActiveTableChangedEventArgs
      Returns void
Returns void

activeWorksheet

get activeWorksheet(): Worksheet
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:132
Returns or sets the Worksheet from the workbook whose content should be displayed within the control.

Returns Worksheet
set activeWorksheet(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:133
Parameters
- v: Worksheet
Returns void

activeWorksheetChanged

get activeWorksheetChanged(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:388
Invoked when the activeWorksheet of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveWorksheet" argType="object" Gets the previous active worksheet. eventArgument="ui.oldActiveWorksheetName" argType="string" Gets the name of the previous active worksheet or null if oldActiveWorksheet is null. eventArgument="ui.newActiveWorksheet" argType="object" Gets the current active worksheet. eventArgument="ui.newActiveWorksheetName" argType="string" Gets the name of the new active worksheet or null if newActiveWorksheet is null.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetActiveWorksheetChangedEventArgs
    Returns void
set activeWorksheetChanged(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:389
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetActiveWorksheetChangedEventArgs
      Returns void
Returns void

allowAddWorksheet

get allowAddWorksheet(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:137
Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets.

Returns boolean
set allowAddWorksheet(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:138
Parameters
- v: boolean
Returns void

allowDeleteWorksheet

get allowDeleteWorksheet(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:142
Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets.

Returns boolean
set allowDeleteWorksheet(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:143
Parameters
- v: boolean
Returns void

areGridlinesVisible

get areGridlinesVisible(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:147
Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets.

Returns boolean
set areGridlinesVisible(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:148
Parameters
- v: boolean
Returns void

areHeadersVisible

get areHeadersVisible(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:152
Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets.

Returns boolean
set areHeadersVisible(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:153
Parameters
- v: boolean
Returns void

cellEditMode

get cellEditMode(): SpreadsheetCellEditMode
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:157
Returns an enumeration used to indicate the current edit mode state.

Returns SpreadsheetCellEditMode
set cellEditMode(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:158
Parameters
- v: SpreadsheetCellEditMode
Returns void

chartAdapter

get chartAdapter(): SpreadsheetChartAdapterBase
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:168
Returns or sets the object that will provide the chart visualization for display within the Spreadsheet By default charts are not displayed within the spreadsheet. To display charts one should set this property to an instance of a SpreadsheetChartAdapter which is in a separate reference since it relies upon the chart and other data visualization controls.

Returns SpreadsheetChartAdapterBase
set chartAdapter(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:169
Parameters
- v: SpreadsheetChartAdapterBase
Returns void

contextMenuOpening

get contextMenuOpening(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:310
Invoked when a contextmenu is being opened for the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.menuArea" argType="string" Get the area for which the menu is being displayed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetContextMenuOpeningEventArgs
    Returns void
set contextMenuOpening(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:311
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetContextMenuOpeningEventArgs
      Returns void
Returns void

editModeEntered

get editModeEntered(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:439
Invoked when the Spreadsheet has started in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has entered edit mode.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditModeEnteredEventArgs
    Returns void
set editModeEntered(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:440
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditModeEnteredEventArgs
      Returns void
Returns void

editModeEntering

get editModeEntering(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:427
Invoked when the Spreadsheet is about to start in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control is going into edit mode.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditModeEnteringEventArgs
    Returns void
set editModeEntering(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:428
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditModeEnteringEventArgs
      Returns void
Returns void

editModeExited

get editModeExited(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:415
Invoked when the Spreadsheet has ended the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has exited edit mode.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditModeExitedEventArgs
    Returns void
set editModeExited(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:416
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditModeExitedEventArgs
      Returns void
Returns void

editModeExiting

get editModeExiting(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:403
Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.acceptChanges" argType="bool" Get or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. eventArgument="ui.cell" argType="string" Gets the cell for which the control is exiting edit mode. eventArgument="ui.editText" argType="string" Gets the edit text that will be used to update the cell(s).

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditModeExitingEventArgs
    Returns void
set editModeExiting(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:404
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditModeExitingEventArgs
      Returns void
Returns void

editModeValidationError

get editModeValidationError(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:471
Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Get or set the action to take in response to the failed validation. eventArgument="ui.canStayInEditMode" argType="bool" Get a boolean indicating whether the cell is allowed to stay in edit mode. eventArgument="ui.cell" argType="string" Gets the cell for which the control is in edit mode. eventArgument="ui.validationRule" argType="string" Get the rule which failed validation. The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should be taken using the action. Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit. Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt . Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditModeValidationErrorEventArgs
    Returns void
set editModeValidationError(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:472
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditModeValidationErrorEventArgs
      Returns void
Returns void

editRangePasswordNeeded

get editRangePasswordNeeded(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:483
Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.ranges" argType="array" Get an array of protected range objects that should be unlocked. eventArgument="ui.unprotect" argType="object" Get a parameterless function that may be invoked to unlock the associated ranges.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetEditRangePasswordNeededEventArgs
    Returns void
set editRangePasswordNeeded(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:484
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetEditRangePasswordNeededEventArgs
      Returns void
Returns void

enterKeyNavigationDirection

get enterKeyNavigationDirection(): SpreadsheetEnterKeyNavigationDirection
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:177
Returns or sets an enumeration indicating the direction of the cell adjacent to the activeCell that should be activated when the enter key is pressed. This property is only used if the isEnterKeyNavigationEnabled is set to true. Also, the reverse direction is navigated when Shift + Enter are pressed.

Returns SpreadsheetEnterKeyNavigationDirection
set enterKeyNavigationDirection(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:178
Parameters
- v: SpreadsheetEnterKeyNavigationDirection
Returns void

fixedDecimalPlaceCount

get fixedDecimalPlaceCount(): number
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:183
Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true

Returns number
set fixedDecimalPlaceCount(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:184
Parameters
- v: number
Returns void

height

get height(): string
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:41
Returns string
set height(value): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:40
Parameters
- value: string
Returns void

hyperlinkExecuting

get hyperlinkExecuting(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:494
Invoked when a hyperlink is being followed in the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.hyperlink" argType="object" Get the hyperlink to be executed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetHyperlinkExecutingEventArgs
    Returns void
set hyperlinkExecuting(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:495
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetHyperlinkExecutingEventArgs
      Returns void
Returns void

isEnterKeyNavigationEnabled

get isEnterKeyNavigationEnabled(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:189
Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed.

Returns boolean
set isEnterKeyNavigationEnabled(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:190
Parameters
- v: boolean
Returns void

isFixedDecimalEnabled

get isFixedDecimalEnabled(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:194
Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode.

Returns boolean
set isFixedDecimalEnabled(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:195
Parameters
- v: boolean
Returns void

isFormulaBarVisible

get isFormulaBarVisible(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:200
Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet.

Returns boolean
set isFormulaBarVisible(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:201
Parameters
- v: boolean
Returns void

isInEditMode

get isInEditMode(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:206
Returns a boolean indicating if the control is currently editing the value of the activeCell

Returns boolean
set isInEditMode(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:207
Parameters
- v: boolean
Returns void

isInEndMode

get isInEndMode(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:216
Returns or sets a boolean indicating whether the control is in "End mode". End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell that has a value (even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End mode will end automatically such as when one presses an arrow key.

Returns boolean
set isInEndMode(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:217
Parameters
- v: boolean
Returns void

isRenamingWorksheet

get isRenamingWorksheet(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:221
Returns a boolean indicating if the user is currently editing the name of the active worksheet.

Returns boolean
set isRenamingWorksheet(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:222
Parameters
- v: boolean
Returns void

isScrollLocked

get isScrollLocked(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:92
Returns or sets a boolean indicating whether the scroll lock key is toggled. This property is used when certain keys are pressed while the control has focus. For example if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing the active cell. Note: This property is not maintained/changed by the control. It is just queried when performing actions that consider whether the scroll lock is enabled.

Returns boolean
set isScrollLocked(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:93
Parameters
- v: boolean
Returns void

isUndoEnabled

get isUndoEnabled(): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:226
Returns or sets a boolean indicating whether undo is enabled for the control.

Returns boolean
set isUndoEnabled(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:227
Parameters
- v: boolean
Returns void

nameBoxWidth

get nameBoxWidth(): number
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:231
Returns or sets the width of the name box within the formula bar.

Returns number
set nameBoxWidth(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:232
Parameters
- v: number
Returns void

panes

get panes(): SpreadsheetPane[]
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:69
Returns an array of the panes for the activeWorksheet.

Returns SpreadsheetPane[]

selectedWorksheets

get selectedWorksheets(): Worksheet[]
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:241
Returns or sets an array of the Worksheets whose tabs are selected.

Returns Worksheet[]
set selectedWorksheets(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:242
Parameters
- v: Worksheet[]
Returns void

selectionChanged

get selectionChanged(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:506
Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.pane" argType="object" Get the pane for which the selection has changed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetSelectionChangedEventArgs
    Returns void
set selectionChanged(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:507
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetSelectionChangedEventArgs
      Returns void
Returns void

selectionMode

get selectionMode(): SpreadsheetCellSelectionMode
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:236
Returns or sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard.

Returns SpreadsheetCellSelectionMode
set selectionMode(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:237
Parameters
- v: SpreadsheetCellSelectionMode
Returns void

undoManager

get undoManager(): UndoManager
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:248
Returns or sets the UndoManager. Note: this property can not be set to null.

Returns UndoManager
set undoManager(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:249
Parameters
- v: UndoManager
Returns void

userPromptDisplaying

get userPromptDisplaying(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:520
Invoked when the user will be prompted with a message regarding an operation that is being performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the operation that triggered the prompt can be cancelled. eventArgument="ui.displayMessage" argType="bool" Get a boolean indicating if a message will be displayed to the end user. eventArgument="ui.exception" argType="object" Gets the exception for the error, if there was one. eventArgument="ui.message" argType="string" Get or set the message that will be displayed. eventArgument="ui.trigger" argType="string" Get the action that caused the prompt to be displayed.

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetUserPromptDisplayingEventArgs
    Returns void
set userPromptDisplaying(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:521
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetUserPromptDisplayingEventArgs
      Returns void
Returns void

validationInputMessagePosition

get validationInputMessagePosition(): IgPoint
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:253
Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell.

Returns IgPoint
set validationInputMessagePosition(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:254
Parameters
- v: IgPoint
Returns void

width

get width(): string
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:43
Returns string
set width(value): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:42
Parameters
- value: string
Returns void

workbook

get workbook(): Workbook
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:259
Returns or sets the workbook whose information is displayed in the control.

Returns Workbook
set workbook(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:260
Parameters
- v: Workbook
Returns void

workbookDirtied

get workbookDirtied(): ((s, e) => void)
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:536
Invoked when a change has been made to the workbook that might require a save. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. Note: This event is invoked asynchronously with regards to the change(s) that have occurred. Also some changes alone are not considered to dirty the Workbook even though it does change state on the Workbook or one of its subobjects. An example of that would be a zoom type operation (e.g. changing the magnificationInNormalView).

Returns ((s, e) => void)
- - (s, e): void
  - Parameters
    - s: IgcSpreadsheetComponent
    - e: IgcSpreadsheetWorkbookDirtiedEventArgs
    Returns void
set workbookDirtied(ev): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:537
Parameters
- ev: ((s, e) => void)
  - - (s, e): void
    - Parameters
      - s: IgcSpreadsheetComponent
      - e: IgcSpreadsheetWorkbookDirtiedEventArgs
      Returns void
Returns void

zoomLevel

get zoomLevel(): number
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:264
Returns or sets the magnification of the selected worksheets.

Returns number
set zoomLevel(v): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:265
Parameters
- v: number
Returns void

`Static` observedAttributes

get observedAttributes(): string[]
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:77
Returns string[]

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Inherited from IgcHTMLElement.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6535
Type parameters
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      - this: HTMLElement
      - ev: HTMLElementEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
addEventListener(type, listener, options?): void
Inherited from IgcHTMLElement.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6536
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

after

after(...nodes): void
Inherited from IgcHTMLElement.after
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3711
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

afterContentInit

afterContentInit(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:55
Returns void

animate

animate(keyframes, options?): Animation
Inherited from IgcHTMLElement.animate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2127
Parameters
- keyframes: PropertyIndexedKeyframes | Keyframe[]
- Optional options: number | KeyframeAnimationOptions
Returns Animation

append

append(...nodes): void
Inherited from IgcHTMLElement.append
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10523
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

appendChild

appendChild<T>(node): T
Inherited from IgcHTMLElement.appendChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10110
Type parameters
Type Parameters
- T extends Node<T>
Parameters
- node: T
Returns T

attachInternals

attachInternals(): ElementInternals
Inherited from IgcHTMLElement.attachInternals
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6533
Returns ElementInternals

attachShadow

attachShadow(init): ShadowRoot
Inherited from IgcHTMLElement.attachShadow
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5045
Creates a shadow root for element and returns it.

Parameters
- init: ShadowRootInit
Returns ShadowRoot

attributeChangedCallback

attributeChangedCallback(name, oldValue, newValue): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:79
Parameters
- name: string
- oldValue: string
- newValue: string
Returns void

before

before(...nodes): void
Inherited from IgcHTMLElement.before
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3717
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
Inherited from IgcHTMLElement.blur
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7726
Returns void

click

click(): void
Inherited from IgcHTMLElement.click
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6534
Returns void

cloneNode

cloneNode(deep?): Node
Inherited from IgcHTMLElement.cloneNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10112
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

Parameters
- Optional deep: boolean
Returns Node

closest

closest<K>(selector): HTMLElementTagNameMap[K]
Inherited from IgcHTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5047
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

Type parameters
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selector: K
Returns HTMLElementTagNameMap[K]
closest<K>(selector): SVGElementTagNameMap[K]
Inherited from IgcHTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5048
Type parameters
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selector: K
Returns SVGElementTagNameMap[K]
closest<E>(selectors): E
Inherited from IgcHTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5049
Type parameters
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns E

compareDocumentPosition

compareDocumentPosition(other): number
Inherited from IgcHTMLElement.compareDocumentPosition
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10114
Returns a bitmask indicating the position of other relative to node.

Parameters
- other: Node
Returns number

connectedCallback

connectedCallback(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:54
Returns void

containerResized

containerResized(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:279
Notifies the spreadsheet that the container object has been resized.

Returns void

contains

contains(other): boolean
Inherited from IgcHTMLElement.contains
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10116
Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters
- other: Node
Returns boolean

createShadow

createShadow(): ShadowRoot
Inherited from IgcHTMLElement.createShadow
- Defined in node_modules/igniteui-webcomponents-core/lib/igc-html-element.d.ts:3
Returns ShadowRoot

destroy

destroy(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:47
Returns void

disconnectedCallback

disconnectedCallback(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:53
Returns void

dispatchEvent

dispatchEvent(event): boolean
Inherited from IgcHTMLElement.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5309
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

executeAction

executeAction(action): boolean
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:285
Executes the specified action.

Parameters
- action: SpreadsheetAction
  - Identifies the action to be performed.
Returns boolean

exportVisualData

exportVisualData(): any
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:300
Returns an object with information about the visual state of the spreadsheet.

Returns any

findByName

findByName(name): any
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:266
Parameters
- name: string
Returns any

flush

flush(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:290
Forces the spreadsheet to synchronously perform any deferred work.

Returns void

focus

focus(options?): void
Inherited from IgcHTMLElement.focus
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7727
Parameters
- Optional options: FocusOptions
Returns void

getAnimations

getAnimations(options?): Animation[]
Inherited from IgcHTMLElement.getAnimations
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2128
Parameters
- Optional options: GetAnimationsOptions
Returns Animation[]

getAttribute

getAttribute(qualifiedName): string
Inherited from IgcHTMLElement.getAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5051
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

Parameters
- qualifiedName: string
Returns string

getAttributeNS

getAttributeNS(namespace, localName): string
Inherited from IgcHTMLElement.getAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5053
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

Parameters
- namespace: string
- localName: string
Returns string

getAttributeNames

getAttributeNames(): string[]
Inherited from IgcHTMLElement.getAttributeNames
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5055
Returns the qualified names of all element's attributes. Can contain duplicates.

Returns string[]

getAttributeNode

getAttributeNode(qualifiedName): Attr
Inherited from IgcHTMLElement.getAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5056
Parameters
- qualifiedName: string
Returns Attr

getAttributeNodeNS

getAttributeNodeNS(namespace, localName): Attr
Inherited from IgcHTMLElement.getAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5057
Parameters
- namespace: string
- localName: string
Returns Attr

getBoundingClientRect

getBoundingClientRect(): DOMRect
Inherited from IgcHTMLElement.getBoundingClientRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5058
Returns DOMRect

getClientRects

getClientRects(): DOMRectList
Inherited from IgcHTMLElement.getClientRects
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5059
Returns DOMRectList

getElementsByClassName

getElementsByClassName(classNames): HTMLCollectionOf<Element>
Inherited from IgcHTMLElement.getElementsByClassName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5061
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

Parameters
- classNames: string
Returns HTMLCollectionOf<Element>

getElementsByTagName

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from IgcHTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5062
Type parameters
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from IgcHTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5063
Type parameters
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<SVGElementTagNameMap[K]>
getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>
Inherited from IgcHTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5064
Parameters
- qualifiedName: string
Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>
Inherited from IgcHTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5065
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- localName: string
Returns HTMLCollectionOf<HTMLElement>
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>
Inherited from IgcHTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5066
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- localName: string
Returns HTMLCollectionOf<SVGElement>
getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>
Inherited from IgcHTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5067
Parameters
- namespace: string
- localName: string
Returns HTMLCollectionOf<Element>

getRootNode

getRootNode(options?): Node
Inherited from IgcHTMLElement.getRootNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10118
Returns node's root.

Parameters
- Optional options: GetRootNodeOptions
Returns Node

hasAttribute

hasAttribute(qualifiedName): boolean
Inherited from IgcHTMLElement.hasAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5069
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

Parameters
- qualifiedName: string
Returns boolean

hasAttributeNS

hasAttributeNS(namespace, localName): boolean
Inherited from IgcHTMLElement.hasAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5071
Returns true if element has an attribute whose namespace is namespace and local name is localName.

Parameters
- namespace: string
- localName: string
Returns boolean

hasAttributes

hasAttributes(): boolean
Inherited from IgcHTMLElement.hasAttributes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5073
Returns true if element has attributes, and false otherwise.

Returns boolean

hasChildNodes

hasChildNodes(): boolean
Inherited from IgcHTMLElement.hasChildNodes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10120
Returns whether node has children.

Returns boolean

hasPointerCapture

hasPointerCapture(pointerId): boolean
Inherited from IgcHTMLElement.hasPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5074
Parameters
- pointerId: number
Returns boolean

insertAdjacentElement

insertAdjacentElement(where, element): Element
Inherited from IgcHTMLElement.insertAdjacentElement
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5075
Parameters
- where: InsertPosition
- element: Element
Returns Element

insertAdjacentHTML

insertAdjacentHTML(position, text): void
Inherited from IgcHTMLElement.insertAdjacentHTML
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5076
Parameters
- position: InsertPosition
- text: string
Returns void

insertAdjacentText

insertAdjacentText(where, data): void
Inherited from IgcHTMLElement.insertAdjacentText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5077
Parameters
- where: InsertPosition
- data: string
Returns void

insertBefore

insertBefore<T>(node, child): T
Inherited from IgcHTMLElement.insertBefore
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10121
Type parameters
Type Parameters
- T extends Node<T>
Parameters
- node: T
- child: Node
Returns T

isDefaultNamespace

isDefaultNamespace(namespace): boolean
Inherited from IgcHTMLElement.isDefaultNamespace
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10122
Parameters
- namespace: string
Returns boolean

isEqualNode

isEqualNode(otherNode): boolean
Inherited from IgcHTMLElement.isEqualNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10124
Returns whether node and otherNode have the same properties.

Parameters
- otherNode: Node
Returns boolean

isSameNode

isSameNode(otherNode): boolean
Inherited from IgcHTMLElement.isSameNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10125
Parameters
- otherNode: Node
Returns boolean

lookupNamespaceURI

lookupNamespaceURI(prefix): string
Inherited from IgcHTMLElement.lookupNamespaceURI
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10126
Parameters
- prefix: string
Returns string

lookupPrefix

lookupPrefix(namespace): string
Inherited from IgcHTMLElement.lookupPrefix
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10127
Parameters
- namespace: string
Returns string

matches

matches(selectors): boolean
Inherited from IgcHTMLElement.matches
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5079
Returns true if matching selectors against element's root yields element, and false otherwise.

Parameters
- selectors: string
Returns boolean

normalize

normalize(): void
Inherited from IgcHTMLElement.normalize
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10129
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

Returns void

prepend

prepend(...nodes): void
Inherited from IgcHTMLElement.prepend
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10529
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

querySelector

querySelector<K>(selectors): HTMLElementTagNameMap[K]
Inherited from IgcHTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10531
Returns the first element that is a descendant of node that matches selectors.

Type parameters
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns HTMLElementTagNameMap[K]
querySelector<K>(selectors): SVGElementTagNameMap[K]
Inherited from IgcHTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10532
Type parameters
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns SVGElementTagNameMap[K]
querySelector<E>(selectors): E
Inherited from IgcHTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10533
Type parameters
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns E

querySelectorAll

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>
Inherited from IgcHTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10535
Returns all element descendants of node that match selectors.

Type parameters
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>
Inherited from IgcHTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10536
Type parameters
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
querySelectorAll<E>(selectors): NodeListOf<E>
Inherited from IgcHTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10537
Type parameters
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns NodeListOf<E>

releasePointerCapture

releasePointerCapture(pointerId): void
Inherited from IgcHTMLElement.releasePointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5080
Parameters
- pointerId: number
Returns void

remove

remove(): void
Inherited from IgcHTMLElement.remove
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3719
Removes node.

Returns void

removeAttribute

removeAttribute(qualifiedName): void
Inherited from IgcHTMLElement.removeAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5082
Removes element's first attribute whose qualified name is qualifiedName.

Parameters
- qualifiedName: string
Returns void

removeAttributeNS

removeAttributeNS(namespace, localName): void
Inherited from IgcHTMLElement.removeAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5084
Removes element's attribute whose namespace is namespace and local name is localName.

Parameters
- namespace: string
- localName: string
Returns void

removeAttributeNode

removeAttributeNode(attr): Attr
Inherited from IgcHTMLElement.removeAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5085
Parameters
- attr: Attr
Returns Attr

removeChild

removeChild<T>(child): T
Inherited from IgcHTMLElement.removeChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10130
Type parameters
Type Parameters
- T extends Node<T>
Parameters
- child: T
Returns T

removeEventListener

removeEventListener<K>(type, listener, options?): void
Inherited from IgcHTMLElement.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6537
Type parameters
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      - this: HTMLElement
      - ev: HTMLElementEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
removeEventListener(type, listener, options?): void
Inherited from IgcHTMLElement.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:6538
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

replaceChild

replaceChild<T>(node, child): T
Inherited from IgcHTMLElement.replaceChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10131
Type parameters
Type Parameters
- T extends Node<T>
Parameters
- node: Node
- child: T
Returns T

replaceChildren

replaceChildren(...nodes): void
Inherited from IgcHTMLElement.replaceChildren
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10543
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

replaceWith

replaceWith(...nodes): void
Inherited from IgcHTMLElement.replaceWith
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3725
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

requestFullscreen

requestFullscreen(options?): Promise<void>
Inherited from IgcHTMLElement.requestFullscreen
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5091
Displays element fullscreen and resolves promise when done.

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

Parameters
- Optional options: FullscreenOptions
Returns Promise<void>

requestPointerLock

requestPointerLock(): void
Inherited from IgcHTMLElement.requestPointerLock
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5092
Returns void

scroll

scroll(options?): void
Inherited from IgcHTMLElement.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5093
Parameters
- Optional options: ScrollToOptions
Returns void
scroll(x, y): void
Inherited from IgcHTMLElement.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5094
Parameters
- x: number
- y: number
Returns void

scrollBy

scrollBy(options?): void
Inherited from IgcHTMLElement.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5095
Parameters
- Optional options: ScrollToOptions
Returns void
scrollBy(x, y): void
Inherited from IgcHTMLElement.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5096
Parameters
- x: number
- y: number
Returns void

scrollIntoView

scrollIntoView(arg?): void
Inherited from IgcHTMLElement.scrollIntoView
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5097
Parameters
- Optional arg: boolean | ScrollIntoViewOptions
Returns void

scrollTo

scrollTo(options?): void
Inherited from IgcHTMLElement.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5098
Parameters
- Optional options: ScrollToOptions
Returns void
scrollTo(x, y): void
Inherited from IgcHTMLElement.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5099
Parameters
- x: number
- y: number
Returns void

setAttribute

setAttribute(qualifiedName, value): void
Inherited from IgcHTMLElement.setAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5101
Sets the value of element's first attribute whose qualified name is qualifiedName to value.

Parameters
- qualifiedName: string
- value: string
Returns void

setAttributeNS

setAttributeNS(namespace, qualifiedName, value): void
Inherited from IgcHTMLElement.setAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5103
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

Parameters
- namespace: string
- qualifiedName: string
- value: string
Returns void

setAttributeNode

setAttributeNode(attr): Attr
Inherited from IgcHTMLElement.setAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5104
Parameters
- attr: Attr
Returns Attr

setAttributeNodeNS

setAttributeNodeNS(attr): Attr
Inherited from IgcHTMLElement.setAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5105
Parameters
- attr: Attr
Returns Attr

setPointerCapture

setPointerCapture(pointerId): void
Inherited from IgcHTMLElement.setPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5106
Parameters
- pointerId: number
Returns void

styleUpdated

styleUpdated(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:295
Notifies the spreadsheet that style information used for rendering may have been updated.

Returns void

toggleAttribute

toggleAttribute(qualifiedName, force?): boolean
Inherited from IgcHTMLElement.toggleAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5112
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

Returns true if qualifiedName is now present, and false otherwise.

Parameters
- qualifiedName: string
- Optional force: boolean
Returns boolean

webkitMatchesSelector

webkitMatchesSelector(selectors): boolean
Inherited from IgcHTMLElement.webkitMatchesSelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5114
Deprecated
This is a legacy alias of matches.

Parameters
- selectors: string
Returns boolean

`Static` _createFromInternal

_createFromInternal(internal): IgcSpreadsheetComponent
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:65
Parameters
- internal: any
Returns IgcSpreadsheetComponent

`Static` register

register(): void
- Defined in dist/igniteui-webcomponents-spreadsheet/lib/igc-spreadsheet-component.d.ts:82
Returns void

Class IgcSpreadsheetComponent

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IgcSpreadsheetComponent

Properties

Readonly ATTRIBUTE_NODE

Readonly CDATA_SECTION_NODE

Readonly COMMENT_NODE

Readonly DOCUMENT_FRAGMENT_NODE

Readonly DOCUMENT_NODE

Readonly DOCUMENT_POSITION_CONTAINED_BY

Readonly DOCUMENT_POSITION_CONTAINS

Readonly DOCUMENT_POSITION_DISCONNECTED

Readonly DOCUMENT_POSITION_FOLLOWING

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Readonly DOCUMENT_POSITION_PRECEDING

Readonly DOCUMENT_TYPE_NODE

Readonly ELEMENT_NODE

Readonly ENTITY_NODE

Readonly ENTITY_REFERENCE_NODE

Readonly NOTATION_NODE

Readonly PROCESSING_INSTRUCTION_NODE

Readonly TEXT_NODE

accessKey

Readonly accessKeyLabel

ariaAtomic

ariaAutoComplete

ariaBusy

ariaChecked

ariaColCount

ariaColIndex

ariaColIndexText

ariaColSpan

ariaCurrent

ariaDisabled

ariaExpanded

ariaHasPopup

ariaHidden

ariaInvalid

ariaKeyShortcuts

ariaLabel

ariaLevel

ariaLive

ariaModal

ariaMultiLine

ariaMultiSelectable

ariaOrientation

ariaPlaceholder

ariaPosInSet

ariaPressed

ariaReadOnly

ariaRequired

ariaRoleDescription

ariaRowCount

ariaRowIndex

ariaRowIndexText

ariaRowSpan

ariaSelected

ariaSetSize

ariaSort

ariaValueMax

ariaValueMin

ariaValueNow

ariaValueText

Readonly assignedSlot

Readonly attributes

autocapitalize

autofocus

Readonly baseURI

Readonly childElementCount

Readonly childNodes

Readonly children

Readonly classList

className

`Readonly` ATTRIBUTE_NODE

`Readonly` CDATA_SECTION_NODE

`Readonly` COMMENT_NODE

`Readonly` DOCUMENT_FRAGMENT_NODE

`Readonly` DOCUMENT_NODE

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

`Readonly` DOCUMENT_POSITION_CONTAINS

`Readonly` DOCUMENT_POSITION_DISCONNECTED

`Readonly` DOCUMENT_POSITION_FOLLOWING

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly` DOCUMENT_POSITION_PRECEDING

`Readonly` DOCUMENT_TYPE_NODE

`Readonly` ELEMENT_NODE

`Readonly` ENTITY_NODE

`Readonly` ENTITY_REFERENCE_NODE

`Readonly` NOTATION_NODE

`Readonly` PROCESSING_INSTRUCTION_NODE

`Readonly` TEXT_NODE

`Readonly` accessKeyLabel

`Readonly` assignedSlot

`Readonly` attributes

`Readonly` baseURI

`Readonly` childElementCount

`Readonly` childNodes

`Readonly` children

`Readonly` classList

`Readonly` clientHeight

`Readonly` clientLeft

`Readonly` clientTop

`Readonly` clientWidth

`Readonly` dataset

`Readonly` firstChild

`Readonly` firstElementChild

`Readonly` isConnected

`Readonly` isContentEditable

`Readonly` lastChild

`Readonly` lastElementChild

`Readonly` localName

`Readonly` namespaceURI

`Readonly` nextElementSibling

`Readonly` nextSibling

`Readonly` nodeName

`Readonly` nodeType

`Optional` nonce

`Readonly` offsetHeight

`Readonly` offsetLeft

`Readonly` offsetParent

`Readonly` offsetTop

`Readonly` offsetWidth