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? autoCursorBuilder? disableAnimations? type?

Properties

Optional animationsEnabled

animationsEnabled?: boolean

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

Optional autoCursorBuilder

autoCursorBuilder?: StaticCursor2DBuilder<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.

Optional disableAnimations

disableAnimations?: boolean

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

Deprecated

Deprecated in v5.0.0. Use animationsEnabled instead (note that value should be inverted from previous applications!)

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