KmlLayer class
google.maps.KmlLayer
class
תג KmlLayer מוסיף למפה תיוג גאוגרפי מקובץ KML, KMZ או GeoRSS שמתארח בשרת אינטרנט שנגיש לציבור. אובייקט KmlFeatureData מסופק לכל תכונה כשלוחצים עליה.
הכיתה הזו היא הרחבה של MVCObject.
אפשר להתקשר אל const {KmlLayer} = await google.maps.importLibrary("maps") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
יצרן | |
|---|---|
KmlLayer |
KmlLayer([opts])פרמטרים:
יוצר תג KmlLayer שמציג את התוכן של קובץ KML/KMZ שצוין (https://developers.google.com/kml/documentation/kmlreference) או קובץ GeoRSS (http://www.georss.org). |
Methods | |
|---|---|
getDefaultViewport |
getDefaultViewport()פרמטרים: אין
ערך מוחזר:
LatLngBoundsאחזור אזור התצוגה שמוגדר כברירת מחדל לשכבה שמוצגת. |
getMap |
getMap()פרמטרים: אין
ערך מוחזר:
Mapמקבלים את המפה שבה שכבת ה-KML מוצגת. |
getMetadata |
getMetadata()פרמטרים: אין
ערך מוחזר:
KmlLayerMetadataקבלת המטא-נתונים שמשויכים לשכבה הזו, כפי שצוין בתגי העיצוב של השכבה. |
getStatus |
getStatus()פרמטרים: אין
ערך מוחזר:
KmlLayerStatusהסטטוס של השכבה נקבע אחרי שהמסמך המבוקש נטען. |
getUrl |
getUrl()פרמטרים: אין
ערך ההחזרה:
string כתובת URLמחזירה את כתובת ה-URL של קובץ ה-KML שמוצג. |
getZIndex |
getZIndex()פרמטרים: אין
הערך המוחזר:
number ערך ה-z-index.מחזירה את הערך של z-index של שכבת KML. |
setMap |
setMap(map)פרמטרים:
ערך מוחזר: אין
הפונקציה מעבדת את שכבת ה-KML במפה שצוינה. אם המפה מוגדרת ל null, השכבה מוסרת. |
setOptions |
setOptions(options)פרמטרים:
ערך מוחזר: אין
|
setUrl |
setUrl(url)פרמטרים:
ערך מוחזר: אין
הגדרה של כתובת ה-URL של קובץ ה-KML שיוצג. |
setZIndex |
setZIndex(zIndex)פרמטרים:
ערך מוחזר: אין
הגדרת אינדקס-z של שכבת ה-KML. |
בירושה:
addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
אירועים | |
|---|---|
click |
function(kmlClickEvent)ארגומנטים:
האירוע הזה מופעל כשלוחצים על תכונה בשכבה. |
defaultviewport_changed |
function()ארגומנטים: אין
האירוע הזה מופעל כשברירת המחדל של אזור התצוגה בשכבות KML משתנה. |
status_changed |
function()ארגומנטים: אין
האירוע הזה מופעל כשטעינת שכבת ה-KML מסתיימת. בשלב הזה אפשר לקרוא את מאפיין הסטטוס כדי לדעת אם השכבה נטענה בהצלחה. |
KmlLayerOptions interface
google.maps.KmlLayerOptions
ממשק
האובייקט הזה מגדיר את המאפיינים שאפשר להגדיר באובייקט KmlLayer.
מאפיינים | |
|---|---|
clickable optional |
סוג:
boolean optionalברירת מחדל:
trueאם true, השכבה מקבלת אירועי עכבר. |
map optional |
סוג:
Map optionalהמפה שבה רוצים להציג את השכבה. |
preserveViewport optional |
סוג:
boolean optionalברירת מחדל:
falseאם האפשרות הזו מוגדרת ל- true או אם המרכז והזום של המפה לא הוגדרו אף פעם, המפה שמוזנת ממורכזת ומוגדל בה אזור התוכן של השכבה. |
screenOverlays optional |
סוג:
boolean optionalברירת מחדל:
trueהגדרה שקובעת אם להציג את שכבות-העל במסך. |
suppressInfoWindows optional |
סוג:
boolean optionalהשבתת העיבוד של חלונות מידע כשלוחצים על תכונות של שכבה. |
url optional |
סוג:
string optionalכתובת ה-URL של מסמך ה-KML שרוצים להציג. |
zIndex optional |
סוג:
number optionalהערך של z-index של השכבה. |
KmlLayerMetadata interface
google.maps.KmlLayerMetadata
ממשק
מטא-נתונים של שכבת KML אחת, בפורמט JSON.
מאפיינים | |
|---|---|
description |
סוג:
stringהערך של <description> בשכבה, שחולץ מתגי השכבה. |
hasScreenOverlays |
סוג:
booleanהאם לשכבה יש שכבות-על במסך. |
name |
סוג:
stringהערך של <name> בשכבה, שחולץ מתגי השכבה. |
snippet |
סוג:
stringהערך <Snippet> של השכבה, שחולץ מתגי העיצוב של השכבה |
author optional |
סוג:
KmlAuthor optionalהערך של <atom:author> בשכבה, שחולץ מתגי השכבה. |
KmlLayerStatus constants
google.maps.KmlLayerStatus
constants
הסטטוס שמוחזר על ידי KmlLayer בסיום הטעינה של מסמך. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'OK' או google.maps.KmlLayerStatus.OK.
אפשר להתקשר אל const {KmlLayerStatus} = await google.maps.importLibrary("maps") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Constants | |
|---|---|
DOCUMENT_NOT_FOUND |
לא נמצא מסמך. סביר להניח שכתובת ה-URL לא תקינה או שהמסמך לא זמין לציבור. |
DOCUMENT_TOO_LARGE |
המסמך חורג ממגבלות הגודל של קובץ KmlLayer. |
FETCH_ERROR |
לא הייתה אפשרות לאחזר את המסמך. |
INVALID_DOCUMENT |
המסמך לא תקין, הוא לא קובץ KML, KMZ או GeoRSS. |
INVALID_REQUEST |
הערך של KmlLayer לא תקין. |
LIMITS_EXCEEDED |
המסמך חורג ממגבלות התכונות של KmlLayer. |
OK |
השכבה נטענה בהצלחה. |
TIMED_OUT |
לא ניתן היה לטעון את המסמך בזמן סביר. |
UNKNOWN |
המסמך לא נטען מסיבה לא ידועה. |
ממשק KmlMouseEvent
google.maps.KmlMouseEvent
ממשק
המאפיינים של אירוע קליק במסמך KML/KMZ או GeoRSS.
מאפיינים | |
|---|---|
featureData |
סוג:
KmlFeatureDataאובייקט KmlFeatureData שמכיל מידע על התכונה שנלחצה. |
latLng |
סוג:
LatLngהמיקום שבו חלון המידע מעוגן בתכונה שנלחצה. |
pixelOffset |
סוג:
Sizeההיסט שחל על חלון מידע שמעוגן לתכונה שנלחצה. |
ממשק KmlFeatureData
google.maps.KmlFeatureData
ממשק
נתונים של תכונת KML יחידה בפורמט JSON, שמוחזרים כשלוחצים על תכונת KML. הנתונים שכלולים באובייקט הזה הם העתק של הנתונים שמשויכים לתכונה בתגי העיצוב של KML או GeoRSS שבהם הוא מוצהר.
מאפיינים | |
|---|---|
author |
סוג:
KmlAuthorהמאפיין <atom:author> של התכונה, שחולץ מתגי השכבה (אם צוין). |
description |
סוג:
stringהמאפיין <description> של התכונה, שחולץ מתגי העיצוב של השכבה. |
id |
סוג:
stringהמאפיין <id> של התכונה, שחולץ מתגי העיצוב של השכבה. אם לא צוין <id>, ייווצר מזהה ייחודי לתכונה הזו. |
infoWindowHtml |
סוג:
stringהטקסט בסגנון בועה של התכונה, אם הוא מוגדר. |
name |
סוג:
stringהמאפיין <name> של התכונה, שחולץ מתגי העיצוב של השכבה. |
snippet |
סוג:
stringהמאפיין <Snippet> של התכונה, שחולץ מתגי העיצוב של השכבה. |
KmlAuthor interface
google.maps.KmlAuthor
ממשק
מכיל פרטים על מחבר של מסמך או ישות KML.
מאפיינים | |
|---|---|
email |
סוג:
stringכתובת האימייל של המחבר, או מחרוזת ריקה אם לא צוינה כתובת. |
name |
סוג:
stringשם המחבר, או מחרוזת ריקה אם לא צוין שם. |
uri |
סוג:
stringדף הבית של המחבר, או מחרוזת ריקה אם לא צוין. |