Class SpiderAxis

Container for shapes of spider axes and drawing logic.

Hierarchy

SpiderAxis

Index

Properties

axisScale chart scale tag

Methods

dispose formatValue getInterval getLabelSize getScrollStrategy getTag setInterval setScaleLabelFormatter setScrollStrategy

Properties

`Readonly` axisScale

axisScale: LinearScale1D

`Readonly` chart

chart: SpiderChart<UIBackground>

`Readonly` scale

scale: LinearScaleXY

`Readonly` tag

tag: string

Methods

dispose

dispose(): void
Permanently destroy the component.

To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.
```
let chart = ...Spider()
let axis = chart.addAxis(category)
axis.dispose()
```
Returns
Object itself for fluent interface
Returns void

`Readonly` formatValue

formatValue(value: number): string
Format a value along axis to string.

Returns
Value formated to string
Parameters
- value: number
  
  Value along axis
Returns string

getInterval

getInterval(): {
end: number;
start: number;
}
Get the currently applied Spider Axis interval.

Returns
Object containing the current start and end of axis.

Returns {
end: number;
start: number;
}
- end: number
- start: number

getLabelSize

getLabelSize(): Point
Update axis label style and return its computed size. Used for computation of chart margins before drawing.

Returns Point

getScrollStrategy

getScrollStrategy(): undefined | AxisScrollStrategy
Gets the AxisScrollStrategy of Spider Axis

Returns undefined | AxisScrollStrategy

getTag

getTag(): string
Get the axis tag.

Returns
String tag

Returns string

setInterval

setInterval(opts: AxisIntervalConfiguration): SpiderAxis
Set the interval of Spider Axis.

Returns
Object itself
Parameters
- opts: AxisIntervalConfiguration
Returns SpiderAxis

setScaleLabelFormatter

setScaleLabelFormatter(formatter: FormattingFunction): SpiderAxis
Set strategy for formatting scale labels.
```
 axis.setScaleLabelFormatter((value) => `${value} km`)
```
Returns
Object itself
Parameters
- formatter: FormattingFunction
  
  cb function that formats the values of scale
Returns SpiderAxis

setScrollStrategy

setScrollStrategy(scrollStrategy?: AxisScrollStrategy): SpiderAxis
Sets the AxisScrollStrategy of Spider Axis

Returns
Object itself
Parameters
- Optional scrollStrategy: AxisScrollStrategy
  
  AxisScrollStrategy or undefined to disable automatic scrolling. See AxisScrollStrategies for a collection of options.
Returns SpiderAxis