Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional parameters used to configure a RubberBandXyZoomModifier at construct time

Hierarchy

Index

Properties

Optional animationDuration

animationDuration: number

Defines the duration of animations when zooming in milliseconds

Optional easingFunction

easingFunction: TEasingFn | string

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

Optional excludedSeriesIds

excludedSeriesIds: string[]

A list of renderable series to exclude from this modifier

remarks

Also see ChartModifierBase2D.includedSeries which has methods to include or exclude a series by instance

Optional excludedXAxisIds

excludedXAxisIds: string[]

A list of X axes to exclude from this modifier

remarks

Also see ChartModifierBase2D.includedXAxes which has methods to include or exclude an axis by instance

Optional excludedYAxisIds

excludedYAxisIds: string[]

A list of Y axes to exclude from this modifier

remarks

Also see ChartModifierBase2D.includedYAxes which has methods to include or exclude an axis by instance

Optional executeCondition

executeCondition: TModifierExecuteCondition

The primary action execute condition that modifier should respond to

Optional fill

fill: string

Sets the fill of RubberBandSvgRect

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional includedSeriesIds

includedSeriesIds: string[]

A list of renderable series to include to this modifier

remarks

Also see ChartModifierBase2D.includedSeries which has methods to include or exclude a series by instance

Optional includedXAxisIds

includedXAxisIds: string[]

A list of X axes to include to this modifier

remarks

Also see ChartModifierBase2D.includedXAxes which has methods to include or exclude an axis by instance

Optional includedYAxisIds

includedYAxisIds: string[]

A list of Y axes to include this modifier

remarks

Also see ChartModifierBase2D.includedYAxes which has methods to include or exclude an axis by instance

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 secondaryExecuteCondition

secondaryExecuteCondition: TModifierExecuteCondition

The secondary action execute condition that modifier should respond to

Optional stroke

stroke: string

Sets the stroke of RubberBandSvgRect

Optional strokeThickness

strokeThickness: number

Sets the strokeThickness of RubberBandSvgRect

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