Interface GaugeChartOptions<GaugeChartType>

Interface for readonly configuration of GaugeChart.

Some properties of GaugeChart can only be configured when it is created. These arguments are all optional, and are wrapped in a single object parameter:

 // Example, create chart with specified color theme.
const chart = LightningChart.Gauge({
theme: Themes.light,
})

Watch out! The full set of available readonly configuration parameters depends on if the chart is standalone, or inside a dashboard:

For standalone GaugeChart, more parameters are documented in Gauge.

For dashboard GaugeChart, more parameters are documented in createGaugeChart.

Commonly used properties:

  • type: Specify type of gauge chart.
  • GaugeChartOptions.theme: Specify chart color theme.
  • disableAnimations: Convenience flag to disable all animations from chart.

Example usage:

 // Example 1, create chart with default configuration.
const chart = LightningChart.Gauge({})
 // Example 2, create chart with specified color theme.
const chart = LightningChart.Gauge({
theme: Themes.light,
})

Type Parameters

Hierarchy

Properties

disableAnimations?: boolean

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

type?: GaugeChartType

Interface for specifying desired "type" of Gauge Chart. This can be used to select different gauge types.

Note, at this time, there is only a single type available, leaving this API effectively unusable.

Options are located in GaugeChartTypes collection. If undefined, will default to Solid.