Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChartOptions<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerXBackgroundType, CursorTickMarkerYBackgroundType>

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:

// Default
undefined
// Specified AutoCursor ResultTable Background
{ chartXYOptions: { autoCursorBuilder: AutoCursorBuilders.XY.setResultTableBackground(UIBackgrounds.Circle) } }

Index

Properties

Optional autoCursorBuilder

autoCursorBuilder : AutoCursorXYBuilder<CursorPointMarkerType, CursorResultTableBackgroundType, CursorTickMarkerXBackgroundType, CursorTickMarkerYBackgroundType>

Builder for the Charts AutoCursor. If omitted, a default one will be used. AutoCursorBuilders.XY can be used to build a custom one from scratch.

columnIndex

columnIndex : number

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

Optional columnSpan

columnSpan : undefined | number

Column span (X width), default = 1

Optional disableAnimations

disableAnimations : undefined | false | true

Disable animations by default

rowIndex

rowIndex : number

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

Optional rowSpan

rowSpan : undefined | number

Row span (Y height), default = 1

Optional theme

theme : Theme

Theme used to style all elements inside the Chart. See Themes for pre-made options.