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 fill style of Intensity Heatmap Series.
FillStyle.
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 style of wireframe.
Wireframe is a line grid that highlights the edges of each cell of the 3D surface.
FillStyle.
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
Treat the data of the matrix as ColorValue-based type of points. ColorValue-based data is represented in format { ...color: Color } for IndividualPointFill style.
Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.
Matrix of new colors. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as ColorValue-based type of points. ColorValue-based date is represented in format { ...color: Color } for IndividualPointFill style.
Invalidates only the color without update the geometry data, providing significantly faster rendering of dynamically changed colors.
Example usage:
// Fill each surface cell with a color for demonstration purposes.
SurfaceSeries3D
.invalidateColorsOnly( ( row, column ) => ColorHSV( row * column ) )
Callback function to map through the input to modify the matrix colors. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as any of the Point3D-based type of points. Point3D-based data is represented in format { x: number, y: number, z: number } to modify the geometry only.
Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.
Matrix of new vertices. The resolution of the IntensityMesh should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as any of the Point-based type of points. Point-based data is represented in format { x: number, y: number } to modify the geometry only.
Invalidates only the geometry coordinates without update the intensity or color data, providing significantly faster rendering of dynamically changed geometry.
Example usage:
const resolution = 20
SurfaceMeshSeries3D
.invalidateGeometryOnly( ( row, column, prev ) => {
const angle = 2 * Math.PI * row / ( resolution - 1 )
const radius = 2 + Math.cos( column * .resolution )
return {
x: Math.cos( angle ) * radius,
y: column,
z: Math.sin( angle ) * radius
}
} )
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.
Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.
Matrix of new intensity values.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
Treat the data of the matrix as IntensityValue-based type of points. IntensityValue-based data is represented in format { ...intensity: number } for PalettedFill style.
Invalidates only the intensity values without update the geometry data, providing significantly faster rendering of dynamically changed intensity.
Example usage:
// Fill each surface cell with a value for demonstration purposes.
SurfaceSeries3D
.invalidateValuesOnly( ( row, column ) => row + column )
Callback function to map through the input to modify the matrix of intensity values. The resolution of the IntensityShape should be valid.
Optional configuration object to specify the range of the grid to be invalidated.
Series itself for fluent interface.
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
Reset the existing intensity shape and apply new settings. The following method removes all the existing data. The shape would be reset to the default state:
Major mandotary properties of Intensity.
Series itself for fluent interface.
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 fill style of Intensity Heatmap Series.
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series 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 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 style of wireframe.
Wireframe is a line grid that highlights the edges of each cell of the 3D surface.
By default, the wireframe is hidden. It can be displayed like so:
surfaceSeries.setWireframeStyle( new SolidFill({ color: ColorRGBA( 0, 0, 0, 100 ) }) )
Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value.
Series itself for fluent interface.
Class for visualization of a 3D surface mesh inside a Chart3D.
The series behaves exactly like SurfaceGridSeries3D, a grid defined between two XZ locations, but on top of this, it allows the user to map each cell of the grid into any arbitrary XYZ location.
Supports colouring cells by a look up table (LUT) based on user set values as well as geometry Y coordinates.
SurfaceGridSeries3D are created with Chart3D.addSurfaceSeries.
Color shading style.
By default,
SurfaceMeshSeries3D
uses Simple shading style.This can be changed with
SurfaceMeshSeries3D.setColorShadingStyle(new ColorShadingStyles.Phong())