OpenLayers

Class: CartoDB

ol.source.CartoDB

Layer source for the CartoDB tiles.

new ol.source.CartoDB(options)

src/ol/source/cartodb.js, line 18
Name Type Description
options

CartoDB options.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
cacheSize number | undefined

Cache size. Default is 2048.
crossOrigin null | string | undefined

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.
logo string | olx.LogoOptions | undefined

Logo.
projection ol.ProjectionLike

Projection. Default is EPSG:3857.
maxZoom number | undefined

Optional max zoom level. Default is 18.
minZoom number | undefined

Minimum zoom.
wrapX boolean | undefined

Whether to wrap the world horizontally. Default is true.
config Object | undefined

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

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

CartoDB account name Required.
Fires:

Extends

Methods

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

src/ol/observable.js, line 75

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 Object | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 113

Get the attributions of the source.

Returns:
Attributions.

getConfig(){Object}

src/ol/source/cartodb.js, line 65

Returns the current config.

Returns:
The current configuration.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited

src/ol/source/source.js, line 123

Get the logo of the source.

Returns:
Logo.

getProjection(){ol.proj.Projection} inherited

src/ol/source/source.js, line 133

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

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

Returns:
Revision.

getState(){ol.source.State} inherited

src/ol/source/source.js, line 150

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

Returns:
State.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tile.js, line 211

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited

src/ol/source/urltile.js, line 79

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited

src/ol/source/urltile.js, line 89

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

src/ol/source/urltile.js, line 101

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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.
this Object

The object to use as this in listener.
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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

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.
this Object

The object to use as this in listener.
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.

refresh() inherited

src/ol/source/source.js, line 167

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

src/ol/source/source.js, line 179

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

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

setConfig(config)

src/ol/source/cartodb.js, line 89

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, opt_silent) inherited

src/ol/object.js, line 170

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

Update without triggering an event.

setRenderReprojectionEdges(render) inherited

src/ol/source/tileimage.js, line 327

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

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

src/ol/source/tileimage.js, line 352

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 ol.ProjectionLike

Projection.
tilegrid ol.tilegrid.TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited

src/ol/source/urltile.js, line 137

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction, opt_key) inherited

src/ol/source/urltile.js, line 150

Set the tile URL function of the source.

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.
key string

Optional new tile key for the source.

setUrl(url) inherited

src/ol/source/urltile.js, line 165

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

src/ol/source/urltile.js, line 178

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

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.
this Object

The object which was used as this by the listener.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateConfig(config)

src/ol/source/cartodb.js, line 76

Updates the carto db config.

Name Type Description
config Object

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