Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcDataToolTipLayerComponent

Represents an annotation layer that displays grouped tooltips with summaries for series.

Hierarchy

Hierarchy (view full)

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

translate

translate: boolean

Static htmlTagName

htmlTagName: string

Accessors

actualAppearanceMode

  • get actualAppearanceMode(): AnnotationAppearanceMode

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualAppearanceMode(v): void

  • Parameters

    Returns void

actualAreaFillOpacity

  • get actualAreaFillOpacity(): number

  • Gets the actual opacity applied to the area fill visual.

    let actualFillOpacity: number = series.actualAreaFillOpacity;

    Returns number

  • set actualAreaFillOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualBrush

  • get actualBrush(): string

  • Gets the effective brush for the current series object.

    let actualBrush: string = series.actualBrush;

    Returns string

  • set actualBrush(v): void

  • Parameters

    • v: string

    Returns void

actualCloseLabel

  • get actualCloseLabel(): string

  • Gets the text that is displayed for the Close label in the tooltip.

    Returns string

actualFocusBrush

  • get actualFocusBrush(): string

  • Gets the effective emphasis brush for the current series object.

    Returns string

  • set actualFocusBrush(v): void

  • Parameters

    • v: string

    Returns void

actualFocusMode

  • get actualFocusMode(): SeriesSelectionMode

  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualFocusMode(v): void

  • Parameters

    Returns void

actualGroupedPositionModeX

  • get actualGroupedPositionModeX(): DataTooltipGroupedPositionX

  • Gets the actual resolved tooltip position mode on the X axis for grouped series.

    Returns DataTooltipGroupedPositionX

  • set actualGroupedPositionModeX(v): void

  • Parameters

    • v: DataTooltipGroupedPositionX

    Returns void

actualGroupedPositionModeY

  • get actualGroupedPositionModeY(): DataTooltipGroupedPositionY

  • Gets the actual resolved tooltip position mode on the Y axis for grouped series.

    Returns DataTooltipGroupedPositionY

  • set actualGroupedPositionModeY(v): void

  • Parameters

    • v: DataTooltipGroupedPositionY

    Returns void

actualGroupingMode

  • get actualGroupingMode(): DataToolTipLayerGroupingMode

  • Gets the actual resolved tooltip layer grouping mode.

    Returns DataToolTipLayerGroupingMode

  • set actualGroupingMode(v): void

  • Parameters

    • v: DataToolTipLayerGroupingMode

    Returns void

actualHighLabel

  • get actualHighLabel(): string

  • Gets the text that is displayed for the High label in the tooltip.

    Returns string

actualHighlightedValuesFadeOpacity

  • get actualHighlightedValuesFadeOpacity(): number

  • Gets actual HighlightedValues fade opacity

    Returns number

  • set actualHighlightedValuesFadeOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualHighlightingFadeOpacity

  • get actualHighlightingFadeOpacity(): number

  • Gets actual highlighting fade opacity

    Returns number

  • set actualHighlightingFadeOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualHighlightingMode

  • get actualHighlightingMode(): SeriesHighlightingMode

  • Gets actual highlighting mode

    Returns SeriesHighlightingMode

  • set actualHighlightingMode(v): void

  • Parameters

    Returns void

actualHitTestMode

  • get actualHitTestMode(): SeriesHitTestMode

  • Resolved method of hit testing to use when pointing to items in the chart.

    let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;

    Returns SeriesHitTestMode

  • set actualHitTestMode(v): void

  • Parameters

    Returns void

actualHorizontalAppearanceMode

  • get actualHorizontalAppearanceMode(): AnnotationAppearanceMode

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualHorizontalAppearanceMode(v): void

  • Parameters

    Returns void

actualHorizontalDashArray

  • get actualHorizontalDashArray(): number[]

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set actualHorizontalDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

actualHorizontalShiftAmount

  • get actualHorizontalShiftAmount(): number

  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualHorizontalShiftAmount(v): void

  • Parameters

    • v: number

    Returns void

actualLayers

  • get actualLayers(): IgcSeriesLayerCollection

  • Gets the actual extra layers for the series.

    Returns IgcSeriesLayerCollection

  • set actualLayers(v): void

  • Parameters

    Returns void

actualLegendItemBadgeBrush

  • get actualLegendItemBadgeBrush(): string

  • Gets the effective legend badge fill for the current series.

    Returns string

  • set actualLegendItemBadgeBrush(v): void

  • Parameters

    • v: string

    Returns void

actualLegendItemBadgeOutline

  • get actualLegendItemBadgeOutline(): string

  • Gets the effective legend badge outline for the current series.

    Returns string

  • set actualLegendItemBadgeOutline(v): void

  • Parameters

    • v: string

    Returns void

