Class IgcScatterPolygonSeriesComponent

Series class which renders polygons as Paths based on lists of points in the ItemsSource.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

COMMENT_NODE

COMMENT_NODE: number

DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

DOCUMENT_NODE

DOCUMENT_NODE: number

DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

ELEMENT_NODE

ELEMENT_NODE: number

ENTITY_NODE

ENTITY_NODE: number

ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

NOTATION_NODE

NOTATION_NODE: number

PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

TEXT_NODE

TEXT_NODE: number

accessKey

accessKey: string

accessKeyLabel

accessKeyLabel: string

assignedSlot

assignedSlot: HTMLSlotElement | null

attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

baseURI

baseURI: string

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

childElementCount

childElementCount: number

childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

children

children: HTMLCollection

Returns the child elements.

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.

clientHeight

clientHeight: number

clientLeft

clientLeft: number

clientTop

clientTop: number

clientWidth

clientWidth: number

contentEditable

contentEditable: string

dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

firstChild

firstChild: ChildNode | null

Returns the first child.

firstElementChild

firstElementChild: Element | null

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.

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

isContentEditable

isContentEditable: boolean

lang

lang: string

lastChild

lastChild: ChildNode | null

Returns the last child.

lastElementChild

lastElementChild: Element | null

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

localName

localName: string

Returns the local name.

namespaceURI

namespaceURI: string | null

Returns the namespace.

nextElementSibling

nextElementSibling: Element | null

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

nextSibling

nextSibling: Node | null

Returns the next sibling.

nodeName

nodeName: string

Returns a string appropriate for the type of node, as follows: Element Its HTML-uppercased qualified name. Attr Its qualified name. Text "#text". CDATASection "#cdata-section". ProcessingInstruction Its target. Comment "#comment". Document "#document". DocumentType Its name. DocumentFragment "#document-fragment".

nodeType

nodeType: number

nodeValue

nodeValue: string | null

nonce

nonce: string

offsetHeight

offsetHeight: number

offsetLeft

offsetLeft: number

offsetParent

offsetParent: Element | null

offsetTop

offsetTop: number

offsetWidth

offsetWidth: number

onabort

onabort: function | null

Fires when the user aborts the download.

param

The event.

onanimationcancel

onanimationcancel: function | null

onanimationend

onanimationend: function | null

onanimationiteration

onanimationiteration: function | null

onanimationstart

onanimationstart: function | null

onauxclick

onauxclick: function | null

onblur

onblur: function | null

Fires when the object loses the input focus.

param

The focus event.

oncancel

oncancel: function | null

oncanplay

oncanplay: function | null

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

param

The event.

oncanplaythrough

oncanplaythrough: function | null

onchange

onchange: function | null

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

param

The event.

onclick

onclick: function | null

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

param

The mouse event.

onclose

onclose: function | null

oncontextmenu

oncontextmenu: function | null

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

param

The mouse event.

oncopy

oncopy: function | null

oncuechange

oncuechange: function | null

oncut

oncut: function | null

ondblclick

ondblclick: function | null

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

ondrag: function | null

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

ondragend: function | null

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

param

The event.

ondragenter

ondragenter: function | null

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

param

The drag event.

ondragexit

ondragexit: function | null

ondragleave

ondragleave: function | null

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

param

The drag event.

ondragover

ondragover: function | null

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

param

The event.

ondragstart

ondragstart: function | null

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

param

The event.

ondrop

ondrop: function | null

ondurationchange

ondurationchange: function | null

Occurs when the duration attribute is updated.

param

The event.

onemptied

onemptied: function | null

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

param

The event.

onended

onended: function | null

Occurs when the end of playback is reached.

param

The event

onerror

onerror: ErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

onfocus: function | null

Fires when the object receives focus.

param

The event.

onfullscreenchange

onfullscreenchange: function | null

onfullscreenerror

onfullscreenerror: function | null

ongotpointercapture

ongotpointercapture: function | null

oninput

oninput: function | null

oninvalid

oninvalid: function | null

onkeydown

onkeydown: function | null

Fires when the user presses a key.

param

The keyboard event

onkeypress

onkeypress: function | null

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

onkeyup: function | null

Fires when the user releases a key.

param

The keyboard event

