Class IgcSeriesViewerComponent

Represents a control for viewing series objects.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns IgcSeriesViewerComponent

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

title

title: string

translate

translate: boolean

Accessors

actualContentHitTestMode

  • Resolved method of hit testing used when the pointer is over elements in the chart.

    let actualContentHitTestMode: ChartHitTestMode  =this.chart.actualContentHitTestMode;

    Returns ChartHitTestMode

  • Resolved method of hit testing used when the pointer is over elements in the chart.

    let actualContentHitTestMode: ChartHitTestMode  =this.chart.actualContentHitTestMode;

    Parameters

    Returns void

actualInteractionPixelScalingRatio

  • get actualInteractionPixelScalingRatio(): number
  • set actualInteractionPixelScalingRatio(v: number): void
  • Resolved method of pixel scaling to use during end user interaction with the chart.

    let actualInteractionPixelScalingRatio: number = this.chart.actualInteractionPixelScalingRatio;

    Returns number

  • Resolved method of pixel scaling to use during end user interaction with the chart.

    let actualInteractionPixelScalingRatio: number = this.chart.actualInteractionPixelScalingRatio;

    Parameters

    • v: number

    Returns void

actualPixelScalingRatio

  • get actualPixelScalingRatio(): number
  • set actualPixelScalingRatio(v: number): void
  • Gets the resolved pixel scaling ratio.

    A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry

    let actualPixelScalingRatio: number = this.chart.actualPixelScalingRatio;

    Returns number

  • Gets the resolved pixel scaling ratio.

    A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry

    let actualPixelScalingRatio: number = this.chart.actualPixelScalingRatio;

    Parameters

    • v: number

    Returns void

actualWindowPositionHorizontal

  • get actualWindowPositionHorizontal(): number
  • set actualWindowPositionHorizontal(v: number): void
  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the Left of the ActualWindowRect property.

    let actualWindowPositionHorizontal: number = this.chart.actualWindowPositionHorizontal;

    Returns number

  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the Left of the ActualWindowRect property.

    let actualWindowPositionHorizontal: number = this.chart.actualWindowPositionHorizontal;

    Parameters

    • v: number

    Returns void

actualWindowPositionVertical

  • get actualWindowPositionVertical(): number
  • set actualWindowPositionVertical(v: number): void
  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Top of the ActualWindowRect property.

    let actualWindowPositionVertical: number = this.chart.actualWindowPositionVertical;
    ``

    Returns number

  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Top of the ActualWindowRect property.

    let actualWindowPositionVertical: number = this.chart.actualWindowPositionVertical;
    ``

    Parameters

    • v: number

    Returns void

actualWindowRect

  • get actualWindowRect(): IgRect
  • set actualWindowRect(v: IgRect): void
  • Gets the actual value of the window rectangle, which represents the current zoom level.

    Returns IgRect

  • Gets the actual value of the window rectangle, which represents the current zoom level.

    Parameters

    • v: IgRect

    Returns void

actualWindowRectChanged

  • get actualWindowRectChanged(): function
  • set actualWindowRectChanged(ev: function): void
  • Raised when the actual window rectangle of the SeriesViewer changes.

    Returns function

  • Raised when the actual window rectangle of the SeriesViewer changes.

    Parameters

    Returns void

animateSeriesWhenAxisRangeChanges

  • get animateSeriesWhenAxisRangeChanges(): boolean
  • set animateSeriesWhenAxisRangeChanges(v: boolean): void
  • Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

    animateSeriesWhenAxisRangeChanges is a Boolean property to override the default behavior in which series do not animate if an axis range changes.

    this.chart.animateSeriesWhenAxisRangeChanges = true;

    Returns boolean

  • Gets or sets whether the series animations should be allowed when a range change has been detected on an axis.

    animateSeriesWhenAxisRangeChanges is a Boolean property to override the default behavior in which series do not animate if an axis range changes.

    this.chart.animateSeriesWhenAxisRangeChanges = true;

    Parameters

    • v: boolean

    Returns void

autoMarginHeight

  • get autoMarginHeight(): number
  • set autoMarginHeight(v: number): void
  • Sets or gets the automatic height to add when automatically adding margins to the chart.

     this.chart.autoMarginHeight = 50;

    Returns number

  • Sets or gets the automatic height to add when automatically adding margins to the chart.

     this.chart.autoMarginHeight = 50;

    Parameters

    • v: number

    Returns void

