Interface BarChartOptions<CursorResultTableBackgroundType>

Interface for readonly configuration of BarChart.

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

 // Example, configure bar chart orientation.
const chart = lightningChart().BarChart({
type: BarChartTypes.Horizontal
})

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

For standalone BarChart, more parameters are documented in BarChart.

For dashboard BarChart, more parameters are documented in createBarChart.

Commonly used properties:

  • BarChartOptions.theme: Specify chart color theme.
  • animationsEnabled: Convenience flag to disable all animations from chart.
  • type: Configure bar chart orientation.

Example usage:

 // Example 1, create chart with default configuration.
const chart = lightningChart().BarChart({})
 // Example 2, create chart with specified color theme.
const chart = lightningChart().BarChart({
theme: Themes.light,
})
 // Example 3, create chart with specified orientation
const chart = lightningChart().BarChart({
type: BarChartTypes.Horizontal,
})

Type Parameters

Hierarchy

Properties

animationsEnabled?: boolean

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

cursorBuilder?: CursorBuilder2D<CursorResultTableBackgroundType>

Builder for the charts' auto cursor.

For most use cases, it is not recommended to use this, but rather setCursor for a more convenient API.

Specify orientation of bar chart (vertical or horizontal).

 // Example usage
const chart = lightningChart().BarChart({ type: BarChartTypes.Horizontal })

Interface for supplying read-only configurations for the Value Axis. These can only be specified when the chart is created. See BarChartValueAxisOptions for more information.