Interface PolarOptions<CursorResultTableBackgroundType>

Interface that can be used to define PolarChart configurations, when inside a Dashboard, that can't be changed after creation.

Example usage:

// Specified AutoCursor ResultTable Background
{ polarChartOptions: { autoCursorBuilder: AutoCursorBuilders.Polar.setResultTableBackground(UIBackgrounds.Circle) } }

Type Parameters

Hierarchy

Properties

animationsEnabled? autoCursorBuilder? columnIndex columnSpan? disableAnimations? rowIndex rowSpan?

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)
 })

columnIndex

columnIndex: number

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

Optional columnSpan

columnSpan?: number

Column span (X width), default = 1

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!)

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