Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcDataLegendComponent

Represents data legend that displays information about each series including values and summaries.

Hierarchy

Hierarchy

  • cons
    • IgcDataLegendComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: string

ariaAutoComplete

ariaAutoComplete: string

ariaBusy

ariaBusy: string

ariaChecked

ariaChecked: string

ariaColCount

ariaColCount: string

ariaColIndex

ariaColIndex: string

ariaColIndexText

ariaColIndexText: string

ariaColSpan

ariaColSpan: string

ariaCurrent

ariaCurrent: string

ariaDisabled

ariaDisabled: string

ariaExpanded

ariaExpanded: string

ariaHasPopup

ariaHasPopup: string

ariaHidden

ariaHidden: string

ariaInvalid

ariaInvalid: string

ariaKeyShortcuts

ariaKeyShortcuts: string

ariaLabel

ariaLabel: string

ariaLevel

ariaLevel: string

ariaLive

ariaLive: string

ariaModal

ariaModal: string

ariaMultiLine

ariaMultiLine: string

ariaMultiSelectable

ariaMultiSelectable: string

ariaOrientation

ariaOrientation: string

ariaPlaceholder

ariaPlaceholder: string

ariaPosInSet

ariaPosInSet: string

ariaPressed

ariaPressed: string

ariaReadOnly

ariaReadOnly: string

ariaRequired

ariaRequired: string

ariaRoleDescription

ariaRoleDescription: string

ariaRowCount

ariaRowCount: string

ariaRowIndex

ariaRowIndex: string

ariaRowIndexText

ariaRowIndexText: string

ariaRowSpan

ariaRowSpan: string

ariaSelected

ariaSelected: string

ariaSetSize

ariaSetSize: string

ariaSort

ariaSort: string

ariaValueMax

ariaValueMax: string

ariaValueMin

ariaValueMin: string

ariaValueNow

ariaValueNow: string

ariaValueText

ariaValueText: string

Readonly assignedSlot

assignedSlot: HTMLSlotElement

Readonly attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

Readonly baseURI

baseURI: string

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

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly classList

classList: DOMTokenList

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

className

className: string

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

Readonly clientHeight

clientHeight: number

Readonly clientLeft

clientLeft: number

Readonly clientTop

clientTop: number

Readonly clientWidth

clientWidth: number

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

Readonly firstChild

firstChild: ChildNode

Returns the first child.

Readonly firstElementChild

firstElementChild: Element

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

hidden

hidden: boolean

id

id: string

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

inert

inert: boolean

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly isContentEditable

isContentEditable: boolean

lang

lang: string

Readonly lastChild

lastChild: ChildNode

Returns the last child.

Readonly lastElementChild

lastElementChild: Element

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

Readonly localName

localName: string

Returns the local name.

Readonly namespaceURI

namespaceURI: string

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: Element

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

Readonly nextSibling

nextSibling: ChildNode

Returns the next sibling.

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

Readonly nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: string

Optional nonce

nonce?: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: Element

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

        The event.

      Returns any

onanimationcancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onblur

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

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

      Returns any

oncancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

oncanplaythrough

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onclick

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onclose

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

oncopy

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick

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

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

ondrag

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

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragend

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragenter

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragleave

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

      Returns any

ondragover

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondragstart

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

      Returns any

ondrop

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange

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

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onemptied

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onended

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

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event

      Returns any

onerror

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

onfocus

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

Fires when the object receives focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

      Returns any

onformdata

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

onfullscreenchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

ongotpointercapture

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown

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

Fires when the user presses a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onkeypress

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

Fires when the user presses an alphanumeric key.

Deprecated

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

onkeyup

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

Fires when the user releases a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

      Returns any

onload

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

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadeddata

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadedmetadata

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onlostpointercapture

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseenter

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove

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

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseout

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseover

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onmouseup

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

      Returns any

onpaste

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause

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

Occurs when playback is paused.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplay

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

Occurs when the play method is requested.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onplaying

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

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onpointercancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress

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

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

      Returns any

onratechange

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

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onreset

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

Fires when the user resets a form.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onresize

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsecuritypolicyviolation

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked

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

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onseeking

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

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselect

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

Fires when the current selection changes.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onselectionchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled

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

