MapProvider

所有已知实现类:

AbstractRestMapProvider, AbstractVectorTileProviderBase, AggregationMapProvider, ArcGISCacheMapProvider, ArcGISCacheProviderBase, ArcGISCacheV1ProviderBase, ArcGISCacheV2MapProvider, ArcGISRestMapProvider, ArcGISRestVectorTileProvider, BaiduMapProvider, BingMapsMapProvider, CloudMapProvider, FastDFSTileProvider, GDPMapProvider, GeoPackageMapProvider, GoogleMapsMapProvider, LocalTileProviderBase, MBTilesMapProvider, MBTilesTileProviderBase, MongoDBMVTTileProvider, MongoDBTileProvider, MultiTilesProvider, MVTTileProvider, OpenStreetMapProvider, OTSTileProvider, RemoteTileProviderBase, RestMapProvider, SMTilesMapProvider, SVTilesMapProvider, TiandituMapProvider, TiledMapProviderBase, TilesetMapProvider, TPKMapProvider, UGCMapProvider, UGCV5TileProvider, VTPKMapProvider, WMSMapProvider, WMTSMapProvider, ZXYTilesMapProvider
```
public interface MapProvider
```
地图服务提供者。

地图服务提供者是一类 GIS 服务提供者，获取并封装了与地图相关的 GIS 功能。

方法概要

方法
限定符和类型	方法和说明
`void`	`clearAllCache()` 清除全部缓存。
`void`	`clearCache(java.lang.String mapName, Rectangle2D bounds)` 清除指定区域的缓存。
`QueryResult`	`findNearest(java.lang.String mapName, Geometry geometry, double maxDistance, QueryParameterSet queryParameterSet)` 在指定地图上，查找距离指定几何对象一定容限内最近的几何对象。
`MapParameter`	`getDefaultMapParameter(java.lang.String mapName)` 获取指定地图的默认地图参数。
`java.util.List<FieldInfo>`	`getFieldsByLayerName(java.lang.String mapName, LayerFieldsQueryParameter layerFieldsQueryParameter)`
`MapImage`	`getMapImage(MapParameter mapParameter, ImageOutputOption outputOption)` 根据地图参数、图片输出设置获取地图图片。
`MapParameter`	`getMapParameter(java.lang.String mapName)` 获取指定地图上次出图之后的状态（地图参数）。
`java.util.List<java.lang.String>`	`getNames()` 获取当前地图服务提供者所对应的所有地图名。
`Overview`	`getOverview(MapParameter mapParameter, ImageOutputOption outputOption)` 根据地图参数以及图片输出设置获取鹰眼。
`java.lang.String`	`getResource(java.lang.String mapName, ResourceParameter resourceParameter)` 根据资源图片参数获取指定地图的资源图片。
`byte[]`	`getResource(java.lang.String mapName, ResourceParameter resourceParameter, Point2D[] points)` 根据资源图片参数获取指定地图的资源图片。
`MapImage`	`getTileImage(MapParameter mapParameter, ImageOutputOption outputOption)` 根据地图参数、图片输出设置获取瓦片图片。
`VectorStyle`	`getVectorStyle(java.lang.String mapName, java.lang.String[] layerNames, VectorStyleType type)` 获取指定地图中，指定矢量图层的样式
`VectorStyle`	`getVectorStyle(VectorStyleParameter vectorStyleParameter)` 获取指定地图中，指定矢量图层的样式
`MeasureResult`	`measureArea(java.lang.String mapName, Point2D[] points, MeasureParameter measureParam)` 根据二维地理坐标点、量算参数，在指定地图上进行面积量算。
`MeasureResult`	`measureDistance(java.lang.String mapName, Point2D[] points, MeasureParameter measureParam)` 根据二维地理坐标点、量算参数，在指定地图上进行距离量算。
`QueryResult`	`queryByBounds(java.lang.String mapName, Rectangle2D bounds, QueryParameterSet queryParameterSet)` 在指定的地图上，查询指定范围内的几何对象，以及外接矩形与指定范围相交的几何对象。
`QueryResult`	`queryByDistance(java.lang.String mapName, Geometry geometry, double distance, QueryParameterSet queryParameterSet)` 在指定地图上，查询距离指定的几何对象一定范围内的所有几何对象。
`QueryResult`	`queryByGeometry(java.lang.String mapName, Geometry geometry, SpatialQueryMode spatialQueryMode, QueryParameterSet queryParameterSet)` 在指定地图上，查询与指定的几何对象符合某种空间关系和查询条件的几何对象。
`QueryResult`	`queryBySQL(java.lang.String mapName, QueryParameterSet queryParameterSet)` 在指定地图上执行 SQL 查询。
`MapParameter`	`setDefaultMapParameter(MapParameter mapParameter)` 设置默认地图参数。
`boolean`	`support(java.lang.String mapName, MapCapability capability)` 判断地图是否支持相应功能。
`boolean`	`updateMap(MapParameter mapParameter)` 永久更新地图状态，会更新到磁盘中进行持久化。
`MapImage`	`viewEntire(java.lang.String layerName, MapParameter mapParameter, ImageOutputOption outputOption)` 根据地图图层名、地图参数以及图片输出设置进行全幅显示。