autoMarginWidth

  • get autoMarginWidth(): number
  • set autoMarginWidth(v: number): void
  • Sets or gets the automatic width to add when automatically adding margins to the chart.

    The autoMarginWidth propertry is used find the automatic width to add when automatically adding margins to the chart.

    this.chart.autoMarginWidth = 50;

    Returns number

  • Sets or gets the automatic width to add when automatically adding margins to the chart.

    The autoMarginWidth propertry is used find the automatic width to add when automatically adding margins to the chart.

    this.chart.autoMarginWidth = 50;

    Parameters

    • v: number

    Returns void

bottomMargin

  • get bottomMargin(): number
  • set bottomMargin(v: number): void
  • Sets or gets the bottom margin to use around the chart content.

    The bottomMargin property is used to gets/set the bottom margin around the chart content in the canvas.

    this.chart.bottomMargin = 50;

    Returns number

  • Sets or gets the bottom margin to use around the chart content.

    The bottomMargin property is used to gets/set the bottom margin around the chart content in the canvas.

    this.chart.bottomMargin = 50;

    Parameters

    • v: number

    Returns void

chartTitle

  • get chartTitle(): string
  • set chartTitle(v: string): void
  • Text to display above the plot area.

    The chartTitle property is used to set the title to display for the component.

    this.chart.title="Items Sold";

    Returns string

  • Text to display above the plot area.

    The chartTitle property is used to set the title to display for the component.

    this.chart.title="Items Sold";

    Parameters

    • v: string

    Returns void

contentHitTestMode

  • Determines the method of hit testing used when mousing over elements in the chart.

    this.chart.contentHitTestMode = ChartHitTestMode.Computational;

    Returns ChartHitTestMode

  • Determines the method of hit testing used when mousing over elements in the chart.

    this.chart.contentHitTestMode = ChartHitTestMode.Computational;

    Parameters

    Returns void

contentViewport

  • get contentViewport(): IgRect
  • Represents the subset area within the viewport into which content should be mapped. This is the projection of the current EffectiveViewport into the viewport at current zoom level.

    Returns IgRect

crosshairPoint

  • get crosshairPoint(): IgPoint
  • set crosshairPoint(v: IgPoint): void
  • Gets or sets the cross hair point (in world coordinates) Either or both of the crosshair point's X and Y may be set to double.NaN, in which case the relevant crosshair line is hidden.

    The crosshairPoint property is used to gets/sets the cross hair point (in world coordinates).

    this.chart.crosshairPoint = {x:.8,y:.2};

    Returns IgPoint

  • Gets or sets the cross hair point (in world coordinates) Either or both of the crosshair point's X and Y may be set to double.NaN, in which case the relevant crosshair line is hidden.

    The crosshairPoint property is used to gets/sets the cross hair point (in world coordinates).

    this.chart.crosshairPoint = {x:.8,y:.2};

    Parameters

    • v: IgPoint

    Returns void

crosshairVisibility

  • get crosshairVisibility(): Visibility
  • set crosshairVisibility(v: Visibility): void
  • Gets or sets the current SeriesViewer's crosshair visibility override.

    The crosshairVisibility property is used to gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart.

    this.chart.crosshairVisibility = Visibility.Visible;

    Returns Visibility

  • Gets or sets the current SeriesViewer's crosshair visibility override.

    The crosshairVisibility property is used to gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart.

    this.chart.crosshairVisibility = Visibility.Visible;

    Parameters

    • v: Visibility

    Returns void

defaultInteraction

  • get defaultInteraction(): InteractionState
  • set defaultInteraction(v: InteractionState): void
  • Gets or sets the DefaultInteraction property. The default interaction state defines the SeriesViewer's response to mouse events.

    The default interaction state defines the chart's response to mouse events.

    this.chart.defaultInteraction = InteractionState.DragPan;

    Returns InteractionState

  • Gets or sets the DefaultInteraction property. The default interaction state defines the SeriesViewer's response to mouse events.

    The default interaction state defines the chart's response to mouse events.

    this.chart.defaultInteraction = InteractionState.DragPan;

    Parameters

    • v: InteractionState

    Returns void

dragModifier

  • get dragModifier(): ModifierKeys
  • set dragModifier(v: ModifierKeys): void
  • Gets or sets the current SeriesViewer's DragModifier property.

    dragModifier is useful to enable zooming when zooming is not the default interaction.

    this.chart.dragModifier = ModifierKeys.Alt;

    Returns ModifierKeys

  • Gets or sets the current SeriesViewer's DragModifier property.

    dragModifier is useful to enable zooming when zooming is not the default interaction.

    this.chart.dragModifier = ModifierKeys.Alt;

    Parameters

    • v: ModifierKeys

    Returns void

