Creates an instance of the PolarLegendModifier
Optional parameters IPolarLegendModifierOptions 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
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
An event handler raised when a SciChartLegend row checkbox is checked or unchecked
Specifies a string ID to group modifiers.
Gets the SciChartLegend control used to render the legend
Direction to which the modifier can be applied
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.
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
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%
Includes all X and Y axes
Includes or excludes X axis
Includes or excludes Y axis
Callback called from inner SciChartLegend when a checkbox is checked or unchecked
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 PolarLegendModifier provides interactive legend behavior on a 2D SciChartPolarSurface within SciChart - High Performance JavaScript Charts
To apply the PolarLegendModifier to a SciChartPolarSurface and add tooltip behavior, use the following code:
const sciChartSurface: SciChartPolarSurface; sciChartSurface.chartModifiers.add(new PolarLegendModifier());📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-legend-modifier/