Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcOrdinalTimeXAxisComponent

A horizontal axis that uses an ordinal DateTime scale. On an ordinal time axis, datapoints are aligned according to their order in the ItemsSource, like a category axis.

You can use the OrdinalTimeXAxis to display dates at equidistant.

this.series.xAxis = this.ordinalTimeXAxis;
this.series.yAxis = this.numericYAxis;
this.series.xAxisName = "xAxis";
this.series.yAxisName = "YAxis";

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ReadonlyATTRIBUTE_NODE

ATTRIBUTE_NODE: number

ReadonlyCDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

ReadonlyCOMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

ReadonlyDOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

ReadonlyDOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

ReadonlyDOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

ReadonlyDOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

ReadonlyDOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

ReadonlyDOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

ReadonlyDOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

ReadonlyELEMENT_NODE

ELEMENT_NODE: number

node is an element.

ReadonlyENTITY_NODE

ENTITY_NODE: number

ReadonlyENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

ReadonlyNOTATION_NODE

NOTATION_NODE: number

ReadonlyPROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

ReadonlyTEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

ReadonlyaccessKeyLabel

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

ReadonlyassignedSlot

assignedSlot: HTMLSlotElement

Readonlyattributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

ReadonlybaseURI

baseURI: string

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

ReadonlychildElementCount

childElementCount: number

ReadonlychildNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonlychildren

children: HTMLCollection

Returns the child elements.

ReadonlyclassList

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.

ReadonlyclientHeight

clientHeight: number

ReadonlyclientLeft

clientLeft: number

ReadonlyclientTop

clientTop: number

ReadonlyclientWidth

clientWidth: number

contentEditable

contentEditable: string

Readonlydataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

ReadonlyfirstChild

firstChild: ChildNode

Returns the first child.

ReadonlyfirstElementChild

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

ReadonlyisConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

ReadonlyisContentEditable

isContentEditable: boolean

lang

lang: string

ReadonlylastChild

lastChild: ChildNode

Returns the last child.

ReadonlylastElementChild

lastElementChild: Element

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

ReadonlylocalName

localName: string

Returns the local name.

ReadonlynamespaceURI

namespaceURI: string

Returns the namespace.

ReadonlynextElementSibling

nextElementSibling: Element

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

ReadonlynextSibling

nextSibling: ChildNode

Returns the next sibling.

ReadonlynodeName

nodeName: string

Returns a string appropriate for the type of node.

ReadonlynodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: string

Optionalnonce

nonce?: string

ReadonlyoffsetHeight

offsetHeight: number

ReadonlyoffsetLeft

offsetLeft: number

ReadonlyoffsetParent

offsetParent: Element

ReadonlyoffsetTop

offsetTop: number

ReadonlyoffsetWidth

offsetWidth: number

onabort

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onblur

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu

oncontextmenu: ((this: GlobalEventHandlers, ev: MouseEvent) => 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: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange

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

Fires when the object receives focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

      Returns any

onformdata

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

onfullscreenchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

ongotpointercapture

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown

onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => 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: GlobalEventHandlers, ev: KeyboardEvent) => 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: GlobalEventHandlers, ev: KeyboardEvent) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: PointerEvent) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove

onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => 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: GlobalEventHandlers, ev: MouseEvent) => 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: GlobalEventHandlers, ev: MouseEvent) => 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: GlobalEventHandlers, ev: MouseEvent) => 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: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause

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

Occurs when playback is paused.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplay

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress

onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: Event) => 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: GlobalEventHandlers, ev: UIEvent) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked

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

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onseeking

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

Fires when the current selection changes.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselectionchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled

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

Occurs when the download has stopped.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsubmit

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Optionalontouchcancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optionalontouchend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optionalontouchmove

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optionalontouchstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange

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

Deprecated

This is a legacy alias of onanimationend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwheel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML

outerHTML: string

outerText

outerText: string

ReadonlyownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

ReadonlyparentElement

parentElement: HTMLElement

Returns the parent element.

ReadonlyparentNode

parentNode: ParentNode

Returns the parent.

Readonlypart

part: DOMTokenList

Readonlyprefix

prefix: string

Returns the namespace prefix.

ReadonlypreviousElementSibling

previousElementSibling: Element

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

ReadonlypreviousSibling

previousSibling: ChildNode

Returns the previous sibling.

role

role: string

ReadonlyscrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

ReadonlyscrollWidth

scrollWidth: number

