CartoDB~CartoDB

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

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

новый CartoDB(options) source/CartoDB.js, строка 46

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

Вызывает:

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

Расширяет

Методы

changed() inherited Observable.js, line 68

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

clear() inherited source/Tile.js, line 257

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

Отправляет событие и вызывает всех слушателей, слушающих события этого типа. Параметр события может быть строкой или объектом со свойством 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

Возвращаемое значение:

Атрибуты можно сворачивать.

getConfig(){Object} source/CartoDB.js, line 95

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

Возвращаемое значение:

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

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} унаследованный source/UrlTile.js, строка 124

Устарело. Используйте источник ImageTile вместо него. Возвращает URL-адреса, используемые для этого источника. Когда используется tileUrlFunction вместо url или urls, возвращается 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	Функция-обработчик.

Возвращает:

set(key, value, silent) унаследованный Object.js, строка 215

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

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без срабатывания события.

setAttributions(attributions) унаследованный source/Source.js, строка 203

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

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции. Может быть передано как `string`, `Array<string>`, `Attribution` или `undefined`.

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

Устанавливает конфигурацию CartoDB.

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

setProperties(values, silent) унаследованный Object.js, строка 235

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

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без срабатывания события.

setRenderReprojectionEdges(render) унаследованный source/TileImage.js, строка 280

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

Имя	Тип	Описание
`render`	boolean	Отображать грани.

setTileGridForProjection(projection, tilegrid) унаследованный source/TileImage.js, строка 300

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

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

Имя	Тип	Описание
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов, используемая для проекции.

setTileLoadFunction(tileLoadFunction) унаследованный 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, строка 187

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

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

setUrls(urls) inherited source/UrlTile.js, строка 199

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

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

un(type, listener) inherited Observable.js, строка 173

Отписывается от события определённого типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) inherited Object.js, строка 259

Удаляет свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без срабатывания события.

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

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

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