onload

onload: function | null

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

onloadeddata: function | null

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

param

The event.

onloadedmetadata

onloadedmetadata: function | null

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

param

The event.

onloadend

onloadend: function | null

onloadstart

onloadstart: function | null

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

onlostpointercapture: function | null

onmousedown

onmousedown: function | null

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

param

The mouse event.

onmouseenter

onmouseenter: function | null

onmouseleave

onmouseleave: function | null

onmousemove

onmousemove: function | null

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

onmouseout: function | null

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

param

The mouse event.

onmouseover

onmouseover: function | null

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

param

The mouse event.

onmouseup

onmouseup: function | null

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

param

The mouse event.

onpaste

onpaste: function | null

onpause

onpause: function | null

Occurs when playback is paused.

param

The event.

onplay

onplay: function | null

Occurs when the play method is requested.

param

The event.

onplaying

onplaying: function | null

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: function | null

onpointerdown

onpointerdown: function | null

onpointerenter

onpointerenter: function | null

onpointerleave

onpointerleave: function | null

onpointermove

onpointermove: function | null

onpointerout

onpointerout: function | null

onpointerover

onpointerover: function | null

onpointerup

onpointerup: function | null

onprogress

onprogress: function | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

onratechange: function | null

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

onreset: function | null

Fires when the user resets a form.

param

The event.

onresize

onresize: function | null

onscroll

onscroll: function | null

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

param

The event.

onsecuritypolicyviolation

onsecuritypolicyviolation: function | null

onseeked

onseeked: function | null

Occurs when the seek operation ends.

param

The event.

onseeking

onseeking: function | null

Occurs when the current playback position is moved.

param

The event.

onselect

onselect: function | null

Fires when the current selection changes.

param

The event.

onstalled

onstalled: function | null

Occurs when the download has stopped.

param

The event.

onsubmit

onsubmit: function | null

onsuspend

onsuspend: function | null

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

ontimeupdate: function | null

Occurs to indicate the current playback position.

param

The event.

ontoggle

ontoggle: function | null

ontouchcancel

ontouchcancel: function | null

ontouchend

ontouchend: function | null

ontouchmove

ontouchmove: function | null

ontouchstart

ontouchstart: function | null

ontransitioncancel

ontransitioncancel: function | null

ontransitionend

ontransitionend: function | null

ontransitionrun

ontransitionrun: function | null

ontransitionstart

ontransitionstart: function | null

onvolumechange

onvolumechange: function | null

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

param

The event.

onwaiting

onwaiting: function | null

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

param

The event.

onwheel

onwheel: function | null

outerHTML

outerHTML: string

ownerDocument

ownerDocument: Document | null

Returns the node document. Returns null for documents.

parentElement

parentElement: HTMLElement | null

Returns the parent element.

parentNode

parentNode: Node & ParentNode | null

Returns the parent.

prefix

prefix: string | null

Returns the namespace prefix.

previousElementSibling

previousElementSibling: Element | null

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

previousSibling

previousSibling: Node | null

Returns the previous sibling.

scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

scrollWidth

scrollWidth: number

shadowRoot

shadowRoot: ShadowRoot | null

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

style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: string | null

translate

translate: boolean

Static htmlTagName

htmlTagName: string = "igc-scatter-polygon-series"

Accessors

actualAreaFillOpacity

  • get actualAreaFillOpacity(): number
  • set actualAreaFillOpacity(v: number): void
  • Gets the actual opacity applied to the area fill visual.

    let actualFillOpacity: number = series.actualAreaFillOpacity;

    Returns number

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

    let actualFillOpacity: number = series.actualAreaFillOpacity;

    Parameters

    • v: number

    Returns void

actualBrush

  • get actualBrush(): string
  • set actualBrush(v: string): void
  • Gets the effective brush for the current series object.

    let actualBrush: string = series.actualBrush;

    Returns string

  • Gets the effective brush for the current series object.

    let actualBrush: string = series.actualBrush;

    Parameters

    • v: string

    Returns void

actualCloseLabel

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

    Returns string

actualHighLabel

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

    Returns string

actualHighlightingFadeOpacity

  • get actualHighlightingFadeOpacity(): number
  • set actualHighlightingFadeOpacity(v: number): void

