Peristiwa

Pilih platform: Android iOS JavaScript

Halaman ini menjelaskan peristiwa antarmuka pengguna dan peristiwa error yang bisa Anda pantau dan tangani lewat program.

Peristiwa Antarmuka Pengguna

JavaScript dalam browser digerakkan oleh peristiwa, yang berarti bahwa JavaScript merespons interaksi dengan menghasilkan peristiwa, dan mengharapkan program untuk memantau peristiwa yang menarik. Ada dua jenis peristiwa:

  • Peristiwa pengguna (seperti peristiwa mouse "klik") disebarkan dari DOM ke Maps JavaScript API. Semua peristiwa ini terpisah dan berbeda dari peristiwa DOM standar.
  • Notifikasi perubahan status MVC mencerminkan perubahan dalam objek Maps JavaScript API dan diberi nama menggunakan ketentuan property_changed.

Setiap objek Maps JavaScript API mengekspor sejumlah peristiwa yang telah diberi nama. Program yang tertarik dengan peristiwa tertentu akan mendaftarkan pemroses peristiwa JavaScript untuk peristiwa tersebut dan mengeksekusi kode jika peristiwa tersebut diterima dengan memanggil addListener() untuk mendaftarkan pengendali peristiwa pada objek.

Contoh di bawah akan menunjukkan peristiwa yang dipicu oleh google.maps.Map saat Anda berinteraksi dengan peta.

Untuk mengetahui daftar lengkap peristiwa, lihat Referensi Maps JavaScript API. Peristiwa dicantumkan dalam bagian terpisah untuk setiap objek yang berisi peristiwa.

Peristiwa UI

Beberapa objek dalam Maps JavaScript API dirancang untuk merespons peristiwa pengguna seperti peristiwa mouse atau keyboard. Berikut beberapa contoh peristiwa pengguna yang dapat dipantau oleh objek google.maps.Marker:

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

Untuk daftar lengkapnya, lihat class Marker. Peristiwa ini mungkin terlihat seperti peristiwa DOM standar, tetapi sebenarnya merupakan bagian dari Maps JavaScript API. Karena browser yang berbeda mengimplementasikan model peristiwa DOM yang berbeda, Maps JavaScript API akan menyediakan mekanisme ini untuk memantau dan merespons peristiwa DOM tanpa perlu menangani beragam kekhasan lintas-browser. Peristiwa ini juga biasanya meneruskan argumen dalam peristiwa dengan memperhatikan beberapa status UI (seperti posisi mouse).

Perubahan Status MVC

Objek MVC biasanya berisi status. Setiap kali properti objek berubah, Maps JavaScript API akan memicu peristiwa yang telah diubah oleh properti. Misalnya, API akan memicu peristiwa zoom_changed pada peta jika tingkat zoom peta berubah. Anda dapat mencegat perubahan status ini dengan memanggil addListener() untuk mendaftarkan pengendali peristiwa pada objek tersebut juga.

Peristiwa pengguna dan perubahan status MVC mungkin tampak serupa, tetapi biasanya Anda ingin memperlakukannya secara berbeda dalam kode. Peristiwa MVC, misalnya, tidak meneruskan argumen dalam peristiwanya. Sebaiknya Anda memeriksa properti yang berubah saat perubahan status MVC dengan memanggil metode getProperty yang sesuai pada objek tersebut.

Menangani Peristiwa

Untuk mendaftar notifikasi peristiwa, gunakan pengendali peristiwa addListener(). Metode itu mengambil sebuah peristiwa yang akan dipantau, dan sebuah fungsi yang akan dipanggil jika terjadi peristiwa yang ditentukan.

Contoh: Peristiwa Peta dan Penanda

Kode berikut mencampur peristiwa pengguna dengan peristiwa perubahan status. Kami melekatkan sebuah pengendali peristiwa pada penanda yang akan memperbesar peta jika diklik. Kami juga menambahkan pengendali peristiwa pada peta untuk perubahan pada properti center dan menggeser peta kembali ke penanda 3 detik setelah menerima peristiwa center_changed:

TypeScript

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;

JavaScript

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;
Lihat contoh

Mencoba Contoh

Tips: Jika Anda mencoba mendeteksi perubahan di area pandang, pastikan menggunakan peristiwa bounds_changed spesifik daripada peristiwa zoom_changed dan center_changed konstituen. Karena Maps JavaScript API memicu peristiwa terakhir ini secara independen, getBounds() mungkin tidak melaporkan hasil yang berguna hingga area pandang berubah secara otoritatif. Jika Anda menginginkan getBounds() setelah peristiwa tersebut, pastikan untuk memantau peristiwa bounds_changed.

Contoh: Peristiwa Penarikan dan Pengeditan Bentuk

Saat sebuah bentuk diedit atau ditarik, sebuah peristiwa akan dipicu setelah tindakan selesai. Untuk daftar peristiwa dan beberapa cuplikan kode, lihat Bentuk.

Lihat contoh (rectangle-event.html)

Mengakses Argumen di Peristiwa UI

Peristiwa UI dalam Maps JavaScript API biasanya meneruskan argumen peristiwa, yang dapat diakses oleh pemroses peristiwa, dengan memperhatikan status UI saat peristiwa tersebut terjadi. Misalnya, peristiwa 'click' UI biasanya meneruskan MouseEvent yang berisi properti latLng yang menunjukkan lokasi yang diklik pada peta. Perhatikan, perilaku ini unik untuk peristiwa UI; perubahan status MVC tidak meneruskan argumen dalam peristiwanya.

