Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for passing to the constructor of MouseWheelZoomModifier

Hierarchy

Index

Properties

Optional actionType

actionType: EActionType

Defines whether the Mouse Wheel zooms or pans. See EActionType for options

Optional applyToAxes

applyToAxes: boolean

Whether the modifier applies when the mouse is over the axes. Default true.

Optional applyToSeriesViewRect

applyToSeriesViewRect: boolean

Whether the modifier applies when the mouse is over the chart area (ie not over the axes). Default true.

Optional excludedXAxisIds

excludedXAxisIds: string[]

A list of Ids for X axis to exclude from this modifier

remarks

Also see MouseWheelZoomModifier.includeXAxis function which allows you to include or exclude an axis by instance

Optional excludedYAxisIds

excludedYAxisIds: string[]

A list of Ids for Y axis to exclude from this modifier

remarks

Also see MouseWheelZoomModifier.includeYAxis function which allows you to include or exclude an axis by instance

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional growFactor

growFactor: number

Modifies the speed of mousewheel zoom, for example growFactor = 0.001 means each mousewheel 'click' zooms the chart 0.1%

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional includedXAxisIds

includedXAxisIds: string[]

A list of Ids for X axis to include to this modifier

remarks

Also see MouseWheelZoomModifier.includeXAxis function which allows you to include or exclude an axis by instance

Optional includedYAxisIds

includedYAxisIds: string[]

A list of Ids for Y axis to include this modifier

remarks

Also see MouseWheelZoomModifier.includeYAxis function which allows you to include or exclude an axis by instance

Optional modifierGroup

modifierGroup: string

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

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