Class VisibleTicks

Constructors

constructor

new VisibleTicks(props: Partial<TickStyleProperties>): VisibleTicks

Parameters
- Optional props: Partial<TickStyleProperties>
Returns VisibleTicks

Methods

getGridStrokeLength

getGridStrokeLength(): number

Returns number

Length of GridStroke, where 1 = full and 0 = zero.

getGridStrokeStyle

getGridStrokeStyle(): LineStyle

Returns LineStyle

LineStyle object

getLabelAlignment

getLabelAlignment(): number

Returns number

Horizontal alignment [-1, 1].

getLabelFillStyle

getLabelFillStyle(): FillStyle

Returns FillStyle

Fill style of Label as a VisibleFill object

getLabelFont

getLabelFont(): FontSettings

Returns FontSettings

FontSettings object

getLabelPadding

getLabelPadding(): pixel

Returns pixel

Padding after label as pixels.

getTickLength

getTickLength(): pixel

Returns pixel

Length of Ticks as pixels

getTickPadding

getTickPadding(): pixel

Returns pixel

Padding after Tick as pixels.

getTickStyle

getTickStyle(): LineStyle

Returns LineStyle

LineStyle object

setGridStrokeLength

setGridStrokeLength(length: number): this

Parameters
- length: number
Returns this

New VisibleTicks object

setGridStrokeStyle

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

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

New VisibleTicks object

setLabelAlignment

setLabelAlignment(alignment: number): this

Parameters
- alignment: number
Returns this

New VisibleTicks object with modified Label alignment

setLabelFillStyle

setLabelFillStyle(style: FillStyle | ImmutableMutator<FillStyle>): this

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

New VisibleTicks object

setLabelFont

setLabelFont(font: FontSettings | ImmutableMutator<FontSettings>): this

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

New VisibleTicks object

setLabelPadding

setLabelPadding(padding: pixel): this

Parameters
- padding: pixel
Returns this

New VisibleTicks object with modified Label padding

setTickLength

setTickLength(length: pixel): this

Parameters
- length: pixel
Returns this

New VisibleTicks object

setTickPadding

setTickPadding(padding: pixel): this

Parameters
- padding: pixel
Returns this

New VisibleTicks object with modified Tick padding

setTickStyle

setTickStyle(style: LineStyle | ImmutableMutator<LineStyle>): this

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

New VisibleTicks object

Static Record

Record(defaultValues: TProps, name: undefined | string): Factory<TProps>

Type parameters
- TProps
Parameters
- defaultValues: TProps
- Optional name: undefined | string
Returns Factory<TProps>