actualHighlightingMode

actualHitTestMode

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

    let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;

    Returns SeriesHitTestMode

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

    let hitTestMode: SeriesHitTestMode = this.series.actualHitTestMode;

    Parameters

    Returns void

actualItemSearchMode

actualLowLabel

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

    Returns string

actualMarkerBrush

  • get actualMarkerBrush(): string
  • set actualMarkerBrush(v: string): void
  • Gets the effective marker brush for the current series object.

    Returns string

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

    Parameters

    • v: string

    Returns void

actualMarkerFillOpacity

  • get actualMarkerFillOpacity(): number
  • set actualMarkerFillOpacity(v: number): void

actualMarkerOutline

  • get actualMarkerOutline(): string
  • set actualMarkerOutline(v: string): void
  • Gets the effective marker outline for the current series object.

    Returns string

  • Gets the effective marker outline for the current series object.

    Parameters

    • v: string

    Returns void

actualMarkerTemplate

  • get actualMarkerTemplate(): IgDataTemplate
  • set actualMarkerTemplate(v: IgDataTemplate): void
  • Gets the effective marker template for the current series object.

    Returns IgDataTemplate

  • Gets the effective marker template for the current series object.

    Parameters

    • v: IgDataTemplate

    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
  • set actualOutline(v: string): void
  • Gets the effective outline for the current series object.

    let actualOutline: string = series.ActualOutline;

    Returns string

  • Gets the effective outline for the current series object.

    let actualOutline: string = series.ActualOutline;

    Parameters

    • v: string

    Returns void

actualRadiusLabel

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

    Returns string

actualThickness

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

    Returns number

  • Gets the effective Thickness for the current series object.

    Parameters

    • v: number

    Returns void

actualValueLabel

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

    Returns string

actualVolumeLabel

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

    Returns string

areaFillOpacity

  • get areaFillOpacity(): number
  • set areaFillOpacity(v: number): void
  • Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

    Returns number

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

    Parameters

    • v: number

    Returns void

assigningShapeMarkerStyle

  • get assigningShapeMarkerStyle(): function
  • set assigningShapeMarkerStyle(ev: function): void

assigningShapeStyle

  • get assigningShapeStyle(): function
  • set assigningShapeStyle(ev: function): void

brush

  • get brush(): string
  • set brush(v: string): void
  • 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 IgcSeriesComponent.

    this.series.brush = "red";

    Returns 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 IgcSeriesComponent.

    this.series.brush = "red";

    Parameters

    • v: string

    Returns void

coercionMethods

  • get coercionMethods(): any
  • set coercionMethods(v: any): void
  • 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

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

    Parameters

    • v: any

    Returns void

dataSource

  • get dataSource(): any
  • set dataSource(value: any): void

discreteLegendItemTemplate

  • get discreteLegendItemTemplate(): IgDataTemplate
  • set discreteLegendItemTemplate(v: IgDataTemplate): void
  • 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

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

    Parameters

    • v: IgDataTemplate

    Returns void

