Interface PolarChartOptions<CursorResultTableBackgroundType>

Interface for readonly configuration of PolarChart.

Some properties of PolarChart 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.Polar({
     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 PolarChart, more parameters are documented in Polar.

For dashboard PolarChart, more parameters are documented in createPolarChart.

Commonly used properties:

  • PolarChartOptions.theme: Specify chart color theme.
  • animationsEnabled: Convenience flag to disable all animations from chart.

Example usage:

 // Example 1, create chart with default configuration.
 const chart = LightningChart.Polar({})

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

Type Parameters

Hierarchy

Properties

animationsEnabled? autoCursorBuilder? disableAnimations?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

Optional autoCursorBuilder

autoCursorBuilder?: AutoCursor2DBuilder<CursorResultTableBackgroundType>

Builder for the charts' auto cursor. Use AutoCursorBuilders.Polar to modify the default builder, using methods of AutoCursor2DBuilder.

 // Example, change cursor ResultTable background shape.
 const chart = LightningChart.Polar({
     autoCursorBuilder: AutoCursorBuilders.Polar
         .setResultTableBackground(UIBackgrounds.Circle)
 })

Optional disableAnimations

disableAnimations?: boolean

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

Deprecated

Deprecated in v5.0.0. Use animationsEnabled instead (note that value should be inverted from previous applications!)

Settings

Member Visibility

Theme