## AirspaceMap
Class that wraps Mapbox GL and allows for working with airspace layers.
**Kind**: global class
* [AirspaceMap](#AirspaceMap)
* [new AirspaceMap(config, opts)](#new_AirspaceMap_new)
* [.mapboxgl](#AirspaceMap+mapboxgl)
* [.setLayers(layers)](#AirspaceMap+setLayers) ⇒ [AirspaceMap](#AirspaceMap)
* [.getLayers()](#AirspaceMap+getLayers) ⇒ Array
* [.addLayer(layer)](#AirspaceMap+addLayer) ⇒ [AirspaceMap](#AirspaceMap)
* [.removeLayer(layer)](#AirspaceMap+removeLayer) ⇒ [AirspaceMap](#AirspaceMap)
* [.hasLayer(layer)](#AirspaceMap+hasLayer) ⇒ boolean
* [.move(latitude, longitude, [zoom])](#AirspaceMap+move) ⇒ [AirspaceMap](#AirspaceMap)
* [.flyTo([options])](#AirspaceMap+flyTo) ⇒ [AirspaceMap](#AirspaceMap)
* [.zoom(zoom, [options])](#AirspaceMap+zoom) ⇒ [AirspaceMap](#AirspaceMap)
* [.zoomIn(delta)](#AirspaceMap+zoomIn) ⇒ [AirspaceMap](#AirspaceMap)
* [.zoomOut(delta)](#AirspaceMap+zoomOut) ⇒ [AirspaceMap](#AirspaceMap)
* [.resize()](#AirspaceMap+resize) ⇒ [AirspaceMap](#AirspaceMap)
* [.fitBounds(bounds, [options])](#AirspaceMap+fitBounds) ⇒ [AirspaceMap](#AirspaceMap)
* [.getCenter()](#AirspaceMap+getCenter) ⇒ Object
* [.getZoom()](#AirspaceMap+getZoom) ⇒ number
* [.getSource(id)](#AirspaceMap+getSource) ⇒ Object
* [.addSource(id, source)](#AirspaceMap+addSource)
* [.addControl(control, [position])](#AirspaceMap+addControl) ⇒ [AirspaceMap](#AirspaceMap)
* [.removeControl(control)](#AirspaceMap+removeControl) ⇒ [AirspaceMap](#AirspaceMap)
* [.getTheme()](#AirspaceMap+getTheme) ⇒ string
* [.theme(theme)](#AirspaceMap+theme)
* [.getContainer()](#AirspaceMap+getContainer) ⇒ HTMLElement
* [.addMarker(latitude, longitude, [properties])](#AirspaceMap+addMarker) ⇒ string
* [.removeMarker(id)](#AirspaceMap+removeMarker) ⇒ [AirspaceMap](#AirspaceMap)
* [.remove()](#AirspaceMap+remove)
* [.on(type, listener)](#AirspaceMap+on)
* [.off(type, listener)](#AirspaceMap+off)
### new AirspaceMap(config, opts)
Configure map, set options, and load stylesheets.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| config | Object | | AirMap configuration object containing an API Key and Mapbox Access Token. |
| config.airmap.api_key | string | | AirMap API Key from the developer dashboard. |
| config.mapbox.access_token | string | | Mapbox access token. |
| opts | Object | | Map options. |
| opts.container | string | | ID of the DOM element to load the map inside. |
| [opts.center] | Array | [0,0] | An array with [latitude, longitude] coordinates for where the map should be centered on load. |
| [opts.layers] | Array | [] | Airspace layers to make visible on load. |
| [opts.theme] | string | "standard" | Map theme: standard, dark, light, or satellite. |
| [opts.zoom] | number | 7 | Map zoom level on load. |
| [opts.pitch] | number | 0 | Map pitch on load. |
| [opts.bearing] | number | 0 | Map bearing on load. |
| [opts.interactive] | boolean | true | Specifies whether users can click on and manipulate the map. |
| [opts.language] | string | "'en'" | Languages: 'en' (English) or 'ja' (Japanese). If another language is provided, the SDK will attempt to set the language, otherwise it will default to English or the local language. |
| [opts.showControls] | boolean | true | Show controls for zoom and bearing. |
| [opts.showPopups] | boolean | true | Show a popup with airspace information when a user clicks on the map. |
| [opts.showSearch] | boolean | false | Render a search bar that allows users to query for a specific location. |
| [opts.useLocation] | boolean | true | Attempt to center the map on a user location. |
| [opts.createFlights] | boolean | false | Insert button in popups that allows users to create a flight using DNAS Basic Integration. |
| [opts.suppressWarnings] | boolean | false | Suppress developer warnings. |
### airspaceMap.mapboxgl
Returns the underlying mapboxgl.Map instance, providing access to any
Mapbox GL methods not wrapped in this SDK.
**Kind**: instance property of [AirspaceMap](#AirspaceMap)
**Access:** public
### airspaceMap.setLayers(layers) ⇒ [AirspaceMap](#AirspaceMap)
Set the visible layers on the map and hide all other layers.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| layers | Array | List of layer names you want the map to display. |
### airspaceMap.getLayers() ⇒ Array
Retrieve a list of currently active layers.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: Array - layers - List of visible layers.
**Access:** public
### airspaceMap.addLayer(layer) ⇒ [AirspaceMap](#AirspaceMap)
Show an airspace layer if it is not currently visible.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| layer | string | object | Name of the airspace layer to add. If an object is passed, this will be handed off to [mapboxgl.Map.addLayer](https://www.mapbox.com/mapbox-gl-js/api/#addLayer). |
### airspaceMap.removeLayer(layer) ⇒ [AirspaceMap](#AirspaceMap)
Hide an airspace layer if it is currently visible.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| layer | string | Name of the layer to add. |
### airspaceMap.hasLayer(layer) ⇒ boolean
Checks if the provided layer is currently active on the map.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| layer | string | Name of the layer to check. |
### airspaceMap.move(latitude, longitude, [zoom]) ⇒ [AirspaceMap](#AirspaceMap)
Moves the map to a new location.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| latitude | number | Latitude of the location to move to. |
| longitude | number | Longitude of the location to move to. |
| [zoom] | string | Zoom level when centering on the new location. |
### airspaceMap.flyTo([options]) ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.flyTo.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#flyTo)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| [options] | Object | Mapbox GL [Map.flyTo options](https://www.mapbox.com/mapbox-gl-js/api/#flyTo). |
### airspaceMap.zoom(zoom, [options]) ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.zoomTo.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#zoomTo)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| zoom | number | The zoom level to transition to. |
| [options] | Object | Mapbox GL [AnimationOptions](https://www.mapbox.com/mapbox-gl-js/api/#AnimationOptions). |
### airspaceMap.zoomIn(delta) ⇒ [AirspaceMap](#AirspaceMap)
Zoom in to the map by a specified amount.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| delta | number | The amount to add to the current zoom level. |
### airspaceMap.zoomOut(delta) ⇒ [AirspaceMap](#AirspaceMap)
Zoom out of the map by a specified amount.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| delta | number | The amount to subtract from the current zoom level. |
### airspaceMap.resize() ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.resize. Resizes the map according to the dimensions of its container element.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#resize)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
### airspaceMap.fitBounds(bounds, [options]) ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.fitBounds.
Pans and zooms the map to contain its visible area within the specified geographical bounds.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#fitBounds)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| bounds | Array | | Mapbox GL [LngLatBoundsLike](https://www.mapbox.com/mapbox-gl-js/api/#LngLatBoundsLike). |
| [options] | Object | Object
Wraps Mapbox GL's Map.getCenter. Returns the map's geographical centerpoint.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#getCenter)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: Object - LngLat - Mapbox GL [LngLat](https://www.mapbox.com/mapbox-gl-js/api/#LngLat).
**Access:** public
### airspaceMap.getZoom() ⇒ number
Wraps Mapbox GL's Map.getZoom. Returns the map's current zoom level.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#getZoom)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: number - zoom - Current zoom level.
**Access:** public
### airspaceMap.getSource(id) ⇒ Object
Wraps Mapbox GL's Map.getSource. Returns the source with the specified ID in the map's style.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#getSource)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: Object - source - The style source with the specified ID, or undefined if the ID corresponds to no existing sources.
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| id | string | The ID of the source to get. |
### airspaceMap.addSource(id, source)
Wraps Mapbox GL's Map.addSource.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#addSource)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| id | string | The ID of the source to get. |
| source | Object | The source object, conforming to the Mapbox Style Specification's [source definition](https://www.mapbox.com/mapbox-gl-style-spec/#sources). |
### airspaceMap.addControl(control, [position]) ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.addControl.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#addControl)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| control | Object | The [Control](https://www.mapbox.com/mapbox-gl-js/api/#icontrol) to add. |
| [position] | string | [Position](https://www.mapbox.com/mapbox-gl-js/api/#Map#addControl) on the map where the control will be added. |
### airspaceMap.removeControl(control) ⇒ [AirspaceMap](#AirspaceMap)
Wraps Mapbox GL's Map.removeControl.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#removeControl)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| control | Object | The [Control](https://www.mapbox.com/mapbox-gl-js/api/#Control) to remove. |
### airspaceMap.getTheme() ⇒ string
Returns the theme that is currently active.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: string - theme - Theme that is currently displayed on the map.
**Access:** public
### airspaceMap.theme(theme)
Updates the current theme by requesting new map tiles.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Throws**:
- BadOptionError - Will throw an error if the provided theme is invalid.
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| theme | string | Theme to display on the map. |
### airspaceMap.getContainer() ⇒ HTMLElement
Wraps Mapbox GL's Map.getContainer.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#getContainer)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: HTMLElement - - The map's container.
**Access:** public
### airspaceMap.addMarker(latitude, longitude, [properties]) ⇒ string
Drops a marker at the provided location.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: string - id - An ID referencing the marker.
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| latitude | number | Latitude of the location. |
| longitude | number | Longitude of the location. |
| [properties] | Object | Additional properties to add to the marker feature. |
### airspaceMap.removeMarker(id) ⇒ [AirspaceMap](#AirspaceMap)
Drops a marker at the provided location.
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Returns**: [AirspaceMap](#AirspaceMap) - - `this`
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| id | string | ID of the marker to remove. |
### airspaceMap.remove()
Wraps Mapbox GL's Map.remove. Destroys the map and its underlying resources.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Map#remove)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Access:** public
### airspaceMap.on(type, listener)
Wraps Mapbox GL's method to add an event listener.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Evented#on)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| type | string | The event type to add a listener for. |
| listener | function | The function to be called when the event is fired. |
### airspaceMap.off(type, listener)
Wraps Mapbox GL's method to remove an event listener.
[[docs]](https://www.mapbox.com/mapbox-gl-js/api/#Evented#off)
**Kind**: instance method of [AirspaceMap](#AirspaceMap)
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
| type | string | The event type to remove listeners for. |
| listener | function | The listener function to remove. |