IMap | destination.maps API

Interface for different Map Implemenations (e.g. Mapbox GL JS, Mapbox.js, Leaflet, ...)

Type parameters

MAP

Hierarchy

IMap

Methods

addLayer

addLayer(layer: ILayer): ILayer

- Defined in index.d.ts:180
Parameters
- layer: ILayer
Returns ILayer

addLine

addLine(line: ILine): ILine

- Defined in index.d.ts:181
Parameters
- line: ILine
Returns ILine

addLineArrows

addLineArrows(line: ILine): void

- Defined in index.d.ts:183
Parameters
- line: ILine
Returns void

addLocationMarker

addLocationMarker(coordinate: ICoordinate): IMarkerImpl

- Defined in index.d.ts:179
Adds the default location marker to the map

since

1.0.1

Parameters
- coordinate: ICoordinate
Returns IMarkerImpl

addMarker

addMarker(markerOptions: IMarkerOptions): IMarkerImpl

- Defined in index.d.ts:173
Parameters
- markerOptions: IMarkerOptions
Returns IMarkerImpl

clearLine

clearLine(line: ILine): void

- Defined in index.d.ts:182
Parameters
- line: ILine
Returns void

clearMetaLayer

clearMetaLayer(metaLayer: IMetaLayer): void

- Defined in index.d.ts:191
Parameters
- metaLayer: IMetaLayer
Returns void

clearTour

clearTour(): void

- Defined in index.d.ts:202
Returns void

createMap

createMap(options: IMapOptions): MAP

- Defined in index.d.ts:159
Parameters
- options: IMapOptions
Returns MAP

createPopup

createPopup(item: IMetaLightItem | IMetaItem | IWrappedItem): IPopup

- Defined in index.d.ts:204
Parameters
- item: IMetaLightItem | IMetaItem | IWrappedItem
Returns IPopup

findItem

findItem(guid: string): Promise<IWrappedItem>

- Defined in index.d.ts:211
Parameters
- guid: string
Returns Promise<IWrappedItem>

fire

fire<TYPE>(type: TYPE, event: IMapEvents[TYPE]): void

- Defined in index.d.ts:239
Type parameters
- TYPE: TEventType
Parameters
- type: TYPE
- event: IMapEvents[TYPE]
Returns void

fitBounds

fitBounds(coordinates: ICoordinate[]): void

- Defined in index.d.ts:199
Parameters
- coordinates: ICoordinate[]
Returns void

fitLayer

fitLayer(layer: ILayer): void

- Defined in index.d.ts:200
Parameters
- layer: ILayer
Returns void

flyTo

flyTo(options: ICameraOptions): void

- Defined in index.d.ts:217
Parameters
- options: ICameraOptions
Returns void

getContainer

getContainer(): HTMLElement

- Defined in index.d.ts:164
Returns HTMLElement

getDefaultSearchAPI

getDefaultSearchAPI(): IMetaSearch<IMetaLightResult>

- Defined in index.d.ts:184
Returns IMetaSearch<IMetaLightResult>

getExperience

getExperience(): string | undefined

- Defined in index.d.ts:166
Returns string | undefined

getFullSearchAPI

getFullSearchAPI(): IMetaSearch<IMetaResult>

- Defined in index.d.ts:189
since

1.0.1

Returns IMetaSearch<IMetaResult>

getMap

getMap(): MAP

- Defined in index.d.ts:158
Returns MAP

getMarkerTypesProvider

getMarkerTypesProvider(): IMarkerTypesProvider

- Defined in index.d.ts:185
Returns IMarkerTypesProvider

getMetaLayer

getMetaLayer(): IMetaLayer | undefined

- Defined in index.d.ts:192
Returns IMetaLayer | undefined

getPredefinedConfig

getPredefinedConfig(): Promise<IPredefinedConfig>

- Defined in index.d.ts:216
Returns Promise<IPredefinedConfig>

getSelectedItem

getSelectedItem(): IWrappedItem | undefined

- Defined in index.d.ts:214
Returns IWrappedItem | undefined

hidePopup

hidePopup(): void

- Defined in index.d.ts:208
since

1.0.1

Returns void

isFullscreen

isFullscreen(): boolean

- Defined in index.d.ts:209
Returns boolean

isLoaded

isLoaded(): boolean

- Defined in index.d.ts:163
since

1.0.1

Returns boolean

loadMetaLayer

loadMetaLayer(metaLayer: IMetaLayer): Promise<IMetaLayer>

- Defined in index.d.ts:190
Parameters
- metaLayer: IMetaLayer
Returns Promise<IMetaLayer>

off

off<TYPE>(type: TYPE, listener: TEventTypeListener<TYPE>): void

- Defined in index.d.ts:238
Removes a event listener. All available events can be found at IMapEvents

Type parameters
- TYPE: TEventType
Parameters
- type: TYPE
  
  [[IMapsEvents]]
- listener: TEventTypeListener<TYPE>
  
  Listener Function
Returns void

on

on<TYPE>(type: TYPE, listener: TEventTypeListener<TYPE>): void

- Defined in index.d.ts:231
Adds a event listener. All available events can be found at IMapEvents
example
```
map.on("load", function(event) {
  event.map.showContent( { experience: "demo-dahoam", limit: 5 } );
});
```
Type parameters
- TYPE: TEventType
Parameters
- type: TYPE
  
  [[IMapsEvents]]
- listener: TEventTypeListener<TYPE>
  
  Listener Function
Returns void

resize

resize(): void

- Defined in index.d.ts:172
Resizes the map. This should be done after changing the size of the container element.

Returns void

selectItem

selectItem(item: IMetaLightItem | IWrappedItem, data?: IEventData): void

- Defined in index.d.ts:213
Parameters
- item: IMetaLightItem | IWrappedItem
- Optional data: IEventData
Returns void

setExperience

setExperience(exp: string): Promise<void>

- Defined in index.d.ts:165
Parameters
- exp: string
Returns Promise<void>

setFullscreen

setFullscreen(fullscreen: boolean): void

- Defined in index.d.ts:210
Parameters
- fullscreen: boolean
Returns void

setMapStyle

setMapStyle(id: string): void

- Defined in index.d.ts:167
Parameters
- id: string
Returns void

showContent

showContent(requestOrData: IMetaRequest | IMetaLightResult): Promise<IMetaLayer>

- Defined in index.d.ts:198
Shows d.meta data on the map.

since

1.0.1 (possible to use IMetaLightResult)

Parameters
- requestOrData: IMetaRequest | IMetaLightResult
  
  d.meta request or d.meta result data
Returns Promise<IMetaLayer>

showItem

showItem(item: IMetaLightItem | IWrappedItem, options?: ICameraOptions): void

- Defined in index.d.ts:212
Parameters
- item: IMetaLightItem | IWrappedItem
- Optional options: ICameraOptions
Returns void

showPopup

showPopup(popup: IPopup): void

- Defined in index.d.ts:203
Parameters
- popup: IPopup
Returns void

showTour

showTour(globalId: string): Promise<ILine>

- Defined in index.d.ts:201
Parameters
- globalId: string
Returns Promise<ILine>

unselectAll

unselectAll(): void

- Defined in index.d.ts:215
Returns void