Readonly boundariesReadonly dimensionReadonly endReadonly lowerReadonly lowerReadonly medianReadonly scaleReadonly startReadonly upperReadonly upperAdd callback function to be triggered when specified event is fired.
// Example syntax
object.addEventListener('click', (event) => {
console.log(event)
})
Some classes also report extra information about the interacted object with the second parameter:
// Most series share information about interacted data point
series.addEventListener('click', (event, info) => {
console.log(info)
})
Optional third parameter allows registering event handlers that will automatically remove themselves after first trigger:
// Example this listener will only fire once
object.addEventListener('click', (event) => {})
Each class has its own list of supported events.
Some events are from HTML standard (click, pointerdown, etc.),
while others are own events from LightningChart JS (dispose, resize, etc.)
To find what events are available, you can try following:
TypeScript enabled, just write addEventListener and see what possible event types the IDE suggests. These APIs are strongly typed, and even the callback event will be correctly typed.K type parameter extends.Callback function that is triggered when event is fired.
Optional options: LCJSAddEventListenerOptionsOptional extra configuration options.
Permanently destroy the component.
To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.
let chart = ...ChartXY()
let axisX = chart.getDefaultAxisX()
// Dispose Chart, and remove all references so that they can be garbage-collected.
chart.dispose()
chart = undefined
axisX = undefined
Object itself for fluent interface
Remove event listener added using addEventListener.
The expected argument should be the exact same callback function that was supplied using addEventListener:
// Basic example syntax
const listener = () => {}
obj.addEventListener('click', listener)
obj.removeEventListener('click', listener)
// Basic boilerplate of custom interaction when user drags on an object
obj.addEventListener('pointerdown', (eventDown) => {
let prevCoord = eventDown
const handlePointerMove: LCJSInteractionEventListener<'pointermove'> = (eventMove) => {
const delta = { x: eventMove.clientX - prevCoord.clientX, y: eventMove.clientY - prevCoord.clientY }
prevCoord = eventMove
console.log(delta, eventMove.clientX, eventMove.clientY)
}
const handlePointerUp: LCJSInteractionEventListener<'pointerup'> = (eventUp) => {
window.removeEventListener('pointermove', handlePointerMove)
window.removeEventListener('pointerup', handlePointerUp)
}
window.addEventListener('pointermove', handlePointerMove)
window.addEventListener('pointerup', handlePointerUp)
})
Listener that was added using addEventListener.
Set fill style of Series.
Example Usage:
// Specified FillStyle
BoxAndWhiskers.setBodyFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
// Changed transparency
BoxAndWhiskers.setBodyFillStyle((solidFill) => solidFill.setA(80))
// Hidden (emptyFill is not supported)
BoxAndWhiskers.setBodyFillStyle(transparentFill)
Series itself for fluent interface.
FillStyle which has to be used for recoloring or mutator to modify existing one.
Set border style of Series.
// Specified SolidLine
BoxAndWhiskers.setBodyStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
BoxAndWhiskers.setBodyStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
BoxAndWhiskers.setBodyStrokeStyle(transparentLine)
Series itself for fluent interface.
LineStyle which has to be used for recoloring or mutator to modify existing one.
Set stroke style of Series median line.
Example usage:
// Specified LineStyle
BoxAndWhiskers.setMedianStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
BoxAndWhiskers.setMedianStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
BoxAndWhiskers.setMedianStrokeStyle(transparentLine)
Chart itself
Either a LineStyle object or a function, which will be used to create a new LineStyle based on current value.
Set stroke style of Series whiskers and tails.
Supported line styles:
Example usage:
// Specified LineStyle
BoxAndWhiskers.setStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
BoxAndWhiskers.setStrokeStyle((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
BoxAndWhiskers.setStrokeStyle(transparentLine)
Chart itself
Either a LineStyle object or a function, which will be used to create a new LineStyle based on current value.
Boundaries of BoxFigure. Constant and computed in constructor.