Represents a control for viewing series objects.

IgrSeriesViewer

new IgrSeriesViewer(props: P): IgrSeriesViewer

Returns IgrSeriesViewer

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

``

get actualContentHitTestMode(): ChartHitTestMode

Returns ChartHitTestMode

set actualContentHitTestMode(v: ChartHitTestMode): void

Parameters

Returns void

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

``

get actualInteractionPixelScalingRatio(): number

Returns number

set actualInteractionPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns 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

``

get actualPixelScalingRatio(): number

Returns number

set actualPixelScalingRatio(v: number): void

Parameters

  • v: number

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

``

get actualWindowPositionHorizontal(): number

Returns number

set actualWindowPositionHorizontal(v: number): void

Parameters

  • v: number

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

``

get actualWindowPositionVertical(): number

Returns number

set actualWindowPositionVertical(v: number): void

Parameters

  • v: number

Returns void

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

get actualWindowRect(): IgRect

Returns IgRect

set actualWindowRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

Raised when the actual window rectangle of the SeriesViewer changes.

get actualWindowRectChanged(): object

Returns object

set actualWindowRectChanged(ev: object): void

Parameters

  • ev: object

Returns void

Gets the actual minimum height that the window rect is allowed to reach before being clamped.

get actualWindowRectMinHeight(): number

Returns number

set actualWindowRectMinHeight(v: number): void

Parameters

  • v: number

Returns void

Gets the actual minimum width that the window rect is allowed to reach before being clamped.

get actualWindowRectMinWidth(): number

Returns number

set actualWindowRectMinWidth(v: number): void

Parameters

  • v: number

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

``

``

get animateSeriesWhenAxisRangeChanges(): boolean

Returns boolean

set animateSeriesWhenAxisRangeChanges(v: boolean): void

Parameters

  • v: boolean

Returns void

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

``

``

get autoMarginHeight(): number

Returns number

set autoMarginHeight(v: number): void

Parameters

  • v: number

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

``

``

get autoMarginWidth(): number

Returns number

set autoMarginWidth(v: number): void

Parameters

  • v: number

Returns void

get axisLabelMouseClick(): object

Returns object

set axisLabelMouseClick(ev: object): void

Parameters

  • ev: object

Returns void

get axisLabelMouseDown(): object

Returns object

set axisLabelMouseDown(ev: object): void

Parameters

  • ev: object

Returns void

get axisLabelMouseEnter(): object

Returns object

set axisLabelMouseEnter(ev: object): void

Parameters

  • ev: object

Returns void

get axisLabelMouseLeave(): object

Returns object

set axisLabelMouseLeave(ev: object): void

Parameters

  • ev: object

Returns void

get axisLabelMouseOver(): object

Returns object

set axisLabelMouseOver(ev: object): void

Parameters

  • ev: object

Returns void

get axisLabelMouseUp(): object

Returns object