expectFunctions

  • get expectFunctions(): boolean
  • set expectFunctions(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

finalValue

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

    Returns number

  • The final value of this series.

    Parameters

    • v: number

    Returns void

hasMarkers

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

    Returns boolean

highlightingFadeOpacity

  • get highlightingFadeOpacity(): number
  • set highlightingFadeOpacity(v: number): void
  • Gets or sets the target opacity to fade to for fade style highlighting.

    Returns number

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

    Parameters

    • v: number

    Returns void

hitTestMode

  • 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

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

    Parameters

    Returns void

isAnnotationLayer

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

    let isAnnotationLayer: boolean = this.series.isAnnotationLayer;

    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

isCategory

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

    let isCategory: boolean = this.series.isCategory;

    Returns boolean

isComponentHighlightingModeIgnored

  • get isComponentHighlightingModeIgnored(): boolean
  • set isComponentHighlightingModeIgnored(v: boolean): void

isCustomShapeMarkerStyleAllowed

  • get isCustomShapeMarkerStyleAllowed(): boolean
  • set isCustomShapeMarkerStyleAllowed(v: boolean): void

isCustomShapeStyleAllowed

  • get isCustomShapeStyleAllowed(): boolean
  • set isCustomShapeStyleAllowed(v: boolean): void
  • Gets or sets whether this Shape series should allow custom style overrides of its individual visuals.

    Returns boolean

  • Gets or sets whether this Shape series should allow custom style overrides of its individual visuals.

    Parameters

    • v: boolean

    Returns void

isDefaultCrosshairBehaviorDisabled

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

    isDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.

    let isDefaultCrosshairBehaviorDisabled: boolean = this.series.isDefaultCrosshairBehaviorDisabled;

    Returns boolean

isDefaultToolTipSelected

  • get isDefaultToolTipSelected(): boolean
  • set isDefaultToolTipSelected(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

isDefaultTooltipBehaviorDisabled

  • 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

isDropShadowEnabled

  • get isDropShadowEnabled(): boolean
  • set isDropShadowEnabled(v: boolean): void
  • 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

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

    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

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 seires is a geogrpahic series.

    let isGeographic: boolean = this.series.isGeographic;

    Returns boolean

isHighlightingEnabled

  • get isHighlightingEnabled(): boolean
  • set isHighlightingEnabled(v: boolean): void
  • Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

    this.series.isHighlightingEnabled = true;

    Returns boolean

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

    this.series.isHighlightingEnabled = true;

    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.

    let isIndexed: boolean = this.series.isIndexed;

    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

isPolar

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

    let isPolar: boolean = this.series.isPolar;

    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

isStacked

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

    let isStacked: boolean = this.series.isStacked;

    Returns boolean

isUsableInLegend

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

    let isUsableInLegend: boolean = this.series.isUsableInLegend;

    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

itemSearchMode

itemSearchPointsThreshold

  • get itemSearchPointsThreshold(): number
  • set itemSearchPointsThreshold(v: number): void

itemSearchThreshold

  • get itemSearchThreshold(): number
  • set itemSearchThreshold(v: number): void
  • Gets or sets the threshold to use when searching for items using ItemSearchMode.

    Returns number

  • Gets or sets the threshold to use when searching for items using ItemSearchMode.

    Parameters

    • v: number

    Returns void

legend

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

    Returns any

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

    Parameters

    • v: any

    Returns void

legendItemBadgeTemplate

  • get legendItemBadgeTemplate(): IgDataTemplate
  • set legendItemBadgeTemplate(v: IgDataTemplate): void
  • 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

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

    Parameters

    • v: IgDataTemplate

    Returns void

legendItemTemplate

  • get legendItemTemplate(): IgDataTemplate
  • set legendItemTemplate(v: IgDataTemplate): void
  • 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

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

    Parameters

    • v: IgDataTemplate

    Returns void

legendItemVisibility

  • get legendItemVisibility(): Visibility
  • set legendItemVisibility(v: Visibility): void
  • Gets or sets the legend item visibility for the current series object.

    The LegendItemVisibilty can be used to exclude only certain IgcSeriesComponent from the IgcLegendComponent.

    Returns Visibility

  • Gets or sets the legend item visibility for the current series object.

    The LegendItemVisibilty can be used to exclude only certain IgcSeriesComponent from the IgcLegendComponent.

    Parameters

    • v: Visibility

    Returns void

markerBrush

  • get markerBrush(): string
  • set markerBrush(v: string): void
  • Gets or sets the brush that specifies how the current series object's marker interiors are painted.

    Returns string

  • Gets or sets the brush that specifies how the current series object's marker interiors are painted.

    Parameters

    • v: string

    Returns void

markerCollisionAvoidance

  • The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision.

    Returns CollisionAvoidanceType

  • The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision.

    Parameters

    Returns void

markerFillMode

  • Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.

    Returns MarkerFillMode

  • Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.

    Parameters

    Returns void

markerFillOpacity

  • get markerFillOpacity(): number
  • set markerFillOpacity(v: number): void
  • Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

    Returns number

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

    Parameters

    • v: number

    Returns void

markerOutline

  • get markerOutline(): string
  • set markerOutline(v: string): void
  • Gets or sets the brush that specifies how the current series object's marker outlines are painted.

    Returns string

  • Gets or sets the brush that specifies how the current series object's marker outlines are painted.

    Parameters

    • v: string

    Returns void

markerOutlineMode

  • Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

    Returns MarkerOutlineMode

  • Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

    Parameters

    Returns void

markerTemplate

  • get markerTemplate(): IgDataTemplate
  • set markerTemplate(v: IgDataTemplate): void
  • Gets or sets the MarkerTemplate for the current series object.

    Returns IgDataTemplate

  • Gets or sets the MarkerTemplate for the current series object.

    Parameters

    • v: IgDataTemplate

    Returns void

markerThickness

  • get markerThickness(): number
  • set markerThickness(v: number): void
  • Gets or sets thickness of the marker outline

    Returns number

  • Gets or sets thickness of the marker outline

    Parameters

    • v: number

    Returns void

markerType

  • Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

    Returns MarkerType

  • Gets or sets the marker type for the current series object. If the MarkerTemplate property is set, the setting of the MarkerType property will be ignored.

    Parameters

    Returns void

mouseOverEnabled

  • get mouseOverEnabled(): boolean
  • set mouseOverEnabled(v: boolean): void
  • Gets or sets the whether the chart reacts to mouse move events.

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

name

  • get name(): string
  • set name(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

opacity

  • get opacity(): number
  • set opacity(v: number): void
  • Returns number

  • Parameters

    • v: number

    Returns void

outline

  • get outline(): string
  • set outline(v: string): void
  • 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 IgcSeriesComponent.

    this.series.brush = "red";

    Returns 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 IgcSeriesComponent.

    this.series.brush = "red";

    Parameters

    • v: string

    Returns void

outlineMode

percentChange

  • get percentChange(): number
  • set percentChange(v: number): void
  • The percent change from the beginning to the end of this series.

    Returns number

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

    Parameters

    • v: number

    Returns void

renderRequested

  • get renderRequested(): function
  • set renderRequested(ev: function): void

resolution

  • get resolution(): number
  • set resolution(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

seriesInternal

  • get seriesInternal(): any

shadowBlur

  • get shadowBlur(): number
  • set shadowBlur(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

shadowColor

  • get shadowColor(): string
  • set shadowColor(v: string): void
  • 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

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

    Parameters

    • v: string

    Returns void

shadowOffsetX

  • get shadowOffsetX(): number
  • set shadowOffsetX(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

shadowOffsetY

  • get shadowOffsetY(): number
  • set shadowOffsetY(v: number): void
  • 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

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

    Parameters

    • v: number

    Returns void

shapeFilterResolution

  • get shapeFilterResolution(): number
  • set shapeFilterResolution(v: number): void
  • The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. In the case of ScatterPolylineSeries, the resolution is compared to either dimension, rather than both. In other words, a polyline will not be filtered if its height or its width exceeds the value of this property. Whereas with a ShapeSeries, both the height and the width must exceed the value of this property.

    Returns number

  • The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. In the case of ScatterPolylineSeries, the resolution is compared to either dimension, rather than both. In other words, a polyline will not be filtered if its height or its width exceeds the value of this property. Whereas with a ShapeSeries, both the height and the width must exceed the value of this property.

    Parameters

    • v: number

    Returns void

shapeMemberPath

  • get shapeMemberPath(): string
  • set shapeMemberPath(v: string): void
  • The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points.

    Returns string

  • The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. To be consistent with the Shapefile technical description, it is expected that each list of points is defined as an IEnumerable of IEnumerable of Point, or in other words, a list of lists of points.

    Parameters

    • v: string

    Returns void

shapeStyle

  • get shapeStyle(): IgcStyle
  • set shapeStyle(v: IgcStyle): void
  • The default style to apply to all Shapes in the series.

    Returns IgcStyle

  • The default style to apply to all Shapes in the series.

    Parameters

    • v: IgcStyle

    Returns void

showDefaultTooltip

  • get showDefaultTooltip(): boolean
  • set showDefaultTooltip(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

styleShape

  • get styleShape(): function
  • set styleShape(ev: function): void

thickness

  • get thickness(): number
  • set thickness(v: number): void
  • Gets or sets the width of the current series object's line thickness.

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

    this.series.thickness=5;

    Returns number

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

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

    this.series.thickness=5;

    Parameters

    • v: number

    Returns void

title

  • get title(): any
  • set title(v: any): void
  • Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

    The IgcSeriesComponent title may be used in tooltips and legends.

    this.series.title = "InStock Items";

    Returns 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 IgcSeriesComponent title may be used in tooltips and legends.

    this.series.title = "InStock Items";

    Parameters

    • v: any

    Returns void

tooltipContainerTemplate

tooltipTemplate

transitionDuration

  • get transitionDuration(): number
  • set transitionDuration(v: number): void
  • Gets or sets the duration of the current series's morph.

    The transitionDuration can be used to play animation when data is added or removed from a IgcSeriesComponent. To play an initial animation see transitionInDuration.

    this.series.transitionDuration = 500;

    Returns number

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

    The transitionDuration can be used to play animation when data is added or removed from a IgcSeriesComponent. To play an initial animation see transitionInDuration.

    this.series.transitionDuration = 500;

    Parameters

    • v: number

    Returns void

transitionEasingFunction

  • get transitionEasingFunction(): function
  • set transitionEasingFunction(v: function): void
  • 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 IgcSeriesComponent. To play an initial animation see transitionInDuration.

    this.series.transitionEasingFunction =  EasingFunctions.cubicEase;

    Returns function

      • (time: number): number
      • Parameters

        • time: number

        Returns 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 IgcSeriesComponent. To play an initial animation see transitionInDuration.

    this.series.transitionEasingFunction =  EasingFunctions.cubicEase;

    Parameters

    • v: function
        • (time: number): number
        • Parameters

          • time: number

          Returns number

    Returns void

transitionInDuration

  • get transitionInDuration(): number
  • set transitionInDuration(v: number): void
  • Gets or sets the duration of the current series's 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

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

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

    this.series.transitionDuration = 500;

    Parameters

    • v: number

    Returns void

transitionInEasingFunction

  • get transitionInEasingFunction(): function
  • set transitionInEasingFunction(v: function): void
  • 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 function

      • (time: number): number
      • Parameters

        • time: number

        Returns 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;

    Parameters

    • v: function
        • (time: number): number
        • Parameters

          • time: number

          Returns number

    Returns void

transitionInSpeedType

  • Gets or sets the duration of the current series's 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

  • Gets or sets the duration of the current series's 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;

    Parameters

    Returns void

useSingleShadow

  • get useSingleShadow(): boolean
  • set useSingleShadow(v: boolean): void
  • 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

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

    Parameters

    • v: boolean

    Returns void

visibility

  • get visibility(): Visibility
  • set visibility(v: Visibility): void

visibleRangeMarginBottom

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

    Returns number

  • Gets or sets the bottom margin to use when getting a visible axis range for the series.

    Parameters

    • v: number

    Returns void

visibleRangeMarginLeft

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

    Returns number

  • Gets or sets the left margin to use when getting a visible axis range for the series.

    Parameters

    • v: number

    Returns void

visibleRangeMarginRight

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

    Returns number

  • Gets or sets the right margin to use when getting a visible axis range for the series.

    Parameters

    • v: number

    Returns void

visibleRangeMarginTop

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

    Returns number

  • Gets or sets the top margin to use when getting a visible axis range for the series.

    Parameters

    • v: number

    Returns void

visibleRangeMode

xAxis

xAxisName

  • get xAxisName(): string
  • set xAxisName(v: string): void
  • Gets or sets the name to use to resolve xAxis from markup.

    Returns string

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

    Parameters

    • v: string

    Returns void

yAxis

yAxisName

  • get yAxisName(): string
  • set yAxisName(v: string): void
  • Gets or sets the name to use to resolve yAxis from markup.

    Returns string

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

    Parameters

    • v: string

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]

Methods

addEventListener

  • addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): 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

after

  • after(...nodes: (string | Node)[]): 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

animate

  • animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation
  • Parameters

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

    Returns Animation

append

  • append(...nodes: (string | Node)[]): void
  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

appendChild

  • appendChild<T>(newChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T

    Returns T

attachShadow

  • attachShadow(shadowRootInitDict: ShadowRootInit): ShadowRoot
  • Creates a shadow root for element and returns it.

    Parameters

    • shadowRootInitDict: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(name: string, oldValue: string, newValue: string): void

before

  • before(...nodes: (string | Node)[]): 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

bindAxes

blur

  • blur(): void
  • Returns void

canUseAsXAxis

  • canUseAsXAxis(axis: any): boolean
  • Determine if object can be used as XAxis

    Parameters

    • axis: any
      • The object to check

    Returns boolean

canUseAsYAxis

  • canUseAsYAxis(axis: any): boolean
  • Determine if object can be used as YAxis

    Parameters

    • axis: any
      • The object to check

    Returns boolean

click

  • click(): void
  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node
  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector: K): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest(selector: string): Element | null
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Parameters

    • selector: string

    Returns Element | null

compareDocumentPosition

  • compareDocumentPosition(other: Node): number
  • Parameters

    • other: Node

    Returns number

connectedCallback

  • connectedCallback(): void

contains

  • contains(other: Node | null): boolean
  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: Node | null

    Returns boolean

dispatchEvent

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

    Parameters

    • event: Event

    Returns boolean

findByName

  • findByName(name: string): any

focus

  • focus(options?: FocusOptions): void
  • Parameters

    • Optional options: FocusOptions

    Returns void

fromWorldPosition

  • fromWorldPosition(world: IgPoint): IgPoint
  • 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

getAnimations

  • getAnimations(): Animation[]
  • Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): string | null
  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

  • getAttributeNS(namespace: string | null, localName: string): string | null
  • 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 | null
    • localName: string

    Returns string | null

getAttributeNames

  • getAttributeNames(): string[]
  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

getAttributeNode

  • getAttributeNode(name: string): Attr | null
  • Parameters

    • name: string

    Returns Attr | null

getAttributeNodeNS

  • getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null
  • Parameters

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • getBoundingClientRect(): ClientRect | DOMRect
  • Returns ClientRect | DOMRect

getClientRects

  • getClientRects(): ClientRectList | DOMRectList
  • Returns ClientRectList | DOMRectList

getEffectiveViewport

  • getEffectiveViewport(): IgRect
  • Gets the effective viewport, adjusted to account for margins and other factors.

    Returns IgRect

getElementsByClassName

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
  • Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
  • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
  • getElementsByTagNameNS(namespaceURI: string, localName: string): 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

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getExactItemIndex

  • getExactItemIndex(world: IgPoint): number

getItem

  • getItem(world: IgPoint): any
  • Gets the item that is the best match for the specified world coordinates.

    Parameters

    • world: IgPoint
      • The world coordinates to use.

    Returns any

getItemIndex

  • getItemIndex(world: IgPoint): number
  • Gets the item item index associated with the specified world position

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

    Parameters

    • world: IgPoint

    Returns number

getItemSpan

  • getItemSpan(): 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

getItemValue

  • getItemValue(item: any, memberPathName: string): any

getNextOrExactIndex

  • getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

getPreviousOrExactIndex

  • getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

getRootNode

  • getRootNode(options?: GetRootNodeOptions): Node
  • Returns node's shadow-including root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

getSeriesHighValue

  • getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number
  • Parameters

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

    Returns number

getSeriesHighValuePosition

  • getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

getSeriesLowValue

  • getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number
  • Parameters

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

    Returns number

getSeriesLowValuePosition

  • getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

getSeriesValue

  • getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number
  • Parameters

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

    Returns number

getSeriesValueBoundingBox

  • getSeriesValueBoundingBox(world: IgPoint): IgRect
  • 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

getSeriesValueFromSeriesPixel

  • getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

getSeriesValueMarkerBoundingBox

  • getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect
  • 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

getSeriesValuePosition

  • getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

getSeriesValuePositionFromSeriesPixel

  • getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

hasAttribute

  • hasAttribute(qualifiedName: string): boolean
  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: string | null, localName: string): boolean
  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean
  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

hideToolTips

  • hideToolTips(): void
  • Hides any internal tooltips presented by the series, if any.

    Returns void

insertAdjacentElement

  • insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null
  • Parameters

    • position: InsertPosition
    • insertedElement: Element

    Returns Element | null

insertAdjacentHTML

  • insertAdjacentHTML(where: InsertPosition, html: string): void
  • Parameters

    • where: InsertPosition
    • html: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where: InsertPosition, text: string): void
  • Parameters

    • where: InsertPosition
    • text: string

    Returns void

insertBefore

  • insertBefore<T>(newChild: T, refChild: Node | null): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: string | null): boolean
  • Parameters

    • namespace: string | null

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: Node | null): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

  • isSameNode(otherNode: Node | null): boolean
  • Parameters

    • otherNode: Node | null

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix: string | null): string | null
  • Parameters

    • prefix: string | null

    Returns string | null