actualLegendItemBadgeTemplate

  • get actualLegendItemBadgeTemplate(): IgDataTemplate

  • Gets the actual legend item badge template used by the series.

    Returns IgDataTemplate

  • set actualLegendItemBadgeTemplate(v): void

  • Parameters

    • v: IgDataTemplate

    Returns void

actualLowLabel

  • get actualLowLabel(): string

  • Gets the text that is displayed for the Low label in the tooltip.

    Returns string

actualMarkerFillOpacity

  • get actualMarkerFillOpacity(): number

  • Gets the actual opacity applied to the fill of the markers.

    Returns number

  • set actualMarkerFillOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualOpenLabel

  • get actualOpenLabel(): string

  • Gets the text that is displayed for the Open label in the tooltip.

    Returns string

actualOutline

  • get actualOutline(): string

  • Gets the effective outline for the current series object.

    let actualOutline: string = series.ActualOutline;

    Returns string

  • set actualOutline(v): void

  • Parameters

    • v: string

    Returns void

actualRadiusLabel

  • get actualRadiusLabel(): string

  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

actualResolution

  • get actualResolution(): number

  • Returns number

  • set actualResolution(v): void

  • Parameters

    • v: number

    Returns void

actualSelectionBrush

  • get actualSelectionBrush(): string

  • Gets the effective emphasis brush for the current series object.

    Returns string

  • set actualSelectionBrush(v): void

  • Parameters

    • v: string

    Returns void

actualSelectionMode

  • get actualSelectionMode(): SeriesSelectionMode

  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualSelectionMode(v): void

  • Parameters

    Returns void

actualShiftAmount

  • get actualShiftAmount(): number

  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualShiftAmount(v): void

  • Parameters

    • v: number

    Returns void

actualThickness

  • get actualThickness(): number

  • Gets the effective Thickness for the current series object.

    Returns number

  • set actualThickness(v): void

  • Parameters

    • v: number

    Returns void

actualValueLabel

  • get actualValueLabel(): string

  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

actualVerticalAppearanceMode

  • get actualVerticalAppearanceMode(): AnnotationAppearanceMode

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set actualVerticalAppearanceMode(v): void

  • Parameters

    Returns void

actualVerticalDashArray

  • get actualVerticalDashArray(): number[]

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set actualVerticalDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

actualVerticalShiftAmount

  • get actualVerticalShiftAmount(): number

  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set actualVerticalShiftAmount(v): void

  • Parameters

    • v: number

    Returns void

actualVolumeLabel

  • get actualVolumeLabel(): string

  • Gets the text that is displayed for the Volume label in the tooltip.

    Returns string

appearanceMode

  • get appearanceMode(): AnnotationAppearanceMode

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set appearanceMode(v): void

  • Parameters

    Returns void

areaFillOpacity

  • get areaFillOpacity(): number

  • Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

    Returns number

  • set areaFillOpacity(v): void

  • Parameters

    • v: number

    Returns void

autoCalloutLabelFormat

  • get autoCalloutLabelFormat(): string

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

    Returns string

  • set autoCalloutLabelFormat(v): void

  • Parameters

    • v: string

    Returns void

autoCalloutLabelFormatSpecifiers

  • get autoCalloutLabelFormatSpecifiers(): any[]

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

    Returns any[]

  • set autoCalloutLabelFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

autoCalloutValueLabelFormat

  • get autoCalloutValueLabelFormat(): string

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

    Returns string

  • set autoCalloutValueLabelFormat(v): void

  • Parameters

    • v: string

    Returns void

autoCalloutValueLabelFormatSpecifiers

  • get autoCalloutValueLabelFormatSpecifiers(): any[]

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

    Returns any[]

  • set autoCalloutValueLabelFormatSpecifiers(v): void

  • Parameters

    • v: any[]

    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

brush

  • get brush(): string

  • Gets or sets the brush to use for the series.

    The Brush along with the Outline and Negative Brush can be used to affect the visuals of the Series.

    this.series.brush = "red";

    Returns string

  • set brush(v): void

  • Parameters

    • v: string

    Returns void

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 reimported into the chart.

    <-- position: content member-->

    cMethods: any = {
        ValueCoercion: function(value:number): number {return value+2;}
     }

    Returns any

  • set coercionMethods(v): void

  • Parameters

    • v: any

    Returns void

cursorPosition

  • get cursorPosition(): IgPoint

  • Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position. A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement.

    Returns IgPoint

  • set cursorPosition(v): void

  • Parameters

    • v: IgPoint

    Returns void

dashArray

  • get dashArray(): number[]

  • Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

    Returns number[]

  • set dashArray(v): void

  • Parameters

    • v: number[]

    Returns void

