Creates an instance of a VerticalSliceModifier
Optional parameters used to configure the modifier via IVerticalSliceOptions
Stores info about active pointerdown events
Gets or sets the axis label corner/border radius, in pixels
Gets or sets the axis label padding
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
A unique Id for the IChartModifierBase
The helper property to get and set the list of included renderable series
The helper property to get and set the list of included X axes
The helper property to get and set the list of included Y axes
A callback to invalidate the parent SciChartSurfaceBase
Specifies a string ID to group modifiers.
Gets or sets the snapToDataPoint flag. If True the RolloverModifier line snaps to the nearest data-point of the first visible renderable series
Gets or sets the legend X offset
Gets or sets the legend Y offset
Gets or sets the template for the legend
Direction to which the modifier can be applied
Gets or Sets if tooltips for multiple series are allowed to overlap. Default false
Gets or Sets if tooltips for multiple series are allowed to overlap. Default false
When true, this modifier can receive mouse events
The primary action execute condition that modifier should respond to
The primary action execute condition that modifier should respond to
When true, the modifier is attached to a SciChartSurfaceBase
When true, the modifier is enabled
When true, the modifier is enabled
The type of Chart Modifier, see EModifierType for a list of values
Gets or sets the parent div element reference or id for the Tooltip
Gets or sets the parent div element reference or id for the Tooltip
When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.
When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.
Gets or Sets the color of the vertical rollover line as an html color code
Gets or Sets the color of the vertical rollover line as an html color code
Gets or Sets the dash array of the vertical rollover line
Gets or Sets the dash array of the vertical rollover line
Gets or Sets the thickness of the vertical rollover line
Gets or Sets the thickness of the vertical rollover line
The secondary action execute condition that modifier should respond to
The secondary action execute condition that modifier should respond to
Gets or Sets whether to show the vertical rollover line. Default true
Gets or Sets whether to show the vertical rollover line. Default true
Gets or Sets whether to show the tooltip. Default true
Gets or Sets whether to show the tooltip. Default true
Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip
Gets or Sets the tooltipDataTemplate, which allows you to customize content for the tooltip
Called internally to adjust the positions of tooltips if there are overlaps, or if it is a vertical chart
TTooltipProps[]
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Checks execute condition
Checks execute primary and secondary conditions
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Gets all series on the parent surface.
Returns the list of included X axes
Returns the list of included Y axes
Checks if event conditions should trigger the modifier action
current event info as ModifierMouseArgs
Returns current mouse position
Grows the Axis by a fraction around the mouse point
the X,Y location of the mouse at the time of the operation
the Axis to grow or shrink
the fraction, e.g. 0.1 grows the axis by 10%
Hides all tooltips
Override hitTestRenderableSeries and add a custom logic
Includes all X and Y axes
Includes or excludes X axis
Includes or excludes Y axis
Called when the modifier is attached to a parent SciChartSurfaceBase
Called when a RenderableSeries is attached to this modifier
Called when a SciChartSubSurface} is attached to the parent SciChartSurface
Called when the modifier is detached from a parent SciChartSurfaceBase
Called when a RenderableSeries is detached from this modifier
Called when a SciChartSubSurface is detached from the parent SciChartSurface
Called when the parent SciChartSurfaceBase is rendered
Sets the parent SciChartSurfaceBase on this modifier
Generated using TypeDoc
The VerticalSliceModifier provides a vertical line which can be dragged across the chart area, with optional series tooltips.
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/vertical-slice-modifier/vertical-slice-modifier-overview/