Класс KmlLayer
google.maps . KmlLayer
Класс google.maps . KmlLayer
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 ). |
Методы | |
---|---|
getDefaultViewport | getDefaultViewport() Параметры: Нет Возвращаемое значение: LatLngBounds Получите область просмотра по умолчанию для отображаемого слоя. |
getMap | getMap() Параметры: Нет Возвращаемое значение: Map Получите карту, на которой отображается слой KML. |
getMetadata | getMetadata() Параметры: Нет Возвращаемое значение: KmlLayerMetadata Получите метаданные, связанные с этим слоем, как указано в разметке слоя. |
getStatus | getStatus() Параметры: Нет Возвращаемое значение: KmlLayerStatus Получите статус слоя, установленный после загрузки запрошенного документа. |
getUrl | getUrl() Параметры: Нет Возвращаемое значение: URL-адрес string Получает URL-адрес отображаемого файла KML. |
getZIndex | getZIndex() Параметры: Нет Возвращаемое значение: number Z-индекс. Получает z-индекс слоя 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. На этом этапе можно безопасно прочитать свойство status, чтобы определить, успешно ли загружен слой. |
Интерфейс KmlLayerOptions
google.maps . 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
Интерфейс 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
Константы 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
Интерфейс google.maps . KmlMouseEvent
Свойства события щелчка в документе KML/KMZ или GeoRSS.
Характеристики | |
---|---|
featureData | Тип: KmlFeatureData Объект KmlFeatureData , содержащий информацию о выбранном объекте. |
latLng | Тип: LatLng Позиция, в которой можно привязать информационное окно к выбранному объекту. |
pixelOffset | Тип: Size Смещение, применяемое к информационному окну, привязанному к выбранному объекту. |
Интерфейс KmlFeatureData
google.maps . 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
Интерфейс google.maps . KmlAuthor
Содержит сведения об авторе документа или функции KML.
Характеристики | |
---|---|
email | Тип: string Адрес электронной почты автора или пустая строка, если не указана. |
name | Тип: string Имя автора или пустая строка, если не указано. |
uri | Тип: string Домашняя страница автора или пустая строка, если не указана. |