Class MassifMap<T>

bearing

eventOptions

focusPos

ReadonlymapView

ReadonlymetersPerPixel

projection

restrictedPanning

tilt

zoom

StaticmapClickedEvent

StaticmapIdleEvent

StaticmapInteractionEvent

StaticmapMovedEvent

StaticmapReadyEvent

StaticmapStableEvent

addLayer

• addLayer(layer: Layer<any, any>, index?: number): any

  Parameters

  • layer: Layer<any, any>
  • Optionalindex: number

  Returns any

cancelAllTasks

• cancelAllTasks(): any

  Returns any

captureRendering

• captureRendering(wait?: boolean): Promise<ImageSource>

  Parameters

  • Optionalwait: boolean

  Returns Promise<ImageSource>

clearAllCaches

• clearAllCaches(): any

  Returns any

clearPreloadingCaches

• clearPreloadingCaches(): any

  Returns any

enableFacadeEvents

• enableFacadeEvents(
      eventOptions?: {
          mapClicked?: {
              debounce?: number;
              projection?: string;
              throttle?: number;
          };
          mapIdle?: { debounce?: number; projection?: string; throttle?: number };
          mapInteraction?: {
              debounce?: number;
              projection?: string;
              throttle?: number;
          };
          mapMoved?: { debounce?: number; projection?: string; throttle?: number };
          mapReady?: { debounce?: number; projection?: string; throttle?: number };
          mapStable?: { debounce?: number; projection?: string; throttle?: number };
      },
  ): void

  Called on map load; only needed to change the options afterwards.

  Parameters

  • OptionaleventOptions: {
        mapClicked?: {
            debounce?: number;
            projection?: string;
            throttle?: number;
        };
        mapIdle?: { debounce?: number; projection?: string; throttle?: number };
        mapInteraction?: {
            debounce?: number;
            projection?: string;
            throttle?: number;
        };
        mapMoved?: { debounce?: number; projection?: string; throttle?: number };
        mapReady?: { debounce?: number; projection?: string; throttle?: number };
        mapStable?: { debounce?: number; projection?: string; throttle?: number };
    }

  Returns void

flyTo

• flyTo(position: GenericMapPos<T>, options?: FlyToOptions): void

  Parameters

  • position: GenericMapPos<T>
  • Optionaloptions: FlyToOptions

  Returns void

fromNativeMapPos

• fromNativeMapPos(position: any): GenericMapPos<T>

  Parameters

  • position: any

  Returns GenericMapPos<T>

getFlightProgress

• getFlightProgress(): number

  0..1 while a flight is running, -1 when there is none

  Returns number

getFocusPos

• getFocusPos(): GenericMapPos<T>

  Returns GenericMapPos<T>

getFogOptions

• getFogOptions(): FogOptions

  Returns FogOptions

getLayers

• getLayers(): Layers<any>

  Returns Layers<any>

getLightOptions

• getLightOptions(): LightOptions

  Returns LightOptions

getMapBounds

• getMapBounds(): MapBounds<T>

  Returns MapBounds<T>

getOptions

• getOptions(): MapOptions

  wrapped and cached; null until the map is ready

  Returns MapOptions

getPostProcessEffect

• getPostProcessEffect(): PostProcessEffect

  full-screen shader run on the finished frame; null takes it off again

  Returns PostProcessEffect

getSkyOptions

• getSkyOptions(): SkyOptions

  Returns SkyOptions

getTerrainOptions

• getTerrainOptions(): TerrainOptions

  Returns TerrainOptions

getZoom

• getZoom(): number

  Returns number

isFlightActive

• isFlightActive(): boolean

  Returns boolean

mapToScreen

• mapToScreen(pos: any): ScreenPos

  Parameters

  • pos: any

  Returns ScreenPos

moveToFitBounds

• moveToFitBounds(
      mapBounds: MapBounds<T>,
      screenBounds: ScreenBounds,
      integerZoom: boolean,
      resetRotation: boolean,
      resetTilt: boolean,
      durationSeconds: number,
  ): any

  Parameters

  • mapBounds: MapBounds<T>
  • screenBounds: ScreenBounds
  • integerZoom: boolean
  • resetRotation: boolean
  • resetTilt: boolean
  • durationSeconds: number

  Returns any

off

