Class: CartoDB

ol/source/CartoDB~CartoDB


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

Layer source for the CartoDB Maps API.

new CartoDB(options)

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.

Fires:

Extends

Methods

Increases the revision counter and dispatches a 'change' event.

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean | undefined} inherited

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event BaseEvent | string

Event object.

Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

Returns:
Attributions are collapsible.

getConfig(){Object}

Returns the current config.

Returns:
The current configuration.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

getProjection(){Projection | null} inherited

Get the projection of the source.

Returns:
Projection.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

Get the state of the source, see State for possible states.

Returns:
State.

getTileGrid(){TileGrid | null} inherited

Return the tile grid of the tile source.

Returns:
Tile grid.

Return the tile load function of the source.

Returns:
TileLoadFunction

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:
URLs.

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

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

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

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

Set the attributions of the source.

Name Type Description
attributions AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

setConfig(config)

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.

setProperties(values, silent) inherited

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean | undefined

Update without triggering an event.

setRenderReprojectionEdges(render) inherited

Sets whether to render reprojection edges or not (usually for debugging).

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name Type Description
projection ProjectionLike

Projection.

tilegrid TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited

Set the tile load function of the source.

Name Type Description
tileLoadFunction LoadFunction

Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited

Set the tile URL function of the source.

Name Type Description
tileUrlFunction UrlFunction

Tile URL function.

key string | undefined

Optional new tile key for the source.

Set the URL to use for requests.

Name Type Description
url string

URL.

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener) inherited

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

unset(key, silent) inherited

Unsets a property.

Name Type Description
key string

Key name.

silent boolean | undefined

Unset without triggering an event.

updateConfig(config)

Updates the carto db config.

Name Type Description
config Object

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