Class: VectorTilesMap

var mvtMap = scene.addVectorTilesMap({
     url:URL_CONFIG.MVT,
     canvasWidth:512,
     name:'testMVT',
     viewer:viewer,
     transformRequest:function(url,resourceType){
         return {
             url:url.replace('http','https'),
             headers:{'my-custom-header':true}
         };
     }
});
var layerReadyPromise = mvtMap.readyPromise;
    layerReadyPromise.then(function(data){
        // All subsequent API operations on MVT should be called inside readyPromise
    })

Members

deprecated alphanumber

Get or set the overall transparency of the layer, with a value between 0 and 1 (0 is completely transparent).

Default Value:

1.0

See:

• VectorTilesMapSetting.alpha

Methods

addImage(id, options)

Add an image to the vector tile map.

Name	Type	Description
id	string	Image ID.
options	Object	Optional objects. Name Type Description pixelRatio Object The ratio of image pixels to physical pixels on the screen. sdf boolean Is the image an SDF image. content Array.<number> Shaped as [x1, x2, y1, y2]. This parameter only applies to symbol layers that use the 'icon text fit' style and the image itself This parameter specifies which area of the image can be covered by text, in pixels stretchX Array.<Array.<number>> Shaped as [x1, x2], [x3, x4]. This parameter only applies to symbol layers that use the 'icon text fit' style and the image itself This parameter specifies the horizontal area for image stretching, measured in pixels stretchY Array.<Array.<number>> Shaped as [y1, y2], [y3, y4]. This parameter only applies to symbol layers that use the 'icon text fit' style and the image itself This parameter specifies the vertical area for image stretching, measured in pixels

addLayer(layerObject, before)

Add layers.

Name	Type	Description
layerObject	Object	A layer parameter object that conforms to the layer specification in the style of Mapbox.
before	String	Specify a target layer based on the ID and place the newly added layer in front of it.

Example

// Add a new layer of type symbol before an existing layer
map.addLayer({
    id: 'states',
    // Here, the source needs to reference the id of a source object that already exists in a layer
    source: 'state-data',
    type: 'symbol',
    layout: {
        // Set the label text content to the value of the 'name' attribute in the feature
        'text-field': ['get', 'name']
    }
 // Add this new layer before an existing layer with id 'cities'
}, 'cities');

addSource(id, source)

Add a mapbox style standard data source to the map

Name	Type	Description
id	string	The ID of the added data source. Duplicate data sources cannot exist
source	Object	Data source object, compliant with Mapbox style standards

Examples

添加SuperMap REST地图服务作为栅格数据源
map.addSource('myRestMap', {
    type: 'raster',
    url : "http://localhost:8090/iserver/services/map-myMap/rest/maps/myMap",
});
 

添加SuperMap REST海图出图服务作为栅格数据源，chartSetting为ChartSetting类型海图出图参数类
map.addSource('myRestChartMap', {
    type: 'raster',
    url : "http://localhost:8090/iserver/services/map-myRestChartMap/rest/maps/myRestChartMap",
    chartSetting : chartSetting
});

添加geojson务作为矢量数据源
map.addSource('my-data', {
    "type": "geojson",
    "data": {
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-77.0323, 38.9131]
        }
    }
});

flyTo(center, zoom, scale)

Locate the camera position, MVT data can be located to a specified level.

The camera's perspective after positioning is vertically downward, with Cener as the center of the field of view, and MVT data is displayed at a specific level.

Applicable when terrain is not loaded.

Name	Type	Description
center	Array	The center of the field of view after positioning, the first value is longitude, and the second value is latitude, in degrees.
zoom	Number	MVT hierarchy after positioning.
scale	Number	Global scale.

Example

mvtMap.flyTo({
   center :[103.6454723,  40.134343], 
   zoom : 11
});

mvtMap.flyTo({
   center :[103.6454723,  40.134343], 
   scale : 1.0/36978669.4318207
}) 

getFilter(layerID){Array}

Return the layer filter used by the specified ID layer

Name	Type	Description
layerID	string	To obtain the layer ID of the filter object

Returns:

Type	Description
Array	Filters used for layers

