IIgrSeriesViewerProps

Optional actualContentHitTestMode

Section titled "actualContentHitTestMode"

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

``

actualContentHitTestMode?: string | ChartHitTestMode

Optional actualInteractionPixelScalingRatio

Section titled "actualInteractionPixelScalingRatio"

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

``

actualInteractionPixelScalingRatio?: string | number

Optional actualPixelScalingRatio

Section titled "actualPixelScalingRatio"

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

``

actualPixelScalingRatio?: string | number

Optional actualWindowPositionHorizontal

Section titled "actualWindowPositionHorizontal"

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.

``

actualWindowPositionHorizontal?: string | number

Optional actualWindowPositionVertical

Section titled "actualWindowPositionVertical"

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.

``

actualWindowPositionVertical?: string | number

Optional actualWindowRect

Section titled "actualWindowRect"

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

actualWindowRect?: any

Optional actualWindowRectChanged

Section titled "actualWindowRectChanged"

Raised when the actual window rectangle of the SeriesViewer changes.

actualWindowRectChanged?: object

Optional actualWindowRectMinHeight

Section titled "actualWindowRectMinHeight"

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

actualWindowRectMinHeight?: string | number

Optional actualWindowRectMinWidth

Section titled "actualWindowRectMinWidth"

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

actualWindowRectMinWidth?: string | number

Optional animateSeriesWhenAxisRangeChanges

Section titled "animateSeriesWhenAxisRangeChanges"

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.

``

``

animateSeriesWhenAxisRangeChanges?: string | boolean

Optional autoMarginHeight

Section titled "autoMarginHeight"

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

``

``

autoMarginHeight?: string | number

Optional autoMarginWidth

Section titled "autoMarginWidth"

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.

``

``

autoMarginWidth?: string | number

Optional axisLabelMouseClick

Section titled "axisLabelMouseClick"
axisLabelMouseClick?: object

Optional axisLabelMouseDown

Section titled "axisLabelMouseDown"
axisLabelMouseDown?: object

Optional axisLabelMouseEnter

Section titled "axisLabelMouseEnter"
axisLabelMouseEnter?: object

Optional axisLabelMouseLeave

Section titled "axisLabelMouseLeave"
axisLabelMouseLeave?: object

Optional axisLabelMouseOver

Section titled "axisLabelMouseOver"
axisLabelMouseOver?: object

Optional axisLabelMouseUp

Section titled "axisLabelMouseUp"
axisLabelMouseUp?: object

Optional axisPanelMouseClick

Section titled "axisPanelMouseClick"
axisPanelMouseClick?: object

Optional axisPanelMouseDown

Section titled "axisPanelMouseDown"
axisPanelMouseDown?: object

Optional axisPanelMouseEnter

Section titled "axisPanelMouseEnter"
axisPanelMouseEnter?: object

Optional axisPanelMouseLeave

Section titled "axisPanelMouseLeave"
axisPanelMouseLeave?: object

Optional axisPanelMouseOver

Section titled "axisPanelMouseOver"
axisPanelMouseOver?: object

Optional axisPanelMouseUp

Section titled "axisPanelMouseUp"
axisPanelMouseUp?: object

Optional bottomMargin

Section titled "bottomMargin"

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.

``

``

bottomMargin?: string | number

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.

brushes?: string | string[]

Optional chartTitle

Section titled "chartTitle"

Text to display above the plot area.

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

``

``

chartTitle?: string

Optional children

Section titled "children"
children?: ReactNode

Optional contentHitTestMode

Section titled "contentHitTestMode"

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

``

contentHitTestMode?: string | ChartHitTestMode

Optional crosshairPoint

Section titled "crosshairPoint"

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

``

``

crosshairPoint?: any

Optional crosshairVisibility

Section titled "crosshairVisibility"

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.

``

``

crosshairVisibility?: any

Optional defaultInteraction

Section titled "defaultInteraction"

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.

``

``

defaultInteraction?: any

Optional dragModifier

Section titled "dragModifier"

Gets or sets the current SeriesViewer's DragModifier property.

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

``

``

dragModifier?: any

Optional effectiveViewport

Section titled "effectiveViewport"

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

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

effectiveViewport?: any

Optional fireMouseLeaveOnManipulationStart

Section titled "fireMouseLeaveOnManipulationStart"

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

fireMouseLeaveOnManipulationStart?: string | boolean

Optional focusBrush

Section titled "focusBrush"

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

focusBrush?: string

Optional focusDismissDelayMilliseconds

