Creates an instance of the RolloverModifier
Optional parameters IRolloverModifierOptions used to configure the modifier
Stores info about active pointerdown events
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
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
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 operation that modifier should respond to
The operation 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
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
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 IRenderableSeries without excluded elements
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%
Override hitTestRenderableSeries and add a custom logic
Mark if the Series should be included or excluded, for instance for IChartModifierBase
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
Convert the object to a definition that can be serialized to JSON, or used directly with the builder api
Generated using TypeDoc
The RolloverModifier provides tooltip and cursor behavior on a 2D SciChartSurface within SciChart - High Performance JavaScript Charts
To apply the RolloverModifier to a SciChartSurface and add tooltip behavior, use the following code:
const sciChartSurface: SciChartSurface; sciChartSurface.chartModifiers.add(new RolloverModifier());