effectiveViewport

  • get effectiveViewport(): IgRect
  • set effectiveViewport(v: IgRect): void
  • Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted.

    ts let viewport: IgxRect = this.chart.effectiveViewport;

    Returns IgRect

  • Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted.

    ts let viewport: IgxRect = this.chart.effectiveViewport;

    Parameters

    • v: IgRect

    Returns void

gridAreaRectChanged

  • get gridAreaRectChanged(): function
  • set gridAreaRectChanged(ev: function): void
  • Occurs just after the current SeriesViewer's grid area rectangle is changed. The grid area may change as the result of the SeriesViewer being resized, or of an axis being added or changing size, possibly in another SeriesViewer.

    Returns function

  • Occurs just after the current SeriesViewer's grid area rectangle is changed. The grid area may change as the result of the SeriesViewer being resized, or of an axis being added or changing size, possibly in another SeriesViewer.

    Parameters

    Returns void

highlightingBehavior

  • Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Returns SeriesHighlightingBehavior

  • Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Parameters

    Returns void

highlightingMode

  • Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Returns SeriesHighlightingMode

  • Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHightlightingEnabled.

    Parameters

    Returns void

highlightingTransitionDuration

  • get highlightingTransitionDuration(): number
  • set highlightingTransitionDuration(v: number): void
  • Gets or sets the duration the highlighting/de-highlighting effects.

    The highlightingTransitionDuration property is used to set the time for highlighting transition in milliseconds .

    chart.HighlightingTransitionDuration=500;

    Returns number

  • Gets or sets the duration the highlighting/de-highlighting effects.

    The highlightingTransitionDuration property is used to set the time for highlighting transition in milliseconds .

    chart.HighlightingTransitionDuration=500;

    Parameters

    • v: number

    Returns void

interactionPixelScalingRatio

  • get interactionPixelScalingRatio(): number
  • set interactionPixelScalingRatio(v: number): void
  • Method of pixel scaling to use during end user interaction with the chart.

    Returns number

  • Method of pixel scaling to use during end user interaction with the chart.

    Parameters

    • v: number

    Returns void

isAntiAliasingEnabledDuringInteraction

  • get isAntiAliasingEnabledDuringInteraction(): boolean
  • set isAntiAliasingEnabledDuringInteraction(v: boolean): void
  • Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

    Returns boolean

  • Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

    Parameters

    • v: boolean

    Returns void

isMap

  • get isMap(): boolean
  • Indicates if this SeriesViewer is a map.

    Returns boolean

isPagePanningAllowed

  • get isPagePanningAllowed(): boolean
  • set isPagePanningAllowed(v: boolean): void
  • Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction.

    Returns boolean

  • Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction.

    Parameters

    • v: boolean

    Returns void

isSurfaceInteractionDisabled

  • get isSurfaceInteractionDisabled(): boolean
  • set isSurfaceInteractionDisabled(v: boolean): void
  • Gets or sets whether all surface interactions with the plot area should be disabled.

    The isSurfaceInteractionDisabled property is used to enable/disable interactions with the plot surface.

    chart.isSurfaceInteractionDisabled=true;

    Returns boolean

  • Gets or sets whether all surface interactions with the plot area should be disabled.

    The isSurfaceInteractionDisabled property is used to enable/disable interactions with the plot surface.

    chart.isSurfaceInteractionDisabled=true;

    Parameters

    • v: boolean

    Returns void

isWindowSyncedToVisibleRange

  • get isWindowSyncedToVisibleRange(): boolean
  • set isWindowSyncedToVisibleRange(v: boolean): void
  • Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series.

    Returns boolean

  • Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series.

    Parameters

    • v: boolean

    Returns void

leftMargin

  • get leftMargin(): number
  • set leftMargin(v: number): void
  • Sets or gets the left margin to use around the chart content.

    The leftMargin property is used to set the left margin.

     this.chart.leftMargin = 20;

    Returns number

  • Sets or gets the left margin to use around the chart content.

    The leftMargin property is used to set the left margin.

     this.chart.leftMargin = 20;

    Parameters

    • v: number

    Returns void

legendHighlightingMode

  • Gets or sets the highlighting mode to use for the legend linked to the component, when supported.

    Returns LegendHighlightingMode

  • Gets or sets the highlighting mode to use for the legend linked to the component, when supported.

    Parameters

    Returns void