Occurs when the download has stopped.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onsubmit

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend

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

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontimeupdate

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

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

ontoggle

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Optional ontouchcancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchmove

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwaiting

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

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onwheel

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML

outerHTML: string

outerText

outerText: string

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: ParentNode

Returns the parent.

Readonly part

part: DOMTokenList

Readonly prefix

prefix: string

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: Element

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

Readonly previousSibling

previousSibling: ChildNode

Returns the previous sibling.

role

role: string

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: ShadowRoot

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

slot

slot: string

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

spellcheck

spellcheck: boolean

Readonly style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string

title

title: string

translate

translate: boolean

Static htmlTagName

htmlTagName: string

Accessors

actualBadgesVisible

  • get actualBadgesVisible(): boolean

  • Gets whether or not at least one badge is visible based on BadgesShape and setting of a row's IsVisble in StyleSeriesRow event

    Returns boolean

  • set actualBadgesVisible(v): void

  • Parameters

    • v: boolean

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number

  • Gets the actual pixel scaling ratio used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

  • set actualPixelScalingRatio(v): void

  • Parameters

    • v: number

    Returns void

badgeMarginBottom

  • get badgeMarginBottom(): number

  • Returns number

  • set badgeMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

badgeMarginLeft

  • get badgeMarginLeft(): number

  • Returns number

  • set badgeMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

badgeMarginRight

  • get badgeMarginRight(): number

  • Returns number

  • set badgeMarginRight(v): void

  • Parameters

    • v: number

    Returns void

badgeMarginTop

  • get badgeMarginTop(): number

  • Returns number

  • set badgeMarginTop(v): void

  • Parameters

    • v: number

    Returns void

badgeShape

  • get badgeShape(): LegendItemBadgeShape

  • Gets or sets the BadgeShape for the data legend.

    Returns LegendItemBadgeShape

  • set badgeShape(v): void

  • Parameters

    • v: LegendItemBadgeShape

    Returns void

calculateColumnSummary

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

  • Event raised when calculating summary value for each column in data legend

    Returns ((s, e) => void)

  • set calculateColumnSummary(ev): void

  • Parameters

    Returns void

excludedColumns

  • get excludedColumns(): string[]

  • Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

    Returns string[]

  • set excludedColumns(v): void

  • Parameters

    • v: string[]

    Returns void

excludedSeries

  • get excludedSeries(): string[]

  • Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

    Returns string[]

  • set excludedSeries(v): void

  • Parameters

    • v: string[]

    Returns void

groupRowMarginBottom

  • get groupRowMarginBottom(): number

  • Returns number

  • set groupRowMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

groupRowMarginLeft

  • get groupRowMarginLeft(): number

  • Returns number

  • set groupRowMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

groupRowMarginRight

  • get groupRowMarginRight(): number

  • Returns number

  • set groupRowMarginRight(v): void

  • Parameters

    • v: number

    Returns void

groupRowMarginTop

  • get groupRowMarginTop(): number

  • Returns number

  • set groupRowMarginTop(v): void

  • Parameters

    • v: number

    Returns void

groupRowVisible

  • get groupRowVisible(): boolean

  • Gets or sets whether to show Header row.

    Returns boolean

  • set groupRowVisible(v): void

  • Parameters

    • v: boolean

    Returns void

groupTextColor

  • get groupTextColor(): string

  • Gets or sets the Group text color.

    Returns string

  • set groupTextColor(v): void

  • Parameters

    • v: string

    Returns void

groupTextMarginBottom

  • get groupTextMarginBottom(): number

  • Returns number

  • set groupTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

groupTextMarginLeft

  • get groupTextMarginLeft(): number

  • Returns number

  • set groupTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

groupTextMarginRight

  • get groupTextMarginRight(): number

  • Returns number

  • set groupTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

groupTextMarginTop

  • get groupTextMarginTop(): number

  • Returns number

  • set groupTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

groupTextStyle

  • get groupTextStyle(): string

  • Gets or Sets the style to use for the Group text.

    Returns string

  • set groupTextStyle(v): void

  • Parameters

    • v: string

    Returns void

headerFormatCulture

  • get headerFormatCulture(): string

  • Gets or sets globalization culture applied to header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns string

  • set headerFormatCulture(v): void

  • Parameters

    • v: string

    Returns void