set axisLabelMouseUp(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseClick(): object

Returns object

set axisPanelMouseClick(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseDown(): object

Returns object

set axisPanelMouseDown(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseEnter(): object

Returns object

set axisPanelMouseEnter(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseLeave(): object

Returns object

set axisPanelMouseLeave(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseOver(): object

Returns object

set axisPanelMouseOver(ev: object): void

Parameters

  • ev: object

Returns void

get axisPanelMouseUp(): object

Returns object

set axisPanelMouseUp(ev: object): void

Parameters

  • ev: object

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

``

``

get bottomMargin(): number

Returns number

set bottomMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the palette of brushes used for fill of plotted series. These brushes are automatically assigned to series based on the index of series.

get brushes(): string[]

Returns string[]

set brushes(v: string[]): void

Parameters

  • v: string[]

Returns void

Text to display above the plot area.

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

``

``

get chartTitle(): string

Returns string

set chartTitle(v: string): void

Parameters

  • v: string

Returns void

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

``

get contentHitTestMode(): ChartHitTestMode

Returns ChartHitTestMode

set contentHitTestMode(v: ChartHitTestMode): void

Parameters

Returns void

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.

get contentViewport(): IgRect

Returns IgRect

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).

``

``

get crosshairPoint(): IgPoint

Returns IgPoint

set crosshairPoint(v: IgPoint): void

Parameters

  • v: IgPoint

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

``

``

get crosshairVisibility(): Visibility

Returns Visibility

set crosshairVisibility(v: Visibility): void

Parameters

  • v: Visibility

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

``

``

get defaultInteraction(): InteractionState

Returns InteractionState

set defaultInteraction(v: InteractionState): void

Parameters

  • v: InteractionState

Returns void

Gets or sets the current SeriesViewer's DragModifier property.

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

``

``

get dragModifier(): ModifierKeys

Returns ModifierKeys

set dragModifier(v: ModifierKeys): void

Parameters

  • v: ModifierKeys

Returns void

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

``ts let viewport: Rect = this.chart.effectiveViewport;

get effectiveViewport(): IgRect

Returns IgRect

set effectiveViewport(v: IgRect): void

Parameters

  • v: IgRect

Returns void

Gets or sets how the mouse leave event fires when a manipulation is started.

get fireMouseLeaveOnManipulationStart(): boolean

Returns boolean

set fireMouseLeaveOnManipulationStart(v: boolean): void

Parameters

  • v: boolean

Returns void

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

get focusBrush(): string

Returns string

set focusBrush(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the amount of time to delay before dismissing a selection effect.

get focusDismissDelayMilliseconds(): number

Returns number

set focusDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

Gets the currently focused data items. Adding or removing data items from this collection will focus or blur the visuals associated with those items.

get focusedSeriesItems(): IgrChartSelectedItemCollection

Returns IgrChartSelectedItemCollection

set focusedSeriesItems(v: IgrChartSelectedItemCollection): void

Parameters

Returns void

Raised when the SelectedItems collection has changed.

get focusedSeriesItemsChanged(): object

Returns object

set focusedSeriesItemsChanged(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the focus mode to use for the series in the component, when supported.

get focusMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set focusMode(v: SeriesSelectionMode): void

Parameters

Returns void

Gets or sets the duration the Focus/de-Focus effects.

get focusTransitionDuration(): number

Returns number

set focusTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

get fullSeries(): IgrSeriesCollection

Returns IgrSeriesCollection

set fullSeries(v: IgrSeriesCollection): void

Parameters

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

get gridAreaRectChanged(): object

Returns object

set gridAreaRectChanged(ev: object): void

Parameters

  • ev: object

Returns void

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

get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

Returns SeriesHighlightedValuesDisplayMode

set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void

Parameters

  • v: SeriesHighlightedValuesDisplayMode

Returns void

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

get highlightingBehavior(): SeriesHighlightingBehavior

Returns SeriesHighlightingBehavior

set highlightingBehavior(v: SeriesHighlightingBehavior): void

Parameters

Returns void

highlightingDismissDelayMilliseconds

Section titled "highlightingDismissDelayMilliseconds"

Gets or sets the amount of time to delay before dismissing a selection effect.

get highlightingDismissDelayMilliseconds(): number

Returns number

set highlightingDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

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

get highlightingFadeOpacity(): number

Returns number

set highlightingFadeOpacity(v: number): void

Parameters

  • v: number

Returns void

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

get highlightingMode(): SeriesHighlightingMode

Returns SeriesHighlightingMode

set highlightingMode(v: SeriesHighlightingMode): void

Parameters

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

``

``

get highlightingTransitionDuration(): number

Returns number

set highlightingTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the current SeriesViewer's crosshair horizontal brush override.

get horizontalCrosshairBrush(): string

Returns string

set horizontalCrosshairBrush(v: string): void

Parameters

  • v: string

Returns void

horizontalViewScrollbarCornerRadius

Section titled "horizontalViewScrollbarCornerRadius"

Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarCornerRadius(): number

Returns number

set horizontalViewScrollbarCornerRadius(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarFill(): string

Returns string

set horizontalViewScrollbarFill(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the height to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarHeight(): number

Returns number

set horizontalViewScrollbarHeight(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarInset(): number

Returns number

set horizontalViewScrollbarInset(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarMaxOpacity(): number

Returns number

set horizontalViewScrollbarMaxOpacity(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the horizontal scrollbar mode to use for the series viewer.

get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode

set horizontalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

Returns void

Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarOutline(): string

Returns string

set horizontalViewScrollbarOutline(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the position to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarPosition(): SeriesViewerHorizontalScrollbarPosition

Returns SeriesViewerHorizontalScrollbarPosition

set horizontalViewScrollbarPosition(v: SeriesViewerHorizontalScrollbarPosition): void

Parameters

Returns void

horizontalViewScrollbarShouldAddAutoTrackInsets

Section titled "horizontalViewScrollbarShouldAddAutoTrackInsets"

Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarShouldAddAutoTrackInsets(): boolean

Returns boolean

set horizontalViewScrollbarShouldAddAutoTrackInsets(v: boolean): void

Parameters

  • v: boolean

Returns void

horizontalViewScrollbarStrokeThickness

Section titled "horizontalViewScrollbarStrokeThickness"

Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarStrokeThickness(): number

Returns number

set horizontalViewScrollbarStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarTrackEndInset

Section titled "horizontalViewScrollbarTrackEndInset"

Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarTrackEndInset(): number

Returns number

set horizontalViewScrollbarTrackEndInset(v: number): void

Parameters

  • v: number

Returns void

horizontalViewScrollbarTrackStartInset

Section titled "horizontalViewScrollbarTrackStartInset"

Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled.

get horizontalViewScrollbarTrackStartInset(): number

Returns number

set horizontalViewScrollbarTrackStartInset(v: number): void

Parameters

  • v: number

Returns void

Event raised when an image of the component is saved

get imageCaptured(): object

Returns object

set imageCaptured(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the InteractionOverride property. The interaction override overrides the default interaction and modifiers keys and defines the SeriesViewer's response to mouse events.

get interactionOverride(): InteractionState

Returns InteractionState

set interactionOverride(v: InteractionState): void

Parameters

  • v: InteractionState

Returns void

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

get interactionPixelScalingRatio(): number

Returns number

set interactionPixelScalingRatio(v: number): void

Parameters

  • v: number

Returns void

isAntiAliasingEnabledDuringInteraction

Section titled "isAntiAliasingEnabledDuringInteraction"

Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

get isAntiAliasingEnabledDuringInteraction(): boolean

Returns boolean

set isAntiAliasingEnabledDuringInteraction(v: boolean): void

Parameters

  • v: boolean

Returns void

get isDetached(): boolean

Returns boolean

get isInCreateAnnotationMode(): boolean

Returns boolean

get isInDeleteAnnotationMode(): boolean

Returns boolean

Indicates if this SeriesViewer is a map.

get isMap(): boolean

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.

get isPagePanningAllowed(): boolean

Returns boolean

set isPagePanningAllowed(v: boolean): void

Parameters

  • v: boolean

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

``

``

get isSurfaceInteractionDisabled(): boolean

Returns boolean

set isSurfaceInteractionDisabled(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets whether initiating user annotations from the toolbar is enabled.

get isUserAnnotationsEnabled(): boolean

Returns boolean

set isUserAnnotationsEnabled(v: boolean): void

Parameters

  • v: boolean

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

get isWindowSyncedToVisibleRange(): boolean

Returns boolean

set isWindowSyncedToVisibleRange(v: boolean): void

Parameters

  • v: boolean

Returns void

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

The LeftMargin property is used to set the left margin.

``

``

get leftMargin(): number

Returns number

set leftMargin(v: number): void

Parameters

  • v: number

Returns void

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

get legendHighlightingMode(): LegendHighlightingMode

Returns LegendHighlightingMode

set legendHighlightingMode(v: LegendHighlightingMode): void

Parameters

Returns void

Gets or sets the mode of legend badges representing all series in this chart. This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series

get legendItemBadgeMode(): LegendItemBadgeMode

Returns LegendItemBadgeMode

set legendItemBadgeMode(v: LegendItemBadgeMode): void

Parameters

  • v: LegendItemBadgeMode

Returns void

Gets or sets type of legend badges representing all series displayed in a legend linked to this component This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series

get legendItemBadgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape

set legendItemBadgeShape(v: LegendItemBadgeShape): void

Parameters

  • v: LegendItemBadgeShape

Returns void

Gets or sets the marker mode used for assigning a marker type to series when the marker type is automatic.

get markerAutomaticBehavior(): MarkerAutomaticBehavior

Returns MarkerAutomaticBehavior

set markerAutomaticBehavior(v: MarkerAutomaticBehavior): void

Parameters

Returns void

Gets or sets the palette of brushes used for fill of marker series. These brushes are automatically assigned to markers based on the index of series.

get markerBrushes(): string[]

Returns string[]

set markerBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

Gets or sets the palette of brushes used for outlines of plotted markers. These outlines are automatically assigned to markers based on the index of series.

get markerOutlines(): string[]

Returns string[]

set markerOutlines(v: string[]): void

Parameters

  • v: string[]

Returns void

get nativeElement(): HTMLElement

Returns HTMLElement

Gets or sets the palette of brushes used for outlines of plotted series. These outlines are automatically assigned to series based on the index of series.

get outlines(): string[]

Returns string[]

set outlines(v: string[]): void

Parameters

  • v: string[]

Returns void

Gets or sets the current SeriesViewer's PanModifier property.

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

``

``

get panModifier(): ModifierKeys

Returns ModifierKeys

set panModifier(v: ModifierKeys): void

Parameters

  • v: ModifierKeys

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

get pixelScalingRatio(): number

Returns number

set pixelScalingRatio(v: number): void

Parameters

  • v: number

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

``

``

get plotAreaBackground(): string

Returns string

set plotAreaBackground(v: string): void

Parameters

  • v: string

Returns void

Occurs when the left mouse button is clicked while the mouse pointer is over the plot area.

get plotAreaClicked(): object

Returns object

set plotAreaClicked(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the pointer enters the plot area.

get plotAreaMouseEnter(): object

Returns object

set plotAreaMouseEnter(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the pointer exits the plot area.

get plotAreaMouseLeave(): object

Returns object

set plotAreaMouseLeave(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the left mouse button is pressed while the mouse pointer is over the plot area.

get plotAreaMouseLeftButtonDown(): object

Returns object

set plotAreaMouseLeftButtonDown(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the left mouse button is pressed while the mouse pointer is over the plot area.

get plotAreaMouseLeftButtonUp(): object

Returns object

set plotAreaMouseLeftButtonUp(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the pointer if over the plot area.

get plotAreaMouseOver(): object

Returns object

set plotAreaMouseOver(ev: object): void

Parameters

  • ev: object

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

get preferHigherResolutionTiles(): boolean

Returns boolean

set preferHigherResolutionTiles(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets the brush used as the fill for the current SeriesViewer object's preview path. Null is treated as auto.

get previewPathFill(): string

Returns string

set previewPathFill(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the opacity used as for the fill for the current SeriesViewer object's preview path. Null is treated as auto.

get previewPathOpacity(): number

Returns number

set previewPathOpacity(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the brush used as the border for the current SeriesViewer object's preview path. Null is treated as auto.

get previewPathStroke(): string

Returns string

set previewPathStroke(v: string): void

Parameters

  • v: string

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

``

get previewRect(): IgRect

Returns IgRect

set previewRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

Raised when the SeriesViewer's processing for an update has completed.

get refreshCompleted(): object

Returns object

set refreshCompleted(ev: object): void

Parameters

  • ev: object

Returns void

get resizeIdle(): object

Returns object

set resizeIdle(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the milliseconds before the chart will fire the resize idle event after the last resize.

get resizeIdleMilliseconds(): number

Returns number

set resizeIdleMilliseconds(v: number): void

Parameters

  • v: number

Returns void

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

get rightButtonDefaultInteraction(): InteractionState

Returns InteractionState

set rightButtonDefaultInteraction(v: InteractionState): void

Parameters

  • v: InteractionState

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

``

``

get rightMargin(): number

Returns number

set rightMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the duration of the scrollbar effects.

get scrollbarsAnimationDuration(): number

Returns number

set scrollbarsAnimationDuration(v: number): void

Parameters

  • v: number

Returns void

Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items.

get selectedSeriesItems(): IgrChartSelectedItemCollection

Returns IgrChartSelectedItemCollection

set selectedSeriesItems(v: IgrChartSelectedItemCollection): void

Parameters

Returns void

Raised when the SelectedItems collection has changed.

get selectedSeriesItemsChanged(): object

Returns object

set selectedSeriesItemsChanged(ev: object): void

Parameters

  • ev: object

Returns void

Gets or sets the selection behavior to use for the series in the component, when supported.

get selectionBehavior(): SeriesSelectionBehavior

Returns SeriesSelectionBehavior

set selectionBehavior(v: SeriesSelectionBehavior): void

Parameters

Returns void

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

get selectionBrush(): string

Returns string

set selectionBrush(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the amount of time to delay before dismissing a selection effect.

get selectionDismissDelayMilliseconds(): number

Returns number

set selectionDismissDelayMilliseconds(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the selection mode to use for the series in the component, when supported.

get selectionMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set selectionMode(v: SeriesSelectionMode): void

Parameters

Returns void

Gets or sets the current SeriesViewer's SelectionModifier property.

get selectionModifier(): ModifierKeys

Returns ModifierKeys

set selectionModifier(v: ModifierKeys): void

Parameters

  • v: ModifierKeys

Returns void

Gets or sets the duration the selection/de-Selection effects.

get selectionTransitionDuration(): number

Returns number

set selectionTransitionDuration(v: number): void

Parameters

  • v: number

Returns void

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

get seriesClick(): object

Returns object

set seriesClick(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the cursors are moved over a series in this SeriesViewer.

get seriesCursorMouseMove(): object

Returns object

set seriesCursorMouseMove(ev: object): void

Parameters

  • ev: object

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

``

``

get seriesMouseEnter(): object

Returns object

set seriesMouseEnter(ev: object): void

Parameters

  • ev: object

Returns void

Occurs when the mouse pointer leaves a Series.

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

``

``

get seriesMouseLeave(): object

Returns object

set seriesMouseLeave(ev: object): void

Parameters

  • ev: object

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

``

``

get seriesMouseLeftButtonDown(): object

Returns object

set seriesMouseLeftButtonDown(ev: object): void

Parameters

  • ev: object

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

``

``

``

get seriesMouseLeftButtonUp(): object

Returns object

set seriesMouseLeftButtonUp(ev: object): void

Parameters

  • ev: object

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

``

``

``

get seriesMouseMove(): object

Returns object

set seriesMouseMove(ev: object): void

Parameters

  • ev: object

Returns void

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

get seriesValueLayerUseLegend(): boolean

Returns boolean

set seriesValueLayerUseLegend(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets whether to match the z order of the series to their positional order in the series collection, regardless of mutation.

get shouldMatchZOrderToSeriesOrder(): boolean

Returns boolean

set shouldMatchZOrderToSeriesOrder(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets a whether the chart should pan its content when zooming in passed max zoom level.

get shouldPanOnMaximumZoom(): boolean

Returns boolean

set shouldPanOnMaximumZoom(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldSimulateHoverMoveCrosshairPoint

Section titled "shouldSimulateHoverMoveCrosshairPoint"

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

get shouldSimulateHoverMoveCrosshairPoint(): boolean

Returns boolean

set shouldSimulateHoverMoveCrosshairPoint(v: boolean): void

Parameters

  • v: boolean

Returns void

Occurs after the size of the series viewer changes.

<-- position: content member-->

<-- position: content member-->

``

``

get sizeChanged(): object

Returns object

set sizeChanged(ev: object): void

Parameters

  • ev: object

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

``

``

get subtitle(): string

Returns string

set subtitle(v: string): void

Parameters

  • v: string

Returns void

Margin applied below the subtitle.

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

``

``

get subtitleBottomMargin(): number

Returns number

set subtitleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the SubtitleHorizontalAlignment property.

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

``

``

get subtitleHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set subtitleHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

Margin applied to the left of the subtitle.

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

``

``

get subtitleLeftMargin(): number

Returns number

set subtitleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

Margin applied to the right of the subtitle.

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

``

``

get subtitleRightMargin(): number

Returns number

set subtitleRightMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the Color used for the Subtitle Text.

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

``

``

get subtitleTextColor(): string

Returns string

set subtitleTextColor(v: string): void

Parameters

  • v: string

Returns void

Font settings for the subtitle.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

  • v: string

Returns void

Margin applied above the subtitle.

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

``

``

get subtitleTopMargin(): number

Returns number

set subtitleTopMargin(v: number): void

Parameters

  • v: number

Returns void

Margin applied below the title.

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

``

``

get titleBottomMargin(): number

Returns number

set titleBottomMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the TitleHorizontalAlignment property.

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

``

``

get titleHorizontalAlignment(): HorizontalAlignment

Returns HorizontalAlignment

set titleHorizontalAlignment(v: HorizontalAlignment): void

Parameters

  • v: HorizontalAlignment

Returns void

Margin applied to the left of the title.

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

``

``

get titleLeftMargin(): number

Returns number

set titleLeftMargin(v: number): void

Parameters

  • v: number

Returns void

Margin applied to the right of the title.

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

``

``

get titleRightMargin(): number

Returns number

set titleRightMargin(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the Color used for the Title Text.

The titleTextColor property is used to set the title brush.

``

``

get titleTextColor(): string

Returns string

set titleTextColor(v: string): void

Parameters

  • v: string

Returns void

Font settings for the title.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

  • v: string

Returns void

Margin applied above the title.

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

``

``

get titleTopMargin(): number

Returns number

set titleTopMargin(v: number): void

Parameters

  • v: number

Returns void

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

The topMargin property is used to set the top margin.

``

``

get topMargin(): number

Returns number

set topMargin(v: number): void

Parameters

  • v: number

Returns void

get userAnnotationInformationRequested(): object

Returns object

set userAnnotationInformationRequested(ev: object): void

Parameters

  • ev: object

Returns void

userAnnotationToolTipContentUpdating

Section titled "userAnnotationToolTipContentUpdating"
get userAnnotationToolTipContentUpdating(): object

Returns object

set userAnnotationToolTipContentUpdating(ev: object): void

Parameters

  • ev: object

Returns void

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

get useTiledZooming(): boolean

Returns boolean

set useTiledZooming(v: boolean): void

Parameters

  • v: boolean

Returns void

Gets or sets the current SeriesViewer's crosshair vertical brush override.

get verticalCrosshairBrush(): string

Returns string

set verticalCrosshairBrush(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarCornerRadius(): number

Returns number

set verticalViewScrollbarCornerRadius(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the fill to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarFill(): string

Returns string

set verticalViewScrollbarFill(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarInset(): number

Returns number

set verticalViewScrollbarInset(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarMaxOpacity(): number

Returns number

set verticalViewScrollbarMaxOpacity(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the vertical scrollbar mode to use for the series viewer.

get verticalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode

set verticalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

Returns void

Gets or sets the outline to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarOutline(): string

Returns string

set verticalViewScrollbarOutline(v: string): void

Parameters

  • v: string

Returns void

Gets or sets the position to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarPosition(): SeriesViewerVerticalScrollbarPosition

Returns SeriesViewerVerticalScrollbarPosition

set verticalViewScrollbarPosition(v: SeriesViewerVerticalScrollbarPosition): void

Parameters

Returns void

verticalViewScrollbarShouldAddAutoTrackInsets

Section titled "verticalViewScrollbarShouldAddAutoTrackInsets"

Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarShouldAddAutoTrackInsets(): boolean

Returns boolean

set verticalViewScrollbarShouldAddAutoTrackInsets(v: boolean): void

Parameters

  • v: boolean

Returns void

verticalViewScrollbarStrokeThickness

Section titled "verticalViewScrollbarStrokeThickness"

Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarStrokeThickness(): number

Returns number

set verticalViewScrollbarStrokeThickness(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarTrackEndInset(): number

Returns number

set verticalViewScrollbarTrackEndInset(v: number): void

Parameters

  • v: number

Returns void

verticalViewScrollbarTrackStartInset

Section titled "verticalViewScrollbarTrackStartInset"

Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarTrackStartInset(): number

Returns number

set verticalViewScrollbarTrackStartInset(v: number): void

Parameters

  • v: number

Returns void

Gets or sets the width to use for the vertical scrollbar in the component, when enabled.

get verticalViewScrollbarWidth(): number

Returns number

set verticalViewScrollbarWidth(v: number): void

Parameters

  • v: number

Returns void

Raised when an ongoing manipulation of the series viewer is ended.

get viewerManipulationEnding(): object

Returns object

set viewerManipulationEnding(ev: object): void

Parameters

  • ev: object

Returns void

Raised when an ongoing manipulation of the series viewer is started.

get viewerManipulationStarting(): object

Returns object

set viewerManipulationStarting(ev: object): void

Parameters

  • ev: object

Returns void

Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area.

get viewportRect(): IgRect

Returns IgRect

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.

``

get windowPositionHorizontal(): number

Returns number

set windowPositionHorizontal(v: number): void

Parameters

  • v: number

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

``

get windowPositionVertical(): number

Returns number

set windowPositionVertical(v: number): void

Parameters

  • v: number

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

``

get windowRect(): IgRect

Returns IgRect

set windowRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

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

<-- position: content member-->

<-- position: content member-->

``

``

get windowRectChanged(): object

Returns object

set windowRectChanged(ev: object): void

Parameters

  • ev: object

Returns void

Sets or gets the minimum height 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. This property accepts values between 0.0 (max zooming) and 1.0 (no zooming)

get windowRectMinHeight(): number

Returns number

set windowRectMinHeight(v: number): void

Parameters

  • v: number

Returns 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. This property accepts values between 0.0 (max zooming) and 1.0 (no zooming)

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

``

``

get windowRectMinWidth(): number

Returns number

set windowRectMinWidth(v: number): void

Parameters

  • v: number

Returns void

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.

``

``

get windowResponse(): WindowResponse

Returns WindowResponse

set windowResponse(v: WindowResponse): void

Parameters

Returns void

Sets or gets minimum pixel height that the window 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. This property is overridden by the WindowRectMinHeight property

get windowSizeMinHeight(): number

Returns number

set windowSizeMinHeight(v: number): void

Parameters

  • v: number

Returns void

Sets or gets minimum pixel width that the window 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. This property is overridden by the WindowRectMinWidth property

get windowSizeMinWidth(): number

Returns number

set windowSizeMinWidth(v: number): void

Parameters

  • v: number

Returns void

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

get zoomCoercionMode(): ZoomCoercionMode

Returns ZoomCoercionMode

set zoomCoercionMode(v: ZoomCoercionMode): void

Parameters

Returns void

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

get zoomTileCacheSize(): number

Returns number

set zoomTileCacheSize(v: number): void

Parameters

  • v: number

Returns void

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

Attaches the given series to the chart.

attachSeries(s: IgrSeries): void

Parameters

  • s: IgrSeries
    • The series to attach to the chart.

Returns void

cancelAnnotationFlow(annotationFlowID: string): void

Parameters

  • annotationFlowID: string

Returns void

cancelCreatingAnnotation(): void

Returns void

cancelDeletingAnnotation(): void

Returns void

cancelManipulation(): void

Returns void

captureImage(settings: IgrCaptureImageSettings): void

Parameters

  • settings: IgrCaptureImageSettings

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

clearTileZoomCache(): void

Returns void

componentDidMount(): void

Returns void

Release any resources held by the control.

destroy(): void

Returns void

Manually ends a tiled zoom if one is running.

endTiledZoomingIfRunning(): void

Returns void

findByName(name: string): any

Parameters

  • name: string

Returns any

finishAnnotationFlow(info: IgrUserAnnotationInformation): void

Parameters

Returns void

finishCreatingAnnotation(): void

Returns void

finishDeletingAnnotation(): void

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

``

flush(): void

Returns void

Gets actual window scale for horizontal dimension of the control

``

getActualWindowScaleHorizontal(): number

Returns number

Gets actual window scale for vertical dimension of the control

``

getActualWindowScaleVertical(): number

Returns number

getAnimationIdleVersionNumber(): number

Returns number

getCurrentActualWindowRect(): IgRect

Returns IgRect

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

Hides the active main tooltip, if displayed.

``

hideToolTip(): void

Returns void

isAnimationActive(): boolean

Returns boolean

loadAnnotationsFromJson(jsonString: string): void

Parameters

  • jsonString: string

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

notifyClearItems(source_: any): void

Parameters

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

Returns void

Notification from the containing object that the container has been resized.

notifyContainerResized(): void

Returns void

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

Parameters

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

Returns void

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

Parameters

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

Returns void

notifySeriesDataChanged(): void

Returns void

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

Parameters

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

Returns void

queueForAnimationIdle(action: object, version: number): void

Parameters

  • action: object
  • version: number

Returns void

removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

render(): any

Returns any

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

Parameters

  • width: number
  • height: number

Returns any

resetAnnotations(): void

Returns void

Resets the zoom level to default.

resetZoom(): void

Returns void

saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateClick(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulateHover(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulateMouseLeave(): void

Returns void

simulatePlotPointerUp(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulatePressAndHold(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

startCreatingAnnotation(): void

Returns void

startDeletingAnnotation(): void

Returns void

Manually starts a tiled zoom if one isn't already running.

startTiledZoomingIfNecessary(): void

Returns void

Performs zoom in action on the chart by specified percentage of current window rect

zoomIn(percentage: number): void

Parameters

  • percentage: number

Returns void

Performs zoom out action on the chart by specified percentage of current window rect

zoomOut(percentage: number): void

Parameters

  • percentage: number

Returns void

_createFromInternal(internal: any): IgrSeriesViewer

Parameters

  • internal: any

Returns IgrSeriesViewer