OpenLayers

Class: CartoDB

ol/source/CartoDB~CartoDB 


import CartoDB from 'ol/source/CartoDB';

Layer source for the CartoDB Maps API.

new CartoDB(options)

source/CartoDB.js, line 39
Name Type Description
options

CartoDB options.

Name Type Default Description
attributions module:ol/source/Source~AttributionLike

Attributions.
cacheSize number 2048

Cache size.
crossOrigin null | string

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or 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 'EPSG:3857'

Projection.
maxZoom number 18

Max zoom.
minZoom number

Minimum zoom.
wrapX boolean true

Whether to wrap the world horizontally.
config Object

If using anonymous maps, the CartoDB config to use. See http://docs.cartodb.com/cartodb-platform/maps-api/anonymous-maps/ for more detail. If using named maps, a key-value lookup with the template parameters. See http://docs.cartodb.com/cartodb-platform/maps-api/named-maps/ for more detail.
map string

If using named maps, this will be the name of the template to load. See http://docs.cartodb.com/cartodb-platform/maps-api/named-maps/ for more detail.
account string

If using named maps, this will be the name of the template to load.

Methods

getConfig(){Object}

source/CartoDB.js, line 87

Returns the current config.

Returns:
The current configuration.

setConfig(config)

source/CartoDB.js, line 109

Sets the CartoDB config

Name Type Description
config Object

In the case of anonymous maps, a CartoDB configuration object. If using named maps, a key-value lookup with the template parameters.

updateConfig(config)

source/CartoDB.js, line 97

Updates the carto db config.

Name Type Description
config Object

a key-value lookup. Values will replace current values in the config.