Creates an instance of the LegendModifier3D
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
An event handler raised when a SciChart3DLegend row checkbox is checked or unchecked
Specifies a string ID to group modifiers.
Gets the SciChart3DLegend control used to render the legend
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
Callback called from inner SciChart3DLegend when a checkbox is checked or unchecked
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
Tests if the series is included or excluded
Convert the object to a definition that can be serialized to JSON, or used directly with the builder api
Generated using TypeDoc
The LegendModifier3D provides interactive legend behavior on a 3D SciChart3DSurface within SciChart - High Performance JavaScript Charts
To apply the LegendModifier3D to a SciChart3DSurface and add tooltip behavior, use the following code:
const sciChartSurface: SciChart3DSurface; sciChartSurface.chartModifiers.add(new LegendModifier3D());📚 Docs: todo