Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional parameters used to configure a ZoomExtentsModifier at construct time

Hierarchy

Index

Properties

Optional animationDuration

animationDuration: number

Defines the duration of animations when zooming in milliseconds

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 area where series are drawn (ie not over the axes). Default true.

Optional easingFunction

easingFunction: TEasingFn | string

Defines the easing function for animation. See TEasingFn for a range of functions

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional isAnimated

isAnimated: boolean

When true, the Zoom operations are animated. See also animationDuration and easingFunction

Optional modifierGroup

modifierGroup: string

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

Optional onZoomExtents

onZoomExtents: TZoomExtentsCallback | string

A function to execute when zoomExtents is activated. If this exists and returns false, the builtin behaviour is ignored;

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