Creates an instance of a OverviewRangeSelectionModifier
Optional parameters used to configure the modifier
Stores info about active pointerdown events
A unique Id for the IChartModifierBase
A callback to invalidate the parent SciChartSurfaceBase
Specifies a string ID to group modifiers.
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 the annotation used for range selection
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 selected area ranges of the modifier
Gets or sets the selected area ranges of the modifier
Gets the svg string for the unselected part of the range
Sets the svg string for the unselected part of the range
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.
Checks if event conditions should trigger the modifier action
current event info as ModifierMouseArgs
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%
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 OverviewRangeSelectionModifier provides drag-rectangle to zoom behavior on a 2D SciChartSurface within SciChart - High Performance JavaScript Charts
To apply the OverviewRangeSelectionModifier to a SciChartSurface and add drag to zoom behavior, use the following code:
const sciChartSurface: SciChartSurface; sciChartSurface.chartModifiers.add(new OverviewRangeSelectionModifier());