Interface BarChartDashboardOptions

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

Hierarchy

Properties

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

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

Optional Readonly autoCursorBuilder

autoCursorBuilder?: AutoCursor2DBuilder<UIBackground>

Builder for the charts' auto cursor.

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

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

Optional Readonly type

type?: BarChartType

Specify orientation of bar chart (vertical or horizontal).

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

Optional Readonly valueAxis

valueAxis?: BarChartValueAxisOptions

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.

Settings

Member Visibility

Theme