Spec-Zone.ru › OpenLayers

ol/source/BingMaps~BingMaps


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

Источник слоя для тайловых данных Bing Maps.

new BingMaps(options)

source/BingMaps.js, строка 122
Имя Тип Описание
cacheSize number | undefined

Устарело. Вместо этого используйте параметр cacheSize слоя.

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

Если true, будут запрошены тайлы hidpi.

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

Код языка и региона.

key string

Ключ API Bing Maps. Получите свой на сайте https://www.bingmapsportal.com/.

imagerySet string

Тип изображений.

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

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

maxZoom number (по умолчанию 21)

Максимальный уровень масштабирования. По умолчанию используется значение, указанное службой BingMaps.

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

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

tileLoadFunction LoadFunction | undefined

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

function(imageTile, src) {
  imageTile.getImage().src = src;
};
wrapX boolean (по умолчанию true)

Следует ли зацикливать мир по горизонтали.

transition number | undefined

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

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

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

placeholderTiles boolean | undefined

Показывать ли пустые тайлы BingMaps при масштабировании за пределы максимального уровня, доступного для данной области. Если false, запросы за пределами максимального уровня масштабирования не вернут тайл. Если true, будет возвращён пустой тайл. Если параметр не задан, применяется поведение по умолчанию для набора изображений, которое различается для каждого набора изображений в BingMaps.

url string (по умолчанию 'https://dev.virtualearth.net/REST/v1/Imagery/Metadata/')

URL API метаданных Bing Maps.

Устарело
  • Поддержка Bing Maps for Enterprise прекращается 30 июня 2028 года. Вместо этого используйте `ol/source/ImageTile` с API тайлов Azure Maps. Инструкции см. в примере azure-maps.
Генерирует события:
  • change (BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика ревизий.
  • error (BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки.
  • propertychange (ObjectEvent) — Вызывается при изменении свойства.
  • tileloadend (TileSourceEvent) — Вызывается по завершении загрузки тайла: когда его данные загружены или когда загрузка была прервана, поскольку тайл больше не нужен.
  • tileloaderror (TileSourceEvent) — Вызывается, если при загрузке тайла произошла ошибка. Обратите внимание, что это событие не следует использовать для повторной загрузки тайлов. Подробности см. в load.
  • tileloadstart (TileSourceEvent) — Вызывается при начале загрузки тайла.

Наследует

  • TileImage

Методы

changed() унаследовано

Observable.js, строка 68

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

clear() унаследовано

source/Tile.js, строка 258

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

dispatchEvent(event){boolean | undefined} унаследовано

events/Target.js, строка 85

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

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

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

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

get(key){*} унаследовано

Object.js, строка 136

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

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

Имя ключа.

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

getApiKey(){string}

source/BingMaps.js, строка 199

Получает API-ключ, используемый для этого источника.

Возвращает:
API-ключ.

getAttributions(){Attribution} унаследовано

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

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

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

getAttributionsCollapsible(){boolean} унаследовано

source/Source.js, строка 137
Возвращает:
Можно ли сворачивать атрибуции.

getImagerySet(){string}

source/BingMaps.js, строка 209

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

Возвращает:
Набор изображений.

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

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

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

getProjection(){Projection | null} унаследовано

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

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

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

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

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

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

getRevision(){number} унаследовано

Observable.js, строка 79

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

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

getState(){State} унаследовано

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

Получает состояние источника. Возможные состояния см. в разделе State.

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

getTileGrid(){TileGrid | null} унаследовано

source/Tile.js, строка 190

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

Возвращает:
Сетка тайлов.

getTileLoadFunction(){LoadFunction} унаследовано

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

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

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

getTileUrlFunction(){UrlFunction} унаследовано

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

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

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

getUrls(){!Array.<string> | null} унаследовано

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

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

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

on(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 152

Ожидает событие указанного типа.

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

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

listener function

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

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

once(type, listener){EventsKey | Array<EventsKey>} унаследовано

Observable.js, строка 164

Однократно ожидает событие указанного типа.

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

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

listener function

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

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

refresh() унаследовано

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

Обновляет источник. Источник будет очищен, а данные с сервера загружены заново.

set(key, value, silent) унаследовано

Object.js, строка 218

Задаёт значение.

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

Имя ключа.

value *

Значение.

silent boolean | undefined

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

setAttributions(attributions) унаследовано

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

Задаёт атрибуции источника.

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

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

setProperties(values, silent) унаследовано

Object.js, строка 238

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

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.

silent boolean | undefined

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

setRenderReprojectionEdges(render) унаследовано

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

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

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

Отображать границы.

setTileGridForProjection(projection, tilegrid) унаследовано

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

Задаёт сетку тайлов, которая будет использоваться при перепроецировании тайлов в указанную проекцию вместо стандартной сетки тайлов для этой проекции.

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

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

Проекция.

tilegrid TileGrid

Сетка тайлов для этой проекции.

setTileLoadFunction(tileLoadFunction) унаследовано

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

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

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

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

setTileUrlFunction(tileUrlFunction, key) унаследовано

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

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

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

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

key string | undefined

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

setUrl(url) унаследовано

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

Задаёт URL для запросов.

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

URL.

setUrls(urls) унаследовано

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

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

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

URL-адреса.

un(type, listener) унаследовано

Observable.js, строка 173

Прекращает ожидание события указанного типа.

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

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

listener function

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

unset(key, silent) унаследовано

Object.js, строка 262

Сбрасывает свойство.

Имя Тип Описание
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_BingMaps-BingMaps.html

Spec-Zone.ru

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