Attach object to an legendBox entry
Object which has to be attached
Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.
Series itself for fluent interface
Tell the owning chart to remove this component.
Object itself.
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 the currently used ColorShadingStyle.
The Color Shading Style for the series.
Get 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.
Depth test enabled?
Get FillStyle of BoxSeries.
Supports following FillStyles:
look up table.
FillStyle object.
Get boolean flag for whether object should highlight on mouse hover
Boolean for if object should highlight on mouse hover or not.
the state of highlighted flag
Get boolean flag for whether object is currently under mouse or not
Boolean for is object under mouse currently
Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.
Mouse interactions state
Get the name of the Component.
The name of the Component.
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.
Max X value of the series
Min X value of the series
Max Y value of the series
Min Y value of the series
Max Z value of the series
Min Z value of the series
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:
but only when the BoxSeries is styled as IndividualPointFill
Look-up value to be used when the BoxSeries is styled as PalettedFill.
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:
but only when the BoxSeries is styled as IndividualPointFill
Look-up value to be used when the BoxSeries is styled as PalettedFill.
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)
TODO: True for enabled and false for disabled
Unsubscribe from Highlight object event. This is called whenever an object is highlighted
Token that was received when subscribing to the event.
True if the unsubscription was successful.
Remove event listener from Mouse Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Double Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Down Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Stop Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Enter Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Leave Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Up Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Wheel Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch End Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Subscribe to highlight object event. This is called whenever an object is highlighted.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
Add event listener to Mouse Click Event
Event listener for Mouse Click Event
Token of the event listener
Add event listener to Mouse Double Click Event
Event listener for Mouse Double Click Event
Token of the event listener
Add event listener to Mouse Down Event
Event listener for Mouse Down Event
Token of the event listener
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Event listener for Mouse Enter Event
Token of the event listener
Add event listener to Mouse Leave Event
Event listener for Mouse Leave Event
Token of the event listener
Add event listener to Mouse Move Event
Event listener for Mouse Move Event
Token of the event listener
Add event listener to Mouse Up Event
Event listener for Mouse Up Event
Token of the event listener
Subscribe to Mouse Wheel event
Event handler function
Token of subscription
Subscribe to Touch End event
Event handler function
Token of subscription
Subscribe to Touch Move event
Event handler function
Token of subscription
Subscribe to Touch Start event
Event handler function
Token of subscription
Tell the owning chart to restore this component.
Object itself.
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)
true default, axes will take series into account in scrolling and fitting operations.
false, axes will ignore series boundaries.
Object itself for fluent interface.
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)
}))
Color shading style to use for this series.
Object itself for fluent interface.
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)
Depth test enabled?
Object itself for fluent interface.
Set FillStyle of BoxSeries.
Supports following FillStyles:
look up table.
FillStyle or function which creates a FillStyle based on previous value.
Object itself.
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.
True if highlighting on mouse hover, false if no highlight on mouse hover
Object itself for fluent interface.
Enable or disable forced highlighting of component
True for enabled and false for disabled
component itself for fluent interface
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:
Specifies state of mouse interactions
Object itself for fluent interface
Sets the name of the Component updating attached LegendBox entries
Name of the Component
Object itself
Set 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 to disable rounded edges.
Object itself for fluent interface.
Class for visualization of large sets of individually configurable 3D Boxes.
Add data with BoxSeries3D.invalidateData.
Style boxes with BoxSeries3D.setFillStyle.
Example usage:
// Construct a grid of vertical boxes. const data = [ { x: 0, z: 0 }, { x: 1, z: 0 }, { x: 0, z: 1 }, { x: 1, z: 1 } ] // Map coords into **BoxData**. .map( coords => { const height = Math.random() * 100 return { xCenter: coords.x, yCenter: height / 2, zCenter: coords.z, xSize: 1, ySize: height, zSize: 1 } }) const chart = lightningChart().Chart3D() const boxSeries = chart.addBoxSeries() .invalidateData( data )Color shading style.
By default,
BoxSeries3Duses Phong shading style.This can be changed with
BoxSeries3D.setColorShadingStyle(new ColorShadingStyles.Simple())