Creates an instance of MouseWheelZoomModifier
Optional parameters to configure the modifier via IMouseWheelZoomModifierOptions
Defines whether the Mouse Wheel zooms or pans. See EActionType for options
Stores info about active pointerdown events
Whether the modifier applies when the mouse is over the axes. Default true.
Whether the modifier applies when the mouse is over the area where series are drawn (ie not over the axes). Default true.
Modifies the speed of mousewheel zoom, for example growFactor = 0.001 means each mousewheel 'click' zooms the chart 0.1%
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
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.
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.
Gets the axis size for scroll calculations
Returns the list of included Axis for this IChartModifierBase
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%
Resets to include all axes
Mark if the XAxis should be included or excluded, for instance for IChartModifierBase
Mark if the YAxis 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
Performs a pan operation
the MouseWheel delta
Performs the zoom operation around the mouse point
The X,Y location of the mouse at the time of the zoom
the MouseWheel delta
Sets the parent SciChartSurfaceBase on this modifier
Generated using TypeDoc
The MouseWheelZoomModifier provides Mouse wheel zooming behavior on a 2D SciChartSurface within SciChart - High Performance JavaScript Charts
To apply the MouseWheelZoomModifier to a SciChartSurface and add Mouse-wheel zoom behavior, use the following code:
const sciChartSurface: SciChartSurface; sciChartSurface.chartModifiers.add(new MouseWheelZoomModifier());The speed of mouse-wheel zoom can be modified via the MouseWheelZoomModifier.growFactor property.