headerFormatDate

  • get headerFormatDate(): DataLegendHeaderDateMode

  • Gets or sets date format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns DataLegendHeaderDateMode

  • set headerFormatDate(v): void

  • Parameters

    • v: DataLegendHeaderDateMode

    Returns void

headerFormatSpecifiers

  • get headerFormatSpecifiers(): any[]

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

    Returns any[]

  • set headerFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

headerFormatString

  • get headerFormatString(): string

  • Gets or sets the format string for header text displayed in the data legend.

    Returns string

  • set headerFormatString(v): void

  • Parameters

    • v: string

    Returns void

headerFormatTime

  • get headerFormatTime(): DataLegendHeaderTimeMode

  • Gets or sets time format for the header only when it displays dates that are fetched from date/time axes This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

    Returns DataLegendHeaderTimeMode

  • set headerFormatTime(v): void

  • Parameters

    • v: DataLegendHeaderTimeMode

    Returns void

headerRowMarginBottom

  • get headerRowMarginBottom(): number

  • Returns number

  • set headerRowMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

headerRowMarginLeft

  • get headerRowMarginLeft(): number

  • Returns number

  • set headerRowMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

headerRowMarginRight

  • get headerRowMarginRight(): number

  • Returns number

  • set headerRowMarginRight(v): void

  • Parameters

    • v: number

    Returns void

headerRowMarginTop

  • get headerRowMarginTop(): number

  • Returns number

  • set headerRowMarginTop(v): void

  • Parameters

    • v: number

    Returns void

headerRowVisible

  • get headerRowVisible(): boolean

  • Gets or sets whether to show Header row.

    Returns boolean

  • set headerRowVisible(v): void

  • Parameters

    • v: boolean

    Returns void

headerText

  • get headerText(): string

  • Gets or sets the HeaderText for the data legend.

    Returns string

  • set headerText(v): void

  • Parameters

    • v: string

    Returns void

headerTextColor

  • get headerTextColor(): string

  • Gets or sets the header text color.

    Returns string

  • set headerTextColor(v): void

  • Parameters

    • v: string

    Returns void

headerTextMarginBottom

  • get headerTextMarginBottom(): number

  • Returns number

  • set headerTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

headerTextMarginLeft

  • get headerTextMarginLeft(): number

  • Returns number

  • set headerTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

headerTextMarginRight

  • get headerTextMarginRight(): number

  • Returns number

  • set headerTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

headerTextMarginTop

  • get headerTextMarginTop(): number

  • Returns number

  • set headerTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

headerTextStyle

  • get headerTextStyle(): string

  • Gets or Sets the style to use for the header text.

    Returns string

  • set headerTextStyle(v): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): string

  • Returns string

  • set height(value): void

  • Parameters

    • value: string

    Returns void

i

  • get i(): XamDataLegend

  • Returns XamDataLegend

includedColumns

  • get includedColumns(): string[]

  • Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

    Returns string[]

  • set includedColumns(v): void

  • Parameters

    • v: string[]

    Returns void

includedSeries

  • get includedSeries(): string[]

  • Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

    Returns string[]

  • set includedSeries(v): void

  • Parameters

    • v: string[]

    Returns void

labelDisplayMode

  • get labelDisplayMode(): DataLegendLabelMode

  • Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

    Returns DataLegendLabelMode

  • set labelDisplayMode(v): void

  • Parameters

    • v: DataLegendLabelMode

    Returns void

labelTextColor

  • get labelTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set labelTextColor(v): void

  • Parameters

    • v: string

    Returns void

labelTextMarginBottom

  • get labelTextMarginBottom(): number

  • Returns number

  • set labelTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

labelTextMarginLeft

  • get labelTextMarginLeft(): number

  • Returns number

  • set labelTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

labelTextMarginRight

  • get labelTextMarginRight(): number

  • Returns number

  • set labelTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

labelTextMarginTop

  • get labelTextMarginTop(): number

  • Returns number

  • set labelTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

labelTextStyle

  • get labelTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set labelTextStyle(v): void

  • Parameters

    • v: string

    Returns void

