ol/source/Tile~TileSource
import TileSource from 'ol/source/Tile.js';
Абстрактный базовый класс; обычно используется только для создания подклассов и не создаётся в приложениях. Базовый класс источников, предоставляющих изображения, разделённые на сетку тайлов.
-
new TileSource(options)
-
Имя Тип Описание attributionsAttributionLike | undefined Атрибуции.
attributionsCollapsibleboolean (по умолчанию true) Атрибуции можно свернуть.
cacheSizenumber | undefined Устарело. Вместо этого используйте параметр cacheSize слоя.
tilePixelRationumber | undefined Соотношение пикселей тайла.
projectionProjectionLike | undefined Проекция.
stateState | undefined Состояние.
tileGridTileGrid | undefined Сетка тайлов.
wrapXboolean (по умолчанию false) Обёртка по оси X.
transitionnumber | undefined Переход.
keystring | undefined Ключ.
zDirectionnumber | NearestDirectionFunction (по умолчанию 0) Направление по оси Z.
interpolateboolean (по умолчанию false) Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется ближайший сосед.
Вызывает события:
-
change(BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика версий. -
error(BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки. -
propertychange(ObjectEvent) — вызывается при изменении свойства.
-
Подклассы
Расширяет
Методы
-
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}
-
Возвращает сетку тайлов источника тайлов.
Возвращает:
Сетка тайлов.
-
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 Обновить без вызова события.
-
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_Tile-TileSource.html