ReadonlyshadowRoot

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

Readonlystyle

style: CSSStyleDeclaration

tabIndex

tabIndex: number

ReadonlytagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string

translate

translate: boolean

StatichtmlTagName

htmlTagName: string

Accessors

actualInterval

  • get actualInterval(): number

  • Gets the effective value for the current Interval.

    let effectiveInterval: number = xAxis.actualInterval;

    Returns number

  • set actualInterval(v): void

  • Parameters

    • v: number

    Returns void

actualIntervalChange

  • get actualIntervalChange(): ((s: IgcCategoryXAxisComponent, e: number) => void)

  • Returns ((s: IgcCategoryXAxisComponent, e: number) => void)

  • set actualIntervalChange(ev): void

  • Parameters

    Returns void

actualMajorStroke

  • get actualMajorStroke(): string

  • Gets or sets the ActualMajorStroke property.

    The ActualMajorStroke property is used for ActualMajorStroke of the axis.

    Returns string

  • set actualMajorStroke(v): void

  • Parameters

    • v: string

    Returns void

actualMinorInterval

  • get actualMinorInterval(): number

  • Gets the effective value for the current MinorInterval.

    let effectiveMinorInterval: number = xAxis.actualMinorInterval;

    Returns number

  • set actualMinorInterval(v): void

  • Parameters

    • v: number

    Returns void

actualMinorIntervalChange

  • get actualMinorIntervalChange(): ((s: IgcCategoryXAxisComponent, e: number) => void)

  • Returns ((s: IgcCategoryXAxisComponent, e: number) => void)

  • set actualMinorIntervalChange(ev): void

  • Parameters

    Returns void

actualMinorStroke

  • get actualMinorStroke(): string

  • Gets or sets the ActualMinorStroke property.

    The ActualMinorStroke property is used for ActualMinorStroke of the axis.

    Returns string

  • set actualMinorStroke(v): void

  • Parameters

    • v: string

    Returns void

actualStroke

  • get actualStroke(): string

  • Gets or sets the effective stroke used for the axis.

    Returns string

  • set actualStroke(v): void

  • Parameters

    • v: string

    Returns void

annotations

  • get annotations(): IgcAxisAnnotationCollection

  • Gets the current annotations for the axis.

    Returns IgcAxisAnnotationCollection

  • set annotations(v): void

  • Parameters

    Returns void

axisInternal

  • get axisInternal(): Axis

  • Returns Axis

coercionMethods

  • get coercionMethods(): any

  • Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be re-imported into the chart.

    The coercionMethods methods is to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

    Returns any

  • set coercionMethods(v): void

  • Parameters

    • v: any

    Returns void

crossingAxis

  • get crossingAxis(): IgcAxisComponent

  • Gets or sets the CrossingAxis property.

    The CrossingAxis property is used for CrossingAxis .

    Returns IgcAxisComponent

  • set crossingAxis(v): void

  • Parameters

    Returns void

crossingAxisName

  • get crossingAxisName(): string

  • Gets or sets the name to use to resolve crossingAxis from markup.

    Returns string

  • set crossingAxisName(v): void

  • Parameters

    • v: string

    Returns void

crossingValue

  • get crossingValue(): any

  • Gets or sets the CrossingValue property.

    The CrossingValue property is used for CrossingValue of the axis.

    Returns any

  • set crossingValue(v): void

  • Parameters

    • v: any

    Returns void

dataSource

  • get dataSource(): any

  • Returns any

  • set dataSource(value): void

  • Parameters

    • value: any

    Returns void

dateTimeMemberPath

  • get dateTimeMemberPath(): string

  • Gets or sets the DateTime mapping property for the axis.

    Returns string

  • set dateTimeMemberPath(v): void

  • Parameters

    • v: string

    Returns void

enhancedIntervalMinimumCharacters

  • get enhancedIntervalMinimumCharacters(): number

  • Gets or sets the minimum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.

    The EnhancedIntervalMinimumCharacters property is used to set the mininum desired characters to be displayed for horizontal axes when using advanced label heuristics.

    Returns number

  • set enhancedIntervalMinimumCharacters(v): void

  • Parameters

    • v: number

    Returns void

enhancedIntervalPreferMoreCategoryLabels

  • get enhancedIntervalPreferMoreCategoryLabels(): boolean

  • Gets or sets whether the enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.

    Returns boolean

  • set enhancedIntervalPreferMoreCategoryLabels(v): void

  • Parameters

    • v: boolean

    Returns void

