Класс KmlLayer
class
google.maps.KmlLayer
extends MVCObject
library "maps"
const {KmlLayer} = await google.maps.importLibrary("maps");
Конструктор | |
|---|---|
KmlLayer |
KmlLayer([opts])Параметры:
Создает объект KmlLayer, который отображает содержимое указанного файла KML/KMZ (https://developers.google.com/kml/documentation/kmlreference) или GeoRSS (http://www.georss.org). |
Методы | |
|---|---|
getDefaultViewport |
getDefaultViewport()Параметры: нет.
Возвращаемое значение:
LatLngBounds|nullПолучение окна просмотра по умолчанию для отображаемого слоя. |
getMap |
getMap()Параметры: нет.
Возвращаемое значение:
Map|nullВозвращает карту, на которой отображается KML-слой. |
getMetadata |
getMetadata()Параметры: нет.
Возвращаемое значение:
Получение метаданных, связанных с этим слоем, как указано в разметке слоя. |
getStatus |
getStatus()Параметры: нет.
Возвращаемое значение:
Получить статус слоя, заданный после загрузки запрошенного документа. |
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
Этот объект определяет свойства, которые можно задать для объекта KmlLayer.
Свойства | |
|---|---|
clickable
необязательно |
Тип:
boolean optionalПо умолчанию:
true.Если true, слой принимает события нажатия мыши. |
map
необязательно |
Тип:
Map optionalКарта, на которой должен отображаться слой. |
preserveViewport
необязательно |
Тип:
boolean optionalПо умолчанию:
false.Если для этого параметра задано значение true или если центр и масштаб карты не были заданы, входная карта центрируется и масштабируется по ограничивающей рамке содержимого слоя. |
screenOverlays
необязательно |
Тип:
boolean optionalПо умолчанию:
true.Параметр позволяет включить отрисовку слоев. |
suppressInfoWindows
необязательно |
Тип:
boolean optionalБлокирует вывод информационных окон при нажатии на компоненты слоя. |
url
необязательно |
Тип:
string optionalURL документа KML, который нужно показать. |
zIndex
необязательно |
Тип:
number optionalZ-индекс слоя. |
Интерфейс KmlLayerMetadata
интерфейс
google.maps.KmlLayerMetadata
Метаданные для одного KML-слоя в формате JSON.
Свойства | |
|---|---|
description |
Тип:
string<description> слоя, извлеченный из разметки слоя. |
hasScreenOverlays |
Тип:
booleanЕсть ли на слое экранные наложения. |
name |
Тип:
string<name> слоя, извлеченный из разметки слоя. |
snippet |
Тип:
string<Snippet> слоя, извлеченный из разметки слоя. |
author
необязательно |
Тип:
<atom:author> слоя, извлеченный из разметки слоя. |
Константы KmlLayerStatus
константы
google.maps.KmlLayerStatus
библиотека "maps"
Статус, возвращаемый KmlLayer по завершении загрузки документа. Укажите их по значению или по названию константы. Примеры: 'OK' или google.maps.KmlLayerStatus.OK.
Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом KmlLayerStatusString.
const {KmlLayerStatus} = await google.maps.importLibrary("maps");
Константы | |
|---|---|
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
Свойства события click для KML-, KMZ- или GeoRSS-документа.
Свойства | |
|---|---|
featureData |
Тип:
Объект KmlFeatureData, содержащий информацию об объекте, на который нажал пользователь. |
latLng |
Тип:
LatLngПоложение для прикрепления информационного окна к выбранному компоненту. |
pixelOffset |
Тип:
SizeСдвиг для информационного окна, привязанного к выбранному компоненту. |
Интерфейс KmlFeatureData
интерфейс
google.maps.KmlFeatureData
Данные одного компонента KML в формате JSON, возвращенные при нажатии на KML-компонент. Данные в этом объекте зеркально отражают данные, связанные с компонентом в разметке KML или GeoRSS, где он был объявлен.
Свойства | |
|---|---|
author |
Тип:
<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Главная страница автора или пустая строка, если главная страница не указана. |