Eventi

In questa pagina vengono descritti gli eventi dell'interfaccia utente e gli eventi di errore che puoi ascoltare e gestire in modo programmatico.

Eventi dell'interfaccia utente

JavaScript all'interno del browser è basato sugli eventi, il che significa che JavaScript risponde alle interazioni generando eventi e prevede che un programma ascolti gli eventi interessanti. Esistono due tipi di eventi:

• Gli eventi utente (ad esempio gli eventi del mouse "Clic") vengono propagati dal DOM all'API Maps JavaScript. Questi eventi sono separati e distinti dagli eventi DOM standard.
• Le notifiche di modifica dello stato di MVC riflettono le modifiche negli oggetti dell'API Maps JavaScript e vengono denominate utilizzando una convenzione property_changed.

Ogni oggetto dell'API Maps JavaScript esporta una serie di eventi denominati. I programmi interessati a determinati eventi registreranno listener di eventi JavaScript per tali eventi ed eseguiranno codice quando verranno ricevuti chiamando addListener() per registrare i gestori di eventi sull'oggetto.

L'esempio riportato di seguito mostra quali eventi vengono attivati da google.maps.Map quando interagisci con la mappa.

Per un elenco completo degli eventi, consulta la documentazione relativa all'API Maps JavaScript. Gli eventi sono elencati in una sezione separata per ogni oggetto che contiene eventi.

Eventi UI

Alcuni oggetti all'interno dell'API Maps JavaScript sono progettati per rispondere a eventi utente come eventi del mouse o della tastiera. Ad esempio, ecco alcuni degli eventi utente che un oggetto google.maps.Marker può ascoltare:

• 'click'
• 'dblclick'
• 'mouseup'
• 'mousedown'
• 'mouseover'
• 'mouseout'

Per l'elenco completo, consulta la classe Marker. Questi eventi possono sembrare eventi DOM standard, ma in realtà fanno parte dell'API Maps JavaScript. Poiché diversi browser implementano modelli di eventi DOM diversi, l'API Maps JavaScript fornisce questi meccanismi per ascoltare e rispondere agli eventi DOM senza dover gestire le varie peculiarità dei vari browser. Questi eventi in genere trasmettono argomenti anche all'interno dell'evento, notando alcuni stati dell'interfaccia utente (ad esempio la posizione del mouse).

Modifiche allo stato della MVC

In genere gli oggetti MVC contengono uno stato. Ogni volta che la proprietà di un oggetto cambia, l'API Maps JavaScript attiva un evento che la proprietà è stata modificata. Ad esempio, l'API attiva un evento zoom_changed su una mappa quando il livello di zoom della mappa cambia. Puoi intercettare queste modifiche di stato chiamando addListener() per registrare anche i gestori di eventi sull'oggetto.

Gli eventi utente e le modifiche dello stato delle MVC possono essere simili, ma in genere vuoi trattarli in modo diverso nel codice. Gli eventi MVC, ad esempio, non trasmettono argomenti all'interno del relativo evento. Ti consigliamo di esaminare la proprietà che ha subito una modifica allo stato della MVC chiamando il metodo getProperty appropriato per l'oggetto in questione.

Gestione degli eventi

Per registrarti alle notifiche di eventi, utilizza il gestore di eventi addListener(). Questo metodo richiede un evento per l'ascolto e una funzione da chiamare quando si verifica l'evento specificato.

Esempio: eventi mappa e indicatore

Il seguente codice unisce gli eventi utente agli eventi di modifica dello stato. Alleghiamo un gestore di eventi a un indicatore che esegue lo zoom sulla mappa quando viene fatto clic. Aggiungiamo anche un gestore di eventi alla mappa per eventuali modifiche alla proprietà center e eseguiamo una panoramica della mappa fino all'indicatore dopo 3 secondi dalla ricezione dell'evento center_changed:

function initMap(): void {
  const myLatlng = { lat: -25.363, lng: 131.044 };

  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 4,
      center: myLatlng,
    }
  );

  const marker = new google.maps.Marker({
    position: myLatlng,
    map,
    title: "Click to zoom",
  });

  map.addListener("center_changed", () => {
    // 3 seconds after the center of the map has changed, pan back to the
    // marker.
    window.setTimeout(() => {
      map.panTo(marker.getPosition() as google.maps.LatLng);
    }, 3000);
  });

  marker.addListener("click", () => {
    map.setZoom(8);
    map.setCenter(marker.getPosition() as google.maps.LatLng);
  });
}

declare global {
  interface Window {
    initMap: () => void;
  }
}
window.initMap = initMap;
index.ts

function initMap() {
  const myLatlng = { lat: -25.363, lng: 131.044 };
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 4,
    center: myLatlng,
  });
  const marker = new google.maps.Marker({
    position: myLatlng,
    map,
    title: "Click to zoom",
  });

  map.addListener("center_changed", () => {
    // 3 seconds after the center of the map has changed, pan back to the
    // marker.
    window.setTimeout(() => {
      map.panTo(marker.getPosition());
    }, 3000);
  });
  marker.addListener("click", () => {
    map.setZoom(8);
    map.setCenter(marker.getPosition());
  });
}

window.initMap = initMap;
index.js

Suggerimento: se vuoi rilevare una modifica nell'area visibile, assicurati di utilizzare l'evento bounds_changed specifico anziché gli eventi zoom_changed e center_changed. Poiché l'API Maps JavaScript attiva questi ultimi eventi in modo indipendente, getBounds() potrebbe non fornire risultati utili finché il visualizzatore non è cambiato intenzionalmente. Se vuoi getBounds() dopo questo evento, assicurati di ascoltare l'evento bounds_changed.

Esempio: modifica di forme e trascinamento di eventi

Quando una forma viene modificata o trascinata, un evento viene attivato al termine dell'azione. Per un elenco degli eventi e di alcuni snippet di codice, consulta Forme.

Visualizza esempio (rectangle-event.html)

Accesso agli argomenti negli eventi della UI

In genere, gli eventi UI all'interno dell'API Maps JavaScript trasmettono un argomento evento, a cui il listener di eventi può accedere, annotando lo stato della UI quando si è verificato l'evento. Ad esempio, un evento 'click' della UI generalmente trasmette un MouseEvent contenente una proprietà latLng che indica la posizione selezionata sulla mappa. Tieni presente che questo comportamento è specifico per gli eventi UI; le modifiche di stato delle MVC non trasferiscono argomenti nei loro eventi.

Puoi accedere agli argomenti dell'evento in un listener di eventi nello stesso modo in cui accedi alle proprietà di un oggetto. L'esempio riportato di seguito aggiunge un listener di eventi per la mappa e crea un indicatore quando l'utente fa clic sulla mappa nella posizione selezionata.

function initMap(): void {
  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 4,
      center: { lat: -25.363882, lng: 131.044922 },
    }
  );

  map.addListener("click", (e) => {
    placeMarkerAndPanTo(e.latLng, map);
  });
}

function placeMarkerAndPanTo(latLng: google.maps.LatLng, map: google.maps.Map) {
  new google.maps.Marker({
    position: latLng,
    map: map,
  });
  map.panTo(latLng);
}

declare global {
  interface Window {
    initMap: () => void;
  }
}
window.initMap = initMap;
index.ts

function initMap() {
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 4,
    center: { lat: -25.363882, lng: 131.044922 },
  });

  map.addListener("click", (e) => {
    placeMarkerAndPanTo(e.latLng, map);
  });
}

function placeMarkerAndPanTo(latLng, map) {
  new google.maps.Marker({
    position: latLng,
    map: map,
  });
  map.panTo(latLng);
}

window.initMap = initMap;
index.js

Utilizzo delle chiusure nei listener di eventi

Quando si esegue un listener di eventi, è spesso vantaggioso avere dati privati e permanenti associati a un oggetto. JavaScript non supporta i dati delle istanze "private", ma supporta le chiusure che consentono alle funzioni interne di accedere alle variabili esterne. Le chiusure sono utili all'interno dei listener di eventi per accedere alle variabili normalmente non collegate agli oggetti su cui si verificano gli eventi.

L'esempio seguente utilizza una chiusura di funzione nel listener di eventi per assegnare un messaggio secret a un insieme di indicatori. Se fai clic su ciascun indicatore, verrà visualizzata una parte del messaggio segreto, che non è incluso all'interno dell'indicatore stesso.

function initMap(): void {
  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 4,
      center: { lat: -25.363882, lng: 131.044922 },
    }
  );

  const bounds: google.maps.LatLngBoundsLiteral = {
    north: -25.363882,
    south: -31.203405,
    east: 131.044922,
    west: 125.244141,
  };

  // Display the area between the location southWest and northEast.
  map.fitBounds(bounds);

  // Add 5 markers to map at random locations.
  // For each of these markers, give them a title with their index, and when
  // they are clicked they should open an infowindow with text from a secret
  // message.
  const secretMessages = ["This", "is", "the", "secret", "message"];
  const lngSpan = bounds.east - bounds.west;
  const latSpan = bounds.north - bounds.south;

  for (let i = 0; i < secretMessages.length; ++i) {
    const marker = new google.maps.Marker({
      position: {
        lat: bounds.south + latSpan * Math.random(),
        lng: bounds.west + lngSpan * Math.random(),
      },
      map: map,
    });

    attachSecretMessage(marker, secretMessages[i]);
  }
}

