Function which can override whether a tick should be hidden.
Method which aligns Tick label (general location is set predefined).
Polar scale.
Tick object.
Text alignment, rotation and padding.
Method which creates shape for rendering Tick gridline. Used shape depends on type of Axis:
Layer for rendering Tick.
Scale for rendering Tick.
Arc or Line.
Method which gets a position in XY coordinates from a given Axis value.
PolarScale.
Value along the Axis.
XY coordinate.
Update rendering shape states.
Axis margin as pixels.
Method which plots Axis line, itself.
Polar scale.
Style of Axis line.
Axis margin as pixels.
Method which plots Axis Title.
Polar scale.
Text shape used to render title.
Axis margin as pixels.
Method which positions shape used to render Tick gridline.
PolarScale.
Gridline shape. Class depends on type of Axis.
Tickline shape.
Tick object.
Disable all animations for the Axis.
After calling this function, animations (Zooming, scaling) will be disabled. Animations must be recreated manually afterwards.
Axis itself for fluent interface.
Fit axis view to attached series.
Boolean for animation enabled, or number for animation duration in milliseconds
Freeze axis to fitted view? False by default.
Format a value along axis to string. Behavior depends on the Axis' TickStrategy. Eq. A DateTime-Axis will interpret 'value' as a Date.
Value along axis
Value formated to string
Get the currently applied axis scale interval.
Object containing the current start and end of Axis.
Current AxisScrollStrategy
Axis stroke as a LineStyle object
Get the currently used tick strategy
Axis title string
Axis title fillstyle
Get font of axis labels.
FontSettings
Get is axes' scrolling currently prevented by usage of mouse-interactions or 'stop()' method.
Boolean flag
Remove subscription from scale change event
Event listener
True if the listener is successfully removed and false if it is not found
Subscribe to on scale change event
Event listener
Token that is used to unsubscribe from the event
Undo effects of 'stop'.
Specifies scroll animation.
Boolean flag for whether scrolling should be animated or not.
Specifies zoom animation to use.
Example usage:
| Desired result | Argument | Parameters |
|---|---|---|
| Change animation | setAnimationZoom(AnimationEasings.easeOut, 500) | First parameter defines the easing to use for the animation. Second parameter is optional, and defines the duration for the animation |
| Disable zooming animations | axis.setAnimationZoom(undefined) | Passing undefined as the parameter will disable the zooming animations for the Axis. |
Easing of animation. Undefined disables zoom animations. See 'common/animator.Easings' for defaults
Optional default duration for zooming animations in milliseconds
Set axis scale interval.
Start scale value
End scale value
Boolean for animation enabled, or number for animation duration in milliseconds
If true, disables automatic scrolling after setting interval
Object itself for fluent interface
Enable / disable all interactions of Axis.
Interactions enabled or not.
Object itself for fluent interface.
Specify ScrollStrategy of the Axis. This decides where the Axis scrolls based on current view and series boundaries.
AxisScrollStrategy or undefined to disable automatic scrolling. See AxisScrollStrategies for all options.
Object itself for fluent interface.
Specifies axis stroke
Axis stroke style
Axis itself for fluent interface
Set TickStrategy of Axis.
The TickStrategy defines the positioning and formatting logic of Axis ticks as well as the style of created ticks.
Example usage:
DateTime Axis:
Axis.setTickStrategy( AxisTickStrategies.DateTime )Disable automatic ticks completely:
Axis.setTickStrategy( AxisTickStrategies.Empty )Customized TickStrategy:
Axis.setTickStrategy( AxisTickStrategies.Numeric, ( tickStrategy: NumericTickStrategy ) => tickStrategy
.setNumericUnits( true )
.setMajorTickStyle( ( tickStyle ) => tickStyle
.setLabelFont( ( font ) => font
.setWeight( 'bold' )
)
)
)Type table for optional second parameter ('styler'):
| tickStrategy | styler |
|---|---|
| 'Numeric' | ( tickStrategy: NumericTickStrategy ) => tickStrategy |
| 'DateTime' | ( tickStrategy: DateTimeTickStrategy ) => tickStrategy |
| 'Empty' | undefined |
Selected TickStrategy. See AxisTickStrategies for a collection of options.
Optional callback that can be used to customize the TickStrategy. The type of supplied TickStrategy object depends on what was supplied to 'tickStrategy' parameter; See the above method documentation for a value table.
Object itself for fluent interface.
Specifies an Axis title string
Axis title as a string
Axis itself for fluent interface
Specifies Axis title FillStyle
FillStyle of Axis title or mutator to modify existing one
Axis itself for fluent interface
Set font of Axis title.
FontSettings or mutator function for existing settings
Object itself
Stop scrolling of axis until restored.
Class that represents the amplitude value interval on a PolarChart.
The Amplitude Axis is depicted as a single line segment starting from the very center of the PolarChart and ending at its right side.
The Amplitude Axes' tick grid lines travel all over the PolarCharts Series space, doing a full 360 degree until returning to the other end of the tick, along the Amplitude Axis.
The Amplitude Axes' title is positioned just below the Axis line and centered horizontally.
Here is a list of the most commonly useful methods of Polar Amplitude Axis: