Interface ChartOptions<CursorResultTableBackgroundType>

Interface that can be used to define ChartXY configurations, when inside a Dashboard, that can't be changed after creation. For example:

  • Specifying TickStrategies for default X or Y Axes'. This is mostly used for creating DateTime Axes.

  • Supplying a custom Builder for the Cursor of Chart. This can be used to modify the Cursor on a level, which can't be done during runtime. For example, changing the shape of ResultTable Background, Etc.

Example usage:

// Default
undefined
// Specified Cursor ResultTable Background
{ chartXYOptions: { cursorBuilder: CursorBuilders.XY.setResultTableBackground(UIBackgrounds.Circle) } }

Type Parameters

Hierarchy

Properties

animationsEnabled? columnIndex columnSpan? cursorBuilder? defaultAxisX? defaultAxisY? rowIndex rowSpan?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

Convenience flag that can be used to enable/disable all animations in a component.

columnIndex

columnIndex: number

Column index on dashboard (X location, 0 = left)

Optional columnSpan

columnSpan?: number

Column span (X width), default = 1

Optional cursorBuilder

cursorBuilder?: CursorBuilderXY<CursorResultTableBackgroundType>

Builder for the charts' auto cursor. Use CursorBuilders.XY to modify the default builder, using methods of CursorXYBuilder.

 // Example, change cursor ResultTable background shape.
 const chart = LightningChart.ChartXY({
     cursorBuilder: CursorBuilders.XY
         .setResultTableBackground(UIBackgrounds.Circle)
 })

Optional defaultAxisX

defaultAxisX?: AxisOptions

Interface for specifying Axis X configurations that can't be changed after creation of the Axis.

Example usage:

  • Configure default X Axis of chart on opposite side to default configuration (top).
 ChartXY({
     defaultAxisX: {
         opposite: true,
     }
 })
  • Configure default X Axis of chart as logarithmic (10 base).
 ChartXY({
     defaultAxisX: {
         type: 'logarithmic',
         base: 10,
     }
 })

NOTE: Not all series types support logarithmic axes! Attaching a non-supported Series will crash the application.

List of series that support logarithmic Axes:

List of series that do not support logarithmic Axes:

Optional defaultAxisY

defaultAxisY?: AxisOptions

Interface for specifying Axis Y configurations that can't be changed after creation of the Axis.

Example usage:

  • Configure default Y Axis of chart on opposite side to default configuration (top).
 ChartXY({
     defaultAxisY: {
         opposite: true,
     }
 })
  • Configure default Y Axis of chart as logarithmic (10 base).
 ChartXY({
     defaultAxisY: {
         type: 'logarithmic',
         base: 10,
     }
 })

NOTE: Not all series types support logarithmic axes! Attaching a non-supported Series will crash the application.

List of series that support logarithmic Axes:

List of series that do not support logarithmic Axes:

rowIndex

rowIndex: number

Row index on dashboard (Y location, 0 = top)

Optional rowSpan

rowSpan?: number

Row span (Y height), default = 1

Settings

Member Visibility

Theme