panModifier

  • get panModifier(): ModifierKeys
  • set panModifier(v: ModifierKeys): void
  • Gets or sets the current SeriesViewer's PanModifier property.

    panModifier is useful to enable panning when panning is not the default interaction.

    this.chart.panModifier = ModifierKeys.Alt;

    Returns ModifierKeys

  • Gets or sets the current SeriesViewer's PanModifier property.

    panModifier is useful to enable panning when panning is not the default interaction.

    this.chart.panModifier = ModifierKeys.Alt;

    Parameters

    • v: ModifierKeys

    Returns void

pixelScalingRatio

  • get pixelScalingRatio(): number
  • set pixelScalingRatio(v: number): void
  • Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

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

    Parameters

    • v: number

    Returns void

plotAreaBackground

  • get plotAreaBackground(): string
  • set plotAreaBackground(v: string): void
  • Gets or sets the brush used as the background for the current SeriesViewer object's plot area.

    plotAreaBackground property set the background brush to the current Chart object's plot area.

    this.chart.plotAreaBackground="#F0F8FF";

    Returns string

  • Gets or sets the brush used as the background for the current SeriesViewer object's plot area.

    plotAreaBackground property set the background brush to the current Chart object's plot area.

    this.chart.plotAreaBackground="#F0F8FF";

    Parameters

    • v: string

    Returns void

plotAreaClicked

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

plotAreaMouseEnter

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

plotAreaMouseLeave

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

plotAreaMouseLeftButtonDown

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

plotAreaMouseLeftButtonUp

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

plotAreaMouseOver

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

preferHigherResolutionTiles

  • get preferHigherResolutionTiles(): boolean
  • set preferHigherResolutionTiles(v: boolean): void
  • Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality.

    Returns boolean

  • Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality.

    Parameters

    • v: boolean

    Returns void

previewRect

  • get previewRect(): IgRect
  • set previewRect(v: IgRect): void
  • Gets or sets the preview rectangle. The preview rectangle may be set to Rect.Empty, in which case the visible preview strokePath is hidden.

    previewRect can be used to highlight an area of importance.

    this.chart.previewRect = {left:0,top:0,height:.5,width:.5};

    Returns IgRect

  • Gets or sets the preview rectangle. The preview rectangle may be set to Rect.Empty, in which case the visible preview strokePath is hidden.

    previewRect can be used to highlight an area of importance.

    this.chart.previewRect = {left:0,top:0,height:.5,width:.5};

    Parameters

    • v: IgRect

    Returns void

refreshCompleted

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

rightButtonDefaultInteraction

  • get rightButtonDefaultInteraction(): InteractionState
  • set rightButtonDefaultInteraction(v: InteractionState): void
  • Gets or sets the RightButtonDefaultInteraction property. The default interaction state defines the SeriesViewer's response to right button mouse events.

    Returns InteractionState

  • Gets or sets the RightButtonDefaultInteraction property. The default interaction state defines the SeriesViewer's response to right button mouse events.

    Parameters

    • v: InteractionState

    Returns void

rightMargin

  • get rightMargin(): number
  • set rightMargin(v: number): void
  • Sets or gets the right margin to use around the chart content.

    The rightMargin property is used to set the left margin around the chart content in the canvas.

    this.chart.rightMargin=20;

    Returns number

  • Sets or gets the right margin to use around the chart content.

    The rightMargin property is used to set the left margin around the chart content in the canvas.

    this.chart.rightMargin=20;

    Parameters

    • v: number

    Returns void

seriesCursorMouseMove

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

seriesMouseEnter

  • get seriesMouseEnter(): function
  • set seriesMouseEnter(ev: function): void
  • Occurs when the mouse pointer enters a Series.

    The SeriesMouseEnter event occurs when the left mouse pointer enters an element of this chart.

    <-- position: content member-->

    public onSeriesMouseEnter(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }

    Returns function

  • Occurs when the mouse pointer enters a Series.

    The SeriesMouseEnter event occurs when the left mouse pointer enters an element of this chart.

    <-- position: content member-->

    public onSeriesMouseEnter(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }

    Parameters

    Returns void

seriesMouseLeave

  • get seriesMouseLeave(): function
  • set seriesMouseLeave(ev: function): void
  • Occurs when the mouse pointer leaves a Series.

    The SeriesMouseLeave event occurs when the left mouse pointer leaves an element of this chart.

    public onSeriesMouseLeave(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }

    Returns function

  • Occurs when the mouse pointer leaves a Series.

    The SeriesMouseLeave event occurs when the left mouse pointer leaves an element of this chart.

    public onSeriesMouseLeave(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }

    Parameters

    Returns void