• off<K extends keyof MassifMapEventMap>(
      event: K,
      callback?: (args: MassifMapEventMap[K]) => void,
      thisArg?: any,
  ): void

  Removes the listener(s) for the specified event name.

  Type Parameters

  • K extends keyof MassifMapEventMap

  Parameters

  • event: K
  • Optionalcallback: (args: MassifMapEventMap[K]) => void

    An optional specific event listener to remove (if omitted, all event listeners by this name will be removed).

  • OptionalthisArg: any

    An optional parameter which, when set, will be used to refine search of the correct event listener to be removed.

  Returns void

• off(event: string, callback?: (args: EventData) => void, thisArg?: any): void

  Parameters

  • event: string
  • Optionalcallback: (args: EventData) => void
  • OptionalthisArg: any

  Returns void

on

• on<K extends keyof MassifMapEventMap>(
      event: K,
      callback: (args: MassifMapEventMap[K]) => void,
      thisArg?: any,
  ): void

  Adds a listener for the specified event name.

  Type Parameters

  • K extends keyof MassifMapEventMap

  Parameters

  • event: K
  • callback: (args: MassifMapEventMap[K]) => void

    The event listener to add. Will be called when an event of the given name is raised.

  • OptionalthisArg: any

    An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.

  Returns void

• on(event: string, callback: (args: EventData) => void, thisArg?: any): void

  Raised when a loaded event occurs.

  Parameters

  • event: string
  • callback: (args: EventData) => void
  • OptionalthisArg: any

  Returns void

once

• once<K extends keyof MassifMapEventMap>(
      event: K,
      callback: (args: MassifMapEventMap[K]) => void,
      thisArg?: any,
  ): void

  Adds a listener for the specified event name, which, once fired, will remove itself.

  Type Parameters

  • K extends keyof MassifMapEventMap

  Parameters

  • event: K
  • callback: (args: MassifMapEventMap[K]) => void

    The event listener to add. Will be called when an event of the given name is raised.

  • OptionalthisArg: any

    An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.

  Returns void

• once(event: string, callback: (args: EventData) => void, thisArg?: any): void

  Parameters

  • event: string
  • callback: (args: EventData) => void
  • OptionalthisArg: any

  Returns void

removeAllLayers

• removeAllLayers(layers: Layer<any, any>[]): any

  Parameters

  • layers: Layer<any, any>[]

  Returns any

removeLayer

• removeLayer(layer: Layer<any, any>): any

  Parameters

  • layer: Layer<any, any>

  Returns any

requestRedraw

• requestRedraw(): any

  Returns any

screenToMap

• screenToMap(pos: any): GenericMapPos<T>

  Parameters

  • pos: any

  Returns GenericMapPos<T>

sendEvent

• sendEvent(eventName: string, data?: any): any

  Parameters

  • eventName: string
  • Optionaldata: any

  Returns any

setBearing

• setBearing(value: number, duration?: number): any

  Parameters

  • value: number
  • Optionalduration: number

  Returns any

setFocusPos

• setFocusPos(value: GenericMapPos<T>, duration?: number): any

  Parameters

  • value: GenericMapPos<T>
  • Optionalduration: number

  Returns any

setFogOptions

• setFogOptions(fog: FogOptions): void

  Parameters

  • fog: FogOptions

  Returns void

setLightOptions

• setLightOptions(light: LightOptions): void

  Parameters

  • light: LightOptions

  Returns void

setMapRotation

• setMapRotation(
      value: number,
      target: number | GenericMapPos<T>,
      duration?: number,
  ): any

  Parameters

  • value: number
  • target: number | GenericMapPos<T>
  • Optionalduration: number

  Returns any

setPostProcessEffect

• setPostProcessEffect(effect: PostProcessEffect): void

  Parameters

  • effect: PostProcessEffect

  Returns void

setSkyOptions

• setSkyOptions(sky: SkyOptions): void

  Parameters

  • sky: SkyOptions

  Returns void

setTerrainOptions

• setTerrainOptions(terrain: TerrainOptions): void

  Parameters

  • terrain: TerrainOptions

  Returns void

setTilt

• setTilt(value: number, duration?: number): any

  Parameters

  • value: number
  • Optionalduration: number

  Returns any

setZoom

• setZoom(
      value: number,
      target: number | GenericMapPos<T>,
      duration?: number,
  ): any

  Parameters

  • value: number
  • target: number | GenericMapPos<T>
  • Optionalduration: number

  Returns any

stopFlight

• stopFlight(): void

  Returns void

StaticsetRunOnMainThread

• setRunOnMainThread(value: boolean): any

  Whether every native listener the plugin installs hops to the main thread and waits before calling JS (default true): the SDK calls back from threads with no JS runtime.

  Parameters

  • value: boolean

  Returns any