Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IVerticalSliceOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Optional parameters used to configure a RolloverModifier at construct time

Hierarchy

Index

Properties

Properties

Optional allowTooltipOverlapping

allowTooltipOverlapping: boolean

Sets if tooltips for multiple series are allowed to overlap. Default false

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional hitTestRadius

hitTestRadius: number

If this is set greater than the default of zero, the toolip will only show values for points in this radius, rather than all points on the vertical line

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional isDraggable

isDraggable: boolean

Whether the annotation is draggable by the user. Default false

Optional lineSelectionColor

lineSelectionColor: string

If set and isDraggable is true, a selection box of this color will be shown around the line when it is clicked.

Optional modifierGroup

modifierGroup: string

Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts

Optional placementDivId

placementDivId: string

Sets the parent div element id for the Tooltip

Optional rolloverLineStroke

rolloverLineStroke: string

Sets the color of the vertical rollover line as an html color code

Optional rolloverLineStrokeDashArray

rolloverLineStrokeDashArray: number[]

Gets or Sets the dash array of the vertical rollover line

Optional rolloverLineStrokeThickness

rolloverLineStrokeThickness: number

Sets the thickness of the vertical rollover line

Optional showAxisLabel

showAxisLabel: boolean

Sets if the axis label for the rollover Line should be shown. default false. Customize this futher after the modifier has been created by setting properties on rolloverModifer.rolloverLineAnnotation

Optional showRolloverLine

showRolloverLine: boolean

Gets or Sets whether to show the vertical rollover line. Default true

Optional showTooltip

showTooltip: boolean

Sets whether to show the tooltip. Default true

Optional snapToDataPoint

snapToDataPoint: boolean

If True the RolloverModifier line snaps to the nearest data-point of the first visible renderable series

Optional tooltipDataTemplate

tooltipDataTemplate: TRolloverTooltipDataTemplate | string

Sets the tooltipDataTemplate, which allows to customize content for the tooltip

Optional tooltipLegendOffsetX

tooltipLegendOffsetX: number

Sets the legend X offset

Optional tooltipLegendOffsetY

tooltipLegendOffsetY: number

Sets the legend Y offset

Optional tooltipLegendTemplate

tooltipLegendTemplate: TRolloverLegendSvgTemplate | string

Sets the template for the legend

Optional x1

x1: number
description

the X1 coordinate of the modifier

remarks

The X1 coordinate obeys xCoordinateMode which defines whether the X1 coordinate is a pixel, data-value or relative coordinate

Optional xAxisId

xAxisId: string

The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes

Optional xCoordinateMode

xCoordinateMode: ECoordinateMode

The X-Coordinate mode. See ECoordinateMode for a list of values

remarks

Want to display an annotation stretching across the entire width (or height) or the SciChartSurface? The ECoordinateMode enum has options which allow for relative, absolute or pixel coordinates which define annotation placement.

Optional xyDirection

xyDirection: EXyDirection

Defines the Xy Direction - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with RubberBandXyZoomModifier and EXyDirection.XDirection the modifier works on Y axis

Optional yAxisId

yAxisId: string

The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.

Generated using TypeDoc