Get element visibility.
true when element is set to be visible and false otherwise.
Remove event listener from visibleStateChanged
Register new event listener to visibleStateChanged event
Set element visibility.
true when element should be visible and false when element should be hidden.
Permanently destroy the component.
Object itself for fluent interface.
Get font of custom ticks text.
FontSettings
Unsubscribe from value change event.
This event is called whenever the position of the CustomTick is changed via CustomTick.setValue.
True if unsubscription was successful.
Token that was received when the subscription was created.
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 to value change event. This event is triggered when setValue is called.
Example usage:
// Set onValueChange event
CustomTick.onValueChange((_, num) => {
console.log(num)
})
// Set customTick value
CustomTick.setValue(20)
Token that can be used to unsubscribe from the event.
Function that is called when event is triggered.
Set style of custom ticks gridline. This line highlights the tick location under the series area.
// Example syntax, specify LineStyle
CustomTick3D.setGridStrokeStyle(new SolidLine({
thickness: 2,
fillStyle: new SolidFill({ color: ColorHEX('#F00') })
}))
// Example syntax, change thickness only
CustomTick3D.setGridStrokeStyle((stroke) => new SolidLine({ ...stroke, thickness: 5 }))
// Example syntax, disable stroke
CustomTick3D.setGridStrokeStyle(emptyLine)
Object itself.
LineStyle or function which returns a LineStyle based on previous value.
Set fill style of custom ticks text.
// Example syntax, red fill
CustomTick3D.setTextFillStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
// Example syntax, disable fill
CustomTick3D.setTextFillStyle(emptyFill)
Object itself.
FillStyle or function which returns a FillStyle based on previous value.
Set font of custom ticks text.
// Example syntax, specify FontSettings
CustomTick3D.setTextFont(new FontSettings({
size: 14,
family: 'Arial',
weight: 'normal',
}))
// Example syntax, change to italic
CustomTick3D.setTextFont(font => font.setStyle('italic'))
To remove custom tick text, use setTextFillStyle
Object itself.
FontSettings or function which returns a FontSettings based on previous value.
Set text formatting of custom tick as a callback function.
// Example usage
CustomTick3D.setTextFormatter((value) => `Custom tick at ${value.toFixed(1)}`)
The supplied callback function is called with the current axis location of the custom tick.
To provide hard defined text, just ignore the value.
// Example, hard defined custom tick text.
CustomTick3D.setTextFormatter(() => `My tick text`)
Object itself
Callback function which returns custom tick text as string.
Set padding between CustomTick tickline and text.
// Example usage
CustomTick3D.setTextPadding(5)
Object itself
Padding as pixels
Set custom tick text rotation as degrees.
// Example usage
CustomTick3D.setTextRotation(90)
Object itself
Rotation as degrees.
Set tickline length as pixels.
// Example usage
CustomTick3D.setTickLength(5)
Object itself
Tickline length as pixels
Set style of custom ticks tickline. This line connects the text to its Axis, generally a very short line (6 pixels, or so).
// Example syntax, specify LineStyle
CustomTick3D.setTickStyle(new SolidLine({
thickness: 2,
fillStyle: new SolidFill({ color: ColorHEX('#F00') })
}))
// Example syntax, change thickness only
CustomTick3D.setTickStyle((stroke) => new SolidLine({ ...stroke, thickness: 5 }))
// Example syntax, disable stroke
CustomTick3D.setTickStyle(emptyLine)
Object itself.
LineStyle or function which returns a LineStyle based on previous value.
Set location of custom tick on its Axis.
// Example usage
CustomTick3D.setValue(5)
Object itself
Location on axis.
End user managed 3D Axis Tick. Custom ticks are just like default ticks, except they can be completely controlled by the end user.
For example, their position, text, text fill style, gridline style, etc. everything can be customized. They can be created whenever and destroyed whenever.
They are created with addCustomTick method, and destroyed with dispose method.
Default 3D Axis ticks can be hidden by selecting empty tick strategy.