- 方法详细资料
  - getNames
```
java.util.List<java.lang.String> getNames()
```
    获取当前地图服务提供者所对应的所有地图名。
    
    返回:
    
    地图名称列表。
  - getMapParameter
```
MapParameter getMapParameter(java.lang.String mapName)
```
    获取指定地图上次出图之后的状态（地图参数）。
    
    参数:
    
    mapName - 指定地图名称。
    
    返回:
    
    地图参数。
  - clearCache
```
void clearCache(java.lang.String mapName,
              Rectangle2D bounds)
```
    清除指定区域的缓存。
    
    参数:
    
    mapName -
    
    bounds -
  - clearAllCache
```
void clearAllCache()
```
    清除全部缓存。
  - getMapImage
```
MapImage getMapImage(MapParameter mapParameter,
                   ImageOutputOption outputOption)
```
    根据地图参数、图片输出设置获取地图图片。
    
    参数:
    
    mapParameter - 地图参数。
    
    outputOption - 图片输出设置。
    
    返回:
    
    地图图片对象。
  - getTileImage
```
MapImage getTileImage(MapParameter mapParameter,
                    ImageOutputOption outputOption)
```
    根据地图参数、图片输出设置获取瓦片图片。
    
    参数:
    
    mapParameter - 地图参数。
    
    outputOption - 图片输出设置。
    
    返回:
    
    瓦片图片对象。
  - getResource
```
java.lang.String getResource(java.lang.String mapName,
                           ResourceParameter resourceParameter)
```
    根据资源图片参数获取指定地图的资源图片。
    
    参数:
    
    mapName - 地图名称。
    
    resourceParameter - 资源图片参数。
    
    返回:
    
    资源图片地址。
  - getResource
```
byte[] getResource(java.lang.String mapName,
                 ResourceParameter resourceParameter,
                 Point2D[] points)
```
    根据资源图片参数获取指定地图的资源图片。
    
    参数:
    
    mapName - 地图名称。
    
    resourceParameter - 资源图片参数。
    
    points - 绘制资源图片时用的点
    
    返回:
    
    图片对应的二进制流。
  - measureDistance
```
MeasureResult measureDistance(java.lang.String mapName,
                            Point2D[] points,
                            MeasureParameter measureParam)
```
    根据二维地理坐标点、量算参数，在指定地图上进行距离量算。
    
    参数:
    
    mapName - 地图名称。
    
    points - 二维地理坐标点数组。
    
    measureParam - 量算参数。
    
    返回:
    
    量算结果对象。
  - measureArea
