Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapChartDashboardOptions<SelectedMapType, CursorPointMarkerType, 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
 })

Index

Properties

Optional autoCursorBuilder

autoCursorBuilder : StaticCursor2DBuilder<CursorPointMarkerType, CursorResultTableBackgroundType>

Builder for the Charts AutoCursor. If omitted, a default one will be used. AutoCursorBuilders.Map 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

Optional flag that can be used to disable all 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 component. See Themes for pre-made options.

Optional type

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