Protected _modelRotation of the model in radians.
Protected _modelRotation of the model in quaternion.
Protected _shadingParse material string for surface rendering information. Support just colors, not textures or other material properties.
Object itself for fluent interface.
Optional materialSource: stringMaterial source.
Add 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.
Attach object to an legendBox entry
Series itself for fluent interface
Object which has to be attached
Flag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.
By default, entries are assigned a smooth looking gradient based on the component color. If this flag is true, then this is skipped, and exact component solid fill is used instead.
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.
Beta
Get override behavior for when this series is formatted to be displayed by a cursor.
Override callback or undefined
Introduced in v6.0.0, the state and definition of this API is not finalized. It may change in future versions without regard to backwards compatibility if there is significant cause from user feedback.
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 MeshModel3D.
Supports following FillStyles:
FillStyle object.
Get rotation of the model.
Rotation of the model in format {x, y, z}.
Deprecated in v6.1.0, splitted into getModelRotationEuler and getModelRotationQuaternion
Get rotation of the model.
This returns value exactly as set using setModelRotationEuler. If rotation was configured with setModelRotationQuaternion this does NOT return correct values!
Rotation of the model in format { x, y, z } in radians.
Get rotation of the model.
This returns value exactly as set using setModelRotationQuaternion. If rotation was configured with setModelRotationEuler this does NOT return correct values!
Rotation of the model in format { w, x, y, z }.
Get boolean flag that is true when a Pointer device is over the chart component.
In order for this method to work, the components pointer event tracking must be enabled (getPointerEvents)
Boolean
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 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 BackfaceCullingMode of MeshModel3D.
Object itself.
// Example of setting BackfaceCullingMode
series.setBackfaceCullingMode('disabled')
BackfaceCullingMode
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.
Configure whether cursors should pick on this particular series or not.
// Example, prevent chart auto cursor from snapping to a series.
LineSeries.setCursorEnabled(false)
Related API:
Beta
Set override behavior for when this series is formatted to be displayed by a cursor. This can be used to alter and expand on cursor formatting done for a specific series, either by the library's default cursor formatters or even the users own cursor formatters defined on chart level.
// Example syntax, add extra row to display a custom data property
series.setCursorFormattingOverride((hit, before) => {
if (!isHitSampleXY(hit)) return before
const customPropertyValue = data[hit.iSample].customProperty
return [...before, ['ASD', '', customPropertyValue.toFixed(3)]]
})
To use this with users own cursor formatters, you can use useCursorFormatterSeriesOverride:
// Example syntax, define custom cursor formatting with support for series overrides
chart.setCursorFormatting((_, __, hits) => {
return [
[hits[0].axisX.formatValue(hits[0].x)],
...hits.map((hit) => useCursorFormatterSeriesOverride(hit, [['Y:', '', hit.axisY.formatValue(hit.y)]])).flat(),
]
})
Object itself.
Introduced in v6.0.0, the state and definition of this API is not finalized. It may change in future versions without regard to backwards compatibility if there is significant cause from user feedback.
Override callback or undefined
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 model fill style. This will override material set with setModelMaterial, if it was called before.
Can be either SolidFill for solid coloring, or PalettedFill for coloring per-vertex based on values assigned using setVertexValues.
// Example, solid coloring
MeshModel3D.setFillStyle(new SolidFill({ color: ColorRGBA(255, 0, 0) }))
// Example, dynamic per-vertex coloring (from random data, probably doesn't look too good)
MeshModel3D
.setFillStyle(
new PalettedFill({
lut: new LUT({
interpolate: true,
steps: [
{ value: 0, color: ColorRGBA(0, 0, 0) },
{ value: 1, color: ColorRGBA(255, 0, 0) },
],
}),
})
)
.setVertexValues((vertexLocations) => vertexLocations.map((location) => Math.random()))
See more practical examples of per-vertex coloring in our interactive examples gallery.
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 setPointerEvents for more information.
Object itself for fluent interface.
True if highlighting on mouse hover, false if no highlight on mouse hover
Beta
Set icon of the chart component. This is displayed in legends and by default cursor formatters.
const image = new Image()
image.src = 'image.png'
const icon = chart.engine.addCustomIcon(image)
ChartComponent.setIcon(icon)
Object itself.
Released as beta feature in v5.2.0 feature may still change according to user feedback and experiences.
Icon
Set alignment of the model. Describes which "corner" of the model is positioned at model location (setModelLocation).
Object itself.
Alignment of the model. Units in range [-1, 1].
Set model geometry from object file content.
i.e. data parameter should be contents of a OBJ formatted text file.
Object itself for fluent interface.
Obj file content.
Method for loading already triangulated 3D model geometry data.
To supply OBJ file content directly use setModelFromObj instead.
As an example, you can use the open-source NPM library webgl-obj-loader to process .OBJ formatted files (supported by almost every 3D Modeling software out there):
// npm i webgl-obj-loader
import { Mesh } from 'webgl-obj-loader'
// Import .obj file as text
const modelOBJ = require('brain.obj').default
const modelParsed = new Mesh(modelOBJ)
const chart3D = lightningChart().Chart3D()
const modelSeries = chart3D.addMeshModel()
.setModelGeometry({
vertices: modelParsed.vertices,
indices: modelParsed.indices,
normals: modelParsed.vertexNormals,
})
Object itself.
Object containing triangulated 3D model geometry.
Set location of the model.
// Example of setting location of the model
series.setModelLocation({ x: 0, y: 10, z: 0 })
Object itself.
Location in axis coordinates
Set model material. This will override style set with setFillStyle, if it was called before.
Object itself for fluent interface.
Obj material file content as text.
Set rotation of the model.
Object itself.
// Example of setting rotation of the model
series.setModelRotation({ x: 0, y: 0, z: 90 })
Deprecated in v6.1.0, splitted into setModelRotationEuler and setModelRotationQuaternion
Rotation of the model in degrees
Set rotation of the model.
Object itself.
// Example of setting rotation of the model
series.setModelRotationEuler({ x: 0, y: 0, z: 90 })
Rotation of the model in degrees
Set rotation of the model.
// Example of setting rotation of the model
series.setModelRotationQuaternion({ w:1 ,x: 0, y: 0, z: 0 })
Object itself.
Rotation of the model in quaternion
Sets the name of the Component updating attached LegendBox entries
Object itself
Name of the Component
Set whether element can be target of pointer events or not.
Disabling pointer events means that the objects below this component can be interacted through it.
Object itself for fluent interface
Specifies state of mouse interactions
Set scale of the model.
series.setScale(0.1)
series.setScale({ x: 0.1, y: 3, z: 1 })
Object itself.
number for symmetric scale multiplier or object with separate scale multipliers for x, y, z..
Assign number values to each vertex of the model. This can be used for dynamic coloring of the model, when paired with PalettedFill.
// Example, dynamic per-vertex coloring (from random data, probably doesn't look too good)
MeshModel3D
.setFillStyle(
new PalettedFill({
lut: new LUT({
interpolate: true,
steps: [
{ value: 0, color: ColorRGBA(0, 0, 0) },
{ value: 1, color: ColorRGBA(255, 0, 0) },
],
}),
})
)
.setVertexValues((vertexLocations) => vertexLocations.map((location) => Math.random()))
See more practical examples of per-vertex coloring in our interactive examples gallery.
The user supplies a function which is called back with an array of the active Models vertex locations transformed to 3D World coordinates (which can be further translated to axes). This callback function is then used to return a number array which should have a number for every vertex in the model.
The transformation between Model coordinates and World coordinates is invalidated by many effects, like model scale, location, alignment or rotation changing.
After these events it may be necessary to reapply coloring by calling setVertexValues again.
Again, please refer to our online examples for more practical information.
Object itself.
Callback function that supplies the user with array of vertex locations in World coordinate system and expects a number array with same length to be returned.
Set element visibility.
Object itself.
true when element should be visible and false when element should be hidden.
Match legend entry style to reflect components own style.
By default, entries are assigned a smooth looking gradient based on the component color. If this flag is true, then this is skipped, and exact component solid fill is used instead.
3D Series for rendering a 3D object model within a Chart3D.
Creating MeshModel3D:
MeshModel3Dare created with addMeshModel method.Frequently used methods: