Interface MapChartOptions<SelectedMapType, CursorResultTableBackgroundType>

Interface that can be used to define Map Chart configurations that can't be changed after creation.

Example usage:

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

Type Parameters

Hierarchy

Properties

animationsEnabled? cursorBuilder? type?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

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.

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