Section titled "focusDismissDelayMilliseconds"

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

focusDismissDelayMilliseconds?: string | number

Optional focusedSeriesItems

Section titled "focusedSeriesItems"

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

focusedSeriesItems?: string | IgrChartSelectedItemCollection

Optional focusedSeriesItemsChanged

Section titled "focusedSeriesItemsChanged"

Raised when the SelectedItems collection has changed.

focusedSeriesItemsChanged?: object

Optional focusMode

Section titled "focusMode"

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

focusMode?: string | SeriesSelectionMode

Optional focusTransitionDuration

Section titled "focusTransitionDuration"

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

focusTransitionDuration?: string | number

Optional gridAreaRectChanged

Section titled "gridAreaRectChanged"

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.

gridAreaRectChanged?: object

Optional highlightedValuesDisplayMode

Section titled "highlightedValuesDisplayMode"

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.

highlightedValuesDisplayMode?: any

Optional highlightingBehavior

Section titled "highlightingBehavior"

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

highlightingBehavior?: string | SeriesHighlightingBehavior

Optional highlightingDismissDelayMilliseconds

Section titled "highlightingDismissDelayMilliseconds"

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

highlightingDismissDelayMilliseconds?: string | number

Optional highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

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

highlightingFadeOpacity?: string | number

Optional highlightingMode

Section titled "highlightingMode"

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

highlightingMode?: string | SeriesHighlightingMode

Optional highlightingTransitionDuration

Section titled "highlightingTransitionDuration"

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

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

``

``

highlightingTransitionDuration?: string | number

Optional horizontalCrosshairBrush

Section titled "horizontalCrosshairBrush"

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

horizontalCrosshairBrush?: string

Optional horizontalViewScrollbarCornerRadius

Section titled "horizontalViewScrollbarCornerRadius"

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

horizontalViewScrollbarCornerRadius?: string | number

Optional horizontalViewScrollbarFill

Section titled "horizontalViewScrollbarFill"

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

horizontalViewScrollbarFill?: string

Optional horizontalViewScrollbarHeight

Section titled "horizontalViewScrollbarHeight"

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

horizontalViewScrollbarHeight?: string | number

Optional horizontalViewScrollbarInset

Section titled "horizontalViewScrollbarInset"

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

horizontalViewScrollbarInset?: string | number

Optional horizontalViewScrollbarMaxOpacity

Section titled "horizontalViewScrollbarMaxOpacity"

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

horizontalViewScrollbarMaxOpacity?: string | number

Optional horizontalViewScrollbarMode

Section titled "horizontalViewScrollbarMode"

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

horizontalViewScrollbarMode?: string | SeriesViewerScrollbarMode

Optional horizontalViewScrollbarOutline

Section titled "horizontalViewScrollbarOutline"

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

horizontalViewScrollbarOutline?: string

Optional horizontalViewScrollbarPosition

Section titled "horizontalViewScrollbarPosition"

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

horizontalViewScrollbarPosition?: string | SeriesViewerHorizontalScrollbarPosition

Optional horizontalViewScrollbarShouldAddAutoTrackInsets

Section titled "horizontalViewScrollbarShouldAddAutoTrackInsets"

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

horizontalViewScrollbarShouldAddAutoTrackInsets?: string | boolean

Optional horizontalViewScrollbarStrokeThickness

Section titled "horizontalViewScrollbarStrokeThickness"

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

horizontalViewScrollbarStrokeThickness?: string | number

Optional horizontalViewScrollbarTrackEndInset

Section titled "horizontalViewScrollbarTrackEndInset"

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

horizontalViewScrollbarTrackEndInset?: string | number

Optional horizontalViewScrollbarTrackStartInset

Section titled "horizontalViewScrollbarTrackStartInset"

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

horizontalViewScrollbarTrackStartInset?: string | number

Optional imageCaptured

Section titled "imageCaptured"

Event raised when an image of the component is saved

imageCaptured?: object

Optional interactionOverride

Section titled "interactionOverride"

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.

interactionOverride?: any

Optional interactionPixelScalingRatio

Section titled "interactionPixelScalingRatio"

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

interactionPixelScalingRatio?: string | number

Optional isAntiAliasingEnabledDuringInteraction

Section titled "isAntiAliasingEnabledDuringInteraction"

Gets or sets the IsAntiAliasingEnabledDuringInteraction property.

isAntiAliasingEnabledDuringInteraction?: string | boolean

Optional isPagePanningAllowed

Section titled "isPagePanningAllowed"

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.

isPagePanningAllowed?: string | boolean

