Class Axis3D

Properties

scale

scale: UnitScale

Methods

disableAnimations

disableAnimations(): this

Returns this

Axis itself for fluent interface.

fit

fit(animate: number | boolean, freeze: boolean): this

Parameters
- Optional animate: number | boolean
- Default value freeze: boolean
Returns this

formatValue

formatValue(value: number): string

Parameters
- value: number
Returns string

Value formated to string

getScrollStrategy

getScrollStrategy(): AxisScrollStrategy | undefined

Returns AxisScrollStrategy | undefined

Current AxisScrollStrategy

getStrokeStyle

getStrokeStyle(): LineStyle

Returns LineStyle

Style of Axis line.

getTickStrategy

getTickStrategy(): TickStrategyType

Returns TickStrategyType

getTickStyle

getTickStyle(): NumericTickStrategy | DateTimeTickStrategy | undefined

Returns NumericTickStrategy | DateTimeTickStrategy | undefined

getTitle

getTitle(): string

Returns string

Axis title string

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

Axis title fillstyle

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings

isStopped

isStopped(): boolean

Returns boolean

Boolean flag

offScaleChange

offScaleChange(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onScaleChange

onScaleChange(listener: function): Token

Parameters
- listener: function
  - - Parameters
      - start: number
      - end: number
      Returns void
Returns Token

Token that is used to unsubscribe from the event

release

release(): void

Returns void

setAnimationScroll

setAnimationScroll(enabled: boolean | undefined): this

Parameters
- enabled: boolean | undefined
Returns this

setAnimationZoom

setAnimationZoom(easing: AnimationEasing | undefined, duration: undefined | number): this

Parameters
- easing: AnimationEasing | undefined
- Optional duration: undefined | number
Returns this

setInterval

setInterval(start: number, end: number, animate: number | boolean, disableScrolling: boolean): this

Parameters
- start: number
- end: number
- Default value animate: number | boolean
- Default value disableScrolling: boolean
Returns this

Object itself for fluent interface

setMouseInteractions

setMouseInteractions(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself for fluent interface.

setScrollStrategy

setScrollStrategy(scrollStrategy: AxisScrollStrategy): this

Parameters
- scrollStrategy: AxisScrollStrategy
Returns this

Object itself for fluent interface.

setStrokeStyle

setStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself for fluent interface.

setTickStrategy

setTickStrategy(tickStrategy: TickStrategy, styler: TickStrategyStyler<TickStrategyParameters, TickStrategy>): this

Type parameters
- TickStrategy: TickStrategyType
Parameters
- tickStrategy: TickStrategy
- Optional styler: TickStrategyStyler<TickStrategyParameters, TickStrategy>
Returns this

Object itself for fluent interface.

setTickStyle

setTickStyle(styler: TickStrategyStyler<TickStrategyParameters, TickStrategy>): this

Type parameters
- TickStrategy: TickStrategyType
Parameters
- styler: TickStrategyStyler<TickStrategyParameters, TickStrategy>
Returns this

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Axis itself for fluent interface

setTitleFillStyle

setTitleFillStyle(fillStyle: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- fillStyle: FillStyle | ImmutableMutator<FillStyle>
Returns this

Axis itself for fluent interface

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Object itself

stop

stop(): this

Returns this