Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional parameters used to configure a PolarZoomExtentsModifier 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 centerPoint

centerPoint: Point

Sets the center point for both axes. By default the initial center point for X axis is used.

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 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 innerRadius

innerRadius: number

Sets inner radius for the radial axis. By default the initial inner radius is used.

Optional isAnimated

isAnimated: boolean

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

Optional lengthScale

lengthScale: number

Sets lengthScale for radian axis. By default the initial length scale is used.

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 resetCenterPoint

resetCenterPoint: boolean

Sets flag to reset center point for X and Y axes

Optional resetInnerRadius

resetInnerRadius: boolean

Sets flag to reset inner radius for the radial axis

Optional resetLengthScale

resetLengthScale: boolean

Sets flag to reset length scale for radial axis

Optional resetRanges

resetRanges: boolean

Sets flag to reset X and Y visible ranges

Optional resetStartAngles

resetStartAngles: boolean

Sets flag to reset start angles for X and Y axes

Optional resetTotalAngle

resetTotalAngle: boolean

Sets flag to reset total angle for the angular axis

Optional secondaryExecuteCondition

secondaryExecuteCondition: TModifierExecuteCondition

The secondary action execute condition that modifier should respond to

Optional totalAngle

totalAngle: number

Sets total angle for angular axis. By default the initial total angle is used.

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 xStartAngle

xStartAngle: number

Sets start angle for X axis. By default the initial start angle is used.

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.

Optional yStartAngle

yStartAngle: number

Sets start angle for Y axis. By default the initial start angle is used.

Generated using TypeDoc