// Attaches an info window to a marker with the provided message. When the
// marker is clicked, the info window will open with the secret message.
function attachSecretMessage(
  marker: google.maps.Marker,
  secretMessage: string
) {
  const infowindow = new google.maps.InfoWindow({
    content: secretMessage,
  });

  marker.addListener("click", () => {
    infowindow.open(marker.get("map"), marker);
  });
}

declare global {
  interface Window {
    initMap: () => void;
  }
}
window.initMap = initMap;
index.ts

function initMap() {
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 4,
    center: { lat: -25.363882, lng: 131.044922 },
  });
  const bounds = {
    north: -25.363882,
    south: -31.203405,
    east: 131.044922,
    west: 125.244141,
  };

  // Display the area between the location southWest and northEast.
  map.fitBounds(bounds);

  // Add 5 markers to map at random locations.
  // For each of these markers, give them a title with their index, and when
  // they are clicked they should open an infowindow with text from a secret
  // message.
  const secretMessages = ["This", "is", "the", "secret", "message"];
  const lngSpan = bounds.east - bounds.west;
  const latSpan = bounds.north - bounds.south;

  for (let i = 0; i < secretMessages.length; ++i) {
    const marker = new google.maps.Marker({
      position: {
        lat: bounds.south + latSpan * Math.random(),
        lng: bounds.west + lngSpan * Math.random(),
      },
      map: map,
    });

    attachSecretMessage(marker, secretMessages[i]);
  }
}

// Attaches an info window to a marker with the provided message. When the
// marker is clicked, the info window will open with the secret message.
function attachSecretMessage(marker, secretMessage) {
  const infowindow = new google.maps.InfoWindow({
    content: secretMessage,
  });

  marker.addListener("click", () => {
    infowindow.open(marker.get("map"), marker);
  });
}

window.initMap = initMap;
index.js

Recupero e impostazione delle proprietà nei gestori di eventi

Nessuno degli eventi di modifica di stato MVC nel sistema di eventi dell'API JavaScript di Maps trasmette argomenti quando viene attivato l'evento. Gli eventi utente trasmettono argomenti che possono essere ispezionati. Se devi controllare una proprietà in una modifica di stato MVC, chiama esplicitamente il metodo getProperty() appropriato per l'oggetto in questione. Questa ispezione recupera sempre lo stato attuale dell'oggetto MVC, che potrebbe non corrispondere a quello della prima attivazione dell'evento.

Nota: l'impostazione esplicita di una proprietà all'interno di un gestore di eventi che risponde a una modifica dello stato di quella specifica proprietà può produrre comportamenti imprevedibili e/o indesiderati. L'impostazione di questa proprietà attiva un nuovo evento, ad esempio, e se imposti sempre una proprietà all'interno di questo gestore di eventi, potresti creare un loop infinito.

Nell'esempio riportato di seguito, abbiamo configurato un gestore di eventi per rispondere agli eventi di zoom aprendo una finestra informativa che mostra quel livello.

function initMap(): void {
  const originalMapCenter = new google.maps.LatLng(-25.363882, 131.044922);
  const map = new google.maps.Map(
    document.getElementById("map") as HTMLElement,
    {
      zoom: 4,
      center: originalMapCenter,
    }
  );

  const infowindow = new google.maps.InfoWindow({
    content: "Change the zoom level",
    position: originalMapCenter,
  });

  infowindow.open(map);

  map.addListener("zoom_changed", () => {
    infowindow.setContent("Zoom: " + map.getZoom()!);
  });
}

declare global {
  interface Window {
    initMap: () => void;
  }
}
window.initMap = initMap;
index.ts

function initMap() {
  const originalMapCenter = new google.maps.LatLng(-25.363882, 131.044922);
  const map = new google.maps.Map(document.getElementById("map"), {
    zoom: 4,
    center: originalMapCenter,
  });
  const infowindow = new google.maps.InfoWindow({
    content: "Change the zoom level",
    position: originalMapCenter,
  });

  infowindow.open(map);
  map.addListener("zoom_changed", () => {
    infowindow.setContent("Zoom: " + map.getZoom());
  });
}

window.initMap = initMap;
index.js

Ascolto degli eventi DOM