Anda bisa mengakses argumen peristiwa dalam pemroses peristiwa dengan cara yang sama seperti mengakses properti objek. Contoh berikut menambahkan pemroses peristiwa untuk peta, dan membuat penanda jika pengguna mengklik peta di lokasi yang diklik.

TypeScript

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;

JavaScript

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;
Lihat contoh

Mencoba Contoh

Menggunakan Closures di Pemroses Peristiwa

Saat mengeksekusi pemroses peristiwa, sering kali akan menguntungkan jika melekatkan data pribadi dan data persisten ke objek. JavaScript tidak mendukung data instance "pribadi", tetapi mendukung closures yang memungkinkan fungsi internal untuk mengakses variabel luar. Closures berguna dalam pemroses peristiwa untuk mengakses variabel yang biasanya tidak melekat pada objek yang menjadi tempat peristiwa terjadi.

Contoh berikut menggunakan closure fungsi dalam pemroses peristiwa untuk memberikan pesan rahasia pada satu set penanda. Mengklik setiap penanda akan mengungkapkan sebagian pesan rahasia tersebut, yang tidak ada dalam penanda itu sendiri.

TypeScript

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;

JavaScript

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;
Lihat contoh

Mencoba Contoh

Mendapatkan dan Menetapkan Properti dalam Pengendali Peristiwa

Tidak satu pun dari peristiwa perubahan status MVC di sistem peristiwa Maps JavaScript API yang meneruskan argumen jika peristiwa ini terpicu. (Peristiwa pengguna meneruskan argumen yang bisa diperiksa.) Jika Anda perlu memeriksa properti pada perubahan status MVC, Anda harus secara eksplisit memanggil metode getProperty() yang sesuai pada objek tersebut. Pemeriksaan ini akan selalu mengambil status saat ini dari objek MVC, yang mungkin bukan merupakan status saat peristiwa pertama kali dipicu.

Catatan: Menetapkan properti secara eksplisit dalam sebuah pengendali peristiwa yang merespons perubahan status properti tertentu mungkin menghasilkan perilaku yang tidak terduga dan/atau tidak diinginkan. Menetapkan properti tersebut akan memicu peristiwa baru, misalnya, dan jika selalu menetapkan properti dalam pengendali peristiwa ini, Anda mungkin akhirnya akan menciptakan loop tak terhingga.

Dalam contoh di bawah ini, kita mempersiapkan sebuah pengendali peristiwa untuk merespons peristiwa zoom dengan memunculkan jendela info yang menampilkan tingkatan tersebut.

TypeScript

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;

JavaScript

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;
Lihat contoh

Mencoba Contoh

Memantau Peristiwa DOM

Model peristiwa Maps JavaScript API membuat dan mengelola peristiwa kustomnya sendiri. Namun, DOM (Document Object Model) dalam browser juga membuat dan menugaskan peristiwanya sendiri, sesuai dengan model peristiwa browser tertentu yang digunakan. Jika Anda ingin mencatat dan merespons peristiwa ini, Maps JavaScript API menyediakan metode statis addDomListener() untuk memantau dan mengikat peristiwa DOM.

Metode praktis ini memiliki tanda tangan seperti yang ditampilkan di bawah ini:

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

dengan instance dapat berupa elemen DOM apa pun yang didukung oleh browser, termasuk:

  • Anggota hierarki DOM seperti window atau document.body.myform
  • Elemen yang telah diberi nama seperti document.getElementById("foo")

Perhatikan bahwa addDomListener() meneruskan peristiwa yang ditunjukkan ke browser, yang menanganinya sesuai dengan model peristiwa DOM browser. Namun, hampir semua browser modern setidaknya mendukung DOM Level 2. (Untuk informasi selengkapnya tentang peristiwa level DOM, lihat referensi Mozilla DOM Levels.)

TypeScript

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;

JavaScript

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;

HTML

<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.
      See https://developers.google.com/maps/documentation/javascript/load-maps-js-api
      for more information.
      -->
    <script
      src="https://maps.googleapis.com/maps/api/js?key=AIzaSyB41DRUbKWJHPxaFjMAwdrzWzbVKartNGg&callback=initMap&v=weekly"
      defer
    ></script>
  </body>
</html>
Lihat contoh

Mencoba Contoh

Meskipun jika kode di atas adalah kode Maps JavaScript API, metode addDomListener() akan diikat ke objek window browser dan memungkinkan API ini berkomunikasi dengan objek di luar domain normal API.

Menghapus Pemroses Peristiwa

Pemroses peristiwa tertentu harus diberikan dahulu ke sebuah variabel untuk menghapusnya. Anda kemudian dapat memanggil removeListener(), dengan meneruskan nama variabel yang diberikan ke pemroses.

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

google.maps.event.removeListener(listener1);

Untuk menghapus semua pemroses dari instance tertentu, panggil clearInstanceListeners() dengan meneruskan nama instance.

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

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

Untuk menghapus semua pemroses yang berjenis peristiwa tertentu untuk instance spesifik, panggil clearListeners(), dengan meneruskan nama instance dan nama peristiwa.

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');

Untuk informasi selengkapnya, lihat dokumentasi referensi untuk namespace google.maps.event.

Memantau error autentikasi

Jika Anda ingin mendeteksi kegagalan autentikasi lewat program (misalnya untuk mengirim beacon secara otomatis), Anda bisa mempersiapkan fungsi callback. Jika sudah didefinisikan, fungsi global berikut akan dipanggil ketika autentikasi gagal. function gm_authFailure() { /* Code */ };