expectFunctions

  • get expectFunctions(): boolean

  • Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

    Returns boolean

  • set expectFunctions(v): void

  • Parameters

    • v: boolean

    Returns void

formatLabel

  • get formatLabel(): ((item: any) => string)

  • Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.

    The FormatLabel function takes an object that produces a formatted label for displaying in the chart.

    Returns ((item: any) => string)

      • (item): string

      • Parameters

        • item: any

        Returns string

  • set formatLabel(v): void

  • Parameters

    • v: ((item: any) => string)
        • (item): string

        • Parameters

          • item: any

          Returns string

    Returns void

gap

  • get gap(): number

  • Gets or sets the amount of space between adjacent categories for the current axis object. The gap is silently clamped to the range [0, 1] when used.

    Use the Gap property to configure the spacing between items on a category axis with item spacing.

    A Gap of 0 allocates no space between items. A Gap of 1 allocates a space between items equal to the width of one item.

    To set the item spacing to 75% the width of one item, set the Gap to 0.75, as in this code:

    Returns number

  • set gap(v): void

  • Parameters

    • v: number

    Returns void

interval

  • get interval(): number

  • Gets or sets the frequency of displayed labels. The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

    Interval determines how often to show a label, tickmark, and/or gridline along the x-axis. Set this property to n to display a label every nth item.

    Returns number

  • set interval(v): void

  • Parameters

    • v: number

    Returns void

isAngular

  • get isAngular(): boolean

  • Gets if the current axis is of angular axis type

    Returns boolean

isCategory

  • get isCategory(): boolean

  • Checks if the axis is of category axis type

    Returns boolean

isCategoryDateTime

  • get isCategoryDateTime(): boolean

  • Gets if the current axis is of category date time axis type

    Returns boolean

isContinuous

  • get isContinuous(): boolean

  • Gets if the current axis is a continuous rather than a discrete scale

    Returns boolean

isDateTime

  • get isDateTime(): boolean

  • Gets or sets if the current axis is of date time axis type

    Returns boolean

isDisabled

  • get isDisabled(): boolean

  • Gets or sets the IsDisabled property. If true, the axis will not be rendered.

    The IsDisabled property is used to decide if the axis will not be rendered.

    Returns boolean

  • set isDisabled(v): void

  • Parameters

    • v: boolean

    Returns void

isInverted

  • get isInverted(): boolean

  • Gets or sets the IsInverted property.

    Gets or sets the IsInverted property.

    Returns boolean

  • set isInverted(v): void

  • Parameters

    • v: boolean

    Returns void

isNumeric

  • get isNumeric(): boolean

  • Gets or sets if the current axis is of numeric axis type

    Gets or sets if the current axis is of numeric axis type

    Returns boolean

isOrdinal

  • get isOrdinal(): boolean

  • Gets or sets if the current axis is of ordinal axis type

    Returns boolean

isPiecewise

  • get isPiecewise(): boolean

  • Gets or sets if the axis is a piecewise scaling function.

    Returns boolean

isRadial

  • get isRadial(): boolean

  • Gets or sets if the current axis is of radial axis type

    Returns boolean

isSorting

  • get isSorting(): boolean

  • Gets or sets if the current axis is sorting data items

    Returns boolean

isVertical

  • get isVertical(): boolean

  • Gets if the current axis is a vertical axis.

    Returns boolean

itemsCount

  • get itemsCount(): number

  • Gets the number of items in the current category axis items source.

    Returns number

  • set itemsCount(v): void

  • Parameters

    • v: number

    Returns void

label

  • get label(): any

  • Gets or sets the axis label format string.

    The Label property is used for label mapping of the axis labels.

    Returns any

  • set label(v): void

  • Parameters

    • v: any

    Returns void

labelAngle

  • get labelAngle(): number

  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Returns number

  • set labelAngle(v): void

  • Parameters

    • v: number

    Returns void

labelBottomMargin

  • get labelBottomMargin(): number

  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Returns number

  • set labelBottomMargin(v): void

  • Parameters

    • v: number

    Returns void

labelExtent

  • get labelExtent(): number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Returns number

  • set labelExtent(v): void

  • Parameters

    • v: number

    Returns void

labelFormat

  • get labelFormat(): string

  • Gets or sets the label format string to use for the label.

    Returns string

  • set labelFormat(v): void

  • Parameters

    • v: string

    Returns void