Il modello di evento dell'API Maps JavaScript crea e gestisce i propri eventi personalizzati. Tuttavia, il DOM (Document Object Model) all'interno del browser crea e invia anche i propri eventi, in base al modello di evento del browser in uso. Se vuoi acquisire e rispondere a questi eventi, l'API Maps JavaScript fornisce il metodo statico addDomListener() per ascoltare e associare gli eventi DOM.

Questo metodo pratico ha una firma come mostrato di seguito:

addDomListener(instance:Object, eventName:string, handler:Function)

in cui instance può essere qualsiasi elemento DOM supportato dal browser, tra cui:

• Membri gerarchici del DOM, ad esempio window o document.body.myform
• Elementi con nome come document.getElementById("foo")

Tieni presente che addDomListener() trasmette l'evento indicato al browser, che lo gestisce in base al modello di evento DOM del browser; tuttavia, quasi tutti i browser moderni supportano almeno il livello DOM 2. Per ulteriori informazioni sugli eventi a livello di DOM, consulta il riferimento Livelli DOM Mozilla.

function initMap(): void {
  const mapDiv = document.getElementById("map") as HTMLElement;
  const map = new google.maps.Map(mapDiv, {
    zoom: 8,
    center: new google.maps.LatLng(-34.397, 150.644),
  });

  // We add a DOM event here to show an alert if the DIV containing the
  // map is clicked.
  google.maps.event.addDomListener(mapDiv, "click", () => {
    window.alert("Map was clicked!");
  });
}

declare global {
  interface Window {
    initMap: () => void;
  }
}
window.initMap = initMap;
index.ts

function initMap() {
  const mapDiv = document.getElementById("map");
  const map = new google.maps.Map(mapDiv, {
    zoom: 8,
    center: new google.maps.LatLng(-34.397, 150.644),
  });

  // We add a DOM event here to show an alert if the DIV containing the
  // map is clicked.
  google.maps.event.addDomListener(mapDiv, "click", () => {
    window.alert("Map was clicked!");
  });
}

window.initMap = initMap;
index.js

<html>
  <head>
    <title>Listening to DOM Events</title>
    <script src="https://polyfill.io/v3/polyfill.min.js?features=default"></script>

    <link rel="stylesheet" type="text/css" href="./style.css" />
    <script type="module" src="./index.js"></script>
  </head>
  <body>
    <div id="map"></div>

    <!-- 
      The `defer` attribute causes the callback to execute after the full HTML
      document has been parsed. For non-blocking uses, avoiding race conditions,
      and consistent behavior across browsers, consider loading using Promises
      with https://www.npmjs.com/package/@googlemaps/js-api-loader.
      -->
    <script
      src="https://maps.googleapis.com/maps/api/js?key=AIzaSyB41DRUbKWJHPxaFjMAwdrzWzbVKartNGg&callback=initMap&v=weekly"
      defer
    ></script>
  </body>
</html>
index.html

Benché il codice sopra indicato sia l'API Maps JavaScript, il metodo addDomListener() si associa all'oggetto window del browser e consente all'API di comunicare con oggetti che esulano dal normale dominio dell'API.

Rimozione dei listener di eventi

Per rimuovere un listener di eventi specifico, deve essere stato assegnato a una variabile. Puoi quindi chiamare removeListener(), passando il nome della variabile a cui è stato assegnato il listener.

var listener1 = marker.addListener('click', aFunction);

google.maps.event.removeListener(listener1);

Per rimuovere tutti i listener da una determinata istanza, chiama clearInstanceListeners(), passando il nome dell'istanza.

var listener1 = marker.addListener('click', aFunction);
var listener2 = marker.addListener('mouseover', bFunction);

// Remove listener1 and listener2 from marker instance.
google.maps.event.clearInstanceListeners(marker);

Per rimuovere tutti i listener per un tipo di evento specifico per un'istanza specifica, chiama clearListeners(), trasmettendo il nome dell'istanza e il nome dell'evento.

marker.addListener('click', aFunction);
marker.addListener('click', bFunction);
marker.addListener('click', cFunction);

// Remove all click listeners from marker instance.
google.maps.event.clearListeners(marker, 'click');

Per ulteriori informazioni, consulta la documentazione di riferimento per lo spazio dei nomi google.maps.event.

In ascolto degli errori di autenticazione

Se vuoi rilevare in modo programmatico un errore di autenticazione (ad esempio per inviare automaticamente un beacon), puoi preparare una funzione di callback. Se viene definita la seguente funzione globale, verrà richiamata quando l'autenticazione non va a buon fine. function gm_authFailure() { /* Code */ };