Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface I2DSubSurfaceOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Hierarchy

Index

Properties

Properties

Optional autoColorMode

autoColorMode: EAutoColorMode

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

Optional canvasBorder

canvasBorder: TBorder

Optional - Properties of the canvas border

Optional coordinateMode

coordinateMode: ECoordinateMode

Gets or sets the ECoordinateMode used when calculating the actual position based on the subPosition Default Relative

Optional createSuspended

createSuspended: boolean
experimental

Optional - enabling prevents chart rendering until 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 drawSeriesBehindAxis

drawSeriesBehindAxis: boolean

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 isTransparent

isTransparent: boolean

Whether other surfaces, including the parent, will be visible underneath this surface

Optional isVisible

isVisible: boolean

Sets if the subchart is visible, allowing you to hide a subchart without removing it from the parent surface

Optional layoutManager

layoutManager: TLayoutManagerDefinition

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 parentXAxisId

parentXAxisId: string

Sets the AxisId used to determing which X Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue

Optional parentYAxisId

parentYAxisId: string

Sets the AxisId used to determing which Y Axis should be used when calculating the actual position based on the subPosition if coordinateMode is DataValue

Optional position

position: Rect

A rectangle defining the position and size of a subchart. If coordinateMode is Relative (the default) then the values give the size as a proportion of the parent div, and all properties must be between 0 and 1 inclusive. If coordinateMode is DataValue, values will be converted to coordinates using parentXAxisId and parentYAxisId. Subchart will be clpped to the parent SeriesViewRect Can only be set if this is a subChart. See addSubChart

Optional sectionScale

sectionScale: number

Gets or sets scale property for all sections

Optional subChartContainerId

subChartContainerId: string | HTMLDivElement

An id or div element that will wrap the subchart. This can contain top, left, bottom and right section divs. The chart will shrink to fit the sections

Optional subChartPadding

subChartPadding: Thickness

Sets additional absolute padding between the SciChartSubSurface and its parent, in order top, right, bottom, left subPosition is applied first, then this padding is added.

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