Interface Pointable

Interface for UI elements used for CustomTick Markers.

A Pointable has two components: a label and a pointer.

Hierarchy

Pointable

Index

Methods

getDirection getPointerLength getTickLabelAlignment getTickLabelPadding setDirection setPointerLength setTickLabelAlignment setTickLabelPadding

Methods

getDirection

getDirection(): UIDirections
Returns UIDirections

getPointerLength

getPointerLength(): number
NOTE: Usage is not encouraged, please use getTickLength

Returns number

getTickLabelAlignment

getTickLabelAlignment(): number
Get alignment of Label respective to tick line.

Returns
New TickStyle object with modified Label alignment

Returns number

getTickLabelPadding

getTickLabelPadding(): number
NOTE: Usage is not encouraged, please use getTickLabelPadding

Returns number

setDirection

setDirection(direction: UIDirections): Pointable
Parameters
- direction: UIDirections
Returns Pointable

setPointerLength

setPointerLength(length: number): Pointable
NOTE: Usage is not encouraged, please use setTickLength
Parameters
- length: number
Returns Pointable

setTickLabelAlignment

setTickLabelAlignment(alignment: number, alignment2?: number): Pointable
Set alignment of Label respective to tick line.

after: -1

center: 0

before: +1

With XY axes, a second alignment value can additionally be passed, which is used along the other dimension (i.e. X for Y axes).

Returns
New TickStyle object with modified Label alignment
Parameters
- alignment: number
  
  Label alignment [-1, 1].
- Optional alignment2: number
  
  Opposite dimension label alignment [-1, 1], supported only by XY axes.
Returns Pointable

setTickLabelPadding

setTickLabelPadding(margin: number): Pointable
NOTE: Usage is not encouraged, please use setTickLabelPadding
Parameters
- margin: number
Returns Pointable