Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomTick <TickMarkerBackgroundType >

Custom tick.

Is designed to be used strictly by Axis objects.

Index

Properties

Methods

Properties

_theme

_theme: Theme

axis

axis: Axis

Axis that CustomTick belongs to.

mainScale

mainScale: Scale

Scale of owning axis.

scale

scale: Vec2<Scale>

Methods

dispose

  • dispose(): this

  • Disposes all custom tick sub-elements

    Returns this

    This for fluid interface

disposeMarker

  • disposeMarker(): this

  • Remove Marker from rendering collection, so it can be safely trashed by GC

    Returns this

    Object itself for fluent interface

getGridStrokeLength

  • getGridStrokeLength(): number

  • Returns number

    Grid stroke length as a % of the viewport size

getGridStrokeStyle

  • getGridStrokeStyle(): LineStyle

  • Returns LineStyle

    Grid stroke style as a LineStyle object

getIsUnderMouse

  • getIsUnderMouse(): boolean

  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getMarker

  • getMarker(): TickMarker<TickMarkerBackgroundType>

  • Get marker of tick.

    Returns TickMarker<TickMarkerBackgroundType>

    PointableTextBox object

getMouseInteractions

  • getMouseInteractions(): boolean

  • Returns boolean

    Mouse interactions state

getSidePaddings

  • getSidePaddings(): number

  • Returns number

    Size of padding at sides of label

getValue

  • getValue(): number

  • Value of CustomTick

    Returns number

isDisposed

  • isDisposed(): boolean

  • Returns boolean

    True if all customTick child elements are disposed, false if not.

isDisposedMarker

  • isDisposedMarker(): boolean

  • Returns boolean

    True if visible and False for invisible

isInScale

  • isInScale(): boolean

  • Check that customTick fit the main scale

    Returns boolean

    Boolean with the result

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 to Mouse Click event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse clicks the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseDoubleClick

  • Subscribe to Mouse Double Click event

    Parameters

    Returns Token

onMouseDown

  • Subscribe to Mouse Down event

    Parameters

    Returns Token

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Subscribe to Mouse Enter event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse enters the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseLeave

  • Subscribe to Mouse Leave event

    Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseMove

  • Subscribe to Mouse Move event

    Parameters

    Returns Token

    Token of subscription

onMouseUp

  • Subscribe to Mouse Up event

    Parameters

    Returns Token

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

  • Restore all sub-elements of custom tick

    Returns this

    This for fluent interface

restoreMarker

  • restoreMarker(): this

  • Place Marker back to rendering collection, so it became visible again

    Returns this

    Object itself for fluent interface

setGridStrokeLength

  • setGridStrokeLength(length: number): this

  • Set length of grid stroke in percents

    Parameters

    • length: number

      Grid line length as a % of viewport size

    Returns this

    This for fluent interface

setGridStrokeStyle

  • Parameters

    Returns this

    This for fluent interface

setMarker

  • Mutator function for the TickMarker

    Parameters

    Returns this

    Object itself for fluent interface

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

setSidePaddings

  • setSidePaddings(padding: pixel): this

  • Set padding on sides of label

    Parameters

    • padding: pixel

      Distance in pixels

    Returns this

    Object itself for fluent interface

setTextFormatter

  • Set text of CustomTicks' Marker with a formatting function.

    Example usage:

    Desired result Argument
    Marker shows formatted position of CustomTick on its Axis (position, customTick) => customTick.axis.formatValue(position)
    Marker shows 'Hello world' (position, customTick) => 'Hello world'

    Parameters

    • textFormatter: CustomTickTextFormatter

      A function of type: CustomTickTextFormatter, that defines text of CustomTicks' Marker.

    Returns this

    Object itself

setValue

  • setValue(value: number): this

  • Sets the position of this custom tick on its Axis

    sideeffect

    Overrides text of CustomTicks Marker with formated value.

    Parameters

    • value: number

      Value in the units of main scale

    Returns this

    This for fluid interface