Optional isSurfaceInteractionDisabled

Section titled "isSurfaceInteractionDisabled"

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.

``

``

isSurfaceInteractionDisabled?: string | boolean

Optional isUserAnnotationsEnabled

Section titled "isUserAnnotationsEnabled"

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

isUserAnnotationsEnabled?: string | boolean

Optional isWindowSyncedToVisibleRange

Section titled "isWindowSyncedToVisibleRange"

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.

isWindowSyncedToVisibleRange?: string | boolean

Optional leftMargin

Section titled "leftMargin"

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

The LeftMargin property is used to set the left margin.

``

``

leftMargin?: string | number

Optional legendHighlightingMode

Section titled "legendHighlightingMode"

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

legendHighlightingMode?: string | LegendHighlightingMode

Optional legendItemBadgeMode

Section titled "legendItemBadgeMode"

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

legendItemBadgeMode?: any

Optional legendItemBadgeShape

Section titled "legendItemBadgeShape"

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

legendItemBadgeShape?: any

Optional markerAutomaticBehavior

Section titled "markerAutomaticBehavior"

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

markerAutomaticBehavior?: string | MarkerAutomaticBehavior

Optional markerBrushes

Section titled "markerBrushes"

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.

markerBrushes?: string | string[]

Optional markerOutlines

Section titled "markerOutlines"

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.

markerOutlines?: string | string[]

Optional outlines

Section titled "outlines"

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.

outlines?: string | string[]

Optional panModifier

Section titled "panModifier"

Gets or sets the current SeriesViewer's PanModifier property.

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

``

``

panModifier?: any

Optional pixelScalingRatio

Section titled "pixelScalingRatio"

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.

pixelScalingRatio?: string | number

Optional plotAreaBackground

Section titled "plotAreaBackground"

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.

``

``

plotAreaBackground?: string

Optional plotAreaClicked

Section titled "plotAreaClicked"

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

plotAreaClicked?: object

Optional plotAreaMouseEnter

Section titled "plotAreaMouseEnter"

Occurs when the pointer enters the plot area.

plotAreaMouseEnter?: object

Optional plotAreaMouseLeave

Section titled "plotAreaMouseLeave"

Occurs when the pointer exits the plot area.

plotAreaMouseLeave?: object

Optional plotAreaMouseLeftButtonDown

Section titled "plotAreaMouseLeftButtonDown"

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

plotAreaMouseLeftButtonDown?: object

Optional plotAreaMouseLeftButtonUp

Section titled "plotAreaMouseLeftButtonUp"

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

plotAreaMouseLeftButtonUp?: object

Optional plotAreaMouseOver

Section titled "plotAreaMouseOver"

Occurs when the pointer if over the plot area.

plotAreaMouseOver?: object

Optional preferHigherResolutionTiles

Section titled "preferHigherResolutionTiles"

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.

preferHigherResolutionTiles?: string | boolean

Optional previewPathFill

Section titled "previewPathFill"

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

previewPathFill?: string

Optional previewPathOpacity

Section titled "previewPathOpacity"

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

previewPathOpacity?: string | number

Optional previewPathStroke

Section titled "previewPathStroke"

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

previewPathStroke?: string

Optional previewRect

Section titled "previewRect"

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.

``

previewRect?: any

Optional refreshCompleted

Section titled "refreshCompleted"

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

refreshCompleted?: object

Optional resizeIdle

Section titled "resizeIdle"
resizeIdle?: object

Optional resizeIdleMilliseconds

Section titled "resizeIdleMilliseconds"

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

resizeIdleMilliseconds?: string | number

Optional rightButtonDefaultInteraction

Section titled "rightButtonDefaultInteraction"

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

rightButtonDefaultInteraction?: any

Optional rightMargin

Section titled "rightMargin"

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.

``

``

rightMargin?: string | number

Optional scrollbarsAnimationDuration

Section titled "scrollbarsAnimationDuration"

Gets or sets the duration of the scrollbar effects.

scrollbarsAnimationDuration?: string | number

Optional selectedSeriesItems

Section titled "selectedSeriesItems"

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

selectedSeriesItems?: string | IgrChartSelectedItemCollection

Optional selectedSeriesItemsChanged

Section titled "selectedSeriesItemsChanged"

Raised when the SelectedItems collection has changed.

selectedSeriesItemsChanged?: object

Optional selectionBehavior

Section titled "selectionBehavior"

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

selectionBehavior?: string | SeriesSelectionBehavior

Optional selectionBrush

