IgrDataChart

Represents a chart area containing axes, series, an optional legend and other hosted content.

Constructors

new IgrDataChart(props: IIgrDataChartProps): IgrDataChart

Returns IgrDataChart

Properties

actualAxes

The axes actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing axes from the manual axes collection on the axes property.

actualAxes: IgrAxis<IIgrAxisProps>[]

actualSeries

The series actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing series from the manual series collection on the series property.

actualSeries: IgrSeries<IIgrSeriesProps>[]

contentAxes

contentAxes: IgrAxis<IIgrAxisProps>[]

contentSeries

contentSeries: IgrSeries<IIgrSeriesProps>[]

Accessors

actualContentHitTestMode

Inherited from: 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

v: ChartHitTestMode

Returns void

actualInteractionPixelScalingRatio

Inherited from: IgrSeriesViewer

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

actualPixelScalingRatio

Inherited from: IgrSeriesViewer

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

actualPlotAreaMarginBottom

Gets the actual resolved bottom plot area margin;

get actualPlotAreaMarginBottom(): number

Returns number

set actualPlotAreaMarginBottom(v: number): void

Parameters

v: number

Returns void

actualPlotAreaMarginLeft

Gets the actual resolved left plot area margin;

get actualPlotAreaMarginLeft(): number

Returns number

set actualPlotAreaMarginLeft(v: number): void

Parameters

v: number

Returns void

actualPlotAreaMarginRight

Gets the actual resolved right plot area margin;

get actualPlotAreaMarginRight(): number

Returns number

set actualPlotAreaMarginRight(v: number): void

Parameters

v: number

Returns void

actualPlotAreaMarginTop

Gets the actual resolved top plot area margin;

get actualPlotAreaMarginTop(): number

Returns number

set actualPlotAreaMarginTop(v: number): void

Parameters

v: number

Returns void

actualWindowPositionHorizontal

Inherited from: IgrSeriesViewer

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

actualWindowPositionVertical

Inherited from: IgrSeriesViewer

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

actualWindowRect

Inherited from: IgrSeriesViewer

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

actualWindowRectChanged

Inherited from: IgrSeriesViewer

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

actualWindowRectMinHeight

Inherited from: IgrSeriesViewer

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

actualWindowRectMinWidth

Inherited from: IgrSeriesViewer

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

actualWindowScaleHorizontal

A number between 0 and 1 determining the scale of the horizontal zoom. This property is effectively a shortcut to the Width of the ActualWindowRect property.

get actualWindowScaleHorizontal(): number

Returns number

set actualWindowScaleHorizontal(v: number): void

Parameters

v: number

Returns void

actualWindowScaleVertical

A number between 0 and 1 determining the scale of the vertical zoom. This property is effectively a shortcut to the Height of the ActualWindowRect property.

get actualWindowScaleVertical(): number

Returns number

set actualWindowScaleVertical(v: number): void

Parameters

v: number

Returns void

alignsGridLinesToPixels

Gets or sets a value indicating whether grid and tick lines are aligned to device pixels.

get alignsGridLinesToPixels(): boolean

Returns boolean

set alignsGridLinesToPixels(v: boolean): void

Parameters

v: boolean

Returns void

animateSeriesWhenAxisRangeChanges

Inherited from: IgrSeriesViewer

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

autoExpandMarginExtraPadding

Gets or sets the extra amount the series viewer should auto expand margins to accomodate the initial horizontal axis labels.

get autoExpandMarginExtraPadding(): number

Returns number

set autoExpandMarginExtraPadding(v: number): void

Parameters

v: number

Returns void

autoExpandMarginMaximumValue

Gets or sets the maximum amount the series viewer should auto expand margins to accomodate the initial horizontal axis labels.

get autoExpandMarginMaximumValue(): number

Returns number

set autoExpandMarginMaximumValue(v: number): void

Parameters

v: number

Returns void

autoMarginAndAngleUpdateMode

Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true.

get autoMarginAndAngleUpdateMode(): AutoMarginsAndAngleUpdateMode

Returns AutoMarginsAndAngleUpdateMode

set autoMarginAndAngleUpdateMode(v: AutoMarginsAndAngleUpdateMode): void

Parameters

v: AutoMarginsAndAngleUpdateMode

Returns void

autoMarginHeight

Inherited from: IgrSeriesViewer

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

autoMarginWidth

