Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for the AnnotationHoverModifier.

Hierarchy

Index

Properties

Optional enableHover

enableHover: boolean

Toggles hover detection

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional hoverMode

hoverMode: EHoverMode

Specifies the rules for detecting hover state for overlapping targets

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 notifyOutEvent

notifyOutEvent: boolean

Specifies whether an event should be raised when some of the hovered targets became unhovered

Optional notifyPositionUpdate

notifyPositionUpdate: boolean

Specifies whether an event should be raised when the mouse position changes but the list of hovered targets remains unchanged

Optional onHover

onHover: string | THoverCallback<IAnnotation>

A callback executed when hover event is raised

Optional targets

targets: string[] | IAnnotation[] | string | TTargetsSelector<IAnnotation>

Specifies entities which are hit tested. Accepts list of ids, or list of references, as well as getter function or name of the registered function

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.

Generated using TypeDoc