Section titled "selectionBrush"

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

selectionBrush?: string

Optional selectionDismissDelayMilliseconds

Section titled "selectionDismissDelayMilliseconds"

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

selectionDismissDelayMilliseconds?: string | number

Optional selectionMode

Section titled "selectionMode"

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

selectionMode?: string | SeriesSelectionMode

Optional selectionModifier

Section titled "selectionModifier"

Gets or sets the current SeriesViewer's SelectionModifier property.

selectionModifier?: any

Optional selectionTransitionDuration

Section titled "selectionTransitionDuration"

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

selectionTransitionDuration?: string | number

Optional seriesClick

Section titled "seriesClick"

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

seriesClick?: object

Optional seriesCursorMouseMove

Section titled "seriesCursorMouseMove"

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

seriesCursorMouseMove?: object

Optional seriesMouseEnter

Section titled "seriesMouseEnter"

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

``

``

seriesMouseEnter?: object

Optional seriesMouseLeave

Section titled "seriesMouseLeave"

Occurs when the mouse pointer leaves a Series.

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

``

``

seriesMouseLeave?: object

Optional seriesMouseLeftButtonDown

Section titled "seriesMouseLeftButtonDown"

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

``

``

seriesMouseLeftButtonDown?: object

Optional seriesMouseLeftButtonUp

Section titled "seriesMouseLeftButtonUp"

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

``

``

``

seriesMouseLeftButtonUp?: object

Optional seriesMouseMove

Section titled "seriesMouseMove"

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

``

``

``

seriesMouseMove?: object

Optional seriesValueLayerUseLegend

Section titled "seriesValueLayerUseLegend"

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

seriesValueLayerUseLegend?: string | boolean

Optional shouldMatchZOrderToSeriesOrder

Section titled "shouldMatchZOrderToSeriesOrder"

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

shouldMatchZOrderToSeriesOrder?: string | boolean

Optional shouldPanOnMaximumZoom

Section titled "shouldPanOnMaximumZoom"

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

shouldPanOnMaximumZoom?: string | boolean

Optional shouldSimulateHoverMoveCrosshairPoint

Section titled "shouldSimulateHoverMoveCrosshairPoint"

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

shouldSimulateHoverMoveCrosshairPoint?: string | boolean

Optional sizeChanged

Section titled "sizeChanged"

Occurs after the size of the series viewer changes.

<-- position: content member-->

<-- position: content member-->

``

``

sizeChanged?: object

Optional subtitle

Section titled "subtitle"

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.

``

``

subtitle?: string

Optional subtitleBottomMargin

Section titled "subtitleBottomMargin"

Margin applied below the subtitle.

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

``

``

subtitleBottomMargin?: string | number

Optional subtitleHorizontalAlignment

Section titled "subtitleHorizontalAlignment"

Gets or sets the SubtitleHorizontalAlignment property.

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

``

``

subtitleHorizontalAlignment?: any

Optional subtitleLeftMargin

Section titled "subtitleLeftMargin"

Margin applied to the left of the subtitle.

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

``

``

subtitleLeftMargin?: string | number

Optional subtitleRightMargin

Section titled "subtitleRightMargin"

Margin applied to the right of the subtitle.

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

``

``

subtitleRightMargin?: string | number

Optional subtitleTextColor

Section titled "subtitleTextColor"

Gets or sets the Color used for the Subtitle Text.

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

``

``

subtitleTextColor?: string

Optional subtitleTextStyle

Section titled "subtitleTextStyle"

Font settings for the subtitle.

subtitleTextStyle?: string

Optional subtitleTopMargin

Section titled "subtitleTopMargin"

Margin applied above the subtitle.

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

``

``

subtitleTopMargin?: string | number

Optional titleBottomMargin

Section titled "titleBottomMargin"

Margin applied below the title.

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

``

``

titleBottomMargin?: string | number

Optional titleHorizontalAlignment

Section titled "titleHorizontalAlignment"

Gets or sets the TitleHorizontalAlignment property.

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

``

``

titleHorizontalAlignment?: any

Optional titleLeftMargin

Section titled "titleLeftMargin"

Margin applied to the left of the title.

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

``

``

titleLeftMargin?: string | number

Optional titleRightMargin

Section titled "titleRightMargin"

Margin applied to the right of the title.

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

``

``

titleRightMargin?: string | number

Optional titleTextColor

Section titled "titleTextColor"

Gets or sets the Color used for the Title Text.

The titleTextColor property is used to set the title brush.

``

``

titleTextColor?: string

