Creates an instance of the MouseWheelZoomModifier3D
optional parameters of type IMouseWheelZoomModifier3DOptions used to configure the modifier
Stores info about active pointerdown events
A unique Id for the IChartModifierBase
The helper property to get and set the list of included renderable series
A callback to invalidate the parent SciChartSurfaceBase
Specifies a string ID to group modifiers.
The mouse wheel sensitifivity is a factor that determines how much the camera zooms when the mouse wheel scrolls. Default value is 0.1
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
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.
The secondary action execute condition that modifier should respond to
The secondary action execute condition that modifier should respond to
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 all visible and included renderable series. The list also contains included visible stacked renderable series This calls this.testIsIncludedSeries so it is best to customise the including check behaviour there.
Checks if event conditions should trigger the modifier action
current event info as ModifierMouseArgs
Includes renderable series. Returns True if the included items list has changed after the operation.
Notifies the parent surface that a property has changed by calling invalidateParentCallback
the property name which has changed
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 MouseWheelZoomModifier3D provides Mouse wheel zooming behavior on a 3D SciChart3DSurface within SciChart - High Performance JavaScript 3D Charts
To apply the MouseWheelZoomModifier3D to a SciChart3DSurface and add Mouse-wheel zoom behavior, use the following code:
const sciChartS3Durface: SciChart3DSurface; sciChart3DSurface.chartModifiers.add(new MouseWheelZoomModifier3D());The speed of mouse-wheel zoom can be modified via the MouseWheelZoomModifier3D.mouseWheelSensitivity property.
📚 Docs: https://www.scichart.com/documentation/js/v4/3d-charts/chart-modifier-3d-api/zooming-and-panning/mouse-wheel-zoom-modifier-3d/