labelFormatSpecifiers

  • get labelFormatSpecifiers(): any[]

  • Gets or sets the format specifiers to use with the LabelFormat string.

    Returns any[]

  • set labelFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

labelFormats

  • get labelFormats(): IgcTimeAxisLabelFormatCollection

  • A list of axis label formats to apply, which are selected according to the visible axis range. The label format selected will be the one with the largest range smaller than the visible range of the axis.

    You can use the LabelFormats for adjusting the labels depending on the range of the time shown by the chart.

    let labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm:ss";
    labelFormat.range = 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm";
    labelFormat.range = 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "MMM-dd-yy";
    labelFormat.range = 24 * 60 * 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "MMM yy";
    labelFormat.range = 365.24 * 24 * 60 * 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "yyyy";
    labelFormat.range = 5 * 365 * 24 * 60 * 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);

    Returns IgcTimeAxisLabelFormatCollection

  • set labelFormats(v): void

  • Parameters

    Returns void

labelHorizontalAlignment

  • get labelHorizontalAlignment(): HorizontalAlignment

  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

  • set labelHorizontalAlignment(v): void

  • Parameters

    • v: HorizontalAlignment

    Returns void

labelLeftMargin

  • get labelLeftMargin(): number

  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Returns number

  • set labelLeftMargin(v): void

  • Parameters

    • v: number

    Returns void

labelLocation

  • get labelLocation(): AxisLabelsLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Returns AxisLabelsLocation

  • set labelLocation(v): void

  • Parameters

    Returns void

labelRightMargin

  • get labelRightMargin(): number

  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Returns number

  • set labelRightMargin(v): void

  • Parameters

    • v: number

    Returns void

labelShowFirstLabel

  • get labelShowFirstLabel(): boolean

  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Returns boolean

  • set labelShowFirstLabel(v): void

  • Parameters

    • v: boolean

    Returns void

labelTextColor

  • get labelTextColor(): string

  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Returns string

  • set labelTextColor(v): void

  • Parameters

    • v: string

    Returns void

labelTextStyle

  • get labelTextStyle(): string

  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Returns string

  • set labelTextStyle(v): void

  • Parameters

    • v: string

    Returns void

labelTopMargin

  • get labelTopMargin(): number

  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Returns number

  • set labelTopMargin(v): void

  • Parameters

    • v: number

    Returns void

labelVerticalAlignment

  • get labelVerticalAlignment(): VerticalAlignment

  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Returns VerticalAlignment

  • set labelVerticalAlignment(v): void

  • Parameters

    • v: VerticalAlignment

    Returns void

labelVisibility

  • get labelVisibility(): Visibility

  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Returns Visibility

  • set labelVisibility(v): void

  • Parameters

    • v: Visibility

    Returns void

labellingMode

  • get labellingMode(): TimeAxisLabellingMode

  • Gets or sets the labelling mode to use when the automatic label formats are applied.

    Returns TimeAxisLabellingMode

  • set labellingMode(v): void

  • Parameters

    Returns void

majorStroke

  • get majorStroke(): string

  • Gets or sets the MajorStroke property. Null is treated as auto. Major lines will be displayed or not based on the axis type and series used with it.

    Gets or sets the MajorStroke using this property.

    Returns string

  • set majorStroke(v): void

  • Parameters

    • v: string

    Returns void

majorStrokeDashArray

  • get majorStrokeDashArray(): number[]

  • Gets or sets the MajorStrokeDashArray property.

    Returns number[]

  • set majorStrokeDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

majorStrokeThickness

  • get majorStrokeThickness(): number

  • Gets or sets the MajorStrokeThickness property.

    Gets or sets the MajorStrokeThickness using this property.

    Returns number

  • set majorStrokeThickness(v): void

  • Parameters

    • v: number

    Returns void

maximumGap

  • get maximumGap(): number

  • Gets or sets the maximum gap value to allow. This defaults to 1.0.

    Returns number

  • set maximumGap(v): void

  • Parameters

    • v: number

    Returns void

maximumValue

  • get maximumValue(): Date

  • Sets the maximum DateTime value to be displayed on this axis. This property can be used to constrain the items displayed on the axis, within the range of DateTimes in the ItemsSource. It will ignore any setting outside the actual range of data.

    Returns Date

  • set maximumValue(v): void

  • Parameters

    • v: Date

    Returns void