dataLegendGroup

  • get dataLegendGroup(): string

  • Gets or sets a name used for grouping multiple series in the Data Legend If not set, series will be grouped by series family, e.g. Category, Range, Financial, Scatter

    Returns string

  • set dataLegendGroup(v): void

  • Parameters

    • v: string

    Returns void

dataLegendKey

  • get dataLegendKey(): string

  • Gets unique key used to identify the series in data legend

    Returns string

dataSource

  • get dataSource(): any

  • Returns any

  • set dataSource(value): void

  • Parameters

    • value: any

    Returns void

defaultPositionOffsetX

  • get defaultPositionOffsetX(): number

  • Gets or sets the default offset of the tooltip layer on the X axis.

    Returns number

  • set defaultPositionOffsetX(v): void

  • Parameters

    • v: number

    Returns void

defaultPositionOffsetY

  • get defaultPositionOffsetY(): number

  • Gets or sets the default offset of the tooltip layer on the Y axis.

    Returns number

  • set defaultPositionOffsetY(v): void

  • Parameters

    • v: number

    Returns void

discreteLegendItemTemplate

  • get discreteLegendItemTemplate(): IgDataTemplate

  • Gets or sets the DiscreteLegendItemTemplate property. The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set discreteLegendItemTemplate(v): void

  • Parameters

    • v: IgDataTemplate

    Returns void

excludedColumns

  • get excludedColumns(): string[]

  • Gets or sets names of data columns or their labels to exclude from displaying in the data tooltip, 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

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.

    expectFunctions is used to decide whether the series should expect that its data source members need to be called as functions to get their values.

    this.series.expectFunctions=true;

    Returns boolean

  • set expectFunctions(v): void

  • Parameters

    • v: boolean

    Returns void

finalValue

  • get finalValue(): number

  • The final value of this series.

    Returns number

  • set finalValue(v): void

  • Parameters

    • v: number

    Returns void

