परिचय
ओवरले, मैप पर मौजूद ऐसे ऑब्जेक्ट होते हैं जो अक्षांश/देशांतर के कोऑर्डिनेट से जुड़े होते हैं. इसलिए, मैप को खींचने या ज़ूम करने पर ये ऑब्जेक्ट भी मूव करते हैं. पहले से तय किए गए ओवरले टाइप के बारे में जानने के लिए, मैप पर ड्रॉ करना लेख पढ़ें.
Maps JavaScript API, कस्टम ओवरले बनाने के लिए
OverlayView क्लास उपलब्ध कराता है. OverlayView एक बेस क्लास है, जो कई ऐसे तरीके उपलब्ध कराती है जिन्हें ओवरले बनाते समय लागू करना ज़रूरी होता है. यह क्लास कुछ ऐसे तरीके भी उपलब्ध कराती है जिनकी मदद से, स्क्रीन के कोऑर्डिनेट और मैप पर मौजूद जगहों के बीच अनुवाद किया जा सकता है.
कस्टम ओवरले जोड़ना
कस्टम ओवरले बनाने के लिए ज़रूरी चरणों की खास जानकारी यहां दी गई है:
- अपने कस्टम ओवरले ऑब्जेक्ट के
prototypeकोgoogle.maps.OverlayView()के नए इंस्टेंस पर सेट करें. असल में, इससे ओवरले क्लास सबक्लास हो जाएगी. - अपने कस्टम ओवरले के लिए कंस्ट्रक्टर बनाएं और शुरुआती पैरामीटर सेट करें.
- अपने प्रोटोटाइप में
onAdd()तरीका लागू करें और ओवरले को मैप से जोड़ें. जब मैप, ओवरले को जोड़ने के लिए तैयार होगा, तबOverlayView.onAdd()को कॉल किया जाएगा. - अपने प्रोटोटाइप में
draw()तरीका लागू करें और अपने ऑब्जेक्ट के विज़ुअल डिसप्ले को मैनेज करें. जब ऑब्जेक्ट पहली बार दिखेगा, तबOverlayView.draw()को कॉल किया जाएगा. - ओवरले में जोड़े गए किसी भी एलिमेंट को साफ़ तौर पर हटाने के लिए, आपको
onRemove()तरीका भी लागू करना चाहिए.
यहां हर चरण के बारे में ज़्यादा जानकारी दी गई है. काम करने वाले पूरे सैंपल कोड को यहां देखा जा सकता है: सैंपल कोड देखें.
ओवरले को सबक्लास करना
यहां दिए गए उदाहरण में, एक सामान्य इमेज ओवरले बनाने के लिए OverlayView का इस्तेमाल किया गया है.
अब हम USGSOverlay क्लास के लिए एक कंस्ट्रक्टर बनाते हैं और पास किए गए पैरामीटर को नए ऑब्जेक्ट की प्रॉपर्टी के तौर पर शुरू करते हैं.
TypeScript
/** * The custom USGSOverlay object contains the USGS image, * the bounds of the image, and a reference to the map. */ class USGSOverlay extends google.maps.OverlayView { private bounds: google.maps.LatLngBounds; private image: string; private div?: HTMLElement; constructor(bounds: google.maps.LatLngBounds, image: string) { super(); this.bounds = bounds; this.image = image; }
JavaScript
/** * The custom USGSOverlay object contains the USGS image, * the bounds of the image, and a reference to the map. */ class USGSOverlay extends google.maps.OverlayView { bounds; image; div; constructor(bounds, image) { super(); this.bounds = bounds; this.image = image; }
हम फ़िलहाल, ओवरले के कंस्ट्रक्टर में इस ओवरले को मैप से नहीं जोड़ सकते. सबसे पहले, हमें यह पक्का करना होगा कि मैप के सभी पैन उपलब्ध हों. ऐसा इसलिए, क्योंकि ये पैन तय करते हैं कि मैप पर ऑब्जेक्ट किस क्रम में दिखेंगे. एपीआई, एक हेल्पर तरीका उपलब्ध कराता है. इससे पता चलता है कि ऐसा हो गया है. हम अगले सेक्शन में उस तरीके को मैनेज करेंगे.
ओवरले शुरू करना
जब ओवरले पहली बार इंस्टैंशिएट किया जाता है और डिसप्ले के लिए तैयार होता है, तो हमें इसे ब्राउज़र के डीओएम के ज़रिए मैप से जोड़ना होता है. एपीआई, ओवरले के onAdd() तरीके को लागू करके यह बताता है कि ओवरले को मैप में जोड़ दिया गया है. इस तरीके को मैनेज करने के लिए, हम अपनी इमेज को रखने के लिए एक <div> बनाते हैं, एक <img> एलिमेंट जोड़ते हैं, उसे <div> से जोड़ते हैं, और फिर ओवरले को मैप के किसी एक पैन से जोड़ते हैं. पैन, डीओएम ट्री में एक नोड होता है.
`MapPanes` टाइप के पैन, मैप पर अलग-अलग लेयर के लिए स्टैक करने का क्रम तय करते हैं.MapPanes ये पैन उपलब्ध हैं. इन्हें नीचे से ऊपर की ओर स्टैक किए जाने के क्रम में गिना जाता है:
mapPaneसबसे निचला पैन है और यह टाइल के ऊपर होता है. यह डीओएम इवेंट नहीं पा सकता. (पैन 0).overlayLayerमें पॉलीलाइन, पॉलीगॉन, ग्राउंड ओवरले, और टाइल लेयर ओवरले शामिल होते हैं. यह डीओएम इवेंट नहीं पा सकता. (पैन 1).markerLayerमें मार्कर शामिल होते हैं. यह डीओएम इवेंट नहीं पा सकता. (पैन 2).overlayMouseTargetमें ऐसे एलिमेंट शामिल होते हैं जो डीओएम इवेंट पाते हैं. (पैन 3).floatPaneमें जानकारी विंडो शामिल होती है. यह मैप के सभी ओवरले के ऊपर होता है. (पैन 4).
हमारी इमेज एक "ग्राउंड ओवरले" है. इसलिए, हम overlayLayer पैन का इस्तेमाल करेंगे. जब हमारे पास वह पैन होगा, तो हम अपने ऑब्जेक्ट को उसमें चाइल्ड के तौर पर जोड़ेंगे.
TypeScript
/** * onAdd is called when the map's panes are ready and the overlay has been * added to the map. */ onAdd() { this.div = document.createElement("div"); this.div.style.borderStyle = "none"; this.div.style.borderWidth = "0px"; this.div.style.position = "absolute"; // Create the img element and attach it to the div. const img = document.createElement("img"); img.src = this.image; img.style.width = "100%"; img.style.height = "100%"; img.style.position = "absolute"; this.div.appendChild(img); // Add the element to the "overlayLayer" pane. const panes = this.getPanes()!; panes.overlayLayer.appendChild(this.div); }
JavaScript
/** * onAdd is called when the map's panes are ready and the overlay has been * added to the map. */ onAdd() { this.div = document.createElement("div"); this.div.style.borderStyle = "none"; this.div.style.borderWidth = "0px"; this.div.style.position = "absolute"; // Create the img element and attach it to the div. const img = document.createElement("img"); img.src = this.image; img.style.width = "100%"; img.style.height = "100%"; img.style.position = "absolute"; this.div.appendChild(img); // Add the element to the "overlayLayer" pane. const panes = this.getPanes(); panes.overlayLayer.appendChild(this.div); }
ओवरले ड्रॉ करना
ध्यान दें कि हमने ऊपर दिए गए कोड में, किसी खास विज़ुअल डिसप्ले को लागू नहीं किया है. एपीआई, ओवरले पर एक अलग draw() तरीका लागू करता है. ऐसा तब होता है, जब उसे मैप पर ओवरले ड्रॉ करना होता है. इसमें पहली बार ओवरले जोड़ने का समय भी शामिल है.
इसलिए, हम इस draw() तरीके को लागू करेंगे. साथ ही, getProjection() का इस्तेमाल करके ओवरले का MapCanvasProjection हासिल करेंगे और उन सटीक कोऑर्डिनेट की गिनती करेंगे जिन पर ऑब्जेक्ट के ऊपर दाईं ओर और नीचे बाईं ओर के पॉइंट को ऐंकर करना है.
इसके बाद, हम <div> का साइज़ बदल सकते हैं. इससे इमेज का साइज़ भी बदल जाएगा, ताकि वह ओवरले के कंस्ट्रक्टर में तय की गई सीमाओं से मेल खाए.
TypeScript
draw() { // We use the south-west and north-east // coordinates of the overlay to peg it to the correct position and size. // To do this, we need to retrieve the projection from the overlay. const overlayProjection = this.getProjection(); // Retrieve the south-west and north-east coordinates of this overlay // in LatLngs and convert them to pixel coordinates. // We'll use these coordinates to resize the div. const sw = overlayProjection.fromLatLngToDivPixel( this.bounds.getSouthWest() )!; const ne = overlayProjection.fromLatLngToDivPixel( this.bounds.getNorthEast() )!; // Resize the image's div to fit the indicated dimensions. if (this.div) { this.div.style.left = sw.x + "px"; this.div.style.top = ne.y + "px"; this.div.style.width = ne.x - sw.x + "px"; this.div.style.height = sw.y - ne.y + "px"; } }
JavaScript
draw() { // We use the south-west and north-east // coordinates of the overlay to peg it to the correct position and size. // To do this, we need to retrieve the projection from the overlay. const overlayProjection = this.getProjection(); // Retrieve the south-west and north-east coordinates of this overlay // in LatLngs and convert them to pixel coordinates. // We'll use these coordinates to resize the div. const sw = overlayProjection.fromLatLngToDivPixel( this.bounds.getSouthWest(), ); const ne = overlayProjection.fromLatLngToDivPixel( this.bounds.getNorthEast(), ); // Resize the image's div to fit the indicated dimensions. if (this.div) { this.div.style.left = sw.x + "px"; this.div.style.top = ne.y + "px"; this.div.style.width = ne.x - sw.x + "px"; this.div.style.height = sw.y - ne.y + "px"; } }
कस्टम ओवरले हटाना
हम मैप से ओवरले को साफ़ तौर पर हटाने के लिए, onRemove() तरीका भी जोड़ते हैं.
TypeScript
/** * The onRemove() method will be called automatically from the API if * we ever set the overlay's map property to 'null'. */ onRemove() { if (this.div) { (this.div.parentNode as HTMLElement).removeChild(this.div); delete this.div; } }
JavaScript
/** * The onRemove() method will be called automatically from the API if * we ever set the overlay's map property to 'null'. */ onRemove() { if (this.div) { this.div.parentNode.removeChild(this.div); delete this.div; } }
कस्टम ओवरले छिपाना और दिखाना
अगर आपको ओवरले को बनाने या हटाने के बजाय, उसे छिपाना या दिखाना है, तो ओवरले की विज़िबिलिटी को अडजस्ट करने के लिए, अपने hide() और show() तरीके लागू किए जा सकते हैं. इसके अलावा, ओवरले को मैप के डीओएम से अलग किया जा सकता है. हालांकि, इस कार्रवाई में थोड़ा ज़्यादा समय लगता है. ध्यान दें कि अगर ओवरले को मैप के डीओएम से फिर से जोड़ा जाता है, तो ओवरले का onAdd() तरीका फिर से लागू होगा.
यहां दिए गए उदाहरण में, ओवरले के
प्रोटोटाइप में hide() और show() तरीके जोड़े गए हैं. इनसे कंटेनर <div> की विज़िबिलिटी टॉगल होती है. इसके अलावा, हम एक toggleDOM() तरीका जोड़ते हैं. इससे ओवरले को मैप से जोड़ा या अलग किया जाता है.
TypeScript
/** * Set the visibility to 'hidden' or 'visible'. */ hide() { if (this.div) { this.div.style.visibility = "hidden"; } } show() { if (this.div) { this.div.style.visibility = "visible"; } } toggle() { if (this.div) { if (this.div.style.visibility === "hidden") { this.show(); } else { this.hide(); } } } toggleDOM(map: google.maps.Map) { if (this.getMap()) { this.setMap(null); } else { this.setMap(map); } }
JavaScript
/** * Set the visibility to 'hidden' or 'visible'. */ hide() { if (this.div) { this.div.style.visibility = "hidden"; } } show() { if (this.div) { this.div.style.visibility = "visible"; } } toggle() { if (this.div) { if (this.div.style.visibility === "hidden") { this.show(); } else { this.hide(); } } } toggleDOM(map) { if (this.getMap()) { this.setMap(null); } else { this.setMap(map); } }
बटन कंट्रोल जोड़ना
toggle और toggleDom तरीकों को ट्रिगर करने के लिए, मैप में बटन कंट्रोल जोड़े जाते हैं.
TypeScript
const toggleButton = document.createElement("button"); toggleButton.textContent = "Toggle"; toggleButton.classList.add("custom-map-control-button"); const toggleDOMButton = document.createElement("button"); toggleDOMButton.textContent = "Toggle DOM Attachment"; toggleDOMButton.classList.add("custom-map-control-button"); toggleButton.addEventListener("click", () => { overlay.toggle(); }); toggleDOMButton.addEventListener("click", () => { overlay.toggleDOM(map); }); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleDOMButton); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleButton);
JavaScript
const toggleButton = document.createElement("button"); toggleButton.textContent = "Toggle"; toggleButton.classList.add("custom-map-control-button"); const toggleDOMButton = document.createElement("button"); toggleDOMButton.textContent = "Toggle DOM Attachment"; toggleDOMButton.classList.add("custom-map-control-button"); toggleButton.addEventListener("click", () => { overlay.toggle(); }); toggleDOMButton.addEventListener("click", () => { overlay.toggleDOM(map); }); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleDOMButton); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleButton);
पूरा सैंपल कोड
पूरा सैंपल कोड यहां दिया गया है:
TypeScript
// This example adds hide() and show() methods to a custom overlay's prototype. // These methods toggle the visibility of the container <div>. // overlay to or from the map. function initMap(): void { const map = new google.maps.Map( document.getElementById("map") as HTMLElement, { zoom: 11, center: { lat: 62.323907, lng: -150.109291 }, mapTypeId: "satellite", } ); const bounds = new google.maps.LatLngBounds( new google.maps.LatLng(62.281819, -150.287132), new google.maps.LatLng(62.400471, -150.005608) ); // The photograph is courtesy of the U.S. Geological Survey. let image = "https://developers.google.com/maps/documentation/javascript/"; image += "examples/full/images/talkeetna.png"; /** * The custom USGSOverlay object contains the USGS image, * the bounds of the image, and a reference to the map. */ class USGSOverlay extends google.maps.OverlayView { private bounds: google.maps.LatLngBounds; private image: string; private div?: HTMLElement; constructor(bounds: google.maps.LatLngBounds, image: string) { super(); this.bounds = bounds; this.image = image; } /** * onAdd is called when the map's panes are ready and the overlay has been * added to the map. */ onAdd() { this.div = document.createElement("div"); this.div.style.borderStyle = "none"; this.div.style.borderWidth = "0px"; this.div.style.position = "absolute"; // Create the img element and attach it to the div. const img = document.createElement("img"); img.src = this.image; img.style.width = "100%"; img.style.height = "100%"; img.style.position = "absolute"; this.div.appendChild(img); // Add the element to the "overlayLayer" pane. const panes = this.getPanes()!; panes.overlayLayer.appendChild(this.div); } draw() { // We use the south-west and north-east // coordinates of the overlay to peg it to the correct position and size. // To do this, we need to retrieve the projection from the overlay. const overlayProjection = this.getProjection(); // Retrieve the south-west and north-east coordinates of this overlay // in LatLngs and convert them to pixel coordinates. // We'll use these coordinates to resize the div. const sw = overlayProjection.fromLatLngToDivPixel( this.bounds.getSouthWest() )!; const ne = overlayProjection.fromLatLngToDivPixel( this.bounds.getNorthEast() )!; // Resize the image's div to fit the indicated dimensions. if (this.div) { this.div.style.left = sw.x + "px"; this.div.style.top = ne.y + "px"; this.div.style.width = ne.x - sw.x + "px"; this.div.style.height = sw.y - ne.y + "px"; } } /** * The onRemove() method will be called automatically from the API if * we ever set the overlay's map property to 'null'. */ onRemove() { if (this.div) { (this.div.parentNode as HTMLElement).removeChild(this.div); delete this.div; } } /** * Set the visibility to 'hidden' or 'visible'. */ hide() { if (this.div) { this.div.style.visibility = "hidden"; } } show() { if (this.div) { this.div.style.visibility = "visible"; } } toggle() { if (this.div) { if (this.div.style.visibility === "hidden") { this.show(); } else { this.hide(); } } } toggleDOM(map: google.maps.Map) { if (this.getMap()) { this.setMap(null); } else { this.setMap(map); } } } const overlay: USGSOverlay = new USGSOverlay(bounds, image); overlay.setMap(map); const toggleButton = document.createElement("button"); toggleButton.textContent = "Toggle"; toggleButton.classList.add("custom-map-control-button"); const toggleDOMButton = document.createElement("button"); toggleDOMButton.textContent = "Toggle DOM Attachment"; toggleDOMButton.classList.add("custom-map-control-button"); toggleButton.addEventListener("click", () => { overlay.toggle(); }); toggleDOMButton.addEventListener("click", () => { overlay.toggleDOM(map); }); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleDOMButton); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleButton); } declare global { interface Window { initMap: () => void; } } window.initMap = initMap;
JavaScript
// This example adds hide() and show() methods to a custom overlay's prototype. // These methods toggle the visibility of the container <div>. // overlay to or from the map. function initMap() { const map = new google.maps.Map(document.getElementById("map"), { zoom: 11, center: { lat: 62.323907, lng: -150.109291 }, mapTypeId: "satellite", }); const bounds = new google.maps.LatLngBounds( new google.maps.LatLng(62.281819, -150.287132), new google.maps.LatLng(62.400471, -150.005608), ); // The photograph is courtesy of the U.S. Geological Survey. let image = "https://developers.google.com/maps/documentation/javascript/"; image += "examples/full/images/talkeetna.png"; /** * The custom USGSOverlay object contains the USGS image, * the bounds of the image, and a reference to the map. */ class USGSOverlay extends google.maps.OverlayView { bounds; image; div; constructor(bounds, image) { super(); this.bounds = bounds; this.image = image; } /** * onAdd is called when the map's panes are ready and the overlay has been * added to the map. */ onAdd() { this.div = document.createElement("div"); this.div.style.borderStyle = "none"; this.div.style.borderWidth = "0px"; this.div.style.position = "absolute"; // Create the img element and attach it to the div. const img = document.createElement("img"); img.src = this.image; img.style.width = "100%"; img.style.height = "100%"; img.style.position = "absolute"; this.div.appendChild(img); // Add the element to the "overlayLayer" pane. const panes = this.getPanes(); panes.overlayLayer.appendChild(this.div); } draw() { // We use the south-west and north-east // coordinates of the overlay to peg it to the correct position and size. // To do this, we need to retrieve the projection from the overlay. const overlayProjection = this.getProjection(); // Retrieve the south-west and north-east coordinates of this overlay // in LatLngs and convert them to pixel coordinates. // We'll use these coordinates to resize the div. const sw = overlayProjection.fromLatLngToDivPixel( this.bounds.getSouthWest(), ); const ne = overlayProjection.fromLatLngToDivPixel( this.bounds.getNorthEast(), ); // Resize the image's div to fit the indicated dimensions. if (this.div) { this.div.style.left = sw.x + "px"; this.div.style.top = ne.y + "px"; this.div.style.width = ne.x - sw.x + "px"; this.div.style.height = sw.y - ne.y + "px"; } } /** * The onRemove() method will be called automatically from the API if * we ever set the overlay's map property to 'null'. */ onRemove() { if (this.div) { this.div.parentNode.removeChild(this.div); delete this.div; } } /** * Set the visibility to 'hidden' or 'visible'. */ hide() { if (this.div) { this.div.style.visibility = "hidden"; } } show() { if (this.div) { this.div.style.visibility = "visible"; } } toggle() { if (this.div) { if (this.div.style.visibility === "hidden") { this.show(); } else { this.hide(); } } } toggleDOM(map) { if (this.getMap()) { this.setMap(null); } else { this.setMap(map); } } } const overlay = new USGSOverlay(bounds, image); overlay.setMap(map); const toggleButton = document.createElement("button"); toggleButton.textContent = "Toggle"; toggleButton.classList.add("custom-map-control-button"); const toggleDOMButton = document.createElement("button"); toggleDOMButton.textContent = "Toggle DOM Attachment"; toggleDOMButton.classList.add("custom-map-control-button"); toggleButton.addEventListener("click", () => { overlay.toggle(); }); toggleDOMButton.addEventListener("click", () => { overlay.toggleDOM(map); }); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleDOMButton); map.controls[google.maps.ControlPosition.TOP_RIGHT].push(toggleButton); } window.initMap = initMap;
CSS
/* * Always set the map height explicitly to define the size of the div element * that contains the map. */ #map { height: 100%; } /* * Optional: Makes the sample page fill the window. */ html, body { height: 100%; margin: 0; padding: 0; } .custom-map-control-button { background-color: #fff; border: 0; border-radius: 2px; box-shadow: 0 1px 4px -1px rgba(0, 0, 0, 0.3); margin: 10px; padding: 0 0.5em; font: 400 18px Roboto, Arial, sans-serif; overflow: hidden; height: 40px; cursor: pointer; } .custom-map-control-button:hover { background: rgb(235, 235, 235); }
HTML
<html>
<head>
<title>Showing/Hiding Overlays</title>
<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 script 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>