minimumGapSize

  • get minimumGapSize(): number

  • Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.

    Returns number

  • set minimumGapSize(v): void

  • Parameters

    • v: number

    Returns void

minimumValue

  • get minimumValue(): Date

  • Sets the minimum DateTime value to be displayed on this axis. This property can be used to constrain the items displayed on the axis, within the range of DateTimes in the ItemsSource. It will ignore any setting outside the actual range of data.

    Returns Date

  • set minimumValue(v): void

  • Parameters

    • v: Date

    Returns void

minorInterval

  • get minorInterval(): number

  • Gets or sets the frequency of displayed minor lines. The set value is a factor that determines how the minor lines will be displayed.

    MinorInterval determines how often to show a minor gridline along the x-axis. This property is relevant only when the displayed series is a type with grouping, like column series.

    MinorInterval is expressed as a number between 0 and 1, representing the frequency of the interval. To display minor gridlines representing 10ths of an item width, set MinorInterval to 0.1.

    Returns number

  • set minorInterval(v): void

  • Parameters

    • v: number

    Returns void

minorStroke

  • get minorStroke(): string

  • Gets or sets the MinorStroke property.

    Gets or sets the minorStroke thickness using MinorStrokeThickness property.

    Returns string

  • set minorStroke(v): void

  • Parameters

    • v: string

    Returns void

minorStrokeDashArray

  • get minorStrokeDashArray(): number[]

  • Gets or sets the MinorStrokeDashArray property.

    Returns number[]

  • set minorStrokeDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

minorStrokeThickness

  • get minorStrokeThickness(): number

  • Gets or sets the MinorStrokeThickness property.

    Returns number

  • set minorStrokeThickness(v): void

  • Parameters

    • v: number

    Returns void

name

  • get name(): string

  • Returns string

  • set name(value): void

  • Parameters

    • value: string

    Returns void

overlap

  • get overlap(): number

  • Gets or sets the amount of overlap between adjacent categories for the current axis object. The overlap is silently clamped to the range [-1, 1] when used.

    Use the Overlap property to configure the spacing between items on a category axis with item spacing and more than one series.

    An Overlap of 0 places grouped items adjacent to each other. An Overlap of 1 places grouped items in the same axis space, completely overlapping. An Overlap of -1 places a space between grouped items equal to the width of one item.

    To place grouped items with 75% overlap, set the Overlap to 0.75, as in this code:

    Returns number

  • set overlap(v): void

  • Parameters

    • v: number

    Returns void

rangeChanged

renderRequested

shouldAvoidAnnotationCollisions

  • get shouldAvoidAnnotationCollisions(): boolean

  • Gets or sets whether annotations should be shifted to avoid collision, even if this would result in them appearing where they shouldn't be along the scale.

    Returns boolean

  • set shouldAvoidAnnotationCollisions(v): void

  • Parameters

    • v: boolean

    Returns void

shouldKeepAnnotationsInView

  • get shouldKeepAnnotationsInView(): boolean

  • ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale.

    Returns boolean

  • set shouldKeepAnnotationsInView(v): void

  • Parameters

    • v: boolean

    Returns void

strip

  • get strip(): string

  • Gets or sets the Strip property.

    Use Strip property to set the strip of the chart.

    Returns string

  • set strip(v): void

  • Parameters

    • v: string

    Returns void

stroke

  • get stroke(): string

  • Gets or sets the Stroke property. Null is treated as auto. The axis stroke will be displayed or not based on the axis type and series used with it.

    Use Stroke property to set the stroke of the chart.

    Returns string

  • set stroke(v): void

  • Parameters

    • v: string

    Returns void

strokeDashArray

  • get strokeDashArray(): number[]

  • Gets or sets the StrokeDashArray property.

    Returns number[]

  • set strokeDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

strokeThickness

  • get strokeThickness(): number

  • Gets or sets the StrokeThickness property.

    Use StrokeThickness property for the thickness of the stroke.

    Returns number

  • set strokeThickness(v): void

  • Parameters

    • v: number

    Returns void

tickLength

  • get tickLength(): number

  • Gets or sets the TickLength property.

    Use TickLength property for The length of the tickmarks to display for this axis.

    Returns number

  • set tickLength(v): void

  • Parameters

    • v: number

    Returns void

tickStroke

  • get tickStroke(): string

  • Gets or sets the TickStroke property.

    Use TickStroke property for the color of the tickmarks.

    Returns string

  • set tickStroke(v): void

  • Parameters

    • v: string

    Returns void

