Class MaptilerGeolocateControlMaptiler

options

fire

• fire(event: string | Event, properties?: any): this

  Parameters

  • event: string | Event
  • Optionalproperties: any

  Returns this

listens

• listens(type: string): boolean

  Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

  Parameters

  • type: string

    The event type

  Returns boolean

  true if there is at least one registered listener for specified event type, false otherwise

off

• off(type: string, listener: Listener): this

  Removes a previously registered event listener.

  Parameters

  • type: string

    The event type to remove listeners for.

  • listener: Listener

    The listener function to remove.

  Returns this

on

• on(type: string, listener: Listener): Subscription

  Adds a listener to a specified event type.

  Parameters

  • type: string

    The event type to add a listen for.

  • listener: Listener

    The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

  Returns Subscription

once

• once(type: string, listener?: Listener): Promise<any> | MaptilerGeolocateControl

  Adds a listener that will be called only once to a specified event type.

  The listener will be called first time the event fires after the listener is registered.

  Parameters

  • type: string

    The event type to listen for.

  • Optionallistener: Listener

    The function to be called when the event is fired the first time.

  Returns Promise<any> | MaptilerGeolocateControl

  this or a promise if a listener is not provided

onRemove

• onRemove(): void

  Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map.removeControl internally.

  Returns void

setEventedParent

• setEventedParent(parent?: Evented | null, data?: any): this

  Bubble all events fired by this instance of Evented to this parent instance of Evented.

  Parameters

  • Optionalparent: Evented | null
  • Optionaldata: any

  Returns this

trigger

• trigger(): boolean

  Programmatically request and move the map to the user's location.

  Returns boolean

  false if called before control was added to a map, otherwise returns true.

  Example

  // Initialize the geolocate control.
  let geolocate = new GeolocateControl({
   positionOptions: {
     enableHighAccuracy: true
   },
   trackUserLocation: true
  });
  // Add the control to the map.
  map.addControl(geolocate);
  map.on('load', () => {
    geolocate.trigger();
  });