Spec-Zone.ru › OpenLayers

ol/source/Google~Google


import Google from 'ol/source/Google.js';

Источник слоя плиток, отображающих плитки из API Карт Google. Конструктор принимает опции, которые передаются в запрос для создания маркера сессии. Дополнительные сведения см. в документации.

new Google(options)

source/Google.js, строка 80
Имя Тип Описание
key string

Ключ API Google Map Tiles. Получите свой на https://developers.google.com/maps/documentation/tile/get-api-key.

mapType string (по умолчанию 'roadmap')

Тип основной карты.

language string (по умолчанию 'en-US')

Тег языка IETF для информации, отображаемой на плитках.

region string (по умолчанию 'US')

Идентификатор региона Common Locale Data Repository (CLDR), представляющий расположение пользователя.

imageFormat string | undefined

Формат изображения, используемый для плиток карты (например, 'jpeg' или 'png').

scale string | undefined

Масштаб элементов карты ('scaleFactor1x', 'scaleFactor2x' или 'scaleFactor4x').

highDpi boolean (по умолчанию false)

Использовать плитки высокого разрешения.

layerTypes Array.<string> | undefined

Типы слоёв, добавленные на карту (например, 'layerRoadmap', 'layerStreetview' или 'layerTraffic').

overlay boolean (по умолчанию false)

Отображать только layerTypes, а не лежащий под ним mapType (работает только при наличии layerTypes).

styles Array.<Object> | undefined

Пользовательские стили, применяемые к карте.

attributionsCollapsible boolean (по умолчанию true)

Разрешить сворачивание атрибутов.

interpolate boolean (по умолчанию true)

Использовать интерполированные значения при повторной выборке. По умолчанию используется линейная интерполяция при повторной выборке. Установите в значение false, чтобы использовать ближайшего соседа вместо этого.

cacheSize number | undefined

Начальный размер кэша плиток. Автоматически увеличивается, чтобы вместить как минимум количество плиток в области просмотра.

reprojectionErrorThreshold number (по умолчанию 0.5)

Максимальная разрешённая ошибка репроекции (в пикселях). Более высокие значения могут увеличить производительность репроекции, но уменьшат точность.

tileLoadFunction LoadFunction | undefined

Дополнительная функция для загрузки плитки по заданному URL. По умолчанию

function(imageTile, src) {
  imageTile.getImage().src = src;
};
apiOptions Array.<string> | undefined

Массив значений, определяющих дополнительные параметры для применения.

wrapX boolean (по умолчанию true)

Оборачивать мир по горизонтали.

transition number | undefined

Длительность перехода непрозрачности для отображения. Чтобы отключить переход непрозрачности, передайте transition: 0.

zDirection number | NearestDirectionFunction (по умолчанию 0)

Выбор использования плиток с более высоким или более низким уровнем масштабирования при значении между целочисленными уровнями масштабирования. См. getZForResolution.

События:
  • change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика ревизий.
  • error (BaseEvent) - Общее событие об ошибке. Срабатывает при возникновении ошибки.
  • propertychange (ObjectEvent) - Срабатывает при изменении свойства.
  • tileloadend (TileSourceEvent) - Срабатывает, когда загрузка плитки завершается, либо когда данные загружены, либо когда загрузка была прервана, поскольку плитка больше не нужна.
  • tileloaderror (TileSourceEvent) - Срабатывает, если загрузка плитки приводит к ошибке. Обратите внимание, что это не правильное место для повторной загрузки плиток. Подробнее см. load.
  • tileloadstart (TileSourceEvent) - Срабатывает при начале загрузки плитки.

Расширяет

  • TileImage

Методы

changed() inherited

Observable.js, line 68

Увеличивает счётчик ревизии и отправляет событие 'change'.

clear() inherited

source/Tile.js, line 257

Удаляет все кэшированные перепроектированные плитки из источника. Следующий цикл рендеринга создаст новые плитки.

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

Отправляет событие и вызывает всех слушателей, слушающих события этого типа. Параметр event может быть строкой или объектом со свойством type.

Имя Тип Описание
event BaseEvent | string

Объект события.

Возвращает:
false, если кто-то вызвал preventDefault в объекте события или любой из слушателей вернул false.

get(key){*} inherited

Object.js, line 135

Получает значение.

Имя Тип Описание
key string

Имя ключа.

Возвращает:
Значение.