lookupPrefix

  • lookupPrefix(namespace: string | null): string | null
  • Parameters

    • namespace: string | null

    Returns string | null

matches

  • matches(selectors: string): boolean
  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

moveCursorPoint

  • moveCursorPoint(point: IgPoint): void
  • Moves the cursor point to the provided world position. Some series may react to the current cursor position.

    Parameters

    • point: IgPoint
      • The cursor point, in world coordinates.

      moveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.

      this.crosshair.moveCursorPoint({x:.5,y:.5});

    Returns void

msGetRegionContent

  • msGetRegionContent(): any
  • Returns any

normalize

  • normalize(): void
  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

notifyVisualPropertiesChanged

  • notifyVisualPropertiesChanged(): void

prepend

  • prepend(...nodes: (string | Node)[]): void
  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

provideData

  • provideData(data: any[]): void

querySelector

  • querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>
  • Returns all element descendants of node that match selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void
  • Removes node.

    Returns void

removeAllAlternateViews

  • removeAllAlternateViews(): void

removeAlternateView

  • removeAlternateView(viewIdentifier: string): void
  • Removes an alternate view of this series.

    Parameters

    • viewIdentifier: string
      • The string identifier for the view to remove.

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void
  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace: string | null, localName: string): void
  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr
  • Parameters

    • attr: Attr

    Returns Attr