seriesMouseLeftButtonDown

  • get seriesMouseLeftButtonDown(): function
  • set seriesMouseLeftButtonDown(ev: function): void
  • Occurs when the left mouse button is pressed while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonDown event occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    public onSeriesMouseLeftButtonDown(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
        var item = event.args.item;
    }

    Returns function

  • Occurs when the left mouse button is pressed while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonDown event occurs when the left mouse button is pressed while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    public onSeriesMouseLeftButtonDown(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
        var item = event.args.item;
    }

    Parameters

    Returns void

seriesMouseLeftButtonUp

  • get seriesMouseLeftButtonUp(): function
  • set seriesMouseLeftButtonUp(ev: function): void
  • Occurs when the left mouse button is released while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonUp event occurs when the left mouse button is released while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseLeftButtonUp(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
        var item = event.args.item;
    }
    public onSeriesMouseLeftButtonUp =(event: any, args: DataChartMouseButtonEventArgs )
    {
    
    }

    Returns function

  • Occurs when the left mouse button is released while the mouse pointer is over a Series.

    The SeriesMouseLeftButtonUp event occurs when the left mouse button is released while the mouse pointer is over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseLeftButtonUp(event: {sender: any, args: DataChartMouseButtonEventArgs})
    {
        var item = event.args.item;
    }
    public onSeriesMouseLeftButtonUp =(event: any, args: DataChartMouseButtonEventArgs )
    {
    
    }

    Parameters

    Returns void

seriesMouseMove

  • get seriesMouseMove(): function
  • set seriesMouseMove(ev: function): void
  • Occurs when the mouse pointer moves while over a Series.

    The SeriesMouseMove event occurs when the left mouse pointer moves while over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseMove(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }
    public onSeriesMouseMove =( event: any, args: ChartMouseEventArgs) => {
                     }

    Returns function

  • Occurs when the mouse pointer moves while over a Series.

    The SeriesMouseMove event occurs when the left mouse pointer moves while over an element of this chart.

    <-- position: content member-->

    <-- position: content member-->

    public onSeriesMouseMove(event: {sender: any, args: ChartMouseEventArgs})
    {
        var item = event.args.item;
    }
    public onSeriesMouseMove =( event: any, args: ChartMouseEventArgs) => {
                     }

    Parameters

    Returns void

shouldSimulateHoverMoveCrosshairPoint

  • get shouldSimulateHoverMoveCrosshairPoint(): boolean
  • set shouldSimulateHoverMoveCrosshairPoint(v: boolean): void
  • Gets or sets whether calling SimulateHover should shift the crosshair point.

    Returns boolean

  • Gets or sets whether calling SimulateHover should shift the crosshair point.

    Parameters

    • v: boolean

    Returns void

sizeChanged

  • get sizeChanged(): function
  • set sizeChanged(ev: function): void
  • Occurs after the size of the series viewer changes.

    <-- position: content member-->

    <-- position: content member-->

    public onSizeChanged =(event: any, args: RectChangedEventArgs}){
    
    }

    Returns function

  • Occurs after the size of the series viewer changes.

    <-- position: content member-->

    <-- position: content member-->

    public onSizeChanged =(event: any, args: RectChangedEventArgs}){
    
    }

    Parameters

    Returns void

subtitle

  • get subtitle(): string
  • set subtitle(v: string): void
  • Gets or sets the Subtitle property. The Title property defines the Subtitle of the chart

    The subtitle property is used to display subtitle for the component.

    this.chart.subtitle="Date of Sale: 1/1/2018";

    Returns string

  • Gets or sets the Subtitle property. The Title property defines the Subtitle of the chart

    The subtitle property is used to display subtitle for the component.

    this.chart.subtitle="Date of Sale: 1/1/2018";

    Parameters

    • v: string

    Returns void

subtitleBottomMargin

  • get subtitleBottomMargin(): number
  • set subtitleBottomMargin(v: number): void
  • Margin applied below the subtitle.

    The subtitleBottomMargin property is used to set the bottom margin for the subtitle.

    this.chart.subtitleBottomMargin = 20;

    Returns number

  • Margin applied below the subtitle.

    The subtitleBottomMargin property is used to set the bottom margin for the subtitle.

    this.chart.subtitleBottomMargin = 20;

    Parameters

    • v: number

    Returns void

