परिचय
ओवरले, मैप पर मौजूद ऐसे ऑब्जेक्ट होते हैं जो अक्षांश/देशांतर के निर्देशांक से जुड़े होते हैं. इसलिए, मैप को खींचने या उस पर ज़ूम करने पर, ये ऑब्जेक्ट भी अपने-आप चलने लगते हैं. पहले से तय किए गए ओवरले टाइप के बारे में जानने के लिए, मैप पर ड्रॉ करना लेख पढ़ें.
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; }
फ़िलहाल, हम इस ओवरले को ओवरले के कंस्ट्रक्टर में मैप से अटैच नहीं कर सकते. सबसे पहले, हमें यह पक्का करना होगा कि मैप के सभी पैनल उपलब्ध हों. ऐसा इसलिए, क्योंकि इनसे यह तय होता है कि मैप पर ऑब्जेक्ट किस क्रम में दिखें. एपीआई, ऐसा होने पर एक मददगार तरीका उपलब्ध कराता है. हम अगले सेक्शन में इस तरीके को देखेंगे.
ओवरले को शुरू करना
जब ओवरले पहली बार इंस्टैंशिएट होता है और दिखने के लिए तैयार होता है, तो हमें इसे ब्राउज़र के DOM के ज़रिए मैप से अटैच करना होगा. एपीआई से पता चलता है कि ओवरले के onAdd()
तरीके का इस्तेमाल करके, ओवरले को मैप पर जोड़ा गया है. इस तरीके को मैनेज करने के लिए, हम अपनी इमेज को होल्ड करने के लिए एक <div>
बनाते हैं. इसके बाद, एक <img>
एलिमेंट जोड़ते हैं और उसे <div>
से अटैच करते हैं. इसके बाद, ओवरले को मैप के किसी एक पैन से अटैच करते हैं. पैनल, डीओएम ट्री में मौजूद एक नोड होता है.
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;
सीएसएस
/* * 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> <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>