Permanently destroy the component.
Object itself for fluent interface.
NOTE: Internal method, usage is not encouraged.
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.
Boolean that describes whether drawing the theme effect is enabled around the component or not.
Get mouse style.
Interface for defining how mouse should look when hovering over UI object
NOTE: Usage is not encouraged, please use getTickLength
Get font of Label.
FontSettings
NOTE: Usage is not encouraged, please use getTickLabelPadding
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()
Token of subscription
Handler function for event
Subscribe on Mouse Enter click
Token of subscription
Event handler function
Subscribe to Mouse Double Click event
Token of subscription
Event handler function
Subscribe to Mouse Down event
Token of subscription
Event handler function
Subscribe to Mouse Drag event
Token of subscription
Event handler function
Subscribe to Mouse Drag Start event
Token of subscription
Event handler function
Subscribe to Mouse Drag Stop event
Token of subscription
Event handler function
Subscribe on Mouse Enter event
Token of subscription
Event handler function
Subscribe on Mouse Enter leave
Token of subscription
Event handler function
Subscribe to Mouse Move event
Token of subscription
Event handler function
Subscribe to Mouse Up event
Token of subscription
Event handler function
Subscribe to Mouse Wheel event
Token of subscription
Event handler function
Subscribe to Touch End event
Token of subscription
Event handler function
Subscribe to Touch Move event
Token of subscription
Event handler function
Subscribe to Touch Start event
Token of subscription
Event handler function
NOTE: Internal method, usage is not encouraged.
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.
Object itself.
Theme effect enabled
Set margin around object in pixels.
Object itself
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.
Set mouse interactions enabled or disabled
Object itself for fluent interface
Specifies state of mouse interactions
Set mouse style when hovering over UI object.
Object itself
Interface for defining how mouse should look when hovering over UI object
NOTE: Usage is not encouraged, please use setTickLength
Set text fill style object
Object itself for fluent interface
Fill style object or function which modifies it
Set font of Label.
Object itself
FontSettings or mutator function for existing settings
Set rotation of Label.
Object itself
NOTE: Usage is not encouraged, please use setTickLabelPadding
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 setMarker method, using a callback function: