Sources

Where a layer's tiles come from — network, file, cache or another source. Created with kind source.

Type	Class
"assets"	AssetTileDataSource
"combined"	CombinedTileDataSource
"geojson"	GeoJSONVectorTileDataSource
"http"	HTTPTileDataSource
"local"	LocalVectorDataSource
"maptiler"	MapTilerOnlineTileDataSource
"mbtiles"	MBTilesTileDataSource
"memory-cache"	MemoryCacheTileDataSource
"merged-mbvt"	MergedMBVTTileDataSource
"multi"	MultiTileDataSource
"ordered"	OrderedTileDataSource
"persistent-cache"	PersistentCacheTileDataSource
"pmtiles"	PMTilesTileDataSource

"assets" — AssetTileDataSource

{"type": "assets", "minZoom": …, "maxZoom": …, "path": …}

Key	Type	Always required	Notes
minZoom	integer	yes	defaults to 0
maxZoom	integer	yes	defaults to 24
path	string	yes

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"combined" — CombinedTileDataSource

{"type": "combined", "source": …, "source2": …, "zoomLevel": …}

Key	Type	Always required	Notes
source	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec
source2	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec
zoomLevel	integer	yes	defaults to 0

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"geojson" — GeoJSONVectorTileDataSource

{"type": "geojson", "minZoom": …, "maxZoom": …}

Key	Type	Always required	Notes
minZoom	integer	yes	defaults to 0
maxZoom	integer	yes	defaults to 14

Property	Type	Access	Description
defaultLayerBuffer	number	read/write	Returns the default layer buffer in tile pixels.
simplifyTolerance	number	read/write	Returns the simplification tolerance in tile pixels.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
addFeature	layer: int, feature: json	void
createLayer	name: string	int
deleteLayer	layer: int	void
getMetaDataElement	key: string	json
loadTile	tile: tile	object
removeFeature	layer: int, id: json	void
setLayerGeoJSON	layer: int, geoJson: json	void
setMetaDataElement	key: string, value: json	void
updateFeature	layer: int, feature: json	void

"http" — HTTPTileDataSource

{"type": "http", "minZoom": …, "maxZoom": …, "url": …}

Key	Type	Always required	Notes
minZoom	integer	yes	defaults to 0
maxZoom	integer	yes	defaults to 24
url	string	yes

Property	Type	Access	Description
HTTPHeaders	struct std::map<std::string, std::string>	read/write	Returns the current set of HTTP headers used. Initially this set is empty and can be changed with setHTTPHeaders.
TMSScheme	boolean	read/write	Returns true/false based whether the TMS tiling scheme is used.
baseURL	string	read/write	Returns the base URL template containing tags.
maxAgeHeaderCheck	boolean	read/write	Returns true/false based on whether the max-age header check is used. If this is enabled, SDK will automatically refresh the tiles when tiles have expired.
subdomains	struct std::vector<std::string>	read/write	Returns the subdomains for {s} tag. The default is ["a", "b", "c", "d"].
timeout	integer	read/write	Returns the current timeout value.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"local" — LocalVectorDataSource

{"type": "local", "projection": …, "spatialIndexType": …}
{"type": "local", "projection": …}

Key	Type	Always required	Notes
projection	object std::shared_ptr<Projection>	yes	an id of kind projection, or an inline spec
spatialIndexType	enum	no

Property	Type	Access	Description
geometrySimplifier	object geometry.GeometrySimplifier	read/write	Returns the active geometry simplifier of the data source.

Inherited from VectorDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the data of this data source. The bounds are in coordinate system of the projection of the data source.
projection	object projections.Projection	read-only	Returns the projection used by this data source.

Method	Arguments	Returns
add	element: handle	void
clear	—	void
remove	element: handle	bool

"maptiler" — MapTilerOnlineTileDataSource

{"type": "maptiler", "key": …}

Key	Type	Always required	Notes
key	string	yes

Property	Type	Access	Description
customServiceURL	string	read/write	Returns the custom backend service URL.
timeout	integer	read/write	Returns the current timeout value.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"mbtiles" — MBTilesTileDataSource

{"type": "mbtiles", "minZoom": …, "maxZoom": …, "path": …, "scheme": …}
{"type": "mbtiles", "minZoom": …, "maxZoom": …, "path": …}
{"type": "mbtiles", "path": …}

Key	Type	Always required	Notes
minZoom	integer	no	defaults to 0
maxZoom	integer	no	defaults to 24
path	string	yes
scheme	enum	no

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"memory-cache" — MemoryCacheTileDataSource

{"type": "memory-cache", "source": …}

Key	Type	Always required	Notes
source	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec

Inherited from CacheTileDataSource:

Property	Type	Access	Description
capacity	integer	read/write
dataSource	object datasources.TileDataSource	read-only	Returns the original data source that the cache uses.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"merged-mbvt" — MergedMBVTTileDataSource

{"type": "merged-mbvt", "source": …, "source2": …}

Key	Type	Always required	Notes
source	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec
source2	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"multi" — MultiTileDataSource

{"type": "multi", "maxOpenedPackages": …}
{"type": "multi"}

Key	Type	Always required	Notes
maxOpenedPackages	integer	no	defaults to 4

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
add	datasource: handle, tileMask: string	void
getMetaDataElement	key: string	json
loadTile	tile: tile	object
remove	datasource: handle	bool
setMetaDataElement	key: string, value: json	void

"ordered" — OrderedTileDataSource

{"type": "ordered", "source": …, "source2": …}

Key	Type	Always required	Notes
source	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec
source2	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

"persistent-cache" — PersistentCacheTileDataSource

{"type": "persistent-cache", "source": …, "databasePath": …}

Key	Type	Always required	Notes
source	object std::shared_ptr<TileDataSource>	yes	an id of kind source, or an inline spec
databasePath	string	yes

Property	Type	Access	Description
cacheOnlyMode	boolean	read/write	Returns the state of cache only mode.
open	boolean	read-only	Returns the status of the cache database.

Inherited from CacheTileDataSource:

Property	Type	Access	Description
capacity	integer	read/write
dataSource	object datasources.TileDataSource	read-only	Returns the original data source that the cache uses.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
clear	—	void
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void
startDownloadArea	bounds: json, minZoom: int, maxZoom: int, fetchDelay: int	void
stopAllDownloads	—	void

Event	Payload	Consumable
download.completed	—	no
download.failed	TileDownloadInfo	no
download.progress	TileDownloadInfo	no
download.started	TileDownloadInfo	no

"pmtiles" — PMTilesTileDataSource

{"type": "pmtiles", "minZoom": …, "maxZoom": …, "path": …}
{"type": "pmtiles", "path": …}

Key	Type	Always required	Notes
minZoom	integer	no	defaults to 0
maxZoom	integer	no	defaults to 24
path	string	yes

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

Base classes

Not constructed directly. Their properties are reachable on every object above that derives from them.

CacheTileDataSource

Property	Type	Access	Description
capacity	integer	read/write
dataSource	object datasources.TileDataSource	read-only	Returns the original data source that the cache uses.

Inherited from TileDataSource:

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

TileDataSource

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source.
maxOverzoomLevel	integer	read/write	Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn"
maxZoom	integer	read-only	Returns the maximum zoom level supported by this data source.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's.
minZoom	integer	read-only	Returns the minimum zoom level supported by this data source.
projection	object projections.Projection	read-only	Returns the projection of this tile source.

Method	Arguments	Returns
getMetaDataElement	key: string	json
loadTile	tile: tile	object
setMetaDataElement	key: string, value: json	void

VectorDataSource

Property	Type	Access	Description
dataExtent	struct massif::MapBounds	read-only	Returns the extent of the data of this data source. The bounds are in coordinate system of the projection of the data source.
projection	object projections.Projection	read-only	Returns the projection used by this data source.