Namespace Views

The Views module provides the public interface for all mapping functionality, including both static and interactive map views.

Index

Functions

Object literals

Functions

Const InteractiveMap

InteractiveMap(target: any, opts?: InteractiveMapOptions, onInit?: (map: InteractiveMap) => void): InteractiveMap

- Defined in src/maps/index.ts:96
Initializes and returns a new Map instance.

Parameters
- target: any
- Optional opts: InteractiveMapOptions
- Optional onInit: (map: InteractiveMap) => void
  - - (map: InteractiveMap): void
    - Parameters
      - map: InteractiveMap
      Returns void
Returns InteractiveMap

Const Legend

Legend(target: HTMLElement, opts?: LegendOptions): LegendView

- Defined in src/maps/index.ts:124
Initializes and returns a new LegendView instance.

Parameters
- target: HTMLElement
- Optional opts: LegendOptions
Returns LegendView

Const Map

Map(target: HTMLElement, opts?: MapViewOptions): MapView

- Defined in src/maps/index.ts:110
Initializes and returns a new MapView instance.

Parameters
- target: HTMLElement
- Optional opts: MapViewOptions
Returns MapView

Const setAccount

setAccount(account: Account): void

- Defined in src/maps/index.ts:75
Sets the Aeris account instance to use with the Views module.

Parameters
- account: Account
Returns void

Const setServers

setServers(servers: Servers): void

- Defined in src/maps/index.ts:84
Sets the base paths for the API servers to use with data and image requests.

Parameters
- servers: Servers
Returns void

Object literals

Const datasources

datasources: object

Data source classes that can be used to add custom datasets to an InteractiveMap instance.

readonly

GeoJson

GeoJson: GeoJsonSource = GeoJsonSource

Text

Text: TextSource = TextSource

Tile

Tile: TileSource = TileSource

Vector

Vector: VectorSource = VectorSource

Const utils

utils: object

Provides access to the View module's utility functions.

readonly

Generated using TypeDoc