Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TickMarker

Interface for TickMarker, a part of CustomTick that represents the label and pointer attached to the Axis.

Most styling of CustomTicks can be managed directly via CustomTick API, but for some rare cases its TickMarker has to be mutated. TickMarker is accessed via CustomTick.setMarker method, using a callback function:

 CustomTick.setMarker((tickMarker) =>
     // ... mutate TickMarker.
 )

 //

Index

Methods

dispose

  • dispose(): this
  • Remove the component from rendering.

    If the Component supports it, this can be reverted with restore() method.

    Returns this

    Object itself for fluent interface.

getMargin

  • Get margin around object in pixels.

    Returns Margin

    Margin datastructure

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getMouseStyle

  • Get mouse style.

    Returns UIMouseStyle

    Interface for defining how mouse should look when hovering over UI object

getText

  • getText(): string
  • Get the text of the entire shape.

    Returns string

    The entire text string.

getTextFillStyle

  • Returns FillStyle

    Current text fill style object

getTextFont

getTextRotation

  • getTextRotation(): number
  • Get rotation of Label.

    Returns number

    Rotation in degrees

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if the component is currently disposed, and thus not being rendered. If the Component supports it, this can be reverted with restore() method.

offMouseClick

  • offMouseClick(token: Token): boolean
  • Remove event listener from Mouse Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Remove event listener from Mouse Double Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDown

  • offMouseDown(token: Token): boolean
  • Remove event listener from Mouse Down Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Remove event listener from Mouse Drag Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Remove event listener from Mouse Drag start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Remove event listener from Mouse Drag stop Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Remove event listener from Mouse Enter Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Remove event listener from Mouse Leave Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseMove

  • offMouseMove(token: Token): boolean
  • Remove event listener from Mouse Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseUp

  • offMouseUp(token: Token): boolean
  • Remove event listener from Mouse Up Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Remove event listener from Mouse Wheel Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Remove event listener from Touch End Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchMove

  • offTouchMove(token: Token): boolean
  • Remove event listener from Touch Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchStart

  • offTouchStart(token: Token): boolean
  • Remove event listener from Touch Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

onMouseClick

  • Subscribe on Mouse Enter click

    Parameters

    Returns Token

    Token of subscription

onMouseDoubleClick

  • Subscribe to Mouse Double Click event

    Parameters

    Returns Token

    Token of subscription

onMouseDown

  • Subscribe to Mouse Down event

    Parameters

    Returns Token

    Token of subscription

onMouseDrag

  • Subscribe to Mouse Drag event

    Parameters

    Returns Token

    Token of subscription

onMouseDragStart

  • Subscribe to Mouse Drag Start event

    Parameters

    Returns Token

    Token of subscription

onMouseDragStop

  • Subscribe to Mouse Drag Stop event

    Parameters

    Returns Token

    Token of subscription

onMouseEnter

  • Subscribe on Mouse Enter event

    Parameters

    Returns Token

    Token of subscription

onMouseLeave

  • Subscribe on Mouse Enter leave

    Parameters

    Returns Token

    Token of subscription

onMouseMove

  • Subscribe to Mouse Move event

    Parameters

    Returns Token

    Token of subscription

onMouseUp

  • Subscribe to Mouse Up event

    Parameters

    Returns Token

    Token of subscription

onMouseWheel

  • Subscribe to Mouse Wheel event

    Parameters

    Returns Token

    Token of subscription

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

  • Subscribe to Touch Move event

    Parameters

    Returns Token

    Token of subscription

onTouchStart

  • Subscribe to Touch Start event

    Parameters

    Returns Token

    Token of subscription

restore

  • restore(): this
  • After the Components dispose() method has been called, removing it from rendering, restore() can be used to return it back.

    Returns this

    Object itself for fluent interface.

setMargin

  • setMargin(margin: Partial<MMargin> | number): this
  • Set margin around object in pixels.

    Parameters

    • margin: Partial<MMargin> | number

      Number with pixel margins for all sides or datastructure with individual pixel margins for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set mouse interactions enabled or disabled

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setMouseStyle

  • Set mouse style when hovering over UI object.

    Parameters

    • mouseStyle: UIMouseStyle

      Interface for defining how mouse should look when hovering over UI object

    Returns this

    Object itself

setTextFillStyle

  • Set text fill style object

    Parameters

    Returns this

    Object itself for fluent interface

setTextFont

setTextRotation

  • setTextRotation(rotation: number): this
  • Set rotation of Label.

    Parameters

    • rotation: number

    Returns this

    Object itself