layoutMode

  • get layoutMode(): DataLegendLayoutMode

  • Gets or sets the layout of content in the data legend

    Returns DataLegendLayoutMode

  • set layoutMode(v): void

  • Parameters

    • v: DataLegendLayoutMode

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number

  • Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

  • set pixelScalingRatio(v): void

  • Parameters

    • v: number

    Returns void

shouldUpdateWhenSeriesDataChanges

  • get shouldUpdateWhenSeriesDataChanges(): boolean

  • Gets or sets whether the data legend should update when the series data is mutated.

    Returns boolean

  • set shouldUpdateWhenSeriesDataChanges(v): void

  • Parameters

    • v: boolean

    Returns void

styleGroupRow

styleHeaderRow

styleSeriesColumn

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

  • Event raised when styling the label, value, and unit columns in series rows

    Returns ((s, e) => void)

  • set styleSeriesColumn(ev): void

  • Parameters

    Returns void

styleSeriesRow

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

  • Event raised when styling title and badge in series rows

    Returns ((s, e) => void)

  • set styleSeriesRow(ev): void

  • Parameters

    Returns void

styleSummaryColumn

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

  • Event raised when styling the label, value, and unit columns in summary row

    Returns ((s, e) => void)

  • set styleSummaryColumn(ev): void

  • Parameters

    Returns void

styleSummaryRow

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

  • Event raised when styling title in the summary row

    Returns ((s, e) => void)

  • set styleSummaryRow(ev): void

  • Parameters

    Returns void

summaryLabelText

  • get summaryLabelText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryLabelText(v): void

  • Parameters

    • v: string

    Returns void

summaryLabelTextColor

  • get summaryLabelTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryLabelTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryLabelTextStyle

  • get summaryLabelTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryLabelTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summaryRowMarginBottom

  • get summaryRowMarginBottom(): number

  • Returns number

  • set summaryRowMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

summaryRowMarginLeft

  • get summaryRowMarginLeft(): number

  • Returns number

  • set summaryRowMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

summaryRowMarginRight

  • get summaryRowMarginRight(): number

  • Returns number

  • set summaryRowMarginRight(v): void

  • Parameters

    • v: number

    Returns void

summaryRowMarginTop

  • get summaryRowMarginTop(): number

  • Returns number

  • set summaryRowMarginTop(v): void

  • Parameters

    • v: number

    Returns void

summaryTitleText

  • get summaryTitleText(): string

  • Gets or sets the SummaryTitleText for the data legend.

    Returns string

  • set summaryTitleText(v): void

  • Parameters

    • v: string

    Returns void

summaryTitleTextColor

  • get summaryTitleTextColor(): string

  • Gets or sets the summary text color.

    Returns string

  • set summaryTitleTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryTitleTextMarginBottom

  • get summaryTitleTextMarginBottom(): number

  • Returns number

  • set summaryTitleTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

summaryTitleTextMarginLeft

  • get summaryTitleTextMarginLeft(): number

  • Returns number

  • set summaryTitleTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

summaryTitleTextMarginRight

  • get summaryTitleTextMarginRight(): number

  • Returns number

  • set summaryTitleTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

summaryTitleTextMarginTop

  • get summaryTitleTextMarginTop(): number

  • Returns number

  • set summaryTitleTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

summaryTitleTextStyle

  • get summaryTitleTextStyle(): string

  • Gets or Sets the style to use for the summary text.

    Returns string

  • set summaryTitleTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summaryType

  • get summaryType(): DataLegendSummaryType

  • Gets or sets the SummaryType for the data legend.

    Returns DataLegendSummaryType

  • set summaryType(v): void

  • Parameters

    • v: DataLegendSummaryType

    Returns void

summaryUnitsText

  • get summaryUnitsText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set summaryUnitsText(v): void

  • Parameters

    • v: string

    Returns void

summaryUnitsTextColor

  • get summaryUnitsTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryUnitsTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryUnitsTextStyle

  • get summaryUnitsTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryUnitsTextStyle(v): void

  • Parameters

    • v: string

    Returns void

summaryValueTextColor

  • get summaryValueTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set summaryValueTextColor(v): void

  • Parameters

    • v: string

    Returns void

summaryValueTextStyle

  • get summaryValueTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set summaryValueTextStyle(v): void

  • Parameters

    • v: string

    Returns void

target

  • get target(): any

  • Gets or sets the target for the data legend.

    Returns any

  • set target(v): void

  • Parameters

    • v: any

    Returns void