subtitleHorizontalAlignment

  • get subtitleHorizontalAlignment(): HorizontalAlignment
  • set subtitleHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the SubtitleHorizontalAlignment property.

    The subtitleBottomMargin property is used to set the horizontal alignment for the subtitle.

    this.chart.subtitleHorizontalAlignment="left";

    Returns HorizontalAlignment

  • Gets or sets the SubtitleHorizontalAlignment property.

    The subtitleBottomMargin property is used to set the horizontal alignment for the subtitle.

    this.chart.subtitleHorizontalAlignment="left";

    Parameters

    • v: HorizontalAlignment

    Returns void

subtitleLeftMargin

  • get subtitleLeftMargin(): number
  • set subtitleLeftMargin(v: number): void
  • Margin applied to the left of the subtitle.

    The subtitleLeftMarging property is used to set the left margin for the subtitle.

    this.chart.subtitleLeftMarging=10;

    Returns number

  • Margin applied to the left of the subtitle.

    The subtitleLeftMarging property is used to set the left margin for the subtitle.

    this.chart.subtitleLeftMarging=10;

    Parameters

    • v: number

    Returns void

subtitleRightMargin

  • get subtitleRightMargin(): number
  • set subtitleRightMargin(v: number): void
  • Margin applied to the right of the subtitle.

    The subTitleRightMargin property is used to set the right margin for the subtitle.

    this.chart.subtitleLeftMarging=10;

    Returns number

  • Margin applied to the right of the subtitle.

    The subTitleRightMargin property is used to set the right margin for the subtitle.

    this.chart.subtitleLeftMarging=10;

    Parameters

    • v: number

    Returns void

subtitleTextColor

  • get subtitleTextColor(): string
  • set subtitleTextColor(v: string): void
  • Gets or sets the Color used for the Subtitle Text.

    The subtitleTextColor property is used to set the color for the subtitle.

    this.chart.subtitleTextColor="blue";

    Returns string

  • Gets or sets the Color used for the Subtitle Text.

    The subtitleTextColor property is used to set the color for the subtitle.

    this.chart.subtitleTextColor="blue";

    Parameters

    • v: string

    Returns void

subtitleTextStyle

  • get subtitleTextStyle(): string
  • set subtitleTextStyle(v: string): void
  • Font settings for the subtitle.

    Returns string

  • Font settings for the subtitle.

    Parameters

    • v: string

    Returns void

subtitleTopMargin

  • get subtitleTopMargin(): number
  • set subtitleTopMargin(v: number): void
  • Margin applied above the subtitle.

    The subtitleTopMargin property is used to set the top margin for the subtitle.

    this.chart.subtitleTopMargin =10;

    Returns number

  • Margin applied above the subtitle.

    The subtitleTopMargin property is used to set the top margin for the subtitle.

    this.chart.subtitleTopMargin =10;

    Parameters

    • v: number

    Returns void

titleBottomMargin

  • get titleBottomMargin(): number
  • set titleBottomMargin(v: number): void
  • Margin applied below the title.

    The titleBottomMargin property is used to set the bottom margin for the title.

    this.chart.titleBottomMargin=20;

    Returns number

  • Margin applied below the title.

    The titleBottomMargin property is used to set the bottom margin for the title.

    this.chart.titleBottomMargin=20;

    Parameters

    • v: number

    Returns void

titleHorizontalAlignment

  • get titleHorizontalAlignment(): HorizontalAlignment
  • set titleHorizontalAlignment(v: HorizontalAlignment): void
  • Gets or sets the TitleHorizontalAlignment property.

    The subtitleHorizontalAlignment property is used to set horizontal alignment for the subtitle.

    this.chart.titleHorizontalAlignment="left";

    Returns HorizontalAlignment

  • Gets or sets the TitleHorizontalAlignment property.

    The subtitleHorizontalAlignment property is used to set horizontal alignment for the subtitle.

    this.chart.titleHorizontalAlignment="left";

    Parameters

    • v: HorizontalAlignment

    Returns void

titleLeftMargin

  • get titleLeftMargin(): number
  • set titleLeftMargin(v: number): void
  • Margin applied to the left of the title.

    The titleLeftMarging property is used to set the left margin for the title.

    this.chart.titleLeftMarging=10;

    Returns number

  • Margin applied to the left of the title.

    The titleLeftMarging property is used to set the left margin for the title.

    this.chart.titleLeftMarging=10;

    Parameters

    • v: number

    Returns void

