样式类别:CartoDB

ol/source/CartoDB~卡托DB


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

CartoDB 地图 API 的图层源。

new CartoDB(options)

Name Type 描述
attributions AttributionLike | undefined

版权声明。

cacheSize number | undefined

已弃用。请改用图层上的 cacheSize 选项。

crossOrigin null | string | undefined

crossOrigin 表示已加载图像的属性。请注意:必须提供 crossOrigin。若要通过 Canvas 渲染器访问像素数据,请使用此值。参见https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image了解更多详情。

projection ProjectionLike (defaults to 'EPSG:3857')

投影.

maxZoom number (defaults to 18)

最大缩放。

minZoom number | undefined

最小缩放。

wrapX boolean (defaults to 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 (defaults to 250)

渲染时的不透明度过渡动画时长。要禁用不透明度过渡,请传递transition: 0.

zDirection number | NearestDirectionFunction (defaults to 0)

当处于整数缩放级别之间时,请选择是否使用更高或更低缩放级别的图块。请参见getZForResolution.

触发事件:

继承

方法

增加修订计数器并触发 change 事件。

从源中移除所有缓存的重投影切片。下一个渲染周期将创建新的切片。

dispatchEvent(event){boolean | undefined} inherited

调度事件并调用所有监听该类型事件的监听器。事件参数可以是字符串或具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果事件对象上调用了 preventDefault 或任何侦听器返回了 false。

获取值。

Name Type 描述
key string

键名。

返回:
值。

获取数据源的归属函数。

返回:
署名功能。

getAttributionsCollapsible(){boolean} inherited

返回:
归属信息是可折叠的。

getConfig(){Object}

获取当前配置。

返回:
当前配置。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名称列表。

getProjection(){Projection | null} inherited

获取源的投影。

返回:
投影.

getProperties(){Object.<string, *>} inherited

获取包含所有属性名及其值的对象。

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每次修改该对象时,其版本号将递增。

返回:
修订。

获取源的状态,请参阅 State 了解可能的状态。

返回:
状态。

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

已弃用。请改用 ImageTile 源。返回源的瓦片加载函数。

返回:
瓦片加载函数

已弃用。请改用 ImageTile 源。返回源的瓦片URL函数。

返回:
瓦片URL函数

getUrls(){!Array.<string> | null} inherited

此功能已弃用,请改用图像瓦片源。 返回该源使用的URL。 当使用tileUrlFunction而不是url或urls时,将返回null。

返回:
网址。

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数进行调用,则返回结果将为键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

单次监听特定类型的事件。

Name Type 描述
type string | Array.<string>

一个事件类型或事件类型数组。

listener function

监听器函数。

返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回键的数组。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名

value *

值。

silent boolean | undefined

更新而不触发事件。

setAttributions(attributions) inherited

设置源的归属。

Name Type 描述
attributions AttributionLike | undefined

归属。可传递为string, Array<string>, Attribution,或undefined.

setConfig(config)

设置 CartoDB 配置

Name Type 描述
config Object

匿名地图对应一个CartoDB配置对象。若使用命名地图,则通过模板参数进行键值查找。

setProperties(values, silent) inherited

设置一组键值对。请注意,此操作将更改所有现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

setRenderReprojectionEdges(render) inherited

设置是否渲染重投影边缘(通常用于调试)。

Name Type 描述
render boolean

渲染边缘。

setTileGridForProjection(projection, tilegrid) inherited

设置将瓦片重投影到给定投影时所用的瓦片网格,而非该投影的默认瓦片网格。

当默认瓦片网格无法创建时(例如投影未定义范围),或为优化性能(如自定义瓦片大小、分辨率等),这可能很有用。

Name Type 描述
projection ProjectionLike

投影.

tilegrid TileGrid

用于投影的瓦片网格。

setTileLoadFunction(tileLoadFunction) inherited

(该功能)已弃用。请改用 ImageTile 源。设置源的瓦片加载函数。

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数。

setTileUrlFunction(tileUrlFunction, key) inherited

已弃用。请改用 ImageTile 源。设置源的瓦片URL函数。

Name Type 描述
tileUrlFunction UrlFunction

瓦片 URL 函数。

key string | undefined

源的可选新瓦片密钥。

设置请求所使用的URL。

Name Type 描述
url string

网址。

已弃用。请改用 ImageTile 源。设置请求的URL。

Name Type 描述
urls Array.<string>

网址。

un(type, listener) inherited

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型的数组。

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

清除设置而不触发事件。

updateConfig(config)

更新CartoDB配置。

Name Type 描述
config Object

键值查找:值将替换配置中的现有值。