ChartOptions | LightningChart® JS API Documentation

Interface that can be used to define ChartXY configurations, when inside a Dashboard, that can't be changed after creation. For example:

Specifying TickStrategies for default X or Y Axes'. This is mostly used for creating DateTime Axes.
Supplying a custom Builder for the AutoCursor of Chart. This can be used to modify the AutoCursor on a level, which can't be done during runtime. For example, changing the shape of ResultTable Background, Etc.

Example usage:

Desired result	Value
Default	undefined
Default X Axis as DateTime	{ chartXYOptions: { defaultAxisXTickStrategy: AxisTickStrategies.DateTime() } }
Specified AutoCursor ResultTable Background	{ chartXYOptions: { autoCursorBuilder: AutoCursorBuilders.XY.setResultTableBackground(UIBackgrounds.Circle) } }

Index

Properties

Optional chartXYOptions

chartXYOptions: ChartXYOptions<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerXBackgroundType, CursorTickMarkerYBackgroundType>

Options object for creation of chart.

columnIndex

columnIndex: number

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

columnSpan

columnSpan: number

Column span (X width)

rowIndex

rowIndex: number

Row index on dashboard (Y location, 0 = top)

rowSpan

rowSpan: number

Row span (Y height)