```
MeasureResult measureArea(java.lang.String mapName,
                        Point2D[] points,
                        MeasureParameter measureParam)
```
    根据二维地理坐标点、量算参数，在指定地图上进行面积量算。
    
    参数:
    
    mapName - 地图名称。
    
    points - 二维地理坐标点数组。
    
    measureParam - 量算参数。
    
    返回:
    
    量算结果对象。
  - queryByDistance
```
QueryResult queryByDistance(java.lang.String mapName,
                          Geometry geometry,
                          double distance,
                          QueryParameterSet queryParameterSet)
```
    在指定地图上，查询距离指定的几何对象一定范围内的所有几何对象。
    
    到指定几何对象的一定距离范围，实际是以指定几何对象为中心的一个圆，在这个圆内以及与圆相交的几何对象都能够被查询出来。
    
    参数:
    
    mapName - 地图名称。
    
    geometry - 几何对象。
    
    distance - 查询的距离范围。
    
    queryParameterSet - 查询参数集。可对某个地图的多个图层进行查询，单个图层的查询参数在 queryParameterSet.queryParams[i] 中进行设置。
    
    返回:
    
    查询结果对象。
  - queryByGeometry
```
QueryResult queryByGeometry(java.lang.String mapName,
                          Geometry geometry,
                          SpatialQueryMode spatialQueryMode,
                          QueryParameterSet queryParameterSet)
```
    在指定地图上，查询与指定的几何对象符合某种空间关系和查询条件的几何对象。
    
    参数:
    
    mapName - 地图名称。
    
    geometry - 几何对象。该几何对象仅包含空间信息、形状信息等，并不包括属性信息。
    
    spatialQueryMode - 空间几何对象间的查询模式。空间几何对象间的查询模式定义了一些几何对象之间的空间位置关系，根据这些空间关系来构建过滤条件执行查询。例如：查询可被包含在面对象中的空间对象，与面有相离或者相邻关系的空间对象等。
    
    queryParameterSet - 查询参数集。可对某个地图的多个图层进行查询，单个图层的查询参数在 queryParameterSet.queryParams[i] 中进行设置。
    
    返回:
    
    查询结果对象。
  - queryByBounds
```
QueryResult queryByBounds(java.lang.String mapName,
                        Rectangle2D bounds,
                        QueryParameterSet queryParameterSet)
```
    在指定的地图上，查询指定范围内的几何对象，以及外接矩形与指定范围相交的几何对象。
    
    参数:
    
    mapName - 地图名称。
    
    bounds - 指定的查询范围。
    
    queryParameters - 查询参数集。可对某个地图的多个图层进行查询，单个图层的查询参数在 queryParameters.queryParams[i] 中进行设置。
    
    返回:
    
    查询结果对象。
  - queryBySQL
```
QueryResult queryBySQL(java.lang.String mapName,
                     QueryParameterSet queryParameterSet)
```
    在指定地图上执行 SQL 查询。
    
    参数:
    
    mapName - 地图名称。
    
    queryParameterSet - 查询参数集。可对某个地图的多个图层进行查询，单个图层的查询参数在 queryParameterSet.queryParams[i] 中进行设置。
    
    返回:
    
    查询结果对象。
  - setDefaultMapParameter
```
MapParameter setDefaultMapParameter(MapParameter mapParameter)
```
    设置默认地图参数。
    
    参数:
    
    mapParameter - 地图参数。
    
    返回:
    
    地图参数对象。
  - getDefaultMapParameter
```
MapParameter getDefaultMapParameter(java.lang.String mapName)
```
    获取指定地图的默认地图参数。
    
    初始的默认地图参数是由所访问的服务类型决定的，比如，访问 SuperMap Objects Java 提供的 GIS 能力，那么初始默认地图参数从工作空间文件中获取到；访问 WMS 服务提供的 GIS 能力，默认地图参数由 WMS 服务决定。
    
    参数:
    
    mapName - 地图名称。
    
    返回:
    
    地图参数对象。
  - viewEntire