Example

const filter = map.getFilter('myLayer');

getLayer(id){Object}

Return a layer parameter object that conforms to the layer specification in the mapbox style with a specified layer ID

Name	Type	Description
id	string	Layer object ID

Returns:

Type	Description
Object	Return the layer object with the specified ID, or return undefined when the layer ID does not exist

Example

const stateDataLayer = map.getLayer('state-data');

getLayoutProperty(layerId, name){*}

Return a property value in the layout object of the layer with the specified ID

Name	Type	Description
layerId	string	To obtain the layer ID of the layout object
name	string	To obtain the name of the property of the layout object

Returns:

Type	Description
*	Return the property values of a specific layout object

Example

const layoutProperty = map.getLayoutProperty('mySymbolLayer', 'icon-anchor');

getPaintProperty(layerId, name){*}

Return the value of the specified attribute in the canvas style of the specified layer

Name	Type	Description
layerId	string	To obtain the layer ID of the canvas style object
name	string	The property name of the canvas style object to be obtained

Returns:

Type	Description
*	Return the value of a property of a canvas style object

Example

const paintProperty = map.getPaintProperty('mySymbolLayer', 'icon-color');

getSource(id){Object}

Return the source object with the specified ID in the map style

Name	Type	Description
id	string	The ID of the source to get.

Returns:

Type	Description
Object	Return the source object with the specified ID in the style. If the ID does not exist, return undefined The style source with the specified ID or undefined if the ID

Example

const sourceObject = map.getSource('points');

getVisibleInViewport(index){Boolean}

Obtain layer corresponding viewport visibility, mainly used for split screen and large screen display.

Name	Type	Description
index	Number	Indexes.

Throws:

the index is 0~8。

Type

DeveloperError

Returns:

Type	Description
Boolean	Visible visibility.

hasImage(id){boolean}

Determine whether there is an image with ID in the vector tile map.

Name	Type	Description
id	string	Image ID.

Returns:

Type	Description
boolean	True indicates that the service has an image with ID, while false indicates otherwise.

listImages(){Array.<number>}

Obtain all image IDs of the vector tile map.

Returns:

Type	Description
Array.<number>	All image IDs for this service

loadImage(url, callback)

Load an image for the vector tile map.

Name	Type	Description
url	string	Image address.
callback	function	The function called when the image loads successfully or fails, similar to callback (error, data)

Example

mvtMap.loadImage("./p.png", function(err, data){
   if(err){
     return;
   }
   mvtMap.addImage('imageId', data);
})

moveLayer(id, beforeId)

Move the layer to the specified layer array.

Name	Type	Description
id	String	The ID of the layer that is expected to be moved in position.
beforeId	String	optional This ID specifies an existing layer, and the desired layer to be moved will be inserted before this existing layer. The layer to be moved specified by the ID will be displayed below the foredId layer. If this parameter is omitted, the moved layer will be appended to the end of the layer array and displayed above all other layers on the map.

Example

// Move Polygon1 to the position before Polygon2 in the array
VectorTilesMap.moveLayer("ploygon1", "polygon2");

queryRenderedFeatures(cartographicArray, options, layers, filter)

Retrieve rendering features from a specified layer within a specified geographic range.

Name	Type	Description
cartographicArray	Array.<Cartographic> | Cartographic	Specify a geographic range, geographic coordinate point, or geographic coordinate array.
options	Object	Object.
layers	Array.<string>	The specified layer ID, if no layer ID is specified, returns the rendering features of all layers intersecting the specified range.
filter	Filter	filter.

querySourceFeatures(params)

Search for characteristic features. Based on the specified features, querying elements on the map now supports fuzzy queries.

Name	Type	Description
params		Search based on the specified feature characteristics.

Example

var result = mvtMap.querySourceFeatures({
sourceLayer: selectLayer.id, // Sublayer name
filter: ["like","NAME","京"] // Set fuzzy query filter criteria. For example, this can find features whose NAME attribute contains "Jing".
})

releaseSelection()

Release the selected area.

removeImage(id)

Delete the image with the vector tile map ID as id.

