| java.lang.Object | ||||
| ↳ | com.carto.layers.Layer | |||
| ↳ | com.carto.layers.TileLayer | |||
| ↳ | com.carto.layers.VectorTileLayer | |||
| ↳ | com.carto.layers.CartoVectorTileLayer | |||
 Known Direct Subclasses
|
Class Overview
Specialized vector tile layer that can use built-in vector tile styles.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
CartoVectorTileLayer(TileDataSource dataSource, CartoBaseMapStyle style)
Constructs a CartoVectorTileLayer object from a specificed base map style.
| |||||||||||
|
CartoVectorTileLayer(TileDataSource dataSource, AssetPackage styleAssetPackage)
Constructs a CartoVectorTileLayer object from a source name and a style asset package.
| |||||||||||
|
CartoVectorTileLayer(TileDataSource dataSource, AssetPackage styleAssetPackage, String styleName)
Constructs a CartoVectorTileLayer object from a source name and a style asset package.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static VectorTileDecoder |
createTileDecoder(AssetPackage styleAssetPackage, String styleName)
Creates a new tile decoder from the specified asset package.
| ||||||||||
| static VectorTileDecoder |
createTileDecoder(CartoBaseMapStyle style)
Creates a new tile decoder from the specified base map style.
| ||||||||||
| static VectorTileDecoder |
createTileDecoder(AssetPackage styleAssetPackage)
Creates a new tile decoder from the specified asset package.
| ||||||||||
| synchronized void | delete() | ||||||||||
| CartoBaseMapBuildingRenderMode |
getBuildingRenderMode()
Returns the current render mode for buildings.
| ||||||||||
| String |
getFallbackLanguage()
Returns the current fallback language used for the layer.
| ||||||||||
| String |
getLanguage()
Returns the current language used for the layer.
| ||||||||||
| CartoBaseMapPOIRenderMode |
getPOIRenderMode()
Returns the current render mode for Point-Of-Interest icons.
| ||||||||||
| void |
setBuildingRenderMode(CartoBaseMapBuildingRenderMode renderMode)
Sets the current render mode for buildings.
| ||||||||||
| void |
setFallbackLanguage(String lang)
Sets the current fallback map language.
| ||||||||||
| void |
setLanguage(String lang)
Sets the current map language.
| ||||||||||
| void |
setPOIRenderMode(CartoBaseMapPOIRenderMode renderMode)
Sets the current render mode for Point-Of-Interest icons.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.carto.layers.VectorTileLayer
| |||||||||||
|
From class
com.carto.layers.TileLayer
| |||||||||||
|
From class
com.carto.layers.Layer
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public CartoVectorTileLayer (TileDataSource dataSource, CartoBaseMapStyle style)
Constructs a CartoVectorTileLayer object from a specificed base map style.
Parameters
| dataSource | The data source from which this layer loads data. |
|---|---|
| style | The style to use for the layer. |
public CartoVectorTileLayer (TileDataSource dataSource, AssetPackage styleAssetPackage)
Constructs a CartoVectorTileLayer object from a source name and a style asset package.
Style asset package defines visual style of the map and must be compatible with the source.
Parameters
| dataSource | The data source from which this layer loads data. |
|---|---|
| styleAssetPackage | The style asset package (usually a zipped file or an asset) |
public CartoVectorTileLayer (TileDataSource dataSource, AssetPackage styleAssetPackage, String styleName)
Constructs a CartoVectorTileLayer object from a source name and a style asset package.
Style asset package defines visual style of the map and must be compatible with the source.
Parameters
| dataSource | The data source from which this layer loads data. |
|---|---|
| styleAssetPackage | The style asset package (usually a zipped file or an asset) |
| styleName | The style to use from the asset package. |
Public Methods
public static VectorTileDecoder createTileDecoder (AssetPackage styleAssetPackage, String styleName)
Creates a new tile decoder from the specified asset package.
Parameters
| styleAssetPackage | The style asset package (usually a zipped file or an asset) |
|---|---|
| styleName | The name of the style to use. |
Returns
- The new vector tile decoder configured for the style.
public static VectorTileDecoder createTileDecoder (CartoBaseMapStyle style)
Creates a new tile decoder from the specified base map style.
Parameters
| style | The style to use for the decoder. |
|---|
Returns
- The new vector tile decoder configured for the style.
public static VectorTileDecoder createTileDecoder (AssetPackage styleAssetPackage)
Creates a new tile decoder from the specified asset package.
Parameters
| styleAssetPackage | The style asset package (usually a zipped file or an asset) |
|---|
Returns
- The new vector tile decoder configured for the style.
public synchronized void delete ()
public CartoBaseMapBuildingRenderMode getBuildingRenderMode ()
Returns the current render mode for buildings.
Returns
- The current render mode for buildings.
public String getFallbackLanguage ()
Returns the current fallback language used for the layer. Fallback language is used when a primary language name is not available.
Returns
- The current fallback language. If the returned string is empty, then 'local' languages are used.
public String getLanguage ()
Returns the current language used for the layer.
Returns
- The current language. If the returned string is empty, then 'local' languages are used.
public CartoBaseMapPOIRenderMode getPOIRenderMode ()
Returns the current render mode for Point-Of-Interest icons.
Returns
- The current render mode for for Point-Of-Interest icons.
public void setBuildingRenderMode (CartoBaseMapBuildingRenderMode renderMode)
Sets the current render mode for buildings.
Parameters
| renderMode | The new render mode for buildings. |
|---|
public void setFallbackLanguage (String lang)
Sets the current fallback map language. Fallback language is used when a primary language name is not available.
Parameters
| lang | The new fallback language to use. The default is local language (empty string). |
|---|
public void setLanguage (String lang)
Sets the current map language.
Parameters
| lang | The new language to use. The default is local language (empty string). |
|---|
public void setPOIRenderMode (CartoBaseMapPOIRenderMode renderMode)
Sets the current render mode for Point-Of-Interest icons.
Parameters
| renderMode | The new render mode for Point-Of-Interest icons. |
|---|