Optional titleTextStyle

Section titled "titleTextStyle"

Font settings for the title.

titleTextStyle?: string

Optional titleTopMargin

Section titled "titleTopMargin"

Margin applied above the title.

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

``

``

titleTopMargin?: string | number

Optional topMargin

Section titled "topMargin"

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

The topMargin property is used to set the top margin.

``

``

topMargin?: string | number

Optional userAnnotationInformationRequested

Section titled "userAnnotationInformationRequested"
userAnnotationInformationRequested?: object

Optional userAnnotationToolTipContentUpdating

Section titled "userAnnotationToolTipContentUpdating"
userAnnotationToolTipContentUpdating?: object

Optional useTiledZooming

Section titled "useTiledZooming"

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

useTiledZooming?: string | boolean

Optional verticalCrosshairBrush

Section titled "verticalCrosshairBrush"

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

verticalCrosshairBrush?: string

Optional verticalViewScrollbarCornerRadius

Section titled "verticalViewScrollbarCornerRadius"

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

verticalViewScrollbarCornerRadius?: string | number

Optional verticalViewScrollbarFill

Section titled "verticalViewScrollbarFill"

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

verticalViewScrollbarFill?: string

Optional verticalViewScrollbarInset

Section titled "verticalViewScrollbarInset"

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

verticalViewScrollbarInset?: string | number

Optional verticalViewScrollbarMaxOpacity

Section titled "verticalViewScrollbarMaxOpacity"

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

verticalViewScrollbarMaxOpacity?: string | number

Optional verticalViewScrollbarMode

Section titled "verticalViewScrollbarMode"

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

verticalViewScrollbarMode?: string | SeriesViewerScrollbarMode

Optional verticalViewScrollbarOutline

Section titled "verticalViewScrollbarOutline"

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

verticalViewScrollbarOutline?: string

Optional verticalViewScrollbarPosition

Section titled "verticalViewScrollbarPosition"

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

verticalViewScrollbarPosition?: string | SeriesViewerVerticalScrollbarPosition

Optional verticalViewScrollbarShouldAddAutoTrackInsets

Section titled "verticalViewScrollbarShouldAddAutoTrackInsets"

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

verticalViewScrollbarShouldAddAutoTrackInsets?: string | boolean

Optional verticalViewScrollbarStrokeThickness

Section titled "verticalViewScrollbarStrokeThickness"

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

verticalViewScrollbarStrokeThickness?: string | number

Optional verticalViewScrollbarTrackEndInset

Section titled "verticalViewScrollbarTrackEndInset"

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

verticalViewScrollbarTrackEndInset?: string | number

Optional verticalViewScrollbarTrackStartInset

Section titled "verticalViewScrollbarTrackStartInset"

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

verticalViewScrollbarTrackStartInset?: string | number

Optional verticalViewScrollbarWidth

Section titled "verticalViewScrollbarWidth"

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

verticalViewScrollbarWidth?: string | number

Optional viewerManipulationEnding

Section titled "viewerManipulationEnding"

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

viewerManipulationEnding?: object

Optional viewerManipulationStarting

Section titled "viewerManipulationStarting"

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

viewerManipulationStarting?: object

Optional windowPositionHorizontal

Section titled "windowPositionHorizontal"

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.

``

windowPositionHorizontal?: string | number

Optional windowPositionVertical

Section titled "windowPositionVertical"

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.

``

windowPositionVertical?: string | number

Optional windowRect

Section titled "windowRect"

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.

``

windowRect?: any

Optional windowRectChanged

Section titled "windowRectChanged"

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

<-- position: content member-->

<-- position: content member-->

``

``

windowRectChanged?: object

Optional windowRectMinHeight

Section titled "windowRectMinHeight"

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)

windowRectMinHeight?: string | number

Optional windowRectMinWidth

Section titled "windowRectMinWidth"

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.

``

``

windowRectMinWidth?: string | number

Optional windowResponse

Section titled "windowResponse"

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

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

``

``

windowResponse?: string | WindowResponse

Optional windowSizeMinHeight

Section titled "windowSizeMinHeight"

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

windowSizeMinHeight?: string | number

Optional windowSizeMinWidth

Section titled "windowSizeMinWidth"

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

windowSizeMinWidth?: string | number

Optional zoomCoercionMode

Section titled "zoomCoercionMode"

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

zoomCoercionMode?: string | ZoomCoercionMode

Optional zoomTileCacheSize

Section titled "zoomTileCacheSize"

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

zoomTileCacheSize?: string | number