Name	Type	Description
id	string	Image ID.

removeLayer(id)

Remove the layer with the specified ID.

Name	Type	Description
id	String	The ID of the layer to be removed.

Example

// If a layer with id 'state-data' exists, remove it from the map
if (map.getLayer('state-data')) map.removeLayer('state-data');

removeSource(id)

Remove a source with a specified ID from the map style

Name	Type	Description
id	string	The ID of the source to be removed

Example

map.removeSource('bathymetry-data');

setCRS(crs)

Docking with third-party MVT data (the coordinate system of the data must be set when loading third-party data).

Name	Type	Description
crs	String	Currently supports EPSG: 4490, EPSG: 3857, default value EPSG: 4490.

Example

SuperMap3D.when(mvtMap.readyPromise, function(){
     mvtMap.setCRS("EPSG:3857")
})

setFilter(layerID, filter)

Setting the filter object filter used by the layer with a specified ID can control which features from its source objects are selected for rendering in a style layer. Only the features whose expression in the filter calculates' true 'will be rendered onto the map. Features with false calculation results will be hidden. You can use the setFilter method to control the subset of data in the data source you want to display. If you want to clarify the existing filters, the second parameter can be passed as' null 'or' undefined '

Name	Type	Description
layerID	string	The ID of the layer using the filter
filter	Array | null | undefined	Filter information. Please refer to the [filter definition] section of Mapbox Style Specification for formatting. If passing 'null' or 'undefined', it will clear the existing filters of the layer

Examples

// In the 'my-layer' layer, only show those features whose 'name' attribute is 'CHINA'
map.setFilter('my-layer', ['==', ['get', 'name'], 'CHINA']);

// In the 'bike-docks' layer, only show those features whose 'available-spots' attribute value is greater than or equal to 5
map.setFilter('bike-docks', ['>=', ['get', 'available-spots'], 5]);

// Remove the filter used in the style layer with id 'bike-docks'
map.setFilter('bike-docks', null);

setLayoutProperty(layerId, name, value, options)

Set the layout style for the layer with the specified ID. Through this interface, text wrapping display can be set.

Name	Type	Description
layerId	String	Proposed layer ID for setting layout style
name	String	The name of the layout style.
value	String	The value of layout style.
options	Object	optional Optional parameter object.

Example

设置文字换行的用法。
mvtMap.setLayoutProperty(子图层ID,'text-max-width',单行文本的最大字符数）
mvtMap.setLayoutProperty("加油站注记#1", 'text-max-width',5 )
设置文字图层不沿线旋转，默认值false。
mvtMap.setLayoutProperty("沿线文字图层id", 'ignore-line-rotation', true/false )
设置沿线文字图层位置沿着矢量数据定义的顺序放置。
mvtMap.setLayoutProperty("沿线文字图层id", 'symbol-placement', 'line-direction')
沿线文字新增text-keep-upright-alignment风格，支持设置字体向上的对齐目标，默认值‘line'为mapbox渲染效果，与矢量线平行。viewport为文字渲染结果与视口平行。
mvtMap.setLayoutProperty(layer.id, 'text-keep-upright-alignment', 'viewport')
设置文字的方向，默认值为 ['horizontal', 'vertical']，'line' 为控制沿线文字按照矢量数据定义的顺序放置。
mvtMap.setLayoutProperty(layer.id, 'text-writing-mode', 'line')

setPaintProperty(layerId, name, value, options)

Set the canvas style for the layer with the specified ID.

Name	Type	Description
layerId	String	Propose to set the layer ID for the canvas style.
name	String	The name of the canvas.
value	String	The value of the canvas.
options	Object	optional Optional parameter object.

setVisibleInViewport(index, visible)

Set the visibility of the viewport corresponding to the layer, mainly used for split screen and large screen display.

Name	Type	Description
index	Number	Indexes.
visible	Boolean	Visibility.

Throws:

the index is 0~8。

Type

DeveloperError

updateImage(id, image)

Update the image for the vector tile map.

Name	Type	Description
id	string	Image ID.
image	HTMLImageElement | ImageBitmap | ImageData | Object | StyleImageInterface	Image data.