MapInterface
地图相关接口。
地图分为三个图层，分别为基础地图层（baseMap)，背景地图层（backgroundMap),叠加地图层(overlayMap)。三个图层分别设置地图数据，以及透明度设置、显示/隐藏；同时也提供所有地图整体显示/隐藏设置，透明度设置，以及地形设置等。
来源于@ksj/bw
| 接口 | 说明 |
|---|---|
| showMap | 显示地图。 |
| hideMap | 隐藏地图。 |
| isMapShow | 地图显示是否开启。 |
| setBaseMap | 设置接触地图层地图数据。 |
| changeBaseMapTransparency | 设置基础地图的透明度。 |
| getBaseMapTransparency | 获取当前设置的基础地图的透明度。 |
| addOverlayMap | 添加叠加层地图数据。 |
| addBackgroundMap | 添加背景层地图数据。 |
| findOverlayMapByIndex | 按序号获取当前叠加层地图的某个地图数据。 |
| hideOverlayMap | 隐藏叠加层的地图。 |
| showOverlayMap | 显示叠加层的地图。 |
| changeOverlayMapTransparency | 改变叠加层的地图的透明度。 |
| findBackgroundMapByIndex | 按序号获取当前背景层的地图数据。 |
| hideBackgroundMap | 隐藏背景层的地图数据。 |
| removeBackgroundMap | 移除背景层的地图数据。 |
| showBackgroundMap | 显示背景层的地图数据。 |
| changeBackgroundMapTransparency | 改变背景层的地图数据的透明度。 |
| applyTerrain | 应用/不应用地形。 |
| isTerrainApply | 当前是否应用地形。 |
| setMapTransparency | 设置地图透明度。 |
| getMapTransparency | 获取地图透明度设置。 |
| changeOverlayMapIndex | 改变叠加层的地图数据的顺序。 |
| changeBackgroundMapIndex | 改变背景层的地图数据的顺序。 |
| removeOverlayMap | 移除叠加层的地图数据。 |
# 1. showMap
开启地图显示。
static showMap()
参数： 无。
返回： 无。
# 2. hideMap
关闭地图显示。
static hideMap()
参数： 无。
返回： 无。
# 3. isMapShow
检测当前地图是否设置为显示。
static isMapShow():boolean
参数： 无。
返回：
true 当前地图设置为显示。
false 当前地图设置为隐藏。
# 4. setBaseMap
设置基础地图层数据。
目前支持的基础地图数据为 bing 地图 和 mapbox 地图。
static setBaseMap( name:undefined | BackgroundMapProviderName, type:undefined | BackgroundMapType )
参数：
name 地图名。
undefined 不设置基础地图数据。
BingProvider 设置基础地图数据为 bing 地图。
MapBoxProvider 设置基础地图数据为 mapbox 地图。
type 地图类型。
BackgroundMapType.Aerial 基础地理影像数据。
BackgroundMapType.Street 道路数据。
BackgroundMapType.Hybrid 影像数据与道路数据叠加。
返回： 无。
# 5. changeBaseMapTransparency
设置基础地图的透明度。
static changeBaseMapTransparency( transparency:number )
参数：
transparency 透明度值 0---1， 0 表示不透明； 1 表示全透明。
返回： 无。
# 6. getBaseMapTransparency
获取设置的基础地图的透明度。
static getBaseMapTransparency() : number
参数： 无。
返回：
返回透明度值。
# 7. addOverlayMap
添加叠加层地图的地图数据。
static addOverlayMap( formatId:string, name:string, url:string )
参数：
formatId： 地图数据类型。
name： 地图名称。
url: 地图地址。
返回： 无。
# 8. addBackgroundMap
添加背景层地图的地图数据。
static addBackgroundMap( formatId:string, name:string, url:string )
参数：
formatId： 地图数据类型。
name： 地图名称。
url: 地图地址。
返回： 无。
# 9. findOverlayMapByIndex
按序号获取叠加层地图数据。
static findOverlayMapByIndex( index:number ) : undefined | MapLayerSettings
参数：
index 地图的顺序号。
返回：
该序号对应的地图存在则返回相关信息。
该序号对应的地图不存在则返回 undefined。
# 10. hideOverlayMap
设置叠加层的某个地图不显示。
static hideOverlayMap( index:number )
参数：
index 地图的顺序号。
返回： 无。
# 11. showOverlayMap
设置叠加层的某个地图为显示。
static showOverlayMap( index:number )
参数：
index 地图的顺序号。
返回： 无。
# 12. changeOverlayMapTransparency
修改叠加层的地图的透明度。
static changeOverlayMapTransparency( index:number, transparency:number )
参数：
index 地图的顺序号。
transparency 要设置的透明度值。0---1；0 不透明；1 全透明。
返回： 无。
# 13. removeOverlayMap
移除叠加层的地图的数据。
static removeOverlayMap( index:number )
参数：
index 地图的顺序号。
返回： 无。
# 14. applyTerrain
开始/关闭三维地形显示。
static applyTerrain( flag:boolean = true )
参数：
flag 是否开启三维地形。
返回： 无。
# 15. isTerrainApply
检查当前三维地形显示是否开启。
static isTerrainApply() : boolean
参数： 无。
返回：
true 三维地形开启返回 true。
false 三维地形未开启返回 false。
# 16. setMapTransparency
设置地图层整体透明度。
static setMapTransparency( transparency:number )
参数：
transparency： 透明度值 0---1。0 不透明； 1 全透明。
返回： 无。
# 17. getMapTransparency
获取地图层整体透明度值。
static getMapTransparency() : number
参数： 无。
返回：
透明度值。
# 18. changeOverlayMapIndex
交换两个叠加层地图的顺序。
static changeOverlayMapIndex( oldIndex:number, newIndex:number )
参数：
oldIndex： 旧的顺序号。
newIndex： 新的顺序号。
返回： 无。