Creates an instance of SciChart3DSurface
The SciChart 3D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
Optional parameters of type ISciChart3DSurfaceOptions to configure the chart
The AxisCubeEntity is a 3D Scene Entity (inherits BaseSceneEntity3D) which renders the 3D X,Y,Z axis cube, axis walls and labels in a SciChart3DSurface
An ObservableArray of IChartModifierBase derived types. Chart Modifiers provide behavior such as zooming, panning, tooltips, legends and more in SciChart's High Performance Realtime JavaScript Charts. You can use our built in modifiers (see derived types of ChartModifierBase, or create your own for custom interaction behavior.
The {@link SVGSVGElement} placed on the background and could be used instead of domSvgContainer
The {@link HTMLCanvasElement} which is the WebGL canvas that SciChart draws to
The inner {@link HTMLDivElement} div element placed on the background
The {@link SVGSVGElement} which is the SVG adorner layer canvas, is used for annotation adorners
The {@link SVGSVGElement} which is the SVG canvas which SciChart adds elements (tooltips, annotations) to
An event handler which notifies its subscribers when animations stage in render process has finished.
An event handler which notifies its subscribers when a layout stage in render process has finished.
The MouseManager subscribes to mouse events on the domChartRoot and routes them to components within SciChart
For serialization Only. The name of the onCreated function applied by the builder api
An event handler which notifies its subscribers when a chart was visually painted a display canvas.
An event handler which notifies its subscribers when a render operation starts. Use this to update elements of the chart for the current render. Any updates made here will not trigger a subsequent render.
A propertyChanged EventHandler. See EventHandler for how to subscribe to and be notified when a property changes on the SciChartSurfaceBase
An event handler which notifies its subscribers when a chart was requested to redraw initially.
An event handler which notifies its subscribers when a render operation has finished. Use this to time render performance, or to update elements of the chart or your UI on redraw.
An event handler which notifies its subscribers when a chart was rendered to a display canvas.
An event handler which notifies its subscribers when a chart was rendered to WebgL Canvas.
Whether to show errors that occur during the render process. Defaults true.
The position of the watermark for trials and community licenses
The SciChart 3D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods
Global property defining whether the WebGL render target is anti-aliased or not. This will affect all SciChartSurfaces (2D & 3D) in the application.
Gets or sets the application-wide default theme. See IThemeProvider for details
Defines if the shared wasmContext (WebAssembly Context) should be deleted after all of the surfaces that use it are deleted.
The master WebGL canvas
Defines if charts should rerender when the tab becomes active.
Defines a delay of the shared wasmContext auto-dispose if autoDisposeWasmContext is enabled.
Gets or sets the SciChartSurface Background as an HTML color code
Gets or sets the SciChartSurface Background as an HTML color code
The HTML color code
The ICameraController is a 3D Camera which allows choosing perspective, orthogonal projections, camera position, target, orientation such as Pitch, Yaw and Roll etc...
The ICameraController is a 3D Camera which allows choosing perspective, orthogonal projections, camera position, target, orientation such as Pitch, Yaw and Roll etc...
Gets Chart Modifier Groups, is used for sharing events between chart modifiers
Gets or sets whether the Xyz gizmo is enabled - a small 3D Xyz axis on the bottom left of the 3D Chart
Gets or sets whether the Xyz gizmo is enabled - a small 3D Xyz axis on the bottom left of the 3D Chart
When true, charts that are out of the viewport will be frozen (pausing rendering). Data updates can resume Once the chart is in view again, rendering will resume. This can be useful for performance optimization.
When true, charts that are out of the viewport will be frozen (pausing rendering). Data updates can resume Once the chart is in view again, rendering will resume. This can be useful for performance optimization.
Gets or sets the SciChartSurface Id
Gets or sets the SciChartSurface Id
Called internally Gets isAxisCubeRenderedProperty flag
Used internally - gets isDeleted flag
Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
Used internally - gets isInitialized flag
Returns true if an animation is running
Gets a value indicating whether updates for the target are currently suspended
An event handler which notifies its subscribers when a render operation starts. Use this to update elements of the chart for the current render. Any updates made here will not trigger a subsequent render.
Used internally - gets the previous IThemeProvider
Gets the Series View Rect, a rectangle relative to the entire size of the SciChartSurfaceBase
Gets the Surface Type. See ESurfaceType for list of values
Used internally - gets the previous IThemeProvider
Gets or sets the Viewport Manager - a class that allows managing of viewport axis ranges
Gets or sets the Viewport Manager - a class that allows managing of viewport axis ranges
The WorldDimensions defines the size of the world in 3D space. Series and objects can exist outside of this world however the Axis cube will conform to this size.
The WorldDimensions defines the size of the world in 3D space. Series and objects can exist outside of this world however the Axis cube will conform to this size.
Gets or sets the XAxis in the 3D Chart.
Gets or sets the XAxis in the 3D Chart.
Settings for the XY Axis Plane
Gets or sets the YAxis in the 3D Chart.
Gets or sets the YAxis in the 3D Chart.
Gets or sets the ZAxis in the 3D Chart.
Gets or sets the ZAxis in the 3D Chart.
Settings for the ZX Axis Plane
Settings for the ZY Axis Plane
Add a GenericAnimation to the surface. Multiple animations will be run in parallel, so if you want to run one after another, use the onCompleted callback to add another animation after the first completes
Add an IDeleteable object to the surface which will have its delete method called when the surface is deleted
Applies a theme (defined by IThemeProvider) to the current element
The theme data to apply
Changes the Viewport Size of the SciChartSurfaceBase
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Detaches a ChartModifierBase2D from the SciChartSurfaceBase
Called internally - the main drawing loop
Gets the generic animations currently on the surface. Do not manipulate this array directly. To add, use addAnimation. To remove, find an animation and call .cancel() on it.
Gets the main WebGL or 2D canvas
Triggers the rerendering of the surface and after the chart rerendering is completed, returns its serialized state retrieved with SciChartSurface.toJSON.
if set true, data values will not be included in the json.
JSON-like object ISciChart3DDefinition
Used internally: Gets the {@link SCRTSceneWorld} object at the root of the 3d scene graph
Creates a promise which resolves when the chart is updated to the next fully rendered state
The name of the property which has changed
Is being called on each render, to run animations
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
Called after the SciChart3DSurface has rendered.
Register a font to be used with native text.
Used internally - sets destinations
Called internally Sets isAxisCubeRenderedProperty flag after Axis Cube is rendered
Used internally, the flag is set after SciChartSurfaceBase is initialized
Sets the Series View Rect, a rectangle relative to the entire size of the SciChartSurfaceBase
Suspends updates on the target
Convert the object to a definition that can be serialized to JSON, or used directly with the builder api
if set true, data values will not be included in the json.
Updates Clip Planes to do clipping
Causes SciChart to always use its built in community non-commercial license. This stops it attempting to look for the license wizard Usage of the community license constitutes acceptance of the terms at https://www.scichart.com/community-licensing/
Allows setting of web URL for Wasm files, in the case you are loading SciChart outside of npm/webpack environment. Note if loading from CDN the version number of wasm Url must match the version number of SciChart.js you are using.
Creates a SciChart3DSurface and WebAssembly Context to occupy the div by element ID in your DOM.
The ID or reference of Div Element where the SciChart3DSurface will reside
Optional parameters of type I3DSurfaceOptions
USED INTERNALLY - performs a similar operation to SciChart3DSurface.create but used internally for testing
The Div Element ID or reference where the SciChartSurface will reside
Optional parameters of type I3DSurfaceOptions
Tell SciChart to load the Wasm files from CDN, rather than expecting them to be served by the host server.
Tell SciChart to load the Wasm files from the local server, rather than from CDN.
Sets function that will be called by the framework to validate a runtime license from the server, if you need to add additional handling, such as custom authentication. The request sent to the server must include the queryString section passed in, which does not come with a leading ?
Sets the runtime license key. Use for full licenses or trials only, not developer licenses.
Sets the endpoint for validating a runtime license key with the server. Must be a relative path.
Tell SciChart to load the Wasm files from CDN, rather than expecting them to be served by the host server.
Generated using TypeDoc
'){kind=link}
The SciChart3DSurface is the root 3D Chart control in SciChart's High Performance Real-time JavaScript 3D Chart Library
To create a 3D chart using SciChart, declare a SciChart3DSurface using SciChart3DSurface.create, add X,Y,Z axis via the SciChart3DSurface.xAxis SciChart3DSurface.yAxis and SciChart3DSurface.zAxis properties.
Next, add a series or chart type by adding a BaseRenderableSeries3D to the SciChart3DSurface.renderableSeries collection.
Position the camera in the 3D scene by adjusting the SciChart3DSurface.camera property.
To redraw a SciChart3DSurface at any time, call SciChart3DSurface.invalidateElement, however all properties are reactive and the chart will automatically redraw if data or properties change.
SciChartSurfaces scale to fit the parent DIV where they are hosted. Use CSS to position the DIV.