targetCursorPositionX

  • get targetCursorPositionX(): number

  • Gets or sets horizontal position (between 0.0 and 1.0) in viewport of the target component

    Returns number

  • set targetCursorPositionX(v): void

  • Parameters

    • v: number

    Returns void

targetCursorPositionY

  • get targetCursorPositionY(): number

  • Gets or sets vertical position (between 0.0 and 1.0) in viewport of the target component

    Returns number

  • set targetCursorPositionY(v): void

  • Parameters

    • v: number

    Returns void

titleTextColor

  • get titleTextColor(): string

  • Gets or sets the display text color.

    Returns string

  • set titleTextColor(v): void

  • Parameters

    • v: string

    Returns void

titleTextMarginBottom

  • get titleTextMarginBottom(): number

  • Returns number

  • set titleTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

titleTextMarginLeft

  • get titleTextMarginLeft(): number

  • Returns number

  • set titleTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

titleTextMarginRight

  • get titleTextMarginRight(): number

  • Returns number

  • set titleTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

titleTextMarginTop

  • get titleTextMarginTop(): number

  • Returns number

  • set titleTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

titleTextStyle

  • get titleTextStyle(): string

  • Gets or Sets the style to use for the display text.

    Returns string

  • set titleTextStyle(v): void

  • Parameters

    • v: string

    Returns void

unitsDisplayMode

  • get unitsDisplayMode(): DataLegendUnitsMode

  • Gets or sets the UnitsMode for the data legend.

    Returns DataLegendUnitsMode

  • set unitsDisplayMode(v): void

  • Parameters

    • v: DataLegendUnitsMode

    Returns void

unitsText

  • get unitsText(): string

  • Gets or sets the units text for the data legend.

    Returns string

  • set unitsText(v): void

  • Parameters

    • v: string

    Returns void

unitsTextColor

  • get unitsTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set unitsTextColor(v): void

  • Parameters

    • v: string

    Returns void

unitsTextMarginBottom

  • get unitsTextMarginBottom(): number

  • Returns number

  • set unitsTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

unitsTextMarginLeft

  • get unitsTextMarginLeft(): number

  • Returns number

  • set unitsTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

unitsTextMarginRight

  • get unitsTextMarginRight(): number

  • Returns number

  • set unitsTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

unitsTextMarginTop

  • get unitsTextMarginTop(): number

  • Returns number

  • set unitsTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

unitsTextStyle

  • get unitsTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set unitsTextStyle(v): void

  • Parameters

    • v: string

    Returns void

valueFormatAbbreviation

  • get valueFormatAbbreviation(): DataAbbreviationMode

  • Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns DataAbbreviationMode

  • set valueFormatAbbreviation(v): void

  • Parameters

    • v: DataAbbreviationMode

    Returns void

valueFormatCulture

  • get valueFormatCulture(): string

  • Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns string

  • set valueFormatCulture(v): void

  • Parameters

    • v: string

    Returns void

valueFormatCurrencyCode

  • get valueFormatCurrencyCode(): string

  • Gets or sets the currency code used for displaying currency symbol next to values, e.g. USD for $, EUR for € This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns string

  • set valueFormatCurrencyCode(v): void

  • Parameters

    • v: string

    Returns void

valueFormatMaxFractions

  • get valueFormatMaxFractions(): number

  • Gets or sets maximum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns number

  • set valueFormatMaxFractions(v): void

  • Parameters

    • v: number

    Returns void

valueFormatMinFractions

  • get valueFormatMinFractions(): number

  • Gets or sets minimum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns number

  • set valueFormatMinFractions(v): void

  • Parameters

    • v: number

    Returns void

valueFormatMode

  • get valueFormatMode(): DataLegendValueMode

  • Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

    Returns DataLegendValueMode

  • set valueFormatMode(v): void

  • Parameters

    • v: DataLegendValueMode

    Returns void

valueFormatSpecifiers

  • get valueFormatSpecifiers(): any[]

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

    Returns any[]

  • set valueFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

valueFormatString

  • get valueFormatString(): string

  • Gets or sets the format string for values displayed in the data legend.

    Returns string

  • set valueFormatString(v): void

  • Parameters

    • v: string

    Returns void

