KML

Класс KmlLayer

google.maps . KmlLayer

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()
Параметры: нет
Возвращаемое значение: string URL
Получает URL отображаемого файла KML.
getZIndex
getZIndex()
Параметры: нет
Возвращаемое значение: number Z-индекс.
Получает z-индекс слоя KML.
setMap
setMap(map)
Параметры:
Возвращаемое значение: нет
Отображает слой KML на указанной карте. Если значение карты равно null , слой удаляется.
setOptions
setOptions(options)
Параметры:
Возвращаемое значение: нет
setUrl
setUrl(url)
Параметры:
  • url : string
Возвращаемое значение: нет
Задает URL-адрес KML-файла для отображения.
setZIndex
setZIndex(zIndex)
Параметры:
  • zIndex : number Z-индекс, который нужно установить.
Возвращаемое значение: нет
Устанавливает z-индекс слоя KML.
Унаследовано: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll
click
function(kmlClickEvent)
Аргументы:
Это событие вызывается при щелчке по объекту в слое.
defaultviewport_changed
function()
Аргументы: нет
Это событие возникает при изменении области просмотра слоев KML по умолчанию.
status_changed
function()
Аргументы: нет
Это событие срабатывает после завершения загрузки слоя KML. В этот момент можно безопасно прочитать свойство status, чтобы определить, успешно ли загружен слой.

Интерфейс 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.

description
Тип: string
<description> слоя, извлеченное из разметки слоя.
hasScreenOverlays
Тип: boolean
Имеет ли слой какие-либо экранные наложения.
name
Тип: string
<name> слоя, извлеченное из разметки слоя.
snippet
Тип: string
<Snippet> слоя, извлеченный из разметки слоя
author optional
Тип: KmlAuthor optional
<atom:author> слоя, извлеченный из разметки слоя.

Константы 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 , содержащий информацию о выбранном объекте.
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
Домашняя страница автора или пустая строка, если не указано иное.