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.
Object itself for fluent interface
Clear all previously pushed data points from the series.
// Example usage
LineSeries.clear()
Object 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 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 normal line style (not highlighted).
LineSeriesStyle3D
Get highlight style of line.
LineSeriesStyle3D
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 amount of points that series currently has.
Number of points
Get normal line style (not highlighted).
LineSeriesStyle3D
Get highlight style of line.
LineSeriesStyle3D
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
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 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 line style of Series.
Example usage:
lineSeries3D.setStrokeStyle( new SolidLine({
thickness: 5,
fillStyle: new SolidFill({ color: ColorHEX('#FFF') })
}) )
lineSeries.setStrokeStyle( (solidLine) => solidLine
.setThickness( 5 )
)
A LineSeries object, or a function which modifies the current style.
Object itself for fluent interface
Set line style of Series when it is highlighted.
Example usage:
lineSeries3D.setStrokeStyle( new SolidLine({
thickness: 5,
fillStyle: new SolidFill({ color: ColorHEX('#FFF') })
}) )
lineSeries.setStrokeStyle( (solidLine) => solidLine
.setThickness( 5 )
)
lineSeries.setStrokeStyleHighlight( undefined )
A LineSeries object, a function which modifies the current style or undefined for automatic value based on normal style.
Object 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 stroke style of Series.
// Example syntax, specify LineStyle
LineSeries3D.setStrokeStyle(new SolidLine({
thickness: 2,
fillStyle: new SolidFill({ color: ColorHEX('#F00') })
}))
// Example syntax, change active LineStyle
LineSeries3D.setStrokeStyle((stroke) => stroke.setThickness(5))
Use -1 thickness to enable primitive line rendering.
Primitive line rendering can have slightly better rendering performance than line with 1 thickness but the quality of line is not as good.
LineSeries3D.setStrokeStyle((solidLine) => solidLine.setThickness(-1))
Solid color for entire line series.
// Example, solid colored line.
LineSeries3D.setStrokeStyle(new SolidLine({
thickness: 2,
fillStyle: new SolidFill({ color: ColorRGBA(255, 0, 0) })
}))
To learn more about available Color factories, see ColorRGBA
Color line stroke dynamically based on x, y or z coordinate.
// Example, dynamic color by Y coordinates
LineSeries3D.setStrokeStyle(new SolidLine({
thickness: 2,
fillStyle: new PalettedFill({
lookUpProperty: 'y',
lut: new LUT({
interpolate: true,
steps: [
{ value: 0, color: ColorRGBA(255, 0, 0) },
{ value: 100, color: ColorRGBA(0, 255, 0) },
]
})
})
}))
To learn more about Color lookup tables, see LUT.
LineSeries3D has a special feature for drawing primitive line sets.
When enabled, this will draw all line segments as exactly 1 pixel thick on the monitor (regardless of distance from camera).
As a benefit, this is considerably lighter on the GPU, which is especially good with mobile and laptop devices with weak GPUs.
Primitive drawing is enabled by setting stroke thickness to -1:
// Enable primitive 3D line drawing.
LineSeries3D.setStrokeStyle((stroke) => stroke.setThickness(-1))
In 3D, line thickness is not configured exactly as pixels (since the size of pixel is not affected by distance from camera).
However, for usage convenience, you can consider line thickness in 3D as pixels just the same as 2D, even if the resulting visualization will have some differences.
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Object itself for fluent interface.
Set line style of Series when it is highlighted.
Example usage:
lineSeries3D.setStrokeStyle( new SolidLine({
thickness: 5,
fillStyle: new SolidFill({ color: ColorHEX('#FFF') })
}) )
lineSeries.setStrokeStyle( (solidLine) => solidLine
.setThickness( 5 )
)
lineSeries.setStrokeStyleHighlight( undefined )
A LineSeries object, a function which modifies the current style or undefined for automatic value based on normal style.
Object itself for fluent interface.
Series type for visualizing a collection of
{ x, y, z }coordinates by a continuous line stroke.LineSeries3Dis optimized for massive amounts of data - here are some reference specs to give an idea:Creating LineSeries3D:
LineSeries3Dare created with Chart3D.addLineSeries method.// Example syntax, create line series 3D const lineSeries3D = Chart3D.addLineSeries()Frequently used methods:
dispose| restoreColor shading style.
By default,
LineSeries3Duses Phong shading style.This can be changed with
LineSeries3D.setColorShadingStyle(new ColorShadingStyles.Simple())Related information:
To combine line stroke with markers over each data coordinate, PointLineSeries3D can be used.