getAttributions(){Attribution} inherited

source/Source.js, line 129

Получить функцию атрибуции для источника.

Возвращает:
Функцию атрибуции.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 137
Возвращает:
Атрибуты могут быть свёрнуты.

getKeys(){Array.<string>} inherited

Object.js, line 148

Получить список имён свойств объекта.

Возвращает:
Список имён свойств.

getProjection(){Projection | null} inherited

source/Source.js, line 146

Получить проекцию источника.

Возвращает:
Проекцию.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Получить объект всех имён свойств и значений.

Возвращает:
Объект.

getRevision(){number} inherited

Observable.js, line 79

Получить номер версии для этого объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.

Возвращает:
Номер ревизии.

getState(){State} inherited

source/Source.js, line 170

Получить состояние источника, см. State для возможных состояний.

Возвращает:
Состояние.

getTileGrid(){TileGrid | null} inherited

source/Tile.js, line 189

Возвращает сетку плиток для источника плиток.

Возвращает:
Сетку плиток.

getTileLoadFunction(){LoadFunction} inherited

source/UrlTile.js, line 100

Устарело. Используйте источник ImageTile вместо этого. Возвращает функцию загрузки плитки источника.

Возвращает:
TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited

source/UrlTile.js, line 110

Устарело. Используйте источник ImageTile вместо этого. Возвращает функцию URL плитки источника.

Возвращает:
TileUrlFunction

getUrls(){!Array.<string> | null} inherited

source/UrlTile.js, line 124

Устарело. Используйте источник ImageTile вместо этого. Возвращает URL-адреса, используемые для этого источника. Когда используется tileUrlFunction вместо url или urls, возвращается null.

Возвращает:
URL-адреса.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, строка 152

Прослушивать определённый тип события.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

Возвращаемое значение:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемый результат будет массивом ключей.

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, строка 164

Прослушивать один раз определённый тип события.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

Возвращаемое значение:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращаемый результат будет массивом ключей.

set(key, value, silent) inherited

Object.js, строка 215

Устанавливает значение.

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без срабатывания события.

setAttributions(attributions) inherited

source/Source.js, строка 203

Устанавливает атрибуты источника.

Имя Тип Описание
attributions AttributionLike | undefined

Атрибуты. Могут быть переданы как string, Array<string>, Attribution, или undefined.

setProperties(values, silent) inherited

Object.js, строка 235

Устанавливает набор пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет никакие существующие свойства).

Имя Тип Описание
values Object.<string, *>

Значения.

silent boolean | undefined

Обновить без срабатывания события.

setRenderReprojectionEdges(render) inherited

source/TileImage.js, строка 280

Устанавливает, отображать ли края репроекции (обычно для отладки).

Имя Тип Описание
render boolean

Отобразить края.

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, строка 300

Устанавливает сетку тайлов для использования при репроекции тайлов в заданную проекцию вместо стандартной сетки тайлов для данной проекции.

Это может быть полезно, когда стандартная сетка тайлов не может быть создана (например, проекция не имеет заданного охватывающего прямоугольника) или по соображениям оптимизации (настраиваемый размер тайла, разрешения и т.д.).

Имя Тип Описание
projection ProjectionLike

Проекция.

tilegrid TileGrid

Используемая сетка тайлов для проекции.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, строка 161

Устаревшее. Используйте источник ImageTile вместо этого. Устанавливает функцию загрузки тайла для источника.

Имя Тип Описание
tileLoadFunction LoadFunction

Функция загрузки тайла.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, строка 173

Устаревшее. Используйте источник ImageTile вместо этого. Устанавливает функцию URL тайла для источника.

Имя Тип Описание
tileUrlFunction UrlFunction

Функция URL тайла.

key string | undefined

Необязательный новый ключ тайла для источника.

setUrl(url) inherited

source/UrlTile.js, line 187

Установить URL для запросов.

Имя Тип Описание
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 199

Устарело. Используйте вместо этого источник ImageTile. Установить URL-адреса для запросов.

Имя Тип Описание
urls Array.<string>

URL-адреса.

un(type, listener) inherited

Observable.js, line 173

Отменить прослушивание определенного типа события.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

Функция-обработчик.

unset(key, silent) inherited

Object.js, line 259

Удалить свойство.

Имя Тип Описание
key string

Имя ключа.

silent boolean | undefined

Удалить без запуска события.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_Google-Google.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API