Options
All
  • Public
  • Public/Protected
  • All
Menu

Options passed to a SciChartSurface in the SciChartSurface.create function

Hierarchy

Index

Properties

Optional autoColorMode

autoColorMode: EAutoColorMode

Optional - An EAutoColorMode which controls how often series colours set to AUTO_COLOR will be resolved. Default OnAddRemoveSeries

Optional background

background: string

Surface Background as an HTML color code;

remarks

A sub-chart only supports plain color without gradients

Optional canvasBorder

canvasBorder: TBorder

Optional - Properties of the canvas border

Optional createSuspended

createSuspended: boolean
experimental

Optional - enabling prevents chart rendering until {@link SciChartSurface.resume} is called on the surface instance

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 disableEngineLoop

disableEngineLoop: boolean

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 drawSeriesBehindAxis

drawSeriesBehindAxis: boolean

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 layoutManager

Optional - Prove a layoutManager to customise the axis layout. Use CentralAxesLayoutManager for an easy way to configure central axes.

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 padding

padding: Thickness

Optional - Padding between the SciChartSurface and its inner elements. Default 10

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 title

title: string | string[]

Optional a title for the SciChartSurface

Optional titleStyle

titleStyle: TChartTitleStyle

The title text style and placement for the SciChartSurface as TChartTitleStyle

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 viewportBorder

viewportBorder: TBorder

Optional - Properties of the viewport border (where series are drawn)

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.

Generated using TypeDoc