KML

הכיתה KmlLayer

google.maps.KmlLayer class

הרכיב KmlLayer מוסיף למפה תיוג גיאוגרפי מקובץ KML, ‏ KMZ או GeoRSS שמתארח בשרת אינטרנט שגלוי לכולם. אובייקט KmlFeatureData מסופק לכל תכונה כשלוחצים עליה.

הכיתה הזו היא תת-מחלקה של MVCObject.

אפשר לגשת אליו באמצעות חיוג למספר const {KmlLayer} = await google.maps.importLibrary("maps"). ספריות ב-Maps JavaScript API
KmlLayer
KmlLayer([opts])
פרמטרים: 
  • opts:  KmlLayerOptions optional האפשרויות של השכבה הזו.
יצירת KmlLayer שמרינדר את התוכן של קובץ ה-KML או ה-KMZ שצוין (https://developers.google.com/kml/documentation/kmlreference) או של קובץ ה-GeoRSS (http://www.georss.org).
getDefaultViewport
getDefaultViewport()
פרמטרים:  ללא
ערך המוחזר:  LatLngBounds
אחזור חלון התצוגה שמוגדר כברירת מחדל לשכבה שמוצגת.
getMap
getMap()
פרמטרים:  ללא
ערך המוחזר:  Map
אחזור המפה שבה מתבצע העיבוד של שכבת ה-KML.
getMetadata
getMetadata()
פרמטרים:  ללא
ערך המוחזר:  KmlLayerMetadata
אחזור המטא-נתונים שמשויכים לשכבה הזו, כפי שצוין בתגי העיצוב של השכבה.
getStatus
getStatus()
פרמטרים:  ללא
ערך המוחזר:  KmlLayerStatus
אחזור הסטטוס של השכבה, שמוגדר אחרי שהמסמך המבוקש נטען.
getUrl
getUrl()
פרמטרים:  ללא
ערך המובהק: כתובת ה-URL של string
הפונקציה מקבלת את כתובת ה-URL של קובץ ה-KML שמוצג.
getZIndex
getZIndex()
פרמטרים:  ללא
ערך המוחזר:  number אינדקס z.
הפונקציה מקבלת את הערך של z-index של שכבת ה-KML.
setMap
setMap(map)
פרמטרים: 
ערך המוחזר:  None
המערכת מרינדרת את שכבת ה-KML במפה שצוינה. אם המפה מוגדרת כ-null, השכבה תוסר.
setOptions
setOptions(options)
פרמטרים: 
ערך המוחזר:  None
setUrl
setUrl(url)
פרמטרים: 
  • url:  string
ערך המוחזר:  None
הגדרת כתובת ה-URL של קובץ ה-KML שרוצים להציג.
setZIndex
setZIndex(zIndex)
פרמטרים: 
  • zIndex:  number אינדקס ה-Z שרוצים להגדיר.
ערך המוחזר:  None
הגדרת אינדקס-z של שכבת ה-KML.
עובר בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
click
function(kmlClickEvent)
ארגומנטים: 
האירוע הזה מופעל כשלוחצים על תכונה בשכבה.
defaultviewport_changed
function()
ארגומנטים:  None
האירוע הזה מופעל כשאזור התצוגה שמוגדר כברירת מחדל לשכבות ה-KML משתנה.
status_changed
function()
ארגומנטים:  None
האירוע הזה מופעל כשהטעינה של שכבת ה-KML מסתיימת. בשלב הזה אפשר לקרוא את מאפיין הסטטוס כדי לקבוע אם השכבה נטענה בהצלחה.

הממשק KmlLayerOptions

ממשק 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 של השכבה.

הממשק KmlLayerMetadata

ממשק google.maps.KmlLayerMetadata

מטא-נתונים של שכבת KML אחת, בפורמט JSON.
author
סוג:  KmlAuthor
השדה <atom:author> של השכבה, שחולץ מתיוג השכבה.
description
סוג:  string
השדה <description> של השכבה, שחולץ מתיוג השכבה.
hasScreenOverlays
סוג:  boolean
אם יש בשכבה שכבות-על של מסך.
name
סוג:  string
השדה <name> של השכבה, שחולץ מתיוג השכבה.
snippet
סוג:  string
השדה <Snippet> של השכבה, שחולץ מתיוג השכבה

קבועים של KmlLayerStatus

google.maps.KmlLayerStatus קבועים

הסטטוס שהחזיר KmlLayer בסיום הטעינה של מסמך. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'OK' או google.maps.KmlLayerStatus.OK.

אפשר לגשת אליו באמצעות חיוג למספר const {KmlLayerStatus} = await google.maps.importLibrary("maps"). ספריות ב-Maps JavaScript API
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

ממשק google.maps.KmlAuthor

מכיל פרטים על המחבר של מסמך או תכונה ב-KML.
email
סוג:  string
כתובת האימייל של המחבר, או מחרוזת ריקה אם לא צוינה.
name
סוג:  string
שם המחבר, או מחרוזת ריקה אם לא צוין.
uri
סוג:  string
דף הבית של המחבר, או מחרוזת ריקה אם לא צוין.