Inherited from: IgrSeriesViewer

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

axes

A collection or manually added axes for the chart.

get axes(): IgrAxisCollection

Returns IgrAxisCollection

axisLabelMouseClick

Inherited from: IgrSeriesViewer

get axisLabelMouseClick(): object

Returns object

set axisLabelMouseClick(ev: object): void

Parameters

ev: object

Returns void

axisLabelMouseDown

Inherited from: IgrSeriesViewer

get axisLabelMouseDown(): object

Returns object

set axisLabelMouseDown(ev: object): void

Parameters

ev: object

Returns void

axisLabelMouseEnter

Inherited from: IgrSeriesViewer

get axisLabelMouseEnter(): object

Returns object

set axisLabelMouseEnter(ev: object): void

Parameters

ev: object

Returns void

axisLabelMouseLeave

Inherited from: IgrSeriesViewer

get axisLabelMouseLeave(): object

Returns object

set axisLabelMouseLeave(ev: object): void

Parameters

ev: object

Returns void

axisLabelMouseOver

Inherited from: IgrSeriesViewer

get axisLabelMouseOver(): object

Returns object

set axisLabelMouseOver(ev: object): void

Parameters

ev: object

Returns void

axisLabelMouseUp

Inherited from: IgrSeriesViewer

get axisLabelMouseUp(): object

Returns object

