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 Description
attributions AttributionLike | undefined

Attributions.

cacheSize number | undefined

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.

crossOrigin null | string | undefined

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 ProjectionLike
(defaults to 'EPSG:3857')

Projection.

maxZoom number
(defaults to 18)

Max zoom.

minZoom number | undefined

Minimum zoom.

wrapX boolean
(defaults to true)

Whether to wrap the world horizontally.

config Object | undefined

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 | undefined

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 | undefined

Username as used to access public Carto dashboard at https://{username}.carto.com/.

transition number
(defaults to 250)

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.

zDirection number | NearestDirectionFunction
(defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.