focusBrush

  • get focusBrush(): string

  • Gets or sets the Focus brush to use for the series.

    Returns string

  • set focusBrush(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

groupedPositionModeX

  • get groupedPositionModeX(): DataTooltipGroupedPositionX

  • Gets or sets the tooltip position mode on the X axis for grouped series.

    Returns DataTooltipGroupedPositionX

  • set groupedPositionModeX(v): void

  • Parameters

    • v: DataTooltipGroupedPositionX

    Returns void

groupedPositionModeY

  • get groupedPositionModeY(): DataTooltipGroupedPositionY

  • Gets or sets the tooltip position mode on the Y axis for grouped series.

    Returns DataTooltipGroupedPositionY

  • set groupedPositionModeY(v): void

  • Parameters

    • v: DataTooltipGroupedPositionY

    Returns void

groupingMode

  • get groupingMode(): DataToolTipLayerGroupingMode

  • Gets or sets the grouping mode to apply to use for the tooltip layer.

    Returns DataToolTipLayerGroupingMode

  • set groupingMode(v): void

  • Parameters

    • v: DataToolTipLayerGroupingMode

    Returns void

hasMarkers

  • get hasMarkers(): boolean

  • Returns whether the current series supports visual markers.

    let hasMarkers: boolean = this.series.hasMarkers;

    Returns boolean

hasOnlyMarkers

  • get hasOnlyMarkers(): boolean

  • Gets whether the series has only marker as visuals

    Returns boolean

hasValueAxis

  • get hasValueAxis(): boolean

  • Gets whether the current series shows an area shape.

    Returns boolean

hasVisibleMarkers

  • get hasVisibleMarkers(): boolean

  • Returns whether the current series has a visible marker style.

    Returns boolean

headerFormatCulture

  • get headerFormatCulture(): string

  • Gets or sets globalization culture when displaying header as date time 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 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 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

highlightedDataSource

  • get highlightedDataSource(): any

  • Returns any

  • set highlightedDataSource(value): void

  • Parameters

    • value: any

    Returns void

highlightedLegendItemVisibility

  • get highlightedLegendItemVisibility(): Visibility

  • Gets or sets whether the highlighted values layer should have a legend item.

    Returns Visibility

  • set highlightedLegendItemVisibility(v): void

  • Parameters

    • v: Visibility

    Returns void

highlightedTitleSuffix

  • get highlightedTitleSuffix(): string

  • Gets or sets the HighlightedTitleSuffix property.

    Returns string

  • set highlightedTitleSuffix(v): void

  • Parameters

    • v: string

    Returns void

highlightedValuesDataLegendGroup

  • get highlightedValuesDataLegendGroup(): string

  • Gets or sets a name used for grouping highlighted series in the Data Legend If not set, series will default to parent series' DataLegendGroup, e.g. Category, Range, Financial, Scatter

    Returns string

  • set highlightedValuesDataLegendGroup(v): void

  • Parameters

    • v: string

    Returns void

highlightedValuesDisplayMode

  • get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

  • Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

    Returns SeriesHighlightedValuesDisplayMode

  • set highlightedValuesDisplayMode(v): void

  • Parameters

    Returns void

highlightedValuesExtraPropertyOverlays

  • get highlightedValuesExtraPropertyOverlays(): IgcSeriesLayerPropertyOverlayCollection

  • Gets the current extra layers for the series.

    Returns IgcSeriesLayerPropertyOverlayCollection

  • set highlightedValuesExtraPropertyOverlays(v): void

  • Parameters

    Returns void

highlightedValuesFadeOpacity

  • get highlightedValuesFadeOpacity(): number

  • Gets or sets the target opacity to fade to for fade style HighlightedValues.

    Returns number

  • set highlightedValuesFadeOpacity(v): void

  • Parameters

    • v: number

    Returns void

highlightingFadeOpacity

  • get highlightingFadeOpacity(): number

  • Gets or sets the target opacity to fade to for fade style highlighting.

    Returns number

  • set highlightingFadeOpacity(v): void

  • Parameters

    • v: number

    Returns void

hitTestMode

  • get hitTestMode(): SeriesHitTestMode

  • Method of hit testing to use when pointing to items in this series.

    The HitTestMode can be set to either:

    • Auto: automatically decide the appropriate hit test mode for the series.
    • ColorEncoded: use a color encoded off screen buffer for hit testing. Should always be O(1) time for determining a hit series. This increases frame render time and memory usage, however. Consider using this if hit testing time is degrading performance.
    • Computational: use a computational based approach to determine whether the series has been hit. This uses loose bounding boxes, in some cases, and can range in time complexity between O(1) and O(log n) to find a hit. This decreases frame render time compared to color encoded
    this.series.hitTestMode = SeriesHitTestMode.Computational;

    Returns SeriesHitTestMode

  • set hitTestMode(v): void

  • Parameters

    Returns void

horizontalAppearanceMode

  • get horizontalAppearanceMode(): AnnotationAppearanceMode

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set horizontalAppearanceMode(v): void

  • Parameters

    Returns void

horizontalDashArray

  • get horizontalDashArray(): number[]

  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set horizontalDashArray(v): void

  • Parameters

    • v: number[]

    Returns void

horizontalShiftAmount

  • get horizontalShiftAmount(): number

  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set horizontalShiftAmount(v): void

  • Parameters

    • v: number

    Returns void

includedColumns

  • get includedColumns(): string[]

  • Gets or sets names of data columns or their labels to include in displaying in the data tooltip, 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

isActualLegendFinancial

  • get isActualLegendFinancial(): boolean

  • Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

    Returns boolean

  • set isActualLegendFinancial(v): void

  • Parameters

    • v: boolean

    Returns void

isAnnotationCalloutLayer

  • get isAnnotationCalloutLayer(): boolean

  • Gets whether the series is an callout annotation layer.

    Returns boolean

isAnnotationCrosshairLayer

  • get isAnnotationCrosshairLayer(): boolean

  • Gets whether the series is an crosshair annotation layer.

    Returns boolean

isAnnotationFinalValue

  • get isAnnotationFinalValue(): boolean

  • Gets whether the series is final value annotation layer.

    Returns boolean

isAnnotationHoverLayer

  • get isAnnotationHoverLayer(): boolean

  • Gets whether the series is an annotation layer displayed only when hovering over the chart.

    Returns boolean

isAnnotationLayer

  • get isAnnotationLayer(): boolean

  • Gets whether this series is an annotation layer.

    Returns boolean

isAnnotationValueLayer

  • get isAnnotationValueLayer(): boolean

  • Gets whether the series is a value annotation layer.

    Returns boolean

isArea

  • get isArea(): boolean

  • Gets whether the current series shows an area shape.

    Returns boolean

isAreaOrLine

  • get isAreaOrLine(): boolean

  • Gets whether the current series shows an area or line shape.

    let isAreaorLine: boolean = this.series.isAreaorLine;

    Returns boolean

isBar

  • get isBar(): boolean

  • Gets whether the current series shows a horizontal column shape.

    Returns boolean

isCategory

  • get isCategory(): boolean

  • Gets whether the current series is a category type series.

    let isCategory: boolean = this.series.isCategory;

    Returns boolean

isColoredItemwise

  • get isColoredItemwise(): boolean

  • Returns boolean

isColumn

  • get isColumn(): boolean

  • Gets whether the current series shows a column shape.

    Returns boolean

isComponentHighlightingModeIgnored

  • get isComponentHighlightingModeIgnored(): boolean

  • Gets or sets whether the component level highlight mode is ignored.

    Returns boolean

  • set isComponentHighlightingModeIgnored(v): void

  • Parameters

    • v: boolean

    Returns void

isDefaultCrosshairBehaviorDisabled

  • get isDefaultCrosshairBehaviorDisabled(): boolean

  • Gets whether or not the default crosshair behavior is disabled.

    Returns boolean

isDefaultCrosshairDisabled

  • get isDefaultCrosshairDisabled(): boolean

  • Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer.

    Returns boolean

  • set isDefaultCrosshairDisabled(v): void

  • Parameters

    • v: boolean

    Returns void

isDefaultToolTipSelected

  • get isDefaultToolTipSelected(): boolean

  • Gets if the default tooltip has been selected for display.

    To use the default tooltip set ShowDefaultTooltip to true.

    let isDefaultToolTipSelected: boolean = this.series.isDefaultToolTipSelected;

    Returns boolean

  • set isDefaultToolTipSelected(v): void

  • Parameters

    • v: boolean

    Returns void

isDefaultTooltipBehaviorDisabled

  • get isDefaultTooltipBehaviorDisabled(): boolean

  • Gets whether the default tooltip behaviors for the chart are disabled if this layer is present.

    Returns boolean

isDropShadowEnabled

  • get isDropShadowEnabled(): boolean

  • Gets or sets whether drop shadow should be enabled for this series.

    IsDropShadowEnabled is used to decide whether drop shadow should be enabled for this series.

    this.series.isDropShadowEnabled = true;

    Returns boolean

  • set isDropShadowEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isFinancial

  • get isFinancial(): boolean

  • Gets whether the current series is a financial type series.

    let isFinancial: boolean = this.series.isFinancial;

    Returns boolean

isFinancialIndicator

  • get isFinancialIndicator(): boolean

  • Gets whether the series is financial indicator

    Returns boolean

isFinancialOverlay

  • get isFinancialOverlay(): boolean

  • Gets whether the series is financial overlay

    Returns boolean

isFinancialSeries

  • get isFinancialSeries(): boolean

  • Gets whether the series has financial OHLC/candlestick visuals

    Returns boolean

isFinancialWaterfall

  • get isFinancialWaterfall(): boolean

  • Gets whether the series is financial waterfall

    Returns boolean

isFragment

  • get isFragment(): boolean

  • Gets whether the current series is a stack fragment.

    let isFragment: boolean = this.series.isFragment;

    Returns boolean

isGeographic

  • get isGeographic(): boolean

  • Gets whether the current series is a geographic series.

    let isGeographic: boolean = this.series.isGeographic;

    Returns boolean

isHighlightOverlay

  • get isHighlightOverlay(): boolean

  • Gets whether the series is a highlight overlay.

    Returns boolean

isHighlightingEnabled

  • get isHighlightingEnabled(): boolean

  • Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

    this.series.isHighlightingEnabled = true;

    Returns boolean

  • set isHighlightingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isIndexed

  • get isIndexed(): boolean

  • Gets if the series uses an index, which can be used to auto-assign it a color.

    Returns boolean

isLayer

  • get isLayer(): boolean

  • Returns boolean

isLineContour

  • get isLineContour(): boolean

  • Gets whether the current series shows a line contour shape.

    Returns boolean

isLineOnly

  • get isLineOnly(): boolean

  • Gets whether the current series shows only line shapes.

    Returns boolean

isMarkerlessDisplayPreferred

  • get isMarkerlessDisplayPreferred(): boolean

  • Overridden by derived series classes to indicate when markerless display is preferred or not.

    Returns boolean

isNegativeColorSupported

  • get isNegativeColorSupported(): boolean

  • Overridden by derived series classes to indicate when negative colors are supported or not.

    Returns boolean

isPie

  • get isPie(): boolean

  • Gets whether the current series shows a pie shape.

    Returns boolean

isPixel

  • get isPixel(): boolean

  • Gets whether the current series shows pixels.

    Returns boolean

isPolar

  • get isPolar(): boolean

  • Gets whether the current series is a polar type series.

    let isPolar: boolean = this.series.isPolar;

    Returns boolean

isPolygon

  • get isPolygon(): boolean

  • Gets whether the current series shows a polygon shape.

    Returns boolean

isPolyline

  • get isPolyline(): boolean

  • Gets whether the current series shows a polyline shape.

    Returns boolean

isRadial

  • get isRadial(): boolean

  • Gets whether the current series is a radial type series.

    let isRadial: boolean = this.series.isRadial;

    Returns boolean

isRange

  • get isRange(): boolean

  • Gets whether the current series is a range type series.

    let isRange: boolean = this.series.isRange;

    Returns boolean

isScatter

  • get isScatter(): boolean

  • Gets whether the current series is a scatter type series.

    let isScatter: boolean = this.series.isScatter;

    Returns boolean

isShape

  • get isShape(): boolean

  • Gets whether the current series is a shape type series.

    Returns boolean

isShapeControl

  • get isShapeControl(): boolean

  • Gets whether the current series shows interactive shape controls.

    Returns boolean

isSpline

  • get isSpline(): boolean

  • Gets whether the current series shows a spline shape.

    Returns boolean

isStacked

  • get isStacked(): boolean

  • Gets whether the current series is a stacked type series.

    let isStacked: boolean = this.series.isStacked;

    Returns boolean

isStep

  • get isStep(): boolean

  • Gets whether the current series shows step shapes.

    Returns boolean

isSummarizationSupported

  • get isSummarizationSupported(): boolean

  • Gets whether the series supports summarization in Data Legend and Data Tooltip.

    Returns boolean

isTile

  • get isTile(): boolean

  • Gets whether the current series shows a tile imagery.

    Returns boolean

isUsableInLegend

  • get isUsableInLegend(): boolean

  • Gets if the series should appear in any legends.

    Returns boolean

isValueAxisInverted

  • get isValueAxisInverted(): boolean

  • Gets whether the current series shows an area shape.

    Returns boolean

isValueOverlay

  • get isValueOverlay(): boolean

  • Gets whether the series is a value overlay.

    Returns boolean

isVertical

  • get isVertical(): boolean

  • Gets whether the current series is oriented vertically.

    let isVertical: boolean = this.series.isVertical;

    Returns boolean

isWaterfall

  • get isWaterfall(): boolean

  • Gets whether the current series shows a waterfall column shape.

    Returns boolean

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

layers

  • get layers(): IgcSeriesLayerCollection

  • Gets the current extra layers for the series.

    Returns IgcSeriesLayerCollection

  • set layers(v): void

  • Parameters

    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

legend

  • get legend(): any

  • Gets or sets the legend used for the current series.

    Returns any

  • set legend(v): void

  • Parameters

    • v: any

    Returns void

legendItemBadgeMode

  • get legendItemBadgeMode(): LegendItemBadgeMode

  • Gets or sets the mode of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

    Returns LegendItemBadgeMode

  • set legendItemBadgeMode(v): void

  • Parameters

    • v: LegendItemBadgeMode

    Returns void

legendItemBadgeShape

  • get legendItemBadgeShape(): LegendItemBadgeShape

  • Gets or sets the type of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

    Returns LegendItemBadgeShape

  • set legendItemBadgeShape(v): void

  • Parameters

    • v: LegendItemBadgeShape

    Returns void

legendItemBadgeTemplate

  • get legendItemBadgeTemplate(): IgDataTemplate

  • Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemBadgeTemplate(v): void

  • Parameters

    • v: IgDataTemplate

    Returns void

legendItemTemplate

  • get legendItemTemplate(): IgDataTemplate

  • Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

    Returns IgDataTemplate

  • set legendItemTemplate(v): void

  • Parameters

    • v: IgDataTemplate

    Returns void

legendItemVisibility

  • get legendItemVisibility(): Visibility

  • Gets or sets whether or not the current series will have a legend item displayed in a legend.

    The LegendItemVisibilty can be used to exclude only certain Series from the Legend.

    Returns Visibility

  • set legendItemVisibility(v): void

  • Parameters

    • v: Visibility

    Returns void

lineCap

  • get lineCap(): PenLineCap

  • Gets or sets the style of the starting point of any lines or polylines representing this series. Not every series type has a line at which it would be appropriate to display a start cap, so this property does not affect every series type. LineSeries, for example, is affected by StartCap, but ColumnSeries is not.

    Returns PenLineCap

  • set lineCap(v): void

  • Parameters

    • v: PenLineCap

    Returns void

lineJoin

  • get lineJoin(): PenLineJoin

  • Gets or sets the brush that specifies current series object's line join style.

    Returns PenLineJoin

  • set lineJoin(v): void

  • Parameters

    • v: PenLineJoin

    Returns void

markerFillOpacity

  • get markerFillOpacity(): number

  • Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

    Returns number

  • set markerFillOpacity(v): void

  • Parameters

    • v: number

    Returns void

mouseOverEnabled

  • get mouseOverEnabled(): boolean

  • Gets or sets the whether the chart reacts to mouse move events.

    Returns boolean

  • set mouseOverEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

name

  • get name(): string

  • Returns string

  • set name(value): void

  • Parameters

    • value: string

    Returns void

opacity

  • get opacity(): number

  • Returns number

  • set opacity(v): void

  • Parameters

    • v: number

    Returns void

outline

  • get outline(): string

  • Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

    The Outline along with the Brush and NegativeBrush can be used to affect the visuals of the Series.

    this.series.brush = "red";

    Returns string

  • set outline(v): void

  • Parameters

    • v: string

    Returns void

outlineMode

  • get outlineMode(): SeriesOutlineMode

  • Gets or sets the outline mode to use for the series.

    Returns SeriesOutlineMode

  • set outlineMode(v): void

  • Parameters

    Returns void

percentChange

  • get percentChange(): number

  • The percent change from the beginning to the end of this series.

    Returns number

  • set percentChange(v): void

  • Parameters

    • v: number

    Returns void

positionOffsetX

  • get positionOffsetX(): number

  • Gets or sets the offset of the tooltip layer on the X axis.

    Returns number

  • set positionOffsetX(v): void

  • Parameters

    • v: number

    Returns void

positionOffsetY

  • get positionOffsetY(): number

  • Gets or sets the offset of the tooltip layer on the Y axis.

    Returns number

  • set positionOffsetY(v): void

  • Parameters

    • v: number

    Returns void

renderRequested

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

  • This event is raised every time a render has been requested from a series.

    Returns ((s, e) => void)

  • set renderRequested(ev): void

  • Parameters

    Returns void

resolution

  • get resolution(): number

  • Gets or sets the current series object's rendering resolution.

    Setting the Resolution on a Series to a higher value can help with performance, but it will lower the graphical fidelity of the line. As such, it can be increased up until the fidelity is unacceptable.

    this.series.resolution = 1.5;

    Returns number

  • set resolution(v): void

  • Parameters

    • v: number

    Returns void

safeActualBrush

  • get safeActualBrush(): string

  • Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

    Returns string

  • set safeActualBrush(v): void

  • Parameters

    • v: string

    Returns void

selectionBrush

  • get selectionBrush(): string

  • Gets or sets the selection brush to use for the series.

    Returns string

  • set selectionBrush(v): void

  • Parameters

    • v: string

    Returns void

seriesInternal

  • get seriesInternal(): any

  • Returns any

shadowBlur

  • get shadowBlur(): number

  • Gets or sets the shadow blur. This property is ignored when Series.UseSingleShadow is set to true.

    ShadowBlur can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowBlur = 7;

    Returns number

  • set shadowBlur(v): void

  • Parameters

    • v: number

    Returns void

shadowColor

  • get shadowColor(): string

  • Gets or sets the drop shadow color.

    ShadowColor can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowColor = "blue";

    Returns string

  • set shadowColor(v): void

  • Parameters

    • v: string

    Returns void

shadowOffsetX

  • get shadowOffsetX(): number

  • Gets or sets the drop shadow x-offset.

    ShadowOffsetX can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowOffsetX = 10;

    Returns number

  • set shadowOffsetX(v): void

  • Parameters

    • v: number

    Returns void

shadowOffsetY

  • get shadowOffsetY(): number

  • Gets or sets the drop shadow y-offset.

    ShadowOffsetY can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

    this.series.shadowOffsetY = 10;

    Returns number

  • set shadowOffsetY(v): void

  • Parameters

    • v: number

    Returns void

shiftAmount

  • get shiftAmount(): number

  • Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

    Returns number

  • set shiftAmount(v): void

  • Parameters

    • v: number

    Returns void

shouldAnimateOnDataSourceSwap

  • get shouldAnimateOnDataSourceSwap(): boolean

  • Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.

    Returns boolean

  • set shouldAnimateOnDataSourceSwap(v): void

  • Parameters

    • v: boolean

    Returns void

shouldHideAutoCallouts

  • get shouldHideAutoCallouts(): boolean

  • Gets or sets whether this series should suppress it's auto callouts

    Returns boolean

  • set shouldHideAutoCallouts(v): void

  • Parameters

    • v: boolean

    Returns void

shouldRemoveHighlightedDataOnLayerHidden

  • get shouldRemoveHighlightedDataOnLayerHidden(): boolean

  • Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

    Returns boolean

  • set shouldRemoveHighlightedDataOnLayerHidden(v): void

  • Parameters

    • v: boolean

    Returns void

shouldRenderAsOverlay

  • get shouldRenderAsOverlay(): boolean

  • Gets or sets whether this layer renders as an overlay or not.

    Returns boolean

  • set shouldRenderAsOverlay(v): void

  • Parameters

    • v: boolean

    Returns void

shouldShiftOpacityForSafeActualBrush

  • get shouldShiftOpacityForSafeActualBrush(): boolean

  • Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

    Returns boolean

  • set shouldShiftOpacityForSafeActualBrush(v): void

  • Parameters

    • v: boolean

    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

showDefaultTooltip

  • get showDefaultTooltip(): boolean

  • Gets or sets whether default tooltip will be shown.

    The default tooltips display all the information relevant to the particular series item (series title, data values, axis values etc.) and are styled to match the series' style. When using default tooltips, you should also set the series Title.

    this.series.showDefaultTooltip ="true";

    Returns boolean

  • set showDefaultTooltip(v): void

  • Parameters

    • v: boolean

    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

targetAxis

  • get targetAxis(): IgcAxisComponent

  • Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.

    Returns IgcAxisComponent

  • set targetAxis(v): void

  • Parameters

    Returns void

thickness

  • get thickness(): number

  • Gets or sets the width of the current series object's line thickness.

    Depending on the Series type, this can be the main brush used, or just the outline. For example, when using a LineSeries it will affect the thickness of the lines drawn, whereas when using a ColumnSeries it will affect the outer border thickness of the columns.

    this.series.thickness=5;

    Returns number

  • set thickness(v): void

  • Parameters

    • v: number

    Returns void

title

  • get title(): any

  • Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

    The Series Title may be used in tooltips and legends.

    this.series.title = "InStock Items";

    Returns any

  • set title(v): void

  • Parameters

    • v: any

    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

tooltipContainerTemplate

  • get tooltipContainerTemplate(): TemplateFunction

  • Returns TemplateFunction

  • set tooltipContainerTemplate(value): void

  • Parameters

    • value: TemplateFunction

    Returns void

tooltipTemplate

  • get tooltipTemplate(): TemplateFunction

  • Returns TemplateFunction

  • set tooltipTemplate(value): void

  • Parameters

    • value: TemplateFunction

    Returns void

transitionDuration

  • get transitionDuration(): number

  • Gets or sets the duration of the current series' morph.

    The TransitionDuration can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

    this.series.transitionDuration = 500;

    Returns number

  • set transitionDuration(v): void

  • Parameters

    • v: number

    Returns void

transitionEasingFunction

  • get transitionEasingFunction(): ((time) => number)

  • Gets or sets the easing function used to morph the current series.

    The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

    this.series.transitionEasingFunction =  EasingFunctions.cubicEase;

    Returns ((time) => number)

      • (time): number

      • Parameters

        • time: number

        Returns number

  • set transitionEasingFunction(v): void

  • Parameters

    • v: ((time) => number)
        • (time): number

        • Parameters

          • time: number

          Returns number

    Returns void

transitionInDuration

  • get transitionInDuration(): number

  • Gets or sets the duration of the current series' transition in morph.

    The TransitionInDuration can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

    this.series.transitionDuration = 500;

    Returns number

  • set transitionInDuration(v): void

  • Parameters

    • v: number

    Returns void

transitionInEasingFunction

  • get transitionInEasingFunction(): ((time) => number)

  • Gets or sets the EasingFunction used to morph the current series during the initial transition.

    The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

    this.series.transitionInEasingFunction =  EasingFunctions.cubicEase;

    Returns ((time) => number)

      • (time): number

      • Parameters

        • time: number

        Returns number

  • set transitionInEasingFunction(v): void

  • Parameters

    • v: ((time) => number)
        • (time): number

        • Parameters

          • time: number

          Returns number

    Returns void

transitionInSpeedType

  • get transitionInSpeedType(): TransitionInSpeedType

  • Gets or sets the duration of the current series' transition in morph.

    The TransitionInSpeedType can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

    this.series.transitionInSpeedType = TransitionInSpeedType.IndexScaled;

    Returns TransitionInSpeedType

  • set transitionInSpeedType(v): void

  • Parameters

    Returns void

transitionOutCompleted

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

  • Fired when a transition out has completed.

    Returns ((s, e) => void)

  • set transitionOutCompleted(ev): void

  • Parameters

    Returns void

transitionOutDuration

  • get transitionOutDuration(): number

  • Gets or sets the duration of the current series' transition out morph.

    Returns number

  • set transitionOutDuration(v): void

  • Parameters

    • v: number

    Returns void

transitionOutEasingFunction

  • get transitionOutEasingFunction(): ((time) => number)

  • Gets or sets the EasingFunction used to morph the current series during the initial transition.

    Returns ((time) => number)

      • (time): number

      • Parameters

        • time: number

        Returns number

  • set transitionOutEasingFunction(v): void

  • Parameters

    • v: ((time) => number)
        • (time): number

        • Parameters

          • time: number

          Returns number

    Returns void

transitionOutSpeedType

  • get transitionOutSpeedType(): TransitionOutSpeedType

  • Gets or sets the duration of the current series' transition out morph.

    Returns TransitionOutSpeedType

  • set transitionOutSpeedType(v): void

  • Parameters

    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