titleRightMargin

  • get titleRightMargin(): number
  • set titleRightMargin(v: number): void
  • Margin applied to the right of the title.

    The titleRightMargin property is used to set the right margin for the title.

    this.chart.titleRightMargin=10;

    Returns number

  • Margin applied to the right of the title.

    The titleRightMargin property is used to set the right margin for the title.

    this.chart.titleRightMargin=10;

    Parameters

    • v: number

    Returns void

titleTextColor

  • get titleTextColor(): string
  • set titleTextColor(v: string): void
  • Gets or sets the Color used for the Title Text.

    The titleTextColor property is used to set the title brush.

    this.chart.titleTextColor="blue" ;

    Returns string

  • Gets or sets the Color used for the Title Text.

    The titleTextColor property is used to set the title brush.

    this.chart.titleTextColor="blue" ;

    Parameters

    • v: string

    Returns void

titleTextStyle

  • get titleTextStyle(): string
  • set titleTextStyle(v: string): void
  • Font settings for the title.

    Returns string

  • Font settings for the title.

    Parameters

    • v: string

    Returns void

titleTopMargin

  • get titleTopMargin(): number
  • set titleTopMargin(v: number): void
  • Margin applied above the title.

    The titleTopMargin property is used to set the top margin for the title.

    this.chart.titleTopMargin=10;

    Returns number

  • Margin applied above the title.

    The titleTopMargin property is used to set the top margin for the title.

    this.chart.titleTopMargin=10;

    Parameters

    • v: number

    Returns void

topMargin

  • get topMargin(): number
  • set topMargin(v: number): void
  • Sets or gets the top margin to use around the chart content.

    The topMargin property is used to set the top margin.

    this.chart.topMargin=30;

    Returns number

  • Sets or gets the top margin to use around the chart content.

    The topMargin property is used to set the top margin.

    this.chart.topMargin=30;

    Parameters

    • v: number

    Returns void

useTiledZooming

  • get useTiledZooming(): boolean
  • set useTiledZooming(v: boolean): void
  • Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content.

    Returns boolean

  • Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content.

    Parameters

    • v: boolean

    Returns void

viewerManipulationEnding

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

viewerManipulationStarting

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

viewportRect

  • get viewportRect(): IgRect
  • Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area.

    Returns IgRect

windowPositionHorizontal

  • get windowPositionHorizontal(): number
  • set windowPositionHorizontal(v: number): void
  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the X position of the WindowRect property.

    this.chart.windowPositionHorizontal = .2;

    Returns number

  • A number between 0 and 1 determining the position of the horizontal scroll. This property is effectively a shortcut to the X position of the WindowRect property.

    this.chart.windowPositionHorizontal = .2;

    Parameters

    • v: number

    Returns void

windowPositionVertical

  • get windowPositionVertical(): number
  • set windowPositionVertical(v: number): void
  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Y position of the WindowRect property.

    this.chart.windowPositionVertical = .2;

    Returns number

  • A number between 0 and 1 determining the position of the vertical scroll. This property is effectively a shortcut to the Y position of the WindowRect property.

    this.chart.windowPositionVertical = .2;

    Parameters

    • v: number

    Returns void

windowRect

  • get windowRect(): IgRect
  • set windowRect(v: IgRect): void
  • A rectangle representing the portion of the SeriesViewer currently in view. A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in.

    You can set the windowRect to zoom in on an area of interest in the chart.

    this.chart.windowRect = {left:0, top:1, width: .5, height: .5};

    Returns IgRect

  • A rectangle representing the portion of the SeriesViewer currently in view. A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in.

    You can set the windowRect to zoom in on an area of interest in the chart.

    this.chart.windowRect = {left:0, top:1, width: .5, height: .5};

    Parameters

    • v: IgRect

    Returns void

windowRectChanged

  • get windowRectChanged(): function
  • set windowRectChanged(ev: function): void
  • Occurs just after the current SeriesViewer's window rectangle is changed.

    <-- position: content member-->

    <-- position: content member-->

    public onWindowRectChanged =( s:any, e: RectChangedEventArgs) => {
    
           }

    Returns function

  • Occurs just after the current SeriesViewer's window rectangle is changed.

    <-- position: content member-->

    <-- position: content member-->

    public onWindowRectChanged =( s:any, e: RectChangedEventArgs) => {
    
           }

    Parameters

    Returns void