valueFormatUseGrouping

  • get valueFormatUseGrouping(): boolean

  • Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

    Returns boolean

  • set valueFormatUseGrouping(v): void

  • Parameters

    • v: boolean

    Returns void

valueRowMarginBottom

  • get valueRowMarginBottom(): number

  • Returns number

  • set valueRowMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

valueRowMarginLeft

  • get valueRowMarginLeft(): number

  • Returns number

  • set valueRowMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

valueRowMarginRight

  • get valueRowMarginRight(): number

  • Returns number

  • set valueRowMarginRight(v): void

  • Parameters

    • v: number

    Returns void

valueRowMarginTop

  • get valueRowMarginTop(): number

  • Returns number

  • set valueRowMarginTop(v): void

  • Parameters

    • v: number

    Returns void

valueRowVisible

  • get valueRowVisible(): boolean

  • Gets or sets whether to show series rows.

    Returns boolean

  • set valueRowVisible(v): void

  • Parameters

    • v: boolean

    Returns void

valueTextColor

  • get valueTextColor(): string

  • Gets or sets the units text color.

    Returns string

  • set valueTextColor(v): void

  • Parameters

    • v: string

    Returns void

valueTextMarginBottom

  • get valueTextMarginBottom(): number

  • Returns number

  • set valueTextMarginBottom(v): void

  • Parameters

    • v: number

    Returns void

valueTextMarginLeft

  • get valueTextMarginLeft(): number

  • Returns number

  • set valueTextMarginLeft(v): void

  • Parameters

    • v: number

    Returns void

valueTextMarginRight

  • get valueTextMarginRight(): number

  • Returns number

  • set valueTextMarginRight(v): void

  • Parameters

    • v: number

    Returns void

valueTextMarginTop

  • get valueTextMarginTop(): number

  • Returns number

  • set valueTextMarginTop(v): void

  • Parameters

    • v: number

    Returns void

valueTextStyle

  • get valueTextStyle(): string

  • Gets or Sets the style to use for the units text.

    Returns string

  • set valueTextStyle(v): void

  • Parameters

    • v: string

    Returns void

valueTextUseSeriesColors

  • get valueTextUseSeriesColors(): boolean

  • Gets or sets whether to use series colors when displaying values in the legend

    Returns boolean

  • set valueTextUseSeriesColors(v): void

  • Parameters

    • v: boolean

    Returns void

valueTextWhenMissingData

  • get valueTextWhenMissingData(): string

  • Gets or sets text displayed when data column is missing a value, e.g. "no data"

    Returns string

  • set valueTextWhenMissingData(v): void

  • Parameters

    • v: string

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value): void

  • Parameters

    • value: string

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

  • Returns string[]

Methods

addEventListener

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

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

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

  • Parameters

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

    Returns void

after

  • after(...nodes): void

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

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

    Parameters

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

    Returns void

afterContentInit

  • afterContentInit(): void

  • Returns void

animate

  • animate(keyframes, options?): Animation

  • Parameters

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

    Returns Animation

append

  • append(...nodes): void

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

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

    Parameters

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

    Returns void

appendChild

  • appendChild<T>(node): T

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

attachInternals

  • attachInternals(): ElementInternals

  • Returns ElementInternals

attachShadow

  • attachShadow(init): ShadowRoot

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name, oldValue, newValue): void

  • Parameters

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

    Returns void

before

  • before(...nodes): void

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

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

    Parameters

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

    Returns void

blur

  • blur(): void

  • Returns void

click

  • click(): void

  • Returns void

cloneNode

  • cloneNode(deep?): Node

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

    Parameters

    • Optional deep: boolean

    Returns Node

closest

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

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

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K]

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • closest<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void

  • Returns void

contains

  • contains(other): boolean

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

    Parameters

    • other: Node

    Returns boolean

createShadow

  • createShadow(): ShadowRoot

  • Returns ShadowRoot

destroy

  • destroy(): void

  • Returns void

disconnectedCallback

  • disconnectedCallback(): void

  • Returns void

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

ensureBadgeMargin

  • ensureBadgeMargin(): void

  • Returns void

ensureGroupRowMargin

  • ensureGroupRowMargin(): void

  • Returns void

ensureGroupTextMargin

  • ensureGroupTextMargin(): void

  • Returns void

