ol/source/TileJSON~TileJSON
import TileJSON from 'ol/source/TileJSON.js';
Источник слоя для данных тайлов в формате TileJSON.
-
new TileJSON(options)
-
Имя Тип Описание attributionsAttributionLike | undefined Атрибуция.
cacheSizenumber | undefined Устарело. Вместо этого используйте параметр cacheSize слоя.
crossOriginnull | string | undefined Атрибут
crossOriginдля загружаемых изображений. Обратите внимание: если вы хотите получить доступ к данным пикселей с помощью рендерера Canvas, необходимо указать значениеcrossOrigin. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.interpolateboolean (по умолчанию true) Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать метод ближайшего соседа.
jsonpboolean (по умолчанию false) Использовать JSONP с обратным вызовом для загрузки TileJSON. Полезно, если сервер не поддерживает CORS.
reprojectionErrorThresholdnumber (по умолчанию 0.5) Максимально допустимая погрешность перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
tileJSONConfig | undefined Конфигурация TileJSON для этого источника. Если она не задана, необходимо настроить
url.tileLoadFunctionLoadFunction | undefined Необязательная функция для загрузки тайла по URL. По умолчанию используется
function(imageTile, src) { imageTile.getImage().src = src; };tileSizenumber | Size (по умолчанию [256, 256]) Размер тайла, используемый службой тайлов. Примечание:
tileSizeи другие нестандартные свойства TileJSON в настоящее время игнорируются.urlstring | undefined URL файла TileJSON. Если он не задан, необходимо настроить
tileJSON.wrapXboolean (по умолчанию true) Оборачивать ли мир по горизонтали.
transitionnumber | undefined Длительность перехода прозрачности при отрисовке. Чтобы отключить переход прозрачности, передайте
transition: 0.zDirectionnumber | NearestDirectionFunction (по умолчанию 0) Выберите, использовать тайлы с более высоким или более низким уровнем масштабирования при промежуточных целочисленных уровнях масштабирования. См.
getZForResolution.События:
-
change(BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика версий. -
error(BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки. -
propertychange(ObjectEvent) — Вызывается при изменении свойства. -
tileloadend(TileSourceEvent) — Вызывается, когда загрузка тайла завершается: данные загружены либо загрузка прервана, поскольку тайл больше не нужен. -
tileloaderror(TileSourceEvent) — Вызывается, если при загрузке тайла произошла ошибка. Обратите внимание: это событие не следует использовать для повторной загрузки тайлов. Подробнее см.load. -
tileloadstart(TileSourceEvent) — Вызывается при начале загрузки тайла.
-
Наследует
Методы
-
changed() унаследовано
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
clear() унаследовано
-
Удаляет из источника все кэшированные перепроецированные тайлы. В следующем цикле отрисовки будут созданы новые тайлы.
-
dispatchEvent(event){boolean | undefined} унаследовано
-
Отправляет событие и вызывает все обработчики, подписанные на события этого типа. Параметр события может быть строкой или объектом со свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если какой-либо из обработчиков вернул false.
-
get(key){*} унаследовано
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getAttributions(){Attribution} унаследовано
-
Получает функцию атрибуции для источника.
Возвращает:
Функция атрибуции.
-
getAttributionsCollapsible(){boolean} унаследовано
-
Возвращает:
Можно ли сворачивать атрибуции.
-
getKeys(){Array.<string>} унаследовано
-
Получает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getProjection(){Projection | null} унаследовано
-
Получает проекцию источника.
Возвращает:
Проекция.
-
getProperties(){NoInfer.<Properties>} унаследовано
-
Получает объект со всеми именами свойств и их значениями.
Возвращает:
Объект.
-
getRevision(){number} унаследовано
-
Получает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.
Возвращает:
Ревизия.
-
getState(){State} унаследовано
-
Получает состояние источника. Возможные состояния см. в разделе
State.Возвращает:
Состояние.
-
getTileGrid(){TileGrid | null} унаследовано
-
Возвращает сетку тайлов источника тайлов.
Возвращает:
Сетка тайлов.
-
getTileJSON(){Config}
-
Возвращает:
Объект TileJSON.
-
getTileLoadFunction(){LoadFunction} унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию загрузки тайлов источника.
Возвращает:
TileLoadFunction
-
getTileUrlFunction(){UrlFunction} унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию URL тайлов источника.
Возвращает:
TileUrlFunction
-
getUrls(){!Array.<string> | null} унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Возвращает URL-адреса, используемые для этого источника. Если вместо url или urls используется tileUrlFunction, будет возвращено значение null.
Возвращает:
URL-адреса.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Подписывается на события определённого типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Однократно подписывается на события определённого типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, возвращается массив ключей.
-
refresh() унаследовано
-
Обновляет источник. Источник будет очищен, а данные повторно загружены с сервера.
-
set(key, value, silent) унаследовано
-
Задаёт значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без отправки события.
-
setAttributions(attributions) унаследовано
-
Задаёт атрибуции источника.
Имя Тип Описание attributionsAttributionLike | undefined Атрибуции. Можно передать в виде
string,Array<string>,Attributionилиundefined. -
setProperties(values, silent) унаследовано
-
Задаёт набор пар «ключ—значение». Обратите внимание: существующие свойства будут изменены, а новые — добавлены (имеющиеся свойства не удаляются).
Имя Тип Описание valuesPartial.<NoInfer.<Properties>> Значения.
silentboolean | undefined Обновить без отправки события.
-
setRenderReprojectionEdges(render) унаследовано
-
Задаёт, следует ли отображать границы перепроецирования (обычно используется для отладки).
Имя Тип Описание renderboolean Отображать границы.
-
setTileGridForProjection(projection, tilegrid) унаследовано
-
Задаёт сетку тайлов, используемую при перепроецировании тайлов в указанную проекцию, вместо сетки тайлов проекции по умолчанию.
Это может быть полезно, если сетку тайлов по умолчанию нельзя создать (например, для проекции не задана область охвата) или по соображениям оптимизации (пользовательский размер тайлов, разрешения и т. д.).
Имя Тип Описание projectionProjectionLike Проекция.
tilegridTileGrid Сетка тайлов, используемая для проекции.
-
setTileLoadFunction(tileLoadFunction) унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию загрузки тайлов источника.
Имя Тип Описание tileLoadFunctionLoadFunction Функция загрузки тайлов.
-
setTileUrlFunction(tileUrlFunction, key) унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию URL тайлов источника.
Имя Тип Описание tileUrlFunctionUrlFunction Функция URL тайлов.
keystring | undefined Необязательный новый ключ тайла для источника.
-
setUrl(url) унаследовано
-
Задаёт URL, используемый для запросов.
Имя Тип Описание urlstring URL.
-
setUrls(urls) унаследовано
-
Устарело. Вместо этого используйте источник ImageTile. Задаёт URL-адреса, используемые для запросов.
Имя Тип Описание urlsArray.<string> URL-адреса.
-
un(type, listener) унаследовано
-
Отписывается от событий определённого типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
-
unset(key, silent) унаследовано
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | undefined Удалить без отправки события.
© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_TileJSON-TileJSON.html