Creates an instance of PolarMouseWheelZoomModifier
Optional parameters to configure the modifier via IPolarMouseWheelZoomModifierOptions
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.
Gets or sets the default action type
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
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.
Direction to which the modifier can be applied
If True uses length scale zoom on the radial axis, otherwise uses visible range zoom. Default True
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.
Gets the axis size for scroll calculations
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.
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
Includes all X and Y axes
Includes renderable series. Returns True if the included items list has changed after the operation.
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
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 PolarMouseWheelZoomModifier provides Mouse wheel zooming behavior on a 2D SciChartPolarSurface within SciChart - High Performance JavaScript Charts
To apply the PolarMouseWheelZoomModifier to a SciChartPolarSurface and add Mouse-wheel zoom behavior, use the following code:
const sciChartSurface: SciChartPolarSurface; sciChartSurface.chartModifiers.add(new PolarMouseWheelZoomModifier());The speed of mouse-wheel zoom can be modified via the PolarMouseWheelZoomModifier.growFactor property.
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-mouse-wheel-zoom-modifier/