CartoDB~CartoDB

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

Источник слоя для Maps API CartoDB.

new CartoDB(options) source/CartoDB.js, line 46

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции.
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание: для доступа к данным пикселей с помощью рендерера Canvas необходимо указать значение `crossOrigin`. Подробнее см. на странице https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`projection`	ProjectionLike (по умолчанию 'EPSG:3857')	Проекция.
`maxZoom`	number (по умолчанию 18)	Максимальный уровень масштабирования.
`minZoom`	number \| undefined	Минимальный уровень масштабирования.
`wrapX`	boolean (по умолчанию true)	Определяет, следует ли зацикливать мир по горизонтали.
`config`	Object \| undefined	Конфигурация CartoDB, используемая при работе с анонимными картами. Подробнее см. на странице https://carto.com/developers/maps-api/guides/anonymous-maps/. При работе с именованными картами — набор пар «ключ-значение» с параметрами шаблона. Подробнее см. на странице https://carto.com/developers/maps-api/guides/named-maps/.
`map`	string \| undefined	При работе с именованными картами это имя загружаемого шаблона. Подробнее см. на странице https://carto.com/developers/maps-api/guides/named-maps/.
`account`	string \| undefined	Имя пользователя, используемое для доступа к общедоступной панели Carto по адресу https://{username}.carto.com/.
`transition`	number (по умолчанию 250)	Длительность перехода непрозрачности при отрисовке. Чтобы отключить переход непрозрачности, передайте `transition: 0`.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли тайлы с более высоким или более низким уровнем масштабирования, если уровень масштабирования находится между целыми числами. См. `getZForResolution`.

События:

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

Наследует

Методы

changed() унаследовано Observable.js, строка 68

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

clear() унаследовано source/Tile.js, строка 258

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

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

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

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

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

get(key){*} унаследовано Object.js, строка 136

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

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getAttributions(){Attribution} унаследовано source/Source.js, строка 129

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

Возвращает:

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

getAttributionsCollapsible(){boolean} унаследовано source/Source.js, строка 137

Возвращает:

Атрибуцию можно свернуть.

getConfig(){Object} source/CartoDB.js, строка 95

Возвращает текущую конфигурацию.

Возвращает:

Текущая конфигурация.

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`.

setConfig(config) source/CartoDB.js, строка 117

Задаёт конфигурацию CartoDB

Имя	Тип	Описание
`config`	Object	Для анонимных карт — объект конфигурации CartoDB. Для именованных карт — таблица соответствий ключ-значение с параметрами шаблона.

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	Удалить без отправки события.

updateConfig(config) source/CartoDB.js, строка 105

Обновляет конфигурацию CartoDB.

Имя	Тип	Описание
`config`	Object	Таблица соответствий ключ-значение. Значения заменят текущие значения в конфигурации.