Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

Properties

ATTRIBUTE_NODE: number
CDATA_SECTION_NODE: number

node is a CDATASection node.

COMMENT_NODE: number

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

DOCUMENT_NODE: number

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: number

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

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

DOCUMENT_TYPE_NODE: number

node is a doctype.

ELEMENT_NODE: number

node is an element.

ENTITY_NODE: number
ENTITY_REFERENCE_NODE: number
NOTATION_NODE: number
PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

TEXT_NODE: number

node is a Text node.

accessKey: string
accessKeyLabel: string
ariaAtomic: string
ariaAutoComplete: string
ariaBusy: string
ariaChecked: string
ariaColCount: string
ariaColIndex: string
ariaColIndexText: string
ariaColSpan: string
ariaCurrent: string
ariaDisabled: string
ariaExpanded: string
ariaHasPopup: string
ariaHidden: string
ariaInvalid: string
ariaKeyShortcuts: string
ariaLabel: string
ariaLevel: string
ariaLive: string
ariaModal: string
ariaMultiLine: string
ariaMultiSelectable: string
ariaOrientation: string
ariaPlaceholder: string
ariaPosInSet: string
ariaPressed: string
ariaReadOnly: string
ariaRequired: string
ariaRoleDescription: string
ariaRowCount: string
ariaRowIndex: string
ariaRowIndexText: string
ariaRowSpan: string
ariaSelected: string
ariaSetSize: string
ariaSort: string
ariaValueMax: string
ariaValueMin: string
ariaValueNow: string
ariaValueText: string
assignedSlot: HTMLSlotElement
attributes: NamedNodeMap
autocapitalize: string
autofocus: boolean
baseURI: string

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

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

children: HTMLCollection

Returns the child elements.

classList: DOMTokenList

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

className: string

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

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
contentEditable: string
dataset: DOMStringMap
dir: string
draggable: boolean
enterKeyHint: string
firstChild: ChildNode

Returns the first child.

firstElementChild: Element

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

hidden: boolean
id: string

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

inert: boolean
innerHTML: string
innerText: string
inputMode: string
isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable: boolean
lang: string
lastChild: ChildNode

Returns the last child.

lastElementChild: Element

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

localName: string

Returns the local name.

namespaceURI: string

Returns the namespace.

nextElementSibling: Element

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

nextSibling: ChildNode

Returns the next sibling.

nodeName: string

Returns a string appropriate for the type of node.

nodeType: number

Returns the type of node.

