Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardOptions

Interface for readonly configuration of Dashboard.

Mandatory properties:

 // Example, Create a 3x3 dashboard.
 const dashboard = LightningChart.Dashboard({
     // Number of cells in X direction.
     numberOfColumns: 3,
     // Number of cells in Y direction.
     numberOfRows: 3,
 })

To learn about the effects of columns / rows configuration, please read more here Dashboard.

Optional extra configuration:

 // Example 1, create dashboard with specified color theme.
 const dashboard = LightningChart.Dashboard({
     // Number of cells in X direction.
     numberOfColumns: 3,
     // Number of cells in Y direction.
     numberOfRows: 3,
     // Select color theme.
     theme: Themes.light,
 })

Index

Properties

Optional disableAnimations

disableAnimations : undefined | false | true

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

Readonly numberOfColumns

numberOfColumns : number

Number of dashboard cells along horizontal plane.

To learn about the effects of columns / rows configuration, please read more here Dashboard.

Readonly numberOfRows

numberOfRows : number

Number of dashboard cells along vertical plane.

To learn about the effects of columns / rows configuration, please read more here Dashboard.

Optional theme

theme : Theme

Color theme for the component.

A collection of default implementations can be accessed by Themes.

 // Example, specify color theme of chart.
 const chart = LightningChart.ChartXY({
     theme: Themes.light
 })