Interface UITick

UIElement that looks like an Axis tick (tick line + label) and can be used as an Axis CustomTick Marker, by passing its builder as an argument to addCustomTick:

 // Specify builder for CustomTick Marker.
 const customTick = Axis.addCustomTick(UIElementBuilders.AxisTickMajor)

 // TickMarker can be accessed via mutator method of CustomTick.
 customTick.setMarker((marker: UITick) => marker
     // ... do stuff
 )

Hierarchy

Methods

dispose

dispose(): UITick
Permanently destroy the component.

Returns
Object itself for fluent interface.

Returns UITick

Inherited from UIPart.dispose

getDirection

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

Returns UIDirections

Inherited from Pointable.getDirection

getEffect

getEffect(): boolean
Get theme effect enabled on component or disabled.

A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.
```
 // Example, disable theme effect from a particular component.
 Component.setEffect(false)
```
For the most part, theme effects are enabled by default on most components.

Theme effect is configured with effect property.

Returns
Boolean that describes whether drawing the theme effect is enabled around the component or not.
Returns boolean

Inherited from UIPart.getEffect

getMargin

getMargin(): Margin
Get margin around object in pixels.

Returns
Margin datastructure

Returns Margin

Inherited from UIPart.getMargin

getMouseInteractions

getMouseInteractions(): boolean
Returns
Mouse interactions state

Returns boolean

Inherited from UIPart.getMouseInteractions

getMouseStyle

getMouseStyle(): UIMouseStyle
Get mouse style.

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

Returns UIMouseStyle

Inherited from UIPart.getMouseStyle

getPointerLength

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

Returns number

Inherited from Pointable.getPointerLength

getText

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

Returns
The entire text string.

Returns string

Inherited from CustomizableText.getText

getTextFillStyle

getTextFillStyle(): FillStyle
Returns
Current text fill style object

Returns FillStyle

Inherited from CustomizableText.getTextFillStyle

getTextFont

getTextFont(): FontSettings
Get font of Label.

Returns
FontSettings

Returns FontSettings

Inherited from CustomizableText.getTextFont

getTextRotation

getTextRotation(): number
Get rotation of Label.

Returns
Rotation in degrees

Returns number

Inherited from CustomizableText.getTextRotation

getTickLabelPadding

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

Returns number

Inherited from Pointable.getTickLabelPadding

getTickStyle

getTickStyle(): LineStyle
Get tick line style.

Returns
LineStyle.

Returns LineStyle

offDispose

offDispose(token: Token): boolean
Remove event listener from dispose event.

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offDispose

offMouseClick

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseClick

offMouseDoubleClick

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseDoubleClick

offMouseDown

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseDown

offMouseDrag

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseDrag

offMouseDragStart

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseDragStart

offMouseDragStop

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseDragStop

offMouseEnter

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseEnter

offMouseLeave

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseLeave

offMouseMove

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseMove

offMouseUp

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseUp

offMouseWheel

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offMouseWheel

offTouchEnd

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offTouchEnd

offTouchMove

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offTouchMove

offTouchStart

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from UIPart.offTouchStart

onDispose

onDispose(handler: (() => unknown)): Token
Subscribe to onDispose event. This event is triggered whenever the object is disposed.

A component can only be disposed by the end user, by calling the dispose method on the component or the component which owns it.
```
 // Example usage

Dashboard.onDispose(() => {
  console.log('Dashboard was disposed')
})

Dashboard.dispose()
```
Returns
Token of subscription
Parameters
- handler: (() => unknown)
  
  Handler function for event
  - - (): unknown
    - Returns unknown
Returns Token

Inherited from UIPart.onDispose

onMouseClick

onMouseClick(listener: MouseEventHandler<UITick>): Token
Subscribe on Mouse Enter click

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseClick

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<UITick>): Token
Subscribe to Mouse Double Click event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseDoubleClick

onMouseDown

onMouseDown(listener: MouseEventHandler<UITick>): Token
Subscribe to Mouse Down event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseDown

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<UITick>): Token
Subscribe to Mouse Drag event

Returns
Token of subscription
Parameters
- listener: MouseDragEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseDrag

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<UITick>): Token
Subscribe to Mouse Drag Start event

Returns
Token of subscription
Parameters
- listener: MouseDragStartEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseDragStart

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<UITick>): Token
Subscribe to Mouse Drag Stop event

Returns
Token of subscription
Parameters
- listener: MouseDragStopEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseDragStop

onMouseEnter

onMouseEnter(listener: MouseEventHandler<UITick>): Token
Subscribe on Mouse Enter event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseEnter

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<UITick>): Token
Subscribe on Mouse Enter leave

Returns
Token of subscription
Parameters
- listener: AbruptMouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseLeave

onMouseMove

onMouseMove(listener: MouseEventHandler<UITick>): Token
Subscribe to Mouse Move event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseMove

onMouseUp

onMouseUp(listener: MouseEventHandler<UITick>): Token
Subscribe to Mouse Up event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseUp

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<UITick>): Token
Subscribe to Mouse Wheel event

Returns
Token of subscription
Parameters
- listener: MouseWheelEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onMouseWheel

onTouchEnd

onTouchEnd(listener: TouchEventHandler<UITick>): Token
Subscribe to Touch End event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onTouchEnd

onTouchMove

onTouchMove(listener: TouchEventHandler<UITick>): Token
Subscribe to Touch Move event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onTouchMove

onTouchStart

onTouchStart(listener: TouchEventHandler<UITick>): Token
Subscribe to Touch Start event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<UITick>
  
  Event handler function
Returns Token

Inherited from UIPart.onTouchStart

setDirection

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

Inherited from Pointable.setDirection

setEffect

setEffect(enabled: boolean): UITick
Set theme effect enabled on component or disabled.

A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.
```
 // Example, disable theme effect from a particular component.
 Component.setEffect(false)
```
For the most part, theme effects are enabled by default on most components.

Theme effect is configured with effect property.

Returns
Object itself.
Parameters
- enabled: boolean
  
  Theme effect enabled
Returns UITick

Inherited from UIPart.setEffect

setMargin

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

Returns
Object itself
Parameters
- margin: number | Partial<MMargin>
  
  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 UITick

Inherited from UIPart.setMargin

setMouseInteractions

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

Returns
Object itself for fluent interface
Parameters
- state: boolean
  
  Specifies state of mouse interactions
Returns UITick

Inherited from UIPart.setMouseInteractions

setMouseStyle

setMouseStyle(mouseStyle: UIMouseStyle): UITick
Set mouse style when hovering over UI object.

Returns
Object itself
Parameters
- mouseStyle: UIMouseStyle
  
  Interface for defining how mouse should look when hovering over UI object
Returns UITick

Inherited from UIPart.setMouseStyle

setPointerLength

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

Inherited from Pointable.setPointerLength

setText

setText(text: string): UITick
Set the text of the entire shape.
Parameters
- text: string
  
  Text string.
Returns UITick

Inherited from CustomizableText.setText

setTextFillStyle

setTextFillStyle(value: FillStyle | ImmutableMutator<FillStyle, FillStyle>): UITick
Set text fill style object

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

Inherited from CustomizableText.setTextFillStyle

setTextFont

setTextFont(value: FontSettings | ImmutableMutator<FontSettings, FontSettings>): UITick
Set font of Label.

Returns
Object itself
Parameters
- value: FontSettings | ImmutableMutator<FontSettings, FontSettings>
  
  FontSettings or mutator function for existing settings
Returns UITick

Inherited from CustomizableText.setTextFont

setTextRotation

setTextRotation(rotation: number): UITick
Set rotation of Label.

Returns
Object itself
Parameters
- rotation: number
Returns UITick

Inherited from CustomizableText.setTextRotation

setTickLabelPadding

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

Inherited from Pointable.setTickLabelPadding

setTickStyle

setTickStyle(value: LineStyle | ImmutableMutator<LineStyle, LineStyle>): UITick
Set tick line style.

Returns
Object itself for fluent interface.
Parameters
- value: LineStyle | ImmutableMutator<LineStyle, LineStyle>
  
  LineStyle or function that modifies current LineStyle value.
Returns UITick

Interface UITick

Hierarchy

Index

Methods

Methods

dispose

Returns

Returns UITick

getDirection

Returns UIDirections

getEffect

Returns

Returns boolean

getMargin

Returns

Returns Margin

getMouseInteractions

Returns

Returns boolean

getMouseStyle

Returns

Returns UIMouseStyle

getPointerLength

Returns number

getText

Returns

Returns string

getTextFillStyle

Returns

Returns FillStyle

getTextFont

Returns

Returns FontSettings

getTextRotation

Returns

Returns number

getTickLabelPadding

Returns number

getTickStyle

Returns

Returns LineStyle

offDispose

Returns

Parameters

token: Token

Returns boolean

offMouseClick

Returns

Parameters

token: Token

Returns boolean

offMouseDoubleClick

Returns

Parameters

token: Token

Returns boolean

offMouseDown

Returns

Parameters

token: Token

Returns boolean

offMouseDrag

Returns

Parameters

token: Token

Returns boolean

offMouseDragStart

Returns

Parameters

token: Token

Returns boolean

offMouseDragStop

Returns

Parameters

token: Token

Returns boolean

offMouseEnter

Returns

Parameters

token: Token