nodeValue: string
nonce?: string
offsetHeight: number
offsetLeft: number
offsetParent: Element
offsetTop: number
offsetWidth: number
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: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

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: ((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: ((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: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: DocumentAndElementEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Occurs when playback is paused.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

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

Fires when the current selection changes.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

        The event.

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Deprecated

This is a legacy alias of onanimationend.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Deprecated

This is a legacy alias of onanimationstart.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML: string
outerText: string
ownerDocument: Document
parentElement: HTMLElement

Returns the parent element.

parentNode: ParentNode

Returns the parent.

part: DOMTokenList
prefix: string

Returns the namespace prefix.

previousElementSibling: Element

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

previousSibling: ChildNode

Returns the previous sibling.

role: string
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: ShadowRoot

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

slot: string

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

spellcheck: boolean
style: CSSStyleDeclaration
tabIndex: number
tagName: string

Returns the HTML-uppercased qualified name.

textContent: string
translate: boolean
htmlTagName: string

Accessors

  • 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

  • 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

  • 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

  • get actualCloseLabel(): string
  • Gets the text that is displayed for the Close label in the tooltip.

    Returns string

  • get actualFocusBrush(): string
  • Gets the effective emphasis brush for the current series object.

    Returns string

  • set actualFocusBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualFocusMode(): SeriesSelectionMode
  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualFocusMode(v): void
  • Parameters

    Returns void

  • get actualHighLabel(): string
  • Gets the text that is displayed for the High label in the tooltip.

    Returns string

  • get actualHighlightedValuesFadeOpacity(): number
  • Gets actual HighlightedValues fade opacity

    Returns number

  • set actualHighlightedValuesFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightingFadeOpacity(): number
  • Gets actual highlighting fade opacity

    Returns number

  • set actualHighlightingFadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualHighlightingMode(): SeriesHighlightingMode
  • Gets actual highlighting mode

    Returns SeriesHighlightingMode

  • set actualHighlightingMode(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • get actualLayers(): IgcSeriesLayerCollection
  • Gets the actual extra layers for the series.

    Returns IgcSeriesLayerCollection

  • set actualLayers(v): void
  • Parameters

    Returns void

  • get actualLegendItemBadgeBrush(): string
  • Gets the effective legend badge fill for the current series.

    Returns string

  • set actualLegendItemBadgeBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualLegendItemBadgeOutline(): string
  • Gets the effective legend badge outline for the current series.

    Returns string

  • set actualLegendItemBadgeOutline(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • get actualLowLabel(): string
  • Gets the text that is displayed for the Low label in the tooltip.

    Returns string

  • 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

  • get actualOpenLabel(): string
  • Gets the text that is displayed for the Open label in the tooltip.

    Returns string

  • 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

  • get actualRadiusLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • get actualResolution(): number
  • Returns number

  • set actualResolution(v): void
  • Parameters

    • v: number

    Returns void

  • get actualSelectionBrush(): string
  • Gets the effective emphasis brush for the current series object.

    Returns string

  • set actualSelectionBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get actualSelectionMode(): SeriesSelectionMode
  • Gets actual Selection mode

    Returns SeriesSelectionMode

  • set actualSelectionMode(v): void
  • Parameters

    Returns void

  • 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

  • get actualThickness(): number
  • Gets the effective Thickness for the current series object.

    Returns number

  • set actualThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get actualValueLabel(): string
  • Gets the text that is displayed for the Value label in the tooltip.

    Returns string

  • 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

  • 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

  • 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

  • get actualVolumeLabel(): string
  • Gets the text that is displayed for the Volume label in the tooltip.

    Returns string

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get dataLegendKey(): string
  • Gets unique key used to identify the series in data legend

    Returns string

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

  • 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

  • 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

  • get finalValue(): number
  • The final value of this series.

    Returns number

  • set finalValue(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • get hasMarkers(): boolean
  • Returns whether the current series supports visual markers.

    let hasMarkers: boolean = this.series.hasMarkers;
    

    Returns boolean

  • get hasOnlyMarkers(): boolean
  • Gets whether the series has only marker as visuals

    Returns boolean

  • get hasValueAxis(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get highlightedDataSource(): any
  • Returns any

  • set highlightedDataSource(value): void
  • Parameters

    • value: any

    Returns void

  • get highlightedTitleSuffix(): string
  • Gets or sets the HighlightedTitleSuffix property.

    Returns string

  • set highlightedTitleSuffix(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • 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

  • get highlightedValuesExtraPropertyOverlays(): IgcSeriesLayerPropertyOverlayCollection
  • Gets the current extra layers for the series.

    Returns IgcSeriesLayerPropertyOverlayCollection

  • set highlightedValuesExtraPropertyOverlays(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • get horizontalLineStroke(): string
  • Gets or sets the color to use for the horizontal line. Leave null for an automatic value.

    Returns string

  • set horizontalLineStroke(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • 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

  • get isAnnotationCalloutLayer(): boolean
  • Gets whether the series is an callout annotation layer.

    Returns boolean

  • get isAnnotationCrosshairLayer(): boolean
  • Gets whether the series is an crosshair annotation layer.

    Returns boolean

  • get isAnnotationFinalValue(): boolean
  • Gets whether the series is final value annotation layer.

    Returns boolean

  • get isAnnotationHoverLayer(): boolean
  • Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer

    Returns boolean

  • get isAnnotationLayer(): boolean
  • Gets whether this series is an annotation layer.

    Returns boolean

  • get isAnnotationValueLayer(): boolean
  • Gets whether the series is an crosshair annotation layer.

    Returns boolean

  • get isArea(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isAreaOrLine(): boolean
  • Gets whether the current series shows an area or line shape.

    let isAreaorLine: boolean = this.series.isAreaorLine;
    

    Returns boolean

  • get isAxisAnnotationEnabled(): boolean
  • Gets or sets whether to draw annotations over the axes where the crosshair meets with them.

    Returns boolean

  • set isAxisAnnotationEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isBar(): boolean
  • Gets whether the current series shows a horizontal column shape.

    Returns boolean

  • get isCategory(): boolean
  • Gets whether the current series is a category type series.

    let isCategory: boolean = this.series.isCategory;
    

    Returns boolean

  • get isColumn(): boolean
  • Gets whether the current series shows a column shape.

    Returns boolean

  • 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

  • get isDefaultCrosshairBehaviorDisabled(): boolean
  • Gets whether or not the default crosshair behavior is disabled.

    Returns boolean

  • 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

  • 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

  • get isDefaultTooltipBehaviorDisabled(): boolean
  • Gets whether the default tooltip behavior should be disabled if this series is present.

     let isDefaultTooltipBehaviorDisabled: boolean = this.series.isDefaultTooltipBehaviorDisabled;
    

    Returns boolean

  • 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

  • get isFinancial(): boolean
  • Gets whether the current series is a financial type series.

    let isFinancial: boolean = this.series.isFinancial;
    

    Returns boolean

  • get isFinancialIndicator(): boolean
  • Gets whether the series is financial indicator

    Returns boolean

  • get isFinancialOverlay(): boolean
  • Gets whether the series is financial overlay

    Returns boolean

  • get isFinancialSeries(): boolean
  • Gets whether the series has financial OHLC/candlestick visuals

    Returns boolean

  • get isFinancialWaterfall(): boolean
  • Gets whether the series is financial waterfall

    Returns boolean

  • get isFragment(): boolean
  • Gets whether the current series is a stack fragment.

    let isFragment: boolean = this.series.isFragment;
    

    Returns boolean

  • get isGeographic(): boolean
  • Gets whether the current series is a geographic series.

    let isGeographic: boolean = this.series.isGeographic;
    

    Returns boolean

  • get isHighlightOverlay(): boolean
  • Gets whether the series is a highlight overlay.

    Returns boolean

  • 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

  • get isIndexed(): boolean
  • Gets if the series uses an index, which can be used to auto-assign it a color.

    Returns boolean

  • get isLineContour(): boolean
  • Gets whether the current series shows a line contour shape.

    Returns boolean

  • get isLineOnly(): boolean
  • Gets whether the current series shows only line shapes.

    Returns boolean

  • get isMarkerlessDisplayPreferred(): boolean
  • Overridden by derived series classes to indicate when markerless display is preferred or not.

    Returns boolean

  • get isNegativeColorSupported(): boolean
  • Overridden by derived series classes to indicate when negative colors are supported or not.

    Returns boolean

  • get isPie(): boolean
  • Gets whether the current series shows a pie shape.

    Returns boolean

  • get isPixel(): boolean
  • Gets whether the current series shows pixels.

    Returns boolean

  • get isPolar(): boolean
  • Gets whether the current series is a polar type series.

    let isPolar: boolean = this.series.isPolar;
    

    Returns boolean

  • get isPolygon(): boolean
  • Gets whether the current series shows a polygon shape.

    Returns boolean

  • get isPolyline(): boolean
  • Gets whether the current series shows a polyline shape.

    Returns boolean

  • get isRadial(): boolean
  • Gets whether the current series is a radial type series.

    let isRadial: boolean = this.series.isRadial;
    

    Returns boolean

  • get isRange(): boolean
  • Gets whether the current series is a range type series.

    let isRange: boolean = this.series.isRange;
    

    Returns boolean

  • get isScatter(): boolean
  • Gets whether the current series is a scatter type series.

    let isScatter: boolean = this.series.isScatter;
    

    Returns boolean

  • get isShape(): boolean
  • Gets whether the current series is a shape type series.

    Returns boolean

  • get isShapeControl(): boolean
  • Gets whether the current series shows interactive shape controls.

    Returns boolean

  • get isSpline(): boolean
  • Gets whether the current series shows a spline shape.

    Returns boolean

  • get isStacked(): boolean
  • Gets whether the current series is a stacked type series.

    let isStacked: boolean = this.series.isStacked;
    

    Returns boolean

  • get isStep(): boolean
  • Gets whether the current series shows step shapes.

    Returns boolean

  • get isSummarizationSupported(): boolean
  • Gets whether the series supports summarization in Data Legend and Data Tooltip.

    Returns boolean

  • get isTile(): boolean
  • Gets whether the current series shows a tile imagery.

    Returns boolean

  • get isUsableInLegend(): boolean
  • Gets if the series should appear in any legends.

    Returns boolean

  • get isValueAxisInverted(): boolean
  • Gets whether the current series shows an area shape.

    Returns boolean

  • get isValueOverlay(): boolean
  • Gets whether the series is a value overlay.

    Returns boolean

  • get isVertical(): boolean
  • Gets whether the current series is oriented vertically.

    let isVertical: boolean = this.series.isVertical;
    

    Returns boolean

  • get isWaterfall(): boolean
  • Gets whether the current series shows a waterfall column shape.

    Returns boolean

  • get layers(): IgcSeriesLayerCollection
  • Gets the current extra layers for the series.

    Returns IgcSeriesLayerCollection

  • set layers(v): void
  • Parameters

    Returns void

  • get legend(): any
  • Gets or sets the legend used for the current series.

    Returns any

  • set legend(v): void
  • Parameters

    • v: any

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get name(): string
  • Returns string

  • set name(value): void
  • Parameters

    • value: string

    Returns void

  • get opacity(): number
  • Returns number

  • set opacity(v): void
  • Parameters

    • v: number

    Returns void

  • 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

  • get outlineMode(): SeriesOutlineMode
  • Gets or sets the outline mode to use for the series.

    Returns SeriesOutlineMode

  • set outlineMode(v): void
  • Parameters

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • get seriesInternal(): any
  • Returns any

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • get skipUnknownValues(): boolean
  • Gets or sets whether to skip unknown values when searching for series values.

    Returns boolean

  • set skipUnknownValues(v): void
  • Parameters

    • v: boolean

    Returns void

  • get targetAxis(): IgcAxisComponent
  • Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously.

    Returns IgcAxisComponent

  • set targetAxis(v): void
  • Parameters

    Returns void

  • get targetAxisName(): string
  • Gets or sets the name of the axis to target this annotation to. If null, this annotation targets all axis simultaneously.

    Returns string

  • set targetAxisName(v): void
  • Parameters

    • v: string

    Returns void

  • get targetSeries(): IgcSeriesComponent
  • Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.

    Returns IgcSeriesComponent

  • set targetSeries(v): void
  • Parameters

    Returns void

  • get targetSeriesName(): string
  • Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously.

    Returns string

  • set targetSeriesName(v): void
  • Parameters

    • v: string

    Returns void

  • 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

  • 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

  • get tooltipContainerTemplate(): TemplateFunction
  • Returns TemplateFunction

  • set tooltipContainerTemplate(value): void
  • Parameters

    • value: TemplateFunction

    Returns void

  • get tooltipTemplate(): TemplateFunction
  • Returns TemplateFunction

  • set tooltipTemplate(value): void
  • Parameters

    • value: TemplateFunction

    Returns void

  • 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

  • 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

  • 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

  • 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

  • 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

  • get transitionOutCompleted(): ((s, e) => void)
  • Fired when a transition out has completed.

    Returns ((s, e) => void)

  • set transitionOutCompleted(ev): void
  • Parameters

    Returns void

  • 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

  • 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

  • get transitionOutSpeedType(): TransitionOutSpeedType
  • Gets or sets the duration of the current series' transition out morph.

    Returns TransitionOutSpeedType

  • set transitionOutSpeedType(v): void
  • Parameters

    Returns void

  • get useIndex(): boolean
  • Gets or sets whether this series should take up an index for auto brush coloring.

    Returns boolean

  • set useIndex(v): void
  • Parameters

    • v: boolean

    Returns void

  • get useInterpolation(): boolean
  • Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position.

    Returns boolean

  • set useInterpolation(v): void
  • Parameters

    • v: boolean

    Returns void

  • get useLegend(): boolean
  • Gets or sets whether this series interacts with the chart legend.

    Returns boolean

  • set useLegend(v): void
  • Parameters

    • v: boolean

    Returns void

  • get useSingleShadow(): boolean
  • Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. When this property is set to true, no Series.ShadowBlur is applied.

    this.series.useSingleShadow = true;
    

    Returns boolean

  • set useSingleShadow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get valueMode(): ValueLayerValueMode
  • Gets or sets the value mode for the overlay.

    Returns ValueLayerValueMode

  • set valueMode(v): void
  • Parameters

    Returns void

  • get verticalAppearanceMode(): AnnotationAppearanceMode
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns AnnotationAppearanceMode

  • set verticalAppearanceMode(v): void
  • Parameters

    Returns void

  • get verticalDashArray(): number[]
  • Gets or sets the mode used for shifting the annotation layer color based on the target series.

    Returns number[]

  • set verticalDashArray(v): void
  • Parameters

    • v: number[]

    Returns void

  • get verticalLineStroke(): string
  • Gets or sets the color to use for vertical line. Leave null for an automatic value.

    Returns string

  • set verticalLineStroke(v): void
  • Parameters

    • v: string

    Returns void

  • get verticalShiftAmount(): 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 verticalShiftAmount(v): void
  • Parameters

    • v: number

    Returns void

  • get visibility(): Visibility
  • Returns Visibility

  • set visibility(v): void
  • Parameters

    • v: Visibility

    Returns void

  • get visibleRangeMarginBottom(): number
  • Gets or sets the bottom margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginLeft(): number
  • Gets or sets the left margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginRight(): number
  • Gets or sets the right margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginRight(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMarginTop(): number
  • Gets or sets the top margin to use when getting a visible axis range for the series.

    Returns number

  • set visibleRangeMarginTop(v): void
  • Parameters

    • v: number

    Returns void

  • get visibleRangeMode(): SeriesVisibleRangeMode
  • Gets or sets the visible range mode to use.

    Returns SeriesVisibleRangeMode

  • set visibleRangeMode(v): void
  • Parameters

    Returns void

  • get xAxisAnnotationBackground(): string
  • Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value.

    Returns string

  • set xAxisAnnotationBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get xAxisAnnotationBackgroundCornerRadius(): number
  • Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value.

    Returns number

  • set xAxisAnnotationBackgroundCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationFormatLabel(): ((item) => string)
  • Sets or gets a function which takes an object that produces a formatted label for the x axis annotation.

    Returns ((item) => string)

      • (item): string
      • Parameters

        • item: any

        Returns string

  • set xAxisAnnotationFormatLabel(v): void
  • Parameters

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

          • item: any

          Returns string

    Returns void

  • get xAxisAnnotationInterpolatedValuePrecision(): number
  • Gets or sets the precision to use displaying values for interpolated crosshair positions.

    Returns number

  • set xAxisAnnotationInterpolatedValuePrecision(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationOutline(): string
  • Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value.

    Returns string

  • set xAxisAnnotationOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get xAxisAnnotationPaddingBottom(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set xAxisAnnotationPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationPaddingLeft(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set xAxisAnnotationPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationPaddingRight(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set xAxisAnnotationPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationPaddingTop(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set xAxisAnnotationPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationStrokeThickness(): number
  • Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value.

    Returns number

  • set xAxisAnnotationStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get xAxisAnnotationTextColor(): string
  • Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value.

    Returns string

  • set xAxisAnnotationTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get yAxisAnnotationBackground(): string
  • Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value.

    Returns string

  • set yAxisAnnotationBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get yAxisAnnotationBackgroundCornerRadius(): number
  • Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value.

    Returns number

  • set yAxisAnnotationBackgroundCornerRadius(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationFormatLabel(): ((item) => string)
  • Sets or gets a function which takes an object that produces a formatted label for the y axis annotation.

    Returns ((item) => string)

      • (item): string
      • Parameters

        • item: any

        Returns string

  • set yAxisAnnotationFormatLabel(v): void
  • Parameters

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

          • item: any

          Returns string

    Returns void

  • get yAxisAnnotationInterpolatedValuePrecision(): number
  • Gets or sets the precision to use displaying values for interpolated crosshair positions.

    Returns number

  • set yAxisAnnotationInterpolatedValuePrecision(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationOutline(): string
  • Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value.

    Returns string

  • set yAxisAnnotationOutline(v): void
  • Parameters

    • v: string

    Returns void

  • get yAxisAnnotationPaddingBottom(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set yAxisAnnotationPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationPaddingLeft(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set yAxisAnnotationPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationPaddingRight(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set yAxisAnnotationPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationPaddingTop(): number
  • Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

    Returns number

  • set yAxisAnnotationPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationStrokeThickness(): number
  • Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value.

    Returns number

  • set yAxisAnnotationStrokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get yAxisAnnotationTextColor(): string
  • Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value.

    Returns string

  • set yAxisAnnotationTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get observedAttributes(): string[]
  • Returns string[]

Methods

  • 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

  • Parameters

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

    Returns 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

  • Parameters

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

    Returns Animation

  • 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

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Parameters

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

    Returns 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

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

    Parameters

    • Optional deep: boolean

    Returns Node

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

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • Type parameters

    Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns E

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

    Parameters

    • other: Node

    Returns number

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

    Parameters

    • other: Node

    Returns 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

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional options: FocusOptions

    Returns void

  • Converts a point from world coordinates to coordinates within the viewport of the series.

    Parameters

    • world: IgPoint
      • The world position from which to convert.

    Returns IgPoint

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

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

    Parameters

    • qualifiedName: string

    Returns 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

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

    Returns string[]

  • Gets the effective viewport, adjusted to account for margins and other factors.

    Returns IgRect

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

  • Type parameters

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

    Parameters

    • world: IgPoint
      • The world position for which to return the index.
      let index: number = this.series.getExactItemIndex({x:.5,y:.5});
      

    Returns number

  • Gets the item that is the best match for the specified world coordinates.

    Parameters

    • world: IgPoint
      • The world coordinates to use.
      let item: number = this.series.getItem({x:.5,y:.5});
      

    Returns any

  • Gets the item index associated with the specified world position

    let index: number = this.series.getItemIndex({x:.5,y:.5});
    

    Parameters

    • world: IgPoint

    Returns number

  • For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

    let span: number = this.series.getItemSpan();
    

    Returns number

  • Parameters

    • item: any
    • memberPathName: string

    Returns any

  • Gets the value of a requested member path from the series.

    Parameters

    • memberPathName: string
      • The property name of a valid member path for the series

    Returns string

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • skipUnknowns: boolean

    Returns number

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

    Parameters

    • world: IgPoint
      • The world coordinate for which to get a value bounding box for

    Returns IgRect

  • Parameters

    • mouse: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns number

  • If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.

    Parameters

    • world: IgPoint
      • The world coordinates for which to get a value marker bounding box for

    Returns IgRect

  • Parameters

    • world: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint

  • Parameters

    • mouse: IgPoint
    • useInterpolation: boolean
    • skipUnknowns: boolean

    Returns IgPoint