removeAxes

  • removeAxes(): void
  • Call to null out the axes of the series;

    Returns void

removeChild

  • removeChild<T>(oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • oldChild: T

    Returns T

removeEventListener

  • removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: function
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

renderSeries

  • renderSeries(animate: boolean): void
  • Renders the series.

    Parameters

    • animate: boolean
      • True if the change should be animated.
      this.series.renderSeries(true);

    Returns void

replaceChild

  • replaceChild<T>(newChild: Node, oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • replaceWith(...nodes: (string | Node)[]): void
  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

replayTransitionIn

  • replayTransitionIn(): void
  • Replays the assigned transition in animation, if any.

    this.series.replayTransitionIn();

    Returns void

requestFullscreen

  • requestFullscreen(): Promise<void>
  • Displays element fullscreen and resolves promise when done.

    Returns Promise<void>

resolveTooltipBrush

  • resolveTooltipBrush(): string

scroll

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(item: any): boolean
  • Requests that the provided item should be brought into view if possible.

    Parameters

    • item: any
      • The item to attempt to bring into view.
      this.series.scrollIntoView(dataItem);

    Returns boolean

scrollTo

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName: string, value: string): void
  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: string | null
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setNegativeColors

  • setNegativeColors(negativeBrush: string, negativeOutline: string): void
  • Parameters

    • negativeBrush: string
    • negativeOutline: string

    Returns void

setPointerCapture

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

simulateHover

  • simulateHover(point: IgPoint): void
  • Simulates a pointer hover over the series surface.

    Parameters

    • point: IgPoint
      • The pointer position relative to the series viewport over which to hover.

      When tooltips are enabled, simulateHover can be used to automatically display the tooltip over a particular series item.

      this.series.simulateHover({x:250,y:250});

    Returns void

styleUpdated

  • styleUpdated(): void
  • Called when this series' Style is updated.

    Returns void

toWorldPosition

  • toWorldPosition(seriesPoint: IgPoint): IgPoint
  • Converts a point from coordinates within the series plot area to a world position within axis space.

    Parameters

    • seriesPoint: IgPoint
      • The pixel location within the plot area of the series.
      this.series.toWorldPosition({x:500,y:500});

    Returns IgPoint

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean
  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. Returns true if qualifiedName is now present, and false otherwise.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean
  • Parameters

    • selectors: string

    Returns boolean

Static _createFromInternal

Static register

  • register(): void
  • Returns void