tickStrokeDashArray

  • get tickStrokeDashArray(): number[]

  • Gets or sets the TickStrokeDashArray property.

    Returns number[]

  • set tickStrokeDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

tickStrokeThickness

  • get tickStrokeThickness(): number

  • Gets or sets the TickStrokeThickness property.

    Use TickStrokeThickness property for thickness of the stroke tickmarks.

    Returns number

  • set tickStrokeThickness(v): void

  • Parameters

    • v: number

    Returns void

title

  • get title(): string

  • Gets or sets the Title property.

    Use Title property to display the title of the component.

    Returns string

  • set title(v): void

  • Parameters

    • v: string

    Returns void

titleAngle

  • get titleAngle(): number

  • Gets or sets the angle of the {0}.

    The Angle property is used to set the angle of the axis.

    Returns number

  • set titleAngle(v): void

  • Parameters

    • v: number

    Returns void

titleBottomMargin

  • get titleBottomMargin(): number

  • Margin applied below the {0}.

    The labelBottomMargin is used to set the bottom margin of the labels.

    Returns number

  • set titleBottomMargin(v): void

  • Parameters

    • v: number

    Returns void

titleExtent

  • get titleExtent(): number

  • Distance between the axis and the edge of the control.

    The Extent property is used for the extent.

    Returns number

  • set titleExtent(v): void

  • Parameters

    • v: number

    Returns void

titleHorizontalAlignment

  • get titleHorizontalAlignment(): HorizontalAlignment

  • Gets or sets the horizontal alignment of the {0}.

    The HorizontalAlignment property is used for the horizontal alignment.

    Returns HorizontalAlignment

  • set titleHorizontalAlignment(v): void

  • Parameters

    • v: HorizontalAlignment

    Returns void

titleLeftMargin

  • get titleLeftMargin(): number

  • Margin applied to the left of the {0}.

    The labelLeftMargin property is used for the left margin of the labels.

    Returns number

  • set titleLeftMargin(v): void

  • Parameters

    • v: number

    Returns void

titleLocation

  • get titleLocation(): AxisLabelsLocation

  • Gets or sets the location of the {0}.

    The Location property is used for the location.

    Returns AxisLabelsLocation

  • set titleLocation(v): void

  • Parameters

    Returns void

titlePosition

  • get titlePosition(): AxisTitlePosition

  • Gets or sets the title position relative to the axis labels.

    Returns AxisTitlePosition

  • set titlePosition(v): void

  • Parameters

    Returns void

titleRightMargin

  • get titleRightMargin(): number

  • Margin applied to the right of the {0}.

    The labelRightMargin property is used for the right margin of the labels.

    Returns number

  • set titleRightMargin(v): void

  • Parameters

    • v: number

    Returns void

titleShowFirstLabel

  • get titleShowFirstLabel(): boolean

  • Gets or sets whether the first label is displayed when the zoom level is set to 1.

    The ShowFirstLabel is used to check whether the first label is displayed when the zoom level is set to 1.

    Returns boolean

  • set titleShowFirstLabel(v): void

  • Parameters

    • v: boolean

    Returns void

titleTextColor

  • get titleTextColor(): string

  • The color of the {0}.

    The labelTextColor property Overrides the color of the text used for the axis labels.

    Returns string

  • set titleTextColor(v): void

  • Parameters

    • v: string

    Returns void

titleTextStyle

  • get titleTextStyle(): string

  • Gets or sets the text style to use for axis labels.

    The labelTextStyle property Overrides the style of the text used for the axis labels.

    Returns string

  • set titleTextStyle(v): void

  • Parameters

    • v: string

    Returns void

titleTopMargin

  • get titleTopMargin(): number

  • Margin applied above the {0}.

    The labelTopMargin property is used for the top margin of the labels.

    Returns number

  • set titleTopMargin(v): void

  • Parameters

    • v: number

    Returns void

titleVerticalAlignment

  • get titleVerticalAlignment(): VerticalAlignment

  • Gets or sets the vertical alignment of the {0}.

    The VerticalAlignment property is used for the vertical alignment of the axis.

    Returns VerticalAlignment

  • set titleVerticalAlignment(v): void

  • Parameters

    • v: VerticalAlignment

    Returns void

titleVisibility

  • get titleVisibility(): Visibility

  • Gets or sets the visibility of the {0}.

    The Visibility property is used for the visibility of the axis.

    Returns Visibility

  • set titleVisibility(v): void

  • Parameters

    • v: Visibility

    Returns void

