IDataPointSelectionModifierOptions | API Documentation for SciChart.js

Optional parameters used to configure a DataPointSelectionModifier at construct time

Hierarchy

IChartModifierBaseOptions
- IDataPointSelectionModifierOptions

Index

Properties

Optional allowClickSelect

allowClickSelect: boolean

When true, allow click to select a point. Also see IDataPointSelectionModifierOptions.allowDragSelect to allow rectangle dragging

remarks:: default TRUE

Optional allowDragSelect

allowDragSelect: boolean

When true, allow drag to select a rectangle of points. Also see IDataPointSelectionModifierOptions.allowClickSelect to allow click selection

remarks:: default TRUE

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional getSelectionMode

getSelectionMode: ((modifierKeys: TModifierKeys, isAreaSelection: boolean) => ESelectionMode) | string

Optional function to override the ESelectionMode, e.g. Union, Replace or Invert. See the TModifierKeys parameter which tells you if Ctrl, Shift or Alt key are currently pressed.

param: Contains info about whether Ctrl, Shift or Alt key are currently pressed
param: When true, the user is dragging (an area selection), else, a single point to click

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional modifierGroup

modifierGroup: string

Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts

Optional onSelectionChanged

onSelectionChanged: ((args: DataPointSelectionChangedArgs) => void) | string

Optional callback for when any datapoint is selected or deselected

param: Argument of

Optional selectionFill

selectionFill: string

Sets the fill of the selection rectangle as an HTML-compatible color string

remarks: Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077 and RGBA format e.g. rgba(255,0,0,0.5)

Optional selectionStroke

selectionStroke: string

Sets the fill of the selection rectangle as an HTML-compatible color string

remarks: Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077 and RGBA format e.g. rgba(255,0,0,0.5)

Optional selectionStrokeThickness

selectionStrokeThickness: number

Sets the strokeThickness of the selection rectangle

Optional xAxisId

xAxisId: string

The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes

Optional xyDirection

xyDirection: EXyDirection

Defines the Xy Direction - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with RubberBandXyZoomModifier and EXyDirection.XDirection the modifier works on Y axis

Optional yAxisId

yAxisId: string

The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.