Interface PointableBackground

Background that can be pointed at a direction (left,right,up or down)

Hierarchy

Pointable
UIBackground
- PointableBackground

Index

Methods

getDirection getFillStyle getPointerLength getStrokeStyle getTickLabelPadding setDirection setFillStyle setPointerLength setStrokeStyle setTickLabelPadding

Methods

getDirection

getDirection(): UIDirections
NOTE: Internal method, usage is not encouraged.

Returns UIDirections

Inherited from Pointable.getDirection

getFillStyle

getFillStyle(): FillStyle
Returns
Current Background FillStyle

Returns FillStyle

Inherited from UIBackground.getFillStyle

getPointerLength

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

Returns number

Inherited from Pointable.getPointerLength

getStrokeStyle

getStrokeStyle(): LineStyle
Returns
Current Background LineStyle

Returns LineStyle

Inherited from UIBackground.getStrokeStyle

getTickLabelPadding

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

Returns number

Inherited from Pointable.getTickLabelPadding

setDirection

setDirection(direction: UIDirections): PointableBackground
NOTE: Internal method, usage is not encouraged.
Parameters
- direction: UIDirections
Returns PointableBackground

Inherited from Pointable.setDirection

setFillStyle

setFillStyle(value: FillStyle | ImmutableMutator<FillStyle, FillStyle>): PointableBackground
Set FillStyle of Background.

Returns
Object itself for fluent interface
Parameters
- value: FillStyle | ImmutableMutator<FillStyle, FillStyle>
  
  Fill style object or function which modifies it
Returns PointableBackground

Inherited from UIBackground.setFillStyle

setPointerLength

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

Inherited from Pointable.setPointerLength

setStrokeStyle

setStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle, LineStyle>): PointableBackground
Set stroke style of Background.

Returns
Object itself for fluent interface
Parameters
- value: LineStyle | ImmutableMutator<LineStyle, LineStyle>
  
  LineStyle object or function which modifies it
Returns PointableBackground

Inherited from UIBackground.setStrokeStyle

setTickLabelPadding

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

Inherited from Pointable.setTickLabelPadding