Protected _shadingAttach object to an legendBox entry
Series itself for fluent interface
Object which has to be attached
Optional toggleVisibilityOnClick: booleanFlag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.
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
Get whether series is taken into account with automatic scrolling and fitting of attached axes.
By default, this is true for all series.
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
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 FillStyle of BoxSeries.
Supports following FillStyles:
FillStyle object.
Get rounded edges of Boxes.
NOTE: Rounded edges result in increased geometry precision, which in turn uses more rendering resources.
Either a number in range [0, 1] describing the amount of rounding or undefined for disabled rounded edges.
Method for invalidating Box data. Accepts an Array of BoxDataCentered objects.
Properties that must be defined for each NEW Box:
( if altering a previously created Box, these are not necessary )
Optional properties:
Example usage:
BoxSeries3D.invalidateData([
{ xCenter: 0, yCenter: 0, zCenter: 0, xSize: 1, ySize: 1, zSize: 1 }
])
const id = "anything-unique"
BoxSeries3D
.setFillStyle( new IndividualPointFill() )
.invalidateData([
{ id, xCenter: 0, yCenter: 0, zCenter: 0, xSize: 1, ySize: 1, zSize: 1 }
])
setTimeout(() => {
BoxSeries3D.invalidateData([ { id, color: ColorRGBA( 0, 255, 0 ) } ])
}, 2000)
Method for invalidating Box data. Accepts an Array of BoxDataBounds objects.
NOTE: Internally transforms all data into BoxDataCentered format, meaning that this method is slightly slower than the alternative.
Properties that must be defined for each NEW Box:
( if altering a previously created Box, these are not necessary )
Optional properties:
Example usage:
BoxSeries3D.invalidateData([
{ xMin: 0, yMin: 0, zMin: 0, xMax: 1, yMax: 1, zMax: 1 }
])
const id = "anything-unique"
BoxSeries3D
.setFillStyle( new IndividualPointFill() )
.invalidateData([
{ id, xMin: 0, yMin: 0, zMin: 0, xMax: 1, yMax: 1, zMax: 1 }
])
setTimeout(() => {
BoxSeries3D.invalidateData([ { id, color: ColorRGBA( 0, 255, 0 ) } ])
}, 2000)
Subscribe onDispose event.
This event is triggered whenever the ChartComponent is disposed.
// Example usage
lineSeries.onDispose(() => {
console.log('lineSeries was disposed')
})
lineSeries.dispose()
Token of subscription
Event handler function
Subscribe to highlight object event. This is called whenever an object is highlighted.
Token that can be used to unsubscribe from the event.
Function that is called when event is triggered.
Add event listener to Mouse Click Event
Token of the event listener
Event listener for Mouse Click Event
Add event listener to Mouse Double Click Event
Token of the event listener
Event listener for Mouse Double Click Event
Add event listener to Mouse Down Event
Token of the event listener
Event listener for Mouse Down Event
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Token of the event listener
Event listener for Mouse Enter Event
Add event listener to Mouse Leave Event
Token of the event listener
Event listener for Mouse Leave Event
Add event listener to Mouse Move Event
Token of the event listener
Event listener for Mouse Move Event
Add event listener to Mouse Up Event
Token of the event listener
Event listener for 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
Register new event listener to visibleStateChanged event.
Event listener for visibleStateChanged
Set component highlight animations enabled or not. For most components this is enabled by default.
// Example usage, disable highlight animations.
component.setAnimationHighlight(false)
Object itself
Animation enabled?
Set whether series is taken into account with automatic scrolling and fitting of attached axes.
By default, this is true for all series.
By setting this to false, any series can be removed from axis scrolling/fitting.
// Example syntax, remove series from automatic scrolling / fitting.
LineSeries.setAutoScrollingEnabled(false)
Object itself for fluent interface.
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
Set Color Shading Style for series.
Shading style changes the visual style of the rendering. See ColorShadingStyles for available shading styles.
Use Simple color shading style:
series3D.setShadingStyle(new ColorShadingStyles.Simple())
Use Phong color shading style:
series3D.setShadingStyle(new ColorShadingStyles.Phong())
Configuring specular highlight for Phong shading style:
series3D.setShadingStyle(new ColorShadingStyles.Phong({
specularReflection: 0.5,
specularColor: ColorRGBA(255, 255, 255)
}))
Object itself for fluent interface.
Color shading style to use for this series.
Set 3D depth test enabled for this series.
By default this is enabled, meaning that any series that is rendered after this series and is behind this series will not be rendered.
Can be disabled to alter 3D rendering behavior.
// Example syntax, disable depth test.
pointSeries3D.setDepthTestEnabled(false)
Object itself for fluent interface.
Depth test enabled?
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 FillStyle of BoxSeries.
Supports following FillStyles:
Object itself.
FillStyle or function which creates a FillStyle based on previous value.
Set state of component highlighting.
// Example usage
component.setHighlight(true)
component.setHighlight(0.5)
If highlight animations are enabled (which is true by default), the transition will be animated. As long as the component is highlighted, the active highlight intensity will be animated continuously between 0 and the configured value. Highlight animations can be disabled with setAnimationHighlight
Object itself
Boolean or number between 0 and 1, where 1 is fully highlighted.
Set highlight on mouse hover enabled or disabled.
Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.
Object itself for fluent interface.
True if highlighting on mouse hover, false if no highlight on mouse hover
Set component mouse interactions enabled or disabled.
Disabling mouse interactions means that the objects below this component can be interacted through it.
Possible side-effects from disabling mouse interactions:
Object itself for fluent interface
Specifies state of mouse interactions
Sets the name of the Component updating attached LegendBox entries
Object itself
Name of the Component
Set rounded edges of Boxes.
NOTE: Rounded edges result in increased geometry precision, which in turn uses more rendering resources.
Object itself for fluent interface.
Either a number in range [0, 1] describing the amount of rounding or undefined to disable rounded edges.
Set element visibility.
Object itself.
true when element should be visible and false when element should be hidden.
Class for visualization of large sets of individually configurable 3D Boxes.
Add data with invalidateData.
Style boxes with setFillStyle.
Example usage:
Color shading style.
By default,
BoxSeries3Duses Phong shading style.This can be changed with
BoxSeries3D.setColorShadingStyle(new ColorShadingStyles.Simple())