Options
All
  • Public
  • Public/Protected
  • All
Menu

Options passed to a SciChartSurface in the SciChartSurface.create function

Hierarchy

Index

Properties

Optional canvasBorder

canvasBorder: TBorder

Optional - Properties of the canvas border

Optional heightAspect

heightAspect: number

Optional - the height aspect ratio of the SciChartSurface. 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 layoutManager

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

Optional loader

loader: 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

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 SciChartSurface 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 viewportBorder

viewportBorder: TBorder

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

Optional widthAspect

widthAspect: number

Optional - the width aspect ratio of the SciChartSurface. 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