The engine has an internal loop based on requestAnimationFrame which triggers a chart draw on any surfaces that have been invalidated. If you have your own requestAnimationFrame based drawing you wish to synchronise with, you can disable the engine loop by setting this to true. If you do this you are then responsible for calling webassemblyContext.TSRRequestDraw() which will immediately draw all surfaces belonging to the webassemblyContext that have been invalidated. Note that 2D and 3D charts, and all charts created using createSingle have separate webassemblyContexts so you must call TSRRequestDraw() on each one. This setting is applied to the webassembly context when a chart is created, so for SciChartSurface.create this will change the behaviour of all existing charts created using SciChartSurface.create.
Optional - 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.
Optional - the height aspect ratio of the SciChartSurfaceBase. By default SciChart will scale to fit the parent Div. However if height of the div is not provided it will use width/height aspect ratio to calculate the height. The default ratio is 3/2.
Allows you to set custom Id for the surface;
Allows you to customize the loading elements or animation as part of the HTML page / DOM when a SciChartSurface or SciChart3DSurface is loading WebAssembly.
Set to false for disabling.
Optional - extra native wasm modules to load before this surface is constructed.
Chart creation loads only what the chart itself needs, so a feature living in a separate
module has to be asked for. Name it here and it is loaded and ready by the time create()
resolves:
const { sciChartSurface, wasmContext } = await SciChartSurface.create(div, { modules: ["data"] });Equivalent to awaiting ensureModule yourself, or to the init* helper an extension
package exports (initSciChartData in scichart-data, which additionally narrows
wasmContext to a type from which the module's own members are reachable - this option
cannot do that, because it does not know at compile time which modules you named).
Applied per surface, not per page: the shared master wasm context is created once, so a page
whose first chart asks for nothing and whose second asks for "data" still gets it.
Idempotent and race-safe - naming an already-loaded module costs nothing, and in the static
(monolithic) build there is nothing to load.
Optional - The theme applied to the SciChartSurfaceBase on startup
Sets a touch-action property to the canvas style.
Useful if touch interactions in browser should be configured.
https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action
Optional - the width aspect ratio of the SciChartSurfaceBase. By default SciChart will scale to fit the parent Div. However if height of the div is not provided it will use width/height aspect ratio to calculate the height. The default ratio is 3/2.
Generated using TypeDoc
Optional - the option of disabling / enabling scaling of the SciChartSurfaceBase. If false - the SciChartSurfaceBase will take the height and width of parent div without scaling.