Interface MapChartDashboardOptions<SelectedMapType, CursorResultTableBackgroundType>

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

Example usage:

 const mapChart = lightningChart().Dashboard({
     rowIndex: 0,
     columnIndex: 0,
     rowSpan: 1,
     columnSpan: 1
 })
  • Specify MapType.
 const mapChart = lightningChart().Dashboard({
     rowIndex: 0,
     columnIndex: 0,
     rowSpan: 1,
     columnSpan: 1,
     type: MapTypes.USA
 })

Type Parameters

Hierarchy

Properties

animationsEnabled? columnIndex columnSpan? cursorBuilder? rowIndex rowSpan? type?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

columnIndex

columnIndex: number

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

Optional columnSpan

columnSpan?: number

Column span (X width), default = 1

Optional cursorBuilder

cursorBuilder?: CursorBuilder2D<CursorResultTableBackgroundType>

Builder for the Charts Cursor. If omitted, a default one will be used. CursorBuilders.Map can be used to build a custom one from scratch.

rowIndex

rowIndex: number

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

Optional rowSpan

rowSpan?: number

Row span (Y height), default = 1

Optional type

type?: SelectedMapType

Preset selection that defines the displayed Map region as well as the type of associated region data (eq. USA -> states, World -> countries).

Valid options can be referenced via MapTypes:

 const mapChart = lightningChart().Map({
     type: MapTypes.USA
 })

Settings

Member Visibility

Theme