set axisLabelMouseUp(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseClick

Inherited from: IgrSeriesViewer

get axisPanelMouseClick(): object

Returns object

set axisPanelMouseClick(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseDown

Inherited from: IgrSeriesViewer

get axisPanelMouseDown(): object

Returns object

set axisPanelMouseDown(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseEnter

Inherited from: IgrSeriesViewer

get axisPanelMouseEnter(): object

Returns object

set axisPanelMouseEnter(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseLeave

Inherited from: IgrSeriesViewer

get axisPanelMouseLeave(): object

Returns object

set axisPanelMouseLeave(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseOver

Inherited from: IgrSeriesViewer

get axisPanelMouseOver(): object

Returns object

set axisPanelMouseOver(ev: object): void

Parameters

ev: object

Returns void

axisPanelMouseUp

Inherited from: IgrSeriesViewer

get axisPanelMouseUp(): object

Returns object

set axisPanelMouseUp(ev: object): void

Parameters

ev: object

Returns void

bottomMargin

Inherited from: IgrSeriesViewer

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

brushes

Inherited from: IgrSeriesViewer

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

chartTitle

Inherited from: IgrSeriesViewer

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

computedPlotAreaMarginMode

Gets or sets mode to use for automatically calculating the plot area margin.

get computedPlotAreaMarginMode(): ComputedPlotAreaMarginMode

Returns ComputedPlotAreaMarginMode

set computedPlotAreaMarginMode(v: ComputedPlotAreaMarginMode): void

Parameters

v: ComputedPlotAreaMarginMode

Returns void

contentHitTestMode

Inherited from: IgrSeriesViewer

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

v: ChartHitTestMode

Returns void

contentViewport

Inherited from: IgrSeriesViewer

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

crosshairPoint

Inherited from: IgrSeriesViewer

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

crosshairVisibility

Inherited from: IgrSeriesViewer

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

dataSource

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

defaultAxisMajorStroke

Gets or sets the DefaultAxisMajorStroke property. The DefaultAxisMajorStroke property defines the brush which is used by the axes when no Axis.MajorStroke is set.

get defaultAxisMajorStroke(): string

Returns string

set defaultAxisMajorStroke(v: string): void

Parameters

v: string

Returns void

defaultAxisMinorStroke

Gets or sets the DefaultAxisMinorStroke property. The DefaultAxisMinorStroke property defines the brush which is used by the axes when no Axis.MinorStroke is set.

get defaultAxisMinorStroke(): string

Returns string

set defaultAxisMinorStroke(v: string): void

Parameters

v: string

Returns void

defaultAxisStroke

Gets or sets the DefaultAxisStroke property. The DefaultAxisStroke property defines the brush which is used by the axes when no Axis.Stroke is set.

get defaultAxisStroke(): string

Returns string

set defaultAxisStroke(v: string): void

Parameters

v: string

Returns void

defaultInteraction

Inherited from: IgrSeriesViewer

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

dragModifier

Inherited from: IgrSeriesViewer

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

effectiveViewport

Inherited from: IgrSeriesViewer

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

fireMouseLeaveOnManipulationStart

Inherited from: IgrSeriesViewer

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

focusBrush

Inherited from: IgrSeriesViewer

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

focusDismissDelayMilliseconds

Inherited from: IgrSeriesViewer

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

focusedSeriesItems

Inherited from: IgrSeriesViewer

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

v: IgrChartSelectedItemCollection

Returns void

focusedSeriesItemsChanged

Inherited from: IgrSeriesViewer

Raised when the SelectedItems collection has changed.

get focusedSeriesItemsChanged(): object

Returns object

set focusedSeriesItemsChanged(ev: object): void

Parameters

ev: object

Returns void

focusMode

Inherited from: IgrSeriesViewer

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

v: SeriesSelectionMode

Returns void

focusTransitionDuration

Inherited from: IgrSeriesViewer

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

fullAxes

get fullAxes(): IgrAxisCollection

Returns IgrAxisCollection

set fullAxes(v: IgrAxisCollection): void

Parameters

v: IgrAxisCollection

Returns void

fullSeries

Inherited from: IgrSeriesViewer

get fullSeries(): IgrSeriesCollection

Returns IgrSeriesCollection

set fullSeries(v: IgrSeriesCollection): void

Parameters

v: IgrSeriesCollection

Returns void

gridAreaRectChanged

Inherited from: IgrSeriesViewer

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

gridMode

Gets or sets how grid lines are rendered in relation to series.

Try setting the GridMode property to bring your grid lines in front of the data series.

get gridMode(): GridMode

Returns GridMode

set gridMode(v: GridMode): void

Parameters

v: GridMode

Returns void

height

get height(): string

Returns string

set height(value: string): void

Parameters

value: string

Returns void

highlightedDataSource

get highlightedDataSource(): any

Returns any

set highlightedDataSource(value: any): void

Parameters

value: any

Returns void

highlightedValuesDisplayMode

Inherited from: IgrSeriesViewer

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

highlightingBehavior

Inherited from: IgrSeriesViewer

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

v: SeriesHighlightingBehavior

Returns void

highlightingDismissDelayMilliseconds

Inherited from: IgrSeriesViewer

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

highlightingFadeOpacity

Inherited from: IgrSeriesViewer

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

highlightingMode

Inherited from: IgrSeriesViewer

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

v: SeriesHighlightingMode

Returns void

highlightingTransitionDuration

Inherited from: IgrSeriesViewer

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

horizontalCrosshairBrush

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarFill

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarHeight

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarInset

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarMaxOpacity

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarMode

Inherited from: IgrSeriesViewer

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

get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode

set horizontalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

v: SeriesViewerScrollbarMode

Returns void

horizontalViewScrollbarOutline

Inherited from: IgrSeriesViewer

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

horizontalViewScrollbarPosition

Inherited from: IgrSeriesViewer

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

v: SeriesViewerHorizontalScrollbarPosition

Returns void

horizontalViewScrollbarShouldAddAutoTrackInsets

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

imageCaptured

Inherited from: IgrSeriesViewer

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

interactionOverride

Inherited from: IgrSeriesViewer

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

interactionPixelScalingRatio

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

get isAntiAliasingEnabledDuringInteraction(): boolean

Returns boolean

set isAntiAliasingEnabledDuringInteraction(v: boolean): void

Parameters

v: boolean

Returns void

isDetached

Inherited from: IgrSeriesViewer

get isDetached(): boolean

Returns boolean

isHorizontalZoomEnabled

Gets or sets horizontal zoomability of the current control

Set IsHorizontalZoomEnabled to enable or disable horizontal zooming.

get isHorizontalZoomEnabled(): boolean

Returns boolean

set isHorizontalZoomEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isInCreateAnnotationMode

Inherited from: IgrSeriesViewer

get isInCreateAnnotationMode(): boolean

Returns boolean

isInDeleteAnnotationMode

Inherited from: IgrSeriesViewer

get isInDeleteAnnotationMode(): boolean

Returns boolean

isMap

Inherited from: IgrSeriesViewer

Indicates if this SeriesViewer is a map.

get isMap(): boolean

Returns boolean

isPagePanningAllowed

Inherited from: IgrSeriesViewer

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

isSquare

Gets or sets whether to use a square aspect ratio for the chart. This is locked to true for polar and radial charts.

Set IsSquare to true to constrain the chart to a square, using the minimum of its height and width.

get isSquare(): boolean

Returns boolean

set isSquare(v: boolean): void

Parameters

v: boolean

Returns void

isSurfaceInteractionDisabled

Inherited from: IgrSeriesViewer

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

isUserAnnotationsEnabled

Inherited from: IgrSeriesViewer

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

isVerticalZoomEnabled

Gets or sets vertical zoomability of the current control

Set IsVerticalZoomEnabled to enable or disable vertical zooming.

get isVerticalZoomEnabled(): boolean

Returns boolean

set isVerticalZoomEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isWindowSyncedToVisibleRange

Inherited from: IgrSeriesViewer

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

leftMargin

Inherited from: IgrSeriesViewer

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

legend

Gets or sets the legend used for the current chart.

get legend(): any

Returns any

set legend(v: any): void

Parameters

v: any

Returns void

legendHighlightingMode

Inherited from: IgrSeriesViewer

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

v: LegendHighlightingMode

Returns void

legendItemBadgeMode

Inherited from: IgrSeriesViewer

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

legendItemBadgeShape

Inherited from: IgrSeriesViewer

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

markerAutomaticBehavior

Inherited from: IgrSeriesViewer

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

v: MarkerAutomaticBehavior

Returns void

markerBrushes

Inherited from: IgrSeriesViewer

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

markerOutlines

Inherited from: IgrSeriesViewer

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

nativeElement

Inherited from: IgrSeriesViewer

get nativeElement(): HTMLElement

Returns HTMLElement

outlines

Inherited from: IgrSeriesViewer

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

panModifier

Inherited from: IgrSeriesViewer

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

pixelScalingRatio

Inherited from: IgrSeriesViewer

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

plotAreaBackground

Inherited from: IgrSeriesViewer

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

plotAreaClicked

Inherited from: IgrSeriesViewer

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

plotAreaMarginBottom

Margin applied below the plot area.

get plotAreaMarginBottom(): number

Returns number

set plotAreaMarginBottom(v: number): void

Parameters

v: number

Returns void

plotAreaMarginLeft

Margin applied to the left of the plot area.

get plotAreaMarginLeft(): number

Returns number

set plotAreaMarginLeft(v: number): void

Parameters

v: number

Returns void

plotAreaMarginRight

Margin applied to the right of the plot area.

get plotAreaMarginRight(): number

Returns number

set plotAreaMarginRight(v: number): void

Parameters

v: number

Returns void

plotAreaMarginTop

Margin applied above the plot area.

get plotAreaMarginTop(): number

Returns number

set plotAreaMarginTop(v: number): void

Parameters

v: number

Returns void

plotAreaMouseEnter

Inherited from: IgrSeriesViewer

Occurs when the pointer enters the plot area.

get plotAreaMouseEnter(): object

Returns object

set plotAreaMouseEnter(ev: object): void

Parameters

ev: object

Returns void

plotAreaMouseLeave

Inherited from: IgrSeriesViewer

Occurs when the pointer exits the plot area.

get plotAreaMouseLeave(): object

Returns object

set plotAreaMouseLeave(ev: object): void

Parameters

ev: object

Returns void

plotAreaMouseLeftButtonDown

Inherited from: IgrSeriesViewer

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

plotAreaMouseLeftButtonUp

Inherited from: IgrSeriesViewer

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

plotAreaMouseOver

Inherited from: IgrSeriesViewer

Occurs when the pointer if over the plot area.

get plotAreaMouseOver(): object

Returns object

set plotAreaMouseOver(ev: object): void

Parameters

ev: object

Returns void

preferHigherResolutionTiles

Inherited from: IgrSeriesViewer

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

previewPathFill

Inherited from: IgrSeriesViewer

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

previewPathOpacity

Inherited from: IgrSeriesViewer

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

previewPathStroke

Inherited from: IgrSeriesViewer

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

previewRect

Inherited from: IgrSeriesViewer

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

refreshCompleted

Inherited from: IgrSeriesViewer

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

resizeIdle

Inherited from: IgrSeriesViewer

get resizeIdle(): object

Returns object

set resizeIdle(ev: object): void

Parameters

ev: object

Returns void

resizeIdleMilliseconds

Inherited from: IgrSeriesViewer

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

rightButtonDefaultInteraction

Inherited from: IgrSeriesViewer

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

rightMargin

Inherited from: IgrSeriesViewer

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

scrollbarsAnimationDuration

Inherited from: IgrSeriesViewer

Gets or sets the duration of the scrollbar effects.

get scrollbarsAnimationDuration(): number

Returns number

set scrollbarsAnimationDuration(v: number): void

Parameters

v: number

Returns void

selectedSeriesItems

Inherited from: IgrSeriesViewer

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

v: IgrChartSelectedItemCollection

Returns void

selectedSeriesItemsChanged

Inherited from: IgrSeriesViewer

Raised when the SelectedItems collection has changed.

get selectedSeriesItemsChanged(): object

Returns object

set selectedSeriesItemsChanged(ev: object): void

Parameters

ev: object

Returns void

selectionBehavior

Inherited from: IgrSeriesViewer

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

v: SeriesSelectionBehavior

Returns void

selectionBrush

Inherited from: IgrSeriesViewer

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

selectionDismissDelayMilliseconds

Inherited from: IgrSeriesViewer

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

selectionMode

Inherited from: IgrSeriesViewer

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

v: SeriesSelectionMode

Returns void

selectionModifier

Inherited from: IgrSeriesViewer

Gets or sets the current SeriesViewer's SelectionModifier property.

get selectionModifier(): ModifierKeys

Returns ModifierKeys

set selectionModifier(v: ModifierKeys): void

Parameters

v: ModifierKeys

Returns void

selectionTransitionDuration

Inherited from: IgrSeriesViewer

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

series

A collection or manually added series for the chart.

get series(): IgrSeriesCollection

Returns IgrSeriesCollection

seriesClick

Inherited from: IgrSeriesViewer

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

seriesCursorMouseMove

Inherited from: IgrSeriesViewer

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

seriesMouseEnter

Inherited from: IgrSeriesViewer

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

seriesMouseLeave

Inherited from: IgrSeriesViewer

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

seriesMouseLeftButtonDown

Inherited from: IgrSeriesViewer

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

seriesMouseLeftButtonUp

Inherited from: IgrSeriesViewer

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

get seriesMouseLeftButtonUp(): object

Returns object

set seriesMouseLeftButtonUp(ev: object): void

Parameters

ev: object

Returns void

seriesMouseMove

Inherited from: IgrSeriesViewer

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

get seriesMouseMove(): object

Returns object

set seriesMouseMove(ev: object): void

Parameters

ev: object

Returns void

seriesPlotAreaMarginHorizontalMode

Gets or sets horizontal mode to use for automatically calculating the plot area margin based ont the series.

get seriesPlotAreaMarginHorizontalMode(): SeriesPlotAreaMarginHorizontalMode

Returns SeriesPlotAreaMarginHorizontalMode

set seriesPlotAreaMarginHorizontalMode(v: SeriesPlotAreaMarginHorizontalMode): void

Parameters

v: SeriesPlotAreaMarginHorizontalMode

Returns void

seriesPlotAreaMarginVerticalMode

Gets or sets vertical mode to use for automatically calculating the plot area margin based ont the series.

get seriesPlotAreaMarginVerticalMode(): SeriesPlotAreaMarginVerticalMode

Returns SeriesPlotAreaMarginVerticalMode

set seriesPlotAreaMarginVerticalMode(v: SeriesPlotAreaMarginVerticalMode): void

Parameters

v: SeriesPlotAreaMarginVerticalMode

Returns void

seriesValueLayerUseLegend

Inherited from: IgrSeriesViewer

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

shouldAutoExpandMarginForInitialLabels

Gets or sets a whether the series viewer should auto expand margins to accomodate the initial horizontal axis labels.

get shouldAutoExpandMarginForInitialLabels(): boolean

Returns boolean

set shouldAutoExpandMarginForInitialLabels(v: boolean): void

Parameters

v: boolean

Returns void

shouldConsiderAutoRotationForInitialLabels

Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true.

get shouldConsiderAutoRotationForInitialLabels(): boolean

Returns boolean

set shouldConsiderAutoRotationForInitialLabels(v: boolean): void

Parameters

v: boolean

Returns void

shouldMatchZOrderToSeriesOrder

Inherited from: IgrSeriesViewer

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

shouldPanOnMaximumZoom

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

shouldSuppressAxisLabelTruncation

Gets or sets a whether the series viewer should suppress truncation of axis labels.

get shouldSuppressAxisLabelTruncation(): boolean

Returns boolean

set shouldSuppressAxisLabelTruncation(v: boolean): void

Parameters

v: boolean

Returns void

sizeChanged

Inherited from: IgrSeriesViewer

Occurs after the size of the series viewer changes.

<-- position: content member-->

get sizeChanged(): object

Returns object

set sizeChanged(ev: object): void

Parameters

ev: object

Returns void

subtitle

Inherited from: IgrSeriesViewer

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

subtitleBottomMargin

Inherited from: IgrSeriesViewer

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

subtitleHorizontalAlignment

Inherited from: IgrSeriesViewer

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

subtitleLeftMargin

Inherited from: IgrSeriesViewer

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

subtitleRightMargin

Inherited from: IgrSeriesViewer

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

subtitleTextColor

Inherited from: IgrSeriesViewer

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

subtitleTextStyle

Inherited from: IgrSeriesViewer

Font settings for the subtitle.

get subtitleTextStyle(): string

Returns string

set subtitleTextStyle(v: string): void

Parameters

v: string

Returns void

subtitleTopMargin

Inherited from: IgrSeriesViewer

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

suppressAutoMarginAndAngleRecalculation

Gets or sets a whether the series viewer should suppress auto recalculating margin and axis label angles.

get suppressAutoMarginAndAngleRecalculation(): boolean

Returns boolean

set suppressAutoMarginAndAngleRecalculation(v: boolean): void

Parameters

v: boolean

Returns void

syncChannel

Gets or sets the channel with which to synchronize.

Synchronization is the coordination of zooming, panning and crosshairs events between multiple charts. Multiple chart controls can be synchronized horizontally (along X-Axis), vertically (along Y-Axis), or both. If you want to synchronize a set of charts, assign them the same name to the syncChannel and then specify whether or not synchronize chart horizontally and/or vertically.

get syncChannel(): string

Returns string

set syncChannel(v: string): void

Parameters

v: string

Returns void

synchronizeHorizontally

Gets or sets the bool used to display the window preview shadow.

get synchronizeHorizontally(): boolean

Returns boolean

set synchronizeHorizontally(v: boolean): void

Parameters

v: boolean

Returns void

synchronizeVertically

Gets or sets the bool used to display the window preview shadow.

get synchronizeVertically(): boolean

Returns boolean

set synchronizeVertically(v: boolean): void

Parameters

v: boolean

Returns void

titleBottomMargin

Inherited from: IgrSeriesViewer

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

titleHorizontalAlignment

Inherited from: IgrSeriesViewer

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

titleLeftMargin

Inherited from: IgrSeriesViewer

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

titleRightMargin

Inherited from: IgrSeriesViewer

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

titleTextColor

Inherited from: IgrSeriesViewer

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

titleTextStyle

Inherited from: IgrSeriesViewer

Font settings for the title.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

v: string

Returns void

titleTopMargin

Inherited from: IgrSeriesViewer

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

topMargin

Inherited from: IgrSeriesViewer

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

userAnnotationInformationRequested

Inherited from: IgrSeriesViewer

get userAnnotationInformationRequested(): object

Returns object

set userAnnotationInformationRequested(ev: object): void

Parameters

ev: object

Returns void

userAnnotationToolTipContentUpdating

Inherited from: IgrSeriesViewer

get userAnnotationToolTipContentUpdating(): object

Returns object

set userAnnotationToolTipContentUpdating(ev: object): void

Parameters

ev: object

Returns void

useTiledZooming

Inherited from: IgrSeriesViewer

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

verticalCrosshairBrush

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarCornerRadius

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarFill

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarInset

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarMaxOpacity

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarMode

Inherited from: IgrSeriesViewer

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

get verticalViewScrollbarMode(): SeriesViewerScrollbarMode

Returns SeriesViewerScrollbarMode

set verticalViewScrollbarMode(v: SeriesViewerScrollbarMode): void

Parameters

v: SeriesViewerScrollbarMode

Returns void

verticalViewScrollbarOutline

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarPosition

Inherited from: IgrSeriesViewer

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

v: SeriesViewerVerticalScrollbarPosition

Returns void

verticalViewScrollbarShouldAddAutoTrackInsets

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarTrackEndInset

Inherited from: IgrSeriesViewer

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

Inherited from: IgrSeriesViewer

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

verticalViewScrollbarWidth

Inherited from: IgrSeriesViewer

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

viewerManipulationEnding

Inherited from: IgrSeriesViewer

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

viewerManipulationStarting

Inherited from: IgrSeriesViewer

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

viewportRect

Inherited from: IgrSeriesViewer

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

get viewportRect(): IgRect

Returns IgRect

width

get width(): string

Returns string

set width(value: string): void

Parameters

value: string

Returns void

windowPositionHorizontal

Inherited from: IgrSeriesViewer

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

windowPositionVertical

Inherited from: IgrSeriesViewer

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

windowRect

Inherited from: IgrSeriesViewer

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

windowRectChanged

Inherited from: IgrSeriesViewer

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

<-- position: content member-->

get windowRectChanged(): object

Returns object

set windowRectChanged(ev: object): void

Parameters

ev: object

Returns void

windowRectMinHeight

Inherited from: IgrSeriesViewer

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

windowRectMinWidth

Inherited from: IgrSeriesViewer

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

windowResponse

Inherited from: IgrSeriesViewer

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

v: WindowResponse

Returns void

windowScaleHorizontal

A number between 0 and 1 determining the scale of the horizontal zoom. This property is effectively a shortcut to the Width of the WindowRect property.

To programmatically change the horizontal zoom level, set WindowScaleHorizontal to a value between 0 and 1.

get windowScaleHorizontal(): number

Returns number

set windowScaleHorizontal(v: number): void

Parameters

v: number

Returns void

windowScaleVertical

A number between 0 and 1 determining the scale of the vertical zoom. This property is effectively a shortcut to the Height of the WindowRect property.

To programmatically change the vertical zoom level, set WindowScaleVertical to a value between 0 and 1.

get windowScaleVertical(): number

Returns number

set windowScaleVertical(v: number): void

Parameters

v: number

Returns void

windowSizeMinHeight

Inherited from: IgrSeriesViewer

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

windowSizeMinWidth

Inherited from: IgrSeriesViewer

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

zoomCoercionMode

Inherited from: IgrSeriesViewer

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

v: ZoomCoercionMode

Returns void

zoomTileCacheSize

Inherited from: IgrSeriesViewer

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

Methods

addCommandAvailabilityListener

Inherited from: IgrSeriesViewer

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

Inherited from: IgrSeriesViewer

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

attachSeries

Inherited from: IgrSeriesViewer

Attaches the given series to the chart.

attachSeries(s: IgrSeries): void

Parameters

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

Returns void

bindData

bindData(): void

Returns void

bindHighlightedData

bindHighlightedData(): void

Returns void

cancelAnnotationFlow

Inherited from: IgrSeriesViewer

cancelAnnotationFlow(annotationFlowID: string): void

Parameters

annotationFlowID: string

Returns void

cancelCreatingAnnotation

Inherited from: IgrSeriesViewer

cancelCreatingAnnotation(): void

Returns void

cancelDeletingAnnotation

Inherited from: IgrSeriesViewer

cancelDeletingAnnotation(): void

Returns void

cancelManipulation

Inherited from: IgrSeriesViewer

cancelManipulation(): void

Returns void

captureImage

Inherited from: IgrSeriesViewer

captureImage(settings: IgrCaptureImageSettings): void

Parameters

settings: IgrCaptureImageSettings

Returns void

clearTileZoomCache

Inherited from: IgrSeriesViewer

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

componentDidMount(): void

Returns void

componentWillUnmount

componentWillUnmount(): void

Returns void

destroy

Release any resources held by the control.

destroy(): void

Returns void

endTiledZoomingIfRunning

Inherited from: IgrSeriesViewer

Manually ends a tiled zoom if one is running.

endTiledZoomingIfRunning(): void

Returns void

exportSerializedVisualData

Export serialized visual data.

exportSerializedVisualData(): string

Returns string

findByName

findByName(name: string): any

Parameters

name: string

Returns any

finishAnnotationFlow

Inherited from: IgrSeriesViewer

finishAnnotationFlow(info: IgrUserAnnotationInformation): void

Parameters

info: IgrUserAnnotationInformation

Returns void

finishCreatingAnnotation

Inherited from: IgrSeriesViewer

finishCreatingAnnotation(): void

Returns void

finishDeletingAnnotation

Inherited from: IgrSeriesViewer

finishDeletingAnnotation(): void

Returns void

flush

Inherited from: IgrSeriesViewer

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

getActualWindowScaleHorizontal

Inherited from: IgrSeriesViewer

Gets actual window scale for horizontal dimension of the control

getActualWindowScaleHorizontal(): number

Returns number

getActualWindowScaleVertical

Inherited from: IgrSeriesViewer

Gets actual window scale for vertical dimension of the control

getActualWindowScaleVertical(): number

Returns number

getAnimationIdleVersionNumber

Inherited from: IgrSeriesViewer

getAnimationIdleVersionNumber(): number

Returns number

getCurrentActualWindowRect

Inherited from: IgrSeriesViewer

getCurrentActualWindowRect(): IgRect

Returns IgRect

getDesiredToolbarActions

Inherited from: IgrSeriesViewer

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

hideToolTip

Inherited from: IgrSeriesViewer

Hides the active main tooltip, if displayed.

hideToolTip(): void

Returns void

initializeContent

initializeContent(): void

Returns void

isAnimationActive

Inherited from: IgrSeriesViewer

isAnimationActive(): boolean

Returns boolean

loadAnnotationsFromJson

Inherited from: IgrSeriesViewer

loadAnnotationsFromJson(jsonString: string): void

Parameters

jsonString: string

Returns void

notifyClearItems

Inherited from: IgrSeriesViewer

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

notifyContainerResized

Inherited from: IgrSeriesViewer

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

notifyContainerResized(): void

Returns void

notifyInsertItem

Inherited from: IgrSeriesViewer

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

Parameters

source_: any
index: number
newItem: any

Returns void

notifyRemoveItem

Inherited from: IgrSeriesViewer

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

Parameters

source_: any
index: number
oldItem: any

Returns void

notifySeriesDataChanged

Inherited from: IgrSeriesViewer

notifySeriesDataChanged(): void

Returns void

notifySetItem

Inherited from: IgrSeriesViewer

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

Parameters

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

Returns void

queueForAnimationIdle

Inherited from: IgrSeriesViewer

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

Parameters

action: object
version: number

Returns void

recalculateAutoLabelsAngle

recalculateAutoLabelsAngle(): void

Returns void

recalculateMarginAutoExpansion

recalculateMarginAutoExpansion(): void

Returns void

refreshComputedPlotAreaMargin

refreshComputedPlotAreaMargin(): void

Returns void

removeCommandAvailabilityListener

Inherited from: IgrSeriesViewer

removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener

Inherited from: IgrSeriesViewer

removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

render

render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

renderToImage

Inherited from: IgrSeriesViewer

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

Parameters

width: number
height: number

Returns any

resetAnnotations

Inherited from: IgrSeriesViewer

resetAnnotations(): void

Returns void

resetZoom

Inherited from: IgrSeriesViewer

Resets the zoom level to default.

resetZoom(): void

Returns void

saveAnnotationsToJson

Inherited from: IgrSeriesViewer

saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate

Inherited from: IgrSeriesViewer

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateClick

Inherited from: IgrSeriesViewer

simulateClick(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulateHover

Inherited from: IgrSeriesViewer

simulateHover(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulateMouseLeave

Inherited from: IgrSeriesViewer

simulateMouseLeave(): void

Returns void

simulatePlotPointerUp

Inherited from: IgrSeriesViewer

simulatePlotPointerUp(point: IgPoint): void

Parameters

point: IgPoint

Returns void

simulatePressAndHold

Inherited from: IgrSeriesViewer

simulatePressAndHold(point: IgPoint): void

Parameters

point: IgPoint

Returns void

startCreatingAnnotation

Inherited from: IgrSeriesViewer

startCreatingAnnotation(): void

Returns void

startDeletingAnnotation

Inherited from: IgrSeriesViewer

startDeletingAnnotation(): void

Returns void

startTiledZoomingIfNecessary

Inherited from: IgrSeriesViewer

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

startTiledZoomingIfNecessary(): void

Returns void

styleUpdated

Notifies the chart that the CSS styles in effect have been updated.

styleUpdated(): void

Returns void

zoomIn

Inherited from: IgrSeriesViewer

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

zoomIn(percentage: number): void

Parameters

percentage: number

Returns void

zoomOut

Inherited from: IgrSeriesViewer

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

zoomOut(percentage: number): void

Parameters

percentage: number

Returns void

_createFromInternal

Inherited from: IgrSeriesViewer

_createFromInternal(internal: any): IgrSeriesViewer

Parameters

internal: any