useClusteringMode

  • get useClusteringMode(): boolean

  • Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

    UseClusteringMode applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.

    Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:

    Returns boolean

  • set useClusteringMode(v): void

  • Parameters

    • v: boolean

    Returns void

useEnhancedIntervalManagement

  • get useEnhancedIntervalManagement(): boolean

  • Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Use UseEnhancedIntervalManagement property to gets/sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

    Returns boolean

  • set useEnhancedIntervalManagement(v): void

  • Parameters

    • v: boolean

    Returns void

usePerLabelHeightMeasurement

  • get usePerLabelHeightMeasurement(): boolean

  • Gets or sets whether to use label height measurement when determining the initial number of labels to render, before resolving collisions, etc.

    Returns boolean

  • set usePerLabelHeightMeasurement(v): void

  • Parameters

    • v: boolean

    Returns void

zoomMaximumCategoryRange

  • get zoomMaximumCategoryRange(): number

  • Gets or sets number of visible categories at maximum zooming level This property is overridden by chart's WindowRectMinWidth property

    Returns number

  • set zoomMaximumCategoryRange(v): void

  • Parameters

    • v: number

    Returns void

zoomMaximumItemSpan

  • get zoomMaximumItemSpan(): number

  • Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. This property is overridden by chart's WindowRectMinWidth property

    Returns number

  • set zoomMaximumItemSpan(v): void

  • Parameters

    • v: number

    Returns void

zoomToCategoryRange

  • get zoomToCategoryRange(): number

  • Gets or sets range of categories that the chart will zoom in to and fill plot area This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

    Returns number

  • set zoomToCategoryRange(v): void

  • Parameters

    • v: number

    Returns void

zoomToCategoryStart

  • get zoomToCategoryStart(): number

  • Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

    Returns number

  • set zoomToCategoryStart(v): void

  • Parameters

    • v: number

    Returns void

zoomToItemSpan

  • get zoomToItemSpan(): number

  • Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

    Returns number

  • set zoomToItemSpan(v): void

  • Parameters

    • v: number

    Returns void

StaticobservedAttributes

  • get observedAttributes(): string[]

  • Returns string[]

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

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

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

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

    Returns void

after

  • after(...nodes): void

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

animate

  • animate(keyframes, options?): Animation

  • Parameters

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

    Returns Animation

append

  • append(...nodes): void

  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

appendChild

  • appendChild<T>(node): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

attachInternals

attachShadow

  • attachShadow(init): ShadowRoot

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name, oldValue, newValue): void

  • Parameters

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

    Returns void

before

  • before(...nodes): void

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

bindAxes

blur

click

cloneNode

  • cloneNode(deep?): Node

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

    Parameters

    • deep: boolean

    Returns Node

closest

  • closest<K>(selector): HTMLElementTagNameMap[K]

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

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K]

  • closest<K>(selector): SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • closest<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    Parameters

    • other: Node

    Returns number

connectedCallback

contains

  • contains(other): boolean

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

    Parameters

    • other: Node

    Returns boolean

createShadow

disconnectedCallback

dispatchEvent

  • dispatchEvent(event): boolean

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

    Parameters

    • event: Event

    Returns boolean

ensureLabelSettings

ensureTitleSettings

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

focus

  • focus(options?): void

  • Parameters

    • options: FocusOptions

    Returns void

getAnimations

  • getAnimations(options?): Animation[]

  • Parameters

    • options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName): string

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

    Parameters

    • qualifiedName: string

    Returns string

getAttributeNS

  • getAttributeNS(namespace, localName): string

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

    Parameters

    • namespace: string
    • localName: string

    Returns string

getAttributeNames

  • getAttributeNames(): string[]

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

    Returns string[]

getAttributeNode

getAttributeNodeNS

  • getAttributeNodeNS(namespace, localName): Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

getBoundingClientRect

getCategoryBoundingBox

  • getCategoryBoundingBox(point, useInterpolation, singularWidth): IgRect

  • Parameters

    • point: IgPoint
    • useInterpolation: boolean
    • singularWidth: number

    Returns IgRect

getCategoryBoundingBoxHelper

  • getCategoryBoundingBoxHelper(point, useInterpolation, singularWidth, isVertical): IgRect

  • Parameters

    • point: IgPoint
    • useInterpolation: boolean
    • singularWidth: number
    • isVertical: boolean

    Returns IgRect

getClientRects

