Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Axis

Index

Properties

Methods

Properties

chart

chart: ChartXY

directionFactor

directionFactor: 1 | -1

heightScale

heightScale: Scale

plottingScale

plottingScale: Vec2<Scale>

scale

scale: Scale

Methods

addBand

  • addBand(onTop: boolean): Band
  • Parameters

    • Default value onTop: boolean

    Returns Band

    Band object.

addConstantLine

  • Parameters

    • Default value onTop: boolean

    Returns ConstantLine

    ConstantLine object.

addCustomTick

disableAnimations

  • disableAnimations(): this
  • Returns this

    Axis itself for fluent interface.

dispose

  • dispose(): this
  • Returns this

    this 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

getAxisInteractionPanByDragging

  • getAxisInteractionPanByDragging(): boolean
  • Returns boolean

    Boolean flag

getAxisInteractionReleaseByDoubleClicking

  • getAxisInteractionReleaseByDoubleClicking(): boolean
  • Returns boolean

    Boolean flag

getAxisInteractionZoomByDragging

  • getAxisInteractionZoomByDragging(): boolean
  • Returns boolean

    Boolean flag

getAxisInteractionZoomByWheeling

  • getAxisInteractionZoomByWheeling(): boolean
  • Returns boolean

    Boolean flag

getAxisMouseHoverStyle

  • getAxisMouseHoverStyle(): string
  • Returns string

    Mouse-style preset name

getAxisMousePanStyle

  • getAxisMousePanStyle(): string
  • Returns string

    Mouse-style preset name

getAxisMouseZoomStyle

  • getAxisMouseZoomStyle(): string
  • Returns string

    Mouse-style preset name

getChartInteractionFitByDrag

  • getChartInteractionFitByDrag(): boolean
  • Returns boolean

    Boolean flag

getChartInteractionPanByDrag

  • getChartInteractionPanByDrag(): boolean
  • Returns boolean

    Boolean flag

getChartInteractionZoomByDrag

  • getChartInteractionZoomByDrag(): boolean
  • Returns boolean

    Boolean flag

getChartInteractionZoomByWheel

  • getChartInteractionZoomByWheel(): boolean
  • Returns boolean

    Boolean flag

getHeight

  • getHeight(): number
  • Returns number

    Number

getHighlighters

getNibInteractionScaleByDragging

  • getNibInteractionScaleByDragging(): boolean
  • Returns boolean

    Boolean flag

getNibInteractionScaleByWheeling

  • getNibInteractionScaleByWheeling(): boolean
  • Returns boolean

    Boolean flag

getNibLength

  • getNibLength(): number
  • Returns number

    Axis nib stroke length in pixels

getNibMouseHoverStyle

  • getNibMouseHoverStyle(): string
  • Returns string

    Mouse-style preset name

getNibMousePickingAreaSize

  • getNibMousePickingAreaSize(): number
  • Returns number

    Size in pixels

getNibMouseScaleStyle

  • getNibMouseScaleStyle(): string
  • Returns string

    Mouse-style preset name

getNibOverlayStyle

getNibStyle

  • getNibStyle(): LineStyle
  • Returns LineStyle

    nib stroke fillstyle as a Fillstyle object

getOverlayStyle

getScrollStrategy

  • getScrollStrategy(): AxisScrollStrategy | undefined
  • Returns AxisScrollStrategy | undefined

    Current AxisScrollStrategy

getStrokeStyle

  • getStrokeStyle(): LineStyle
  • Returns LineStyle

    Axis stroke as a LineStyle object

getTickStrategy

  • getTickStrategy(): TickStrategyType
  • Returns TickStrategyType

getTickStyle

getTitle

  • getTitle(): string
  • Returns string

    Axis title string

getTitleFillStyle

getTitleFont

getTitleMargin

  • getTitleMargin(): number
  • Returns number

    Padding after Axis title

getUiPosition

  • getUiPosition(): number
  • Returns number

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if all Axis sub-elements are disposed, false if not.

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

restore

  • restore(): this
  • Returns this

    this for fluent interface TODO: Needs to properly restore the nibs - or recreate them. Current dispose would force us to use the latter method. Needs to put the axis back to a proper position.

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

setAxisInteractionPanByDragging

  • setAxisInteractionPanByDragging(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setAxisInteractionReleaseByDoubleClicking

  • setAxisInteractionReleaseByDoubleClicking(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setAxisInteractionZoomByDragging

  • setAxisInteractionZoomByDragging(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setAxisInteractionZoomByWheeling

  • setAxisInteractionZoomByWheeling(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setAxisMouseHoverStyle

  • setAxisMouseHoverStyle(mouseStyle: string): this
  • Parameters

    • Default value mouseStyle: string

    Returns this

    Object itself

setAxisMousePanStyle

  • setAxisMousePanStyle(mouseStyle: string): this
  • Parameters

    • Default value mouseStyle: string

    Returns this

    Object itself

setAxisMouseZoomStyle

  • setAxisMouseZoomStyle(mouseStyle: string): this
  • Parameters

    • Default value mouseStyle: string

    Returns this

    Object itself

setChartInteractionFitByDrag

  • setChartInteractionFitByDrag(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setChartInteractionPanByDrag

  • setChartInteractionPanByDrag(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setChartInteractionZoomByDrag

  • setChartInteractionZoomByDrag(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setChartInteractionZoomByWheel

  • setChartInteractionZoomByWheel(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setChartInteractions

  • setChartInteractions(enabled: boolean): this
  • Parameters

    • enabled: boolean

    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

    Axis itself for fluent interface

setNibInteractionScaleByDragging

  • setNibInteractionScaleByDragging(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setNibInteractionScaleByWheeling

  • setNibInteractionScaleByWheeling(enabled: boolean): this
  • Parameters

    • enabled: boolean

    Returns this

setNibLength

  • setNibLength(length: pixel): this
  • Parameters

    • length: pixel

    Returns this

    Axis itself for fluent interface

setNibMouseHoverStyle

  • setNibMouseHoverStyle(mouseStyle: string): this
  • Parameters

    • Default value mouseStyle: string

    Returns this

    Object itself

setNibMousePickingAreaSize

  • setNibMousePickingAreaSize(size: pixel): this
  • Parameters

    • size: pixel

    Returns this

    Object itself

setNibMouseScaleStyle

  • setNibMouseScaleStyle(mouseStyle: string): this
  • Parameters

    • Default value mouseStyle: string

    Returns this

    Object itself

setNibOverlayStyle

setNibStyle

  • Parameters

    Returns this

    Axis itself for fluent interface

setOverlayStyle

setScrollStrategy

  • setScrollStrategy(scrollStrategy: AxisScrollStrategy): this
  • Parameters

    • scrollStrategy: AxisScrollStrategy

    Returns this

    Object itself for fluent interface.

setStrokeStyle

  • Parameters

    Returns this

    Axis 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

setTitleFont

setTitleMargin

  • setTitleMargin(margin: pixel): this
  • Parameters

    • margin: pixel

    Returns this

    Axis itself for fluent interface

stop

  • stop(): this
  • Returns this