Readonly boundariesReadonly dimensionReadonly endReadonly lowerReadonly lowerReadonly medianReadonly scaleReadonly startReadonly upperReadonly upperPermanently 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
Subscribe onDispose event.
This event is triggered whenever the object is disposed.
// Example usage
Figure.onDispose(() => {
console.log('Figure was disposed')
})
Figure.dispose()
Token of subscription
Subscribe to highlight object event. This is called whenever an object is highlighted.
Token that can be used to unsubscribe from the event.
Subscribe to Mouse Click event
Token-object that is a reference ID to the listener created.
Function that will be called when mouse clicks the bounds of UiObject.
Subscribe to Mouse Double Click event
Subscribe to Mouse Down event
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Subscribe to Mouse Enter event
Token-object that is a reference ID to the listener created.
Function that will be called when mouse enters the bounds of UiObject.
Subscribe to Mouse Leave event
Token-object that is a reference ID to the listener created.
Function that will be called when mouse leaves the bounds of UiObject.
Subscribe to Mouse Move event
Token of subscription
Event handler function
Subscribe to Mouse Up event
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
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.