ensureHeaderRowMargin

  • ensureHeaderRowMargin(): void

  • Returns void

ensureHeaderTextMargin

  • ensureHeaderTextMargin(): void

  • Returns void

ensureLabelTextMargin

  • ensureLabelTextMargin(): void

  • Returns void

ensureSummaryRowMargin

  • ensureSummaryRowMargin(): void

  • Returns void

ensureSummaryTitleTextMargin

  • ensureSummaryTitleTextMargin(): void

  • Returns void

ensureTitleTextMargin

  • ensureTitleTextMargin(): void

  • Returns void

ensureUnitsTextMargin

  • ensureUnitsTextMargin(): void

  • Returns void

ensureValueRowMargin

  • ensureValueRowMargin(): void

  • Returns void

ensureValueTextMargin

  • ensureValueTextMargin(): void

  • Returns void

exportSerializedVisualData

  • exportSerializedVisualData(): string

  • Returns the legend visuals expressed as a serialized string.

    Returns string

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

flush

  • flush(): void

  • Forces any pending refresh to the legend to be finished.

    Returns void

focus

  • focus(options?): void

  • Parameters

    • Optional options: FocusOptions

    Returns void

getAbbreviatedNumber

  • getAbbreviatedNumber(number, mode, minDigits, maxDigits): number

  • Parameters

    • number: number
    • mode: DataAbbreviationMode
    • minDigits: number
    • maxDigits: number

    Returns number

getAbbreviatedString

  • getAbbreviatedString(number, mode, minDigits, maxDigits): string

  • Parameters

    • number: number
    • mode: DataAbbreviationMode
    • minDigits: number
    • maxDigits: number

    Returns string

getAbbreviatedSymbol

  • getAbbreviatedSymbol(number, mode, minDigits, maxDigits): string

  • Parameters

    • number: number
    • mode: DataAbbreviationMode
    • minDigits: number
    • maxDigits: number

    Returns string

getAnimations

  • getAnimations(options?): Animation[]

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName): string

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

    Parameters

    • qualifiedName: string

    Returns string

getAttributeNS

  • getAttributeNS(namespace, localName): string

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

    Parameters

    • namespace: string
    • localName: string

    Returns string

getAttributeNames

  • getAttributeNames(): string[]

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

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName): Attr

  • Parameters

    • qualifiedName: string

    Returns Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace, localName): Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

  • Returns DOMRect

getClientRects

  • getClientRects(): DOMRectList

  • Returns DOMRectList

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>

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

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

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId): boolean

  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(where, element): Element

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

insertAdjacentHTML

  • insertAdjacentHTML(position, text): void

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where, data): void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • Parameters

    • namespace: string

    Returns boolean

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

  • lookupNamespaceURI(prefix): string

  • Parameters

    • prefix: string

    Returns string

lookupPrefix

  • lookupPrefix(namespace): string

  • Parameters

    • namespace: string

    Returns string

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

notifySizeChanged

  • notifySizeChanged(): void

  • Notifies the legend about changes to size

    Returns void

prepend

  • prepend(...nodes): void

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

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

    Parameters

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

    Returns void

querySelector

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

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

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K]

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • querySelector<E>(selectors): E

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

querySelectorAll

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

  • Returns all element descendants of node that match selectors.

    Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

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

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId): void

  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    Returns void

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

  • removeAttributeNode(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

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

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

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

  • Parameters

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

    Returns void

replaceChild

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

  • Type parameters

    Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes): void

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

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

    Parameters

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

    Returns void

replaceWith

  • replaceWith(...nodes): void

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

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

    Parameters

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

    Returns void

requestFullscreen

  • requestFullscreen(options?): Promise<void>

  • Displays element fullscreen and resolves promise when done.

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

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(): void

  • Returns void

scroll

  • scroll(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?): void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?): void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName, value): void

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

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace, qualifiedName, value): void

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

    Parameters

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

    Returns void

setAttributeNode

  • setAttributeNode(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr): Attr

  • Parameters

    • attr: Attr

    Returns Attr

setPointerCapture

  • setPointerCapture(pointerId): void

  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName, force?): boolean

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

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

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

updateStyle

  • updateStyle(): void

  • Returns void

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Static register

  • register(): void

  • Returns void