```
MapImage viewEntire(java.lang.String layerName,
                  MapParameter mapParameter,
                  ImageOutputOption outputOption)
```
    根据地图图层名、地图参数以及图片输出设置进行全幅显示。
    
    参数中指定的图层名称是指以该图层内容的最小外接矩形作为全幅显示的地理范围。
    
    参数:
    
    layerName - 地图图层名，即以该图层的最小外接矩形作为全幅显示的地理范围。
    
    mapParameter - 地图参数。
    
    outputOption - 图片输出设置。
    
    返回:
    
    地图对象。
  - getOverview
```
Overview getOverview(MapParameter mapParameter,
                   ImageOutputOption outputOption)
```
    根据地图参数以及图片输出设置获取鹰眼。
    
    参数:
    
    mapParameter - 地图参数。
    
    outputOption - 图片输出设置。
    
    返回:
    
    鹰眼对象。
  - findNearest
```
QueryResult findNearest(java.lang.String mapName,
                      Geometry geometry,
                      double maxDistance,
                      QueryParameterSet queryParameterSet)
```
    在指定地图上，查找距离指定几何对象一定容限内最近的几何对象。当限制了返回几何对象个数（由QueryParameterSet.expectCount指定）时，查询结果为查询总记录中距离指定中心最近的expectCount个地物，这expectCount个地物按无序排列。
    
    参数:
    
    mapName - 地图名称。
    
    geometry - 几何对象。
    
    maxDistance - 容限范围，单位与 mapName 地图的地图坐标单位相同。
    
    queryParameterSet - 查询参数集。可对某个地图的多个图层进行查询，单个图层的查询参数在 queryParameterSet.queryParams[i] 中进行设置。
    
    返回:
    
    查询结果对象。
  - support
```
boolean support(java.lang.String mapName,
              MapCapability capability)
```
    判断地图是否支持相应功能。
    
    参数:
    
    mapName - 地图名。
    
    capability - 功能类型。
    
    返回:
    
    返回true表示支持该功能；返回false表示不支持该功能。
    
    从以下版本开始:
    
    7.0.1
  - getVectorStyle
```
VectorStyle getVectorStyle(java.lang.String mapName,
                         java.lang.String[] layerNames,
                         VectorStyleType type)
```
    获取指定地图中，指定矢量图层的样式
    
    参数:
    
    mapName - 地图名称
    
    layerNames - 图层名称
    
    type - 矢量样式类型
    
    返回:
    
    矢量图层样式
    
    从以下版本开始:
    
    8.0.3
  - getVectorStyle
```
VectorStyle getVectorStyle(VectorStyleParameter vectorStyleParameter)
```
    获取指定地图中，指定矢量图层的样式
    
    参数:
    
    vectorStyleParameter - 矢量风格参数。
    
    从以下版本开始:
    
    9.1.0
  - updateMap
```
boolean updateMap(MapParameter mapParameter)
```
    永久更新地图状态，会更新到磁盘中进行持久化。
    
    参数:
    
    mapParameter - 要更新的地图状态。
    
    返回:
    
    是否更新成功。
  - getFieldsByLayerName
```
java.util.List<FieldInfo> getFieldsByLayerName(java.lang.String mapName,
                                             LayerFieldsQueryParameter layerFieldsQueryParameter)
```
    参数:
    
    mapName -
    
    layerFieldsQueryParameter -
    
    返回:

接口 MapProvider

方法概要

方法详细资料

getNames

getMapParameter

clearCache

clearAllCache

getMapImage

getTileImage

getResource

getResource

measureDistance

measureArea

queryByDistance

queryByGeometry

queryByBounds

queryBySQL

setDefaultMapParameter

getDefaultMapParameter

viewEntire

getOverview

findNearest

support

getVectorStyle

getVectorStyle

updateMap

getFieldsByLayerName