windowRectMinWidth

  • get windowRectMinWidth(): number
  • set windowRectMinWidth(v: number): void
  • Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

    The windowRectMinWidth property is used to set or get the minimum width that the window rect is allowed to reach before being clamped.

    this.chart.WindowRectMinWidth=".2";

    Returns number

  • Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy.

    The windowRectMinWidth property is used to set or get the minimum width that the window rect is allowed to reach before being clamped.

    this.chart.WindowRectMinWidth=".2";

    Parameters

    • v: number

    Returns void

windowResponse

  • The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    The windowResponse property is used to set the response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    this.chart.windowResponse="deferred";

    Returns WindowResponse

  • The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    The windowResponse property is used to set the response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur.

    this.chart.windowResponse="deferred";

    Parameters

    Returns void

zoomCoercionMode

  • Gets or sets zoom is contrained to within the axes. Setting this to false is a preview feature at the present time.

    Returns ZoomCoercionMode

  • Gets or sets zoom is contrained to within the axes. Setting this to false is a preview feature at the present time.

    Parameters

    Returns void

zoomTileCacheSize

  • get zoomTileCacheSize(): number
  • set zoomTileCacheSize(v: number): void
  • Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode.

    Returns number

  • Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode.

    Parameters

    • v: number

    Returns void

Static observedAttributes

  • get observedAttributes(): string[]
  • Returns 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

attachSeries

  • Attaches the given series to the chart.

    Parameters

    Returns void

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

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

    Returns 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

blur

  • blur(): void
  • Returns void

cancelManipulation

  • cancelManipulation(): void
  • Returns void

clearTileZoomCache

  • clearTileZoomCache(): void
  • Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.

    Returns void

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

destroy

  • destroy(): void
  • Release any resources held by the control.

    Returns void

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

endTiledZoomingIfRunning

  • endTiledZoomingIfRunning(): void
  • Manually ends a tiled zoom if one is running.

    Returns void

findByName

  • findByName(name: string): any
  • Parameters

    • name: string

    Returns any

flush

  • flush(): void
  • Use to force the SeriesViewer to finish any deferred work before printing or evaluating its visual. This should only be called if the visual of the SeriesViewer needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the SeriesViewer.

    this.chart.flush();

    Returns void

focus

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

    • Optional options: FocusOptions

    Returns void

getActualWindowScaleHorizontal

  • getActualWindowScaleHorizontal(): number
  • Gets actual window scale for horizontal dimension of the control

    let actualWindowScaleHorizontal: number = chart.getActualWindowScaleHorizontal();

    Returns number

getActualWindowScaleVertical

  • getActualWindowScaleVertical(): number
  • Gets actual window scale for vertical dimension of the control

    let actualWindowScaleVertical: number = chart.getActualWindowScaleVertical();

    Returns number

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

getCurrentActualWindowRect

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

getRootNode

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

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

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

hideToolTip

  • hideToolTip(): void
  • Hides the active main tooltip, if displayed.

    this.chart.hideToolTip();

    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

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

notifyClearItems

  • notifyClearItems(source_: any): void
  • Used to manually notify the SeriesViewer that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable.

    Parameters

    • source_: any
      • The data source which was cleared or reset.
      this.chart.notifyClearItems(this.data);

    Returns void

notifyContainerResized

  • notifyContainerResized(): void
  • Notification from the containing object that the container has been resized.

    Returns void

notifyInsertItem

  • notifyInsertItem(source_: any, index: number, newItem: any): void
  • Parameters

    • source_: any
    • index: number
    • newItem: any

    Returns void

notifyRemoveItem

  • notifyRemoveItem(source_: any, index: number, oldItem: any): void
  • Parameters

    • source_: any
    • index: number
    • oldItem: any

    Returns void

notifySetItem

  • notifySetItem(source_: any, index: number, oldItem: any, newItem: any): void
  • Parameters

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

    Returns 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

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

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

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

renderToImage

  • renderToImage(width: number, height: number): any
  • Parameters

    • width: number
    • height: number

    Returns any

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

requestFullscreen

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

    Returns Promise<void>

resetZoom

  • resetZoom(): void
  • Resets the zoom level to default.

    Returns void

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(arg?: boolean | ScrollIntoViewOptions): void
  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

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

setPointerCapture

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

simulateHover

  • simulateHover(point: IgPoint): void
  • Parameters

    • point: IgPoint

    Returns void

startTiledZoomingIfNecessary

  • startTiledZoomingIfNecessary(): void
  • Manually starts a tiled zoom if one isn't already running.

    Returns void

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

  • Parameters

    • internal: any

    Returns IgcSeriesViewerComponent