Module: ol/source/CartoDB

ol/source/CartoDB


Classes

CartoDB

Type Definitions

CartoDBLayerInfo{Object}

Properties:
Name Type Description
layergroupid string

The layer group ID
cdn_url Object

The CDN URL

Options{Object}

Properties:
Name Type Argument Default Description
attributions module:ol/source/Source~AttributionLike <optional>

Attributions.
cacheSize number <optional>

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
crossOrigin null | string <optional>

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
projection module:ol/proj~ProjectionLike <optional>
 'EPSG:3857'

Projection.
maxZoom number <optional>
 18

Max zoom.
minZoom number <optional>

Minimum zoom.
wrapX boolean <optional>
 true

Whether to wrap the world horizontally.
config Object <optional>

If using anonymous maps, the CartoDB config to use. See https://carto.com/developers/maps-api/guides/anonymous-maps/ for more detail. If using named maps, a key-value lookup with the template parameters. See https://carto.com/developers/maps-api/guides/named-maps/ for more detail.
map string <optional>

If using named maps, this will be the name of the template to load. See https://carto.com/developers/maps-api/guides/named-maps/ for more detail.
account string <optional>

Username as used to access public Carto dashboard at https://{username}.carto.com/.
transition number <optional>
 250

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
zDirection number | module:ol/array~NearestDirectionFunction <optional>
 0

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See module:ol/tilegrid/TileGrid~TileGrid#getZForResolution.