ISeriesSelectionModifier3DOptions | API Documentation for SciChart.js

Index

enableHover: boolean

When true, hover is enabled. Any series under the mouse or pointer on mouseMove will be notified as mouseOver.

remarks

Enabling hover will decrease performance as a hit-test operation must be performed every mouse-move.

Default false

enableSelection: boolean

When true, Selection is enabled. Any series under the mouse or pointer device on mouseDown can be selected.

Default true

excludedSeriesIds: string[]

A list of 3D renderable series to exclude from this modifier

remarks: Also see ChartModifierBase3D.includedSeries which has methods to include or exclude a series by instance

The primary action execute condition that modifier should respond to

hitTestRadius: number

Pixel radius used for hover and selection hit-testing around the mouse point. A value of 0 means exact pixel only.

Default 2

id: string

A unique Id for the ChartModifierBase3D

includedSeriesIds: string[]

A list of 3D renderable series to include to this modifier

remarks: Also see ChartModifierBase3D.includedSeries which has methods to include or exclude a series by instance

Optional callback for when any series is hovered or unhovered

onSelectionChanged: TSelectionChangedCallback3D | string

Optional callback for when any series is selected or deselected

prioritizeClosestToCamera: boolean

When true, if multiple series are hit at a pixel, the one with hit-point closest to camera is preferred. Default false

note: Use together with a larger hitTestRadius to improve hover behavior for thin 3D lines (a value of 10 instead of the default 2).