Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InteractiveMapOptions

A data type that represents the configuration options for a Map instance.

Hierarchy

  • InteractiveMapOptions

Index

Properties

Optional account

account: Account

Aeris account to use when requesting map data and imagery.

Optional attribution

attribution: boolean

A Boolean indicating whether the standard AerisWeather data attribution should be displayed.

Optional center

center: Coordinate

Center coordinate to initialize the map view.

Optional layers

layers: string | string[] | { layer: string; options?: LayerOptions }[]

Initial layers to add to the map at initialization.

Optional map

map: any

Configuration options to pass to the native map constructor for the specific mapping strategy.

Optional metric

metric: boolean

Whether the current map units are set to metric. Default is false.

Optional refresh

refresh: number

Data update interval, in seconds. Default value is 0, which disables auto-updating.

Optional reloadOnBoundsChange

reloadOnBoundsChange: boolean

Whether map content source data should be reloaded automatically when the map bounds have changed.

Default value is true. Set this value to false to reduce data and map unit usage.

Optional servers

servers: Servers

Base paths for the API servers to use with data and image requests.

Optional strategy

strategy: string

Map strategy.

The following strategy values are supported:

  • leaflet: Uses the Leaflet.js mapping library
  • mapbox: Uses the MapboxGL mapping library
  • 'openlayers': Uses the OpenLayers mapping library
  • 'google': Uses the Google Maps mapping library

Optional styles

styles: {}

Style overrides per layer code.

Type declaration

Optional timeline

timeline: TimelineOptions & { alwaysShowFuture?: boolean; alwaysShowPast?: boolean; resetOnBoundsChange?: boolean; showLoading?: boolean }

Configuration options for the map's animation timeline.

see

{Timeline}

Optional zoom

zoom: number

Zoom level to initialize the map view.

Generated using TypeDoc