getElementsByClassName

  • getElementsByClassName(classNames): HTMLCollectionOf<Element>

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

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

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getFullRange

getItemValue

  • getItemValue(item, memberPathName): any

  • Parameters

    • item: any
    • memberPathName: string

    Returns any

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    Parameters

    • options: GetRootNodeOptions

    Returns Node

getValueLabel

  • getValueLabel(value): string

  • Gets the label for a data item.

    Parameters

    • value: number
      • The unscaled value to get a label for.

    Returns string

getWindowZoomFromCategories

  • getWindowZoomFromCategories(categoriesCount): number

  • Gets window zoom scale required to zoom to specified number of categories

    Parameters

    • categoriesCount: number

    Returns number

getWindowZoomFromItemSpan

  • getWindowZoomFromItemSpan(pixels): number

  • Gets window zoom scale required to zoom to specified span of series item

    Parameters

    • pixels: number

    Returns number

hasAttribute

  • hasAttribute(qualifiedName): boolean

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

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace, localName): boolean

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

    Parameters

    • namespace: string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

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

    Returns boolean

hasChildNodes

hasPointerCapture

insertAdjacentElement

insertAdjacentHTML

insertAdjacentText

insertBefore

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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: Node

    Returns T

isDefaultNamespace

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • Parameters

    • otherNode: Node

    Returns boolean

lookupNamespaceURI

lookupPrefix

matches

  • matches(selectors): boolean

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

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

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

    Returns void

notifyClearItems

  • notifyClearItems(): void

  • Used to manually notify the axis that the data source has reset or cleared its items.

    Returns void

notifyInsertItem

  • notifyInsertItem(index, newItem): void

  • Parameters

    • index: number
    • newItem: any

    Returns void

notifyRemoveItem

  • notifyRemoveItem(index, oldItem): void

  • Parameters

    • index: number
    • oldItem: any

    Returns void

notifySetItem

  • notifySetItem(index, oldItem, newItem): void

  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

prepend

  • prepend(...nodes): void

  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

provideData

  • provideData(data): void

  • Parameters

    • data: any[]

    Returns void

querySelector

  • querySelector<K>(selectors): HTMLElementTagNameMap[K]

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

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K]

  • querySelector<K>(selectors): SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • querySelector<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

querySelectorAll

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

  • Returns all element descendants of node that match selectors.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • querySelectorAll<E>(selectors): NodeListOf<E>

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

remove

removeAttribute

  • removeAttribute(qualifiedName): void

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace, localName): void

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

    Parameters

    • namespace: string
    • localName: string

    Returns void

removeAttributeNode

removeChild

  • removeChild<T>(child): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

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

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

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

    Returns void

renderAxis

  • renderAxis(): void

  • Renders the axis with no animation.

    Returns void

replaceChild

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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes): void

  • Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

replaceWith

  • replaceWith(...nodes): void

  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

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

    Parameters

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

    Returns void

requestFullscreen

  • requestFullscreen(options?): Promise<void>

  • Displays element fullscreen and resolves promise when done.

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

    Parameters

    • options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

resetCachedEnhancedInterval

  • resetCachedEnhancedInterval(): void

  • If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.

    Returns void

scaleValue

  • scaleValue(unscaledValue): number

  • Scales a value from axis space into screen space.

    Parameters

    • unscaledValue: number
      • The unscaled axis value to scale.

    Returns number

scroll

  • scroll(options?): void

  • Parameters

    • options: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • Parameters

    • options: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(item): void

  • Scrolls the specified item into view.

    Parameters

    • item: any
      • Data item to scroll into view

    Returns void

scrollRangeIntoView

  • scrollRangeIntoView(minimum, maximum): void

  • Parameters

    • minimum: number
    • maximum: number

    Returns void

scrollTo

  • scrollTo(options?): void

  • Parameters

    • options: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName, value): void

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

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace, qualifiedName, value): void

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

    Parameters

    • namespace: string
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

setAttributeNodeNS

setPointerCapture

toggleAttribute

  • toggleAttribute(qualifiedName, force?): boolean

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

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

    Parameters

    • qualifiedName: string
    • force: boolean

    Returns boolean

unscaleValue

  • unscaleValue(unscaledValue): number

  • Unscales a value from screen space into axis space.

    Parameters

    • unscaledValue: number
      • The scaled value in screen coordinates to unscale into axis space.

    Returns number

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Static_createFromInternal

Staticregister