I3DSurfaceOptions | API Documentation for SciChart.js

Options passed to a SciChart3DSurface in the SciChart3DSurface.create function

Hierarchy

ISurfaceOptionsBase
- I3DSurfaceOptions

Index

Properties

Optional background

background: string

Surface Background as an HTML color code;

Optional cameraOptions

cameraOptions: ICameraOptions

Optional disableAspect

disableAspect: boolean

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.

Optional freezeWhenOutOfView

freezeWhenOutOfView: boolean

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 heightAspect

heightAspect: number

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.

Optional id

id: string

Allows you to set custom Id for the surface;

remarks: If skipped the Id will be auto-generated

Optional isXYPlaneVisible

isXYPlaneVisible: boolean

Optional isZXPlaneVisible

isZXPlaneVisible: boolean

Optional isZYPlaneVisible

isZYPlaneVisible: boolean

Optional loader

loader: false | ISciChartLoader | { options?: any; type: string }

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 theme

theme: IThemeProvider | ({ type: string | EThemeProviderType } & IThemePartial)

Optional - The theme applied to the SciChartSurfaceBase on startup

remarks: see IThemeProvider for properties which can affect SciChart theme. Two default themes are included out of the box SciChartJSLightTheme and SciChartJSDarkTheme. Custom themes may be created by implementing IThemeProvider

Optional touchAction

touchAction: string

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

remarks: By default a chart will use touch-action: none to prevent the default browser behavior.

Optional widthAspect

widthAspect: number

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.

Optional worldDimensions

worldDimensions: Vector3