Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PointableBackground

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

Index

Methods

getDirection

getFillStyle

  • Returns FillStyle

    Current Background FillStyle

getFillStyleHighlight

  • getFillStyleHighlight(): FillStyle | undefined
  • Returns FillStyle | undefined

    Highlighted FillStyle of Background or undefined for auto assignment

getPointerAngle

  • getPointerAngle(): pixel
  • Get angle of Pointable in degrees.

    Returns pixel

    Angle in degrees

getPointerLength

  • getPointerLength(): pixel
  • Get length of Pointable head in pixels.

    Returns pixel

    Pixel length

getStrokeStyle

  • getStrokeStyle(): LineStyle
  • Returns LineStyle

    Current Background LineStyle

setDirection

  • Set direction.

    Parameters

    Returns this

    Object itself for fluent interface

setFillStyle

  • Set FillStyle of Background.

    Parameters

    Returns this

    Object itself for fluent interface

setFillStyleHighlight

setPointerAngle

  • setPointerAngle(angle?: undefined | number): this
  • Set angle of Pointable in degrees. [0-90]

    Parameters

    • Optional angle: undefined | number

      Angle of pointer or undefined to match head & body size

    Returns this

    Object itself for fluent interface

setPointerLength

  • setPointerLength(length: pixel): this
  • Set length of Pointable head in pixels.

    Parameters

    • length: pixel

      Length of head in pixels.

    Returns this

    Object itself for fluent interface

setStrokeStyle

  • Set stroke style of Background.

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle>

      LineStyle object or function which modifies it

    Returns this

    Object itself for fluent interface