JSDoc: Class: Map

new Map()

地图类，负责地图显示环境的管理。

Source:

Map.js, line 17

Methods

(static) addDataset(dataset, addToHead) → {Promise.<void>}

用于把一个数据集添加到此地图作为一个普通图层显示，即创建一个普通图层。(@deprecated)

Parameters:

Name	Type	Description
`dataset`	object
`addToHead`	boolean

Source:

Map.js, line 78

Returns:

Type: Promise.<void>

(static) addLayer(dataset, addToHead) → {Promise.<layer>}

用于把一个数据集添加到此图层集合作为一个普通图层显示，即创建一个普通图层。其风格由系统默认设置。

Parameters:

Name	Type	Description
`dataset`		要添加到图层的数据集。
`addToHead`		指定新创建图层是否放在图层集合的最上面一层。当设置为 false 时，则将此新创建图层放在最底层。

Source:

Map.js, line 461

Returns:

Type: Promise.<layer>

(static) addThemeLayer(dataset, theme, addToHead) → {Promise.<Layer>}

用于将一个数据集添加到此图层集合作为一个专题图层显示，即创建一个专题图层，并指定专题图层的专题图对象。

Parameters:

Name	Type	Description
`dataset`		要添加到图层的数据集。
`theme`		指定此专题图层的专题图对象。
`addToHead`		指定新创建图层是否放在图层集合的最上面一层。当设置为 false 时，则将此新创建图层放在最底层。

Source:

Map.js, line 480

Returns:

Type: Promise.<Layer>

(static) close() → {Promise.<void>}

关闭当前地图。

Source:

Map.js, line 138

Returns:

Type: Promise.<void>

(static) contains(name) → {Promise.<number>}

判断地图是否包含某个名字的图层。

Parameters:

Name	Type	Description
`name`		图层的名字。

Source:

Map.js, line 520

Returns:

找到指定图层则返回图层索引，否则返回-1

Type: Promise.<number>

(static) getBounds() → {Promise.<Promise.bound>}

返回当前地图的空间范围。

Source:

Map.js, line 257

Returns:

- 返回Bounds的JSON对象：如{top:0,bottom:0,left:0,right:0,height:0,width:0,center:{x,y}}

Type: Promise.<Promise.bound>

(static) getCenter(point2D) → {Promise.<void>}

获取当前地图的显示范围的中心点。

Parameters:

Name	Type	Description
`point2D`	object

Source:

Map.js, line 190

Returns:

Type: Promise.<void>

(static) getLayer(layerIndex|layerName) → {Promise.<Layer>}

返回此图层集合中指定索引或名称的图层对象。

Parameters:

Name	Type	Description
`layerIndex\|layerName`	number \| string	指定索引或名称

Source:

Map.js, line 56

Returns:

Type: Promise.<Layer>

(static) getLayers() → {Promise.<Layers>}

返回当前地图所包含的图层集合对象。

Deprecated:

Source:

Map.js, line 93

Returns:

Type: Promise.<Layers>

(static) getLayersCount() → {Promise.<Promise.count>}

返回此图层集合中图层对象的总数。

Source:

Map.js, line 110

Returns:

Type: Promise.<Promise.count>

(static) getTrackingLayer() → {Promise.<TrackingLayer>}

返回当前地图的跟踪图层。

Source:

Map.js, line 222

Returns:

Type: Promise.<TrackingLayer>

(static) getViewBounds() → {Promise.<Promise.bound>}

返回当前地图的可见范围，也称显示范围。

Source:

Map.js, line 271

Returns:

- 返回Bounds的JSON对象：如{top:0,bottom:0,left:0,right:0,height:0,width:0,center:{x,y}}

Type: Promise.<Promise.bound>

(static) isDynamicProjection(bounds) → {Promise.<Promise.is>}

返回是否允许地图动态投影显示(该接口为安卓端专有接口，iOS无此接口)。

Parameters:

Name	Type	Description
`bounds`	object

Source:

Map.js, line 300

Returns:

Type: Promise.<Promise.is>

(static) mapToPixel(point2D) → {Promise.<Point>}

将地图中指定点的地图坐标转换为像素坐标。

Parameters:

Name	Type	Description
`point2D`	object

Source:

Map.js, line 171

Returns:

Type: Promise.<Point>

(static) moveDown(name) → {Promise.<bool>}

图层下移一层（图层的索引从 0 开始，从顶层开始依次编号）。

Parameters:

Name	Type	Description
`name`		图层的名字。

Source:

Map.js, line 535

Returns:

Type: Promise.<bool>

(static) moveUp(name) → {Promise.<bool>}

图层上移一层（图层的索引从 0 开始，从顶层开始依次编号）。

Parameters:

Name	Type	Description
`name`		图层的名字。

Source:

Map.js, line 550

Returns:

Type: Promise.<bool>

(static) open(mapName) → {Promise.<void>}

打开指定名称的地图。

Parameters:

Name	Type	Description
`mapName`	string	地图名称

Source:

Map.js, line 125

Returns:

Type: Promise.<void>

(static) pan(offsetX, offsetY) → {Promise.<void>}

将地图平移指定的距离。

Parameters:

Name	Type	Description
`offsetX`	double	X 方向上的移动距离，单位为坐标单位。
`offsetY`	double	Y 方向上的移动距离，单位为坐标单位。

Source:

Map.js, line 418

Returns:

Type: Promise.<void>

(static) pixelToMap(point) → {Promise.<Point2D>}

将地图中指定点的像素坐标转换为地图坐标。

Parameters:

Name	Type	Description
`point`	object

Source:

Map.js, line 152

Returns:

Type: Promise.<Point2D>

(static) refresh() → {Promise.<void>}

重新绘制当前地图。

Source:

Map.js, line 42

Returns:

Type: Promise.<void>

(static) removeLayer(index) → {Promise.<void>}

用于把一个图层移除。

Parameters:

Name	Type	Description
`index`		要移除图层的名字或序号。

Source:

Map.js, line 497

Returns:

Type: Promise.<void>

(static) save(mapName) → {Promise.<Promise.saved>}

将当前地图保存／另存为指定名称的地图

Parameters:

Name	Type	Description
`mapName`	string	地图名称（可选参数）

Source:

Map.js, line 239

Returns:

Type: Promise.<Promise.saved>

(static) setCenter(point2D) → {Promise.<void>}

设置当前地图的显示范围的中心点。

Parameters:

Name	Type	Description
`point2D`	object

Source:

Map.js, line 209

Returns:

Type: Promise.<void>

(static) setDynamicProjection(value) → {Promise.<void>}

设置地图是否动态投影显示，以及地图的投影坐标系

Parameters:

Name	Type	Description
`value`	boolean	地图是否动态投影

Source:

Map.js, line 315

Returns:

Type: Promise.<void>

(static) setMapLoadedListener(onMapLoaded) → {Promise.<void>}

获取用于接收地图加载完成的监听器。

Parameters:

Name	Type	Description
`onMapLoaded`	function	地图打开并显示完成后触发该方法。

Source:

Map.js, line 329

Returns:

Type: Promise.<void>

(static) setMapOperateListener(events) → {Promise.<void>}

添加一个用于接收地图打开、关闭事件的监听器。

Parameters:

Name	Type	Description
`events`	object	传入一个对象作为参数，该对象可以包含两个属性：mapOpened和mapClosed。两个属性的值均为function类型，分部作为打开地图和关闭地图监听事件的处理函数。例：{"mapOpened":()=>return console.log('map opened'),"mapClosed":()=> console.log('map closed')}

Source:

Map.js, line 365

Returns:

Type: Promise.<void>

(static) setViewBounds(bounds) → {Promise.<void>}

设置当前地图的可见范围，也称显示范围。

Parameters:

Name	Type	Description
`bounds`	object	Bounds的JSON对象：如{top:0,bottom:0,left:0,right:0,height:0,width:0,center:{x,y}}

Source:

Map.js, line 286

Returns:

Type: Promise.<void>

(static) setWorkspace(workspace) → {Promise.<void>}

设置当前地图所关联的工作空间。地图是对其所关联的工作空间中的数据的显示。

Parameters:

Name	Type	Description
`workspace`	object

Source:

Map.js, line 29

Returns:

Type: Promise.<void>

(static) viewEntire() → {Promise.<void>}

全幅显示此地图。

Source:

Map.js, line 431

Returns:

Type: Promise.<void>

(static) zoom(ratio) → {Promise.<void>}

将地图放大或缩小指定的比例。

Parameters:

Name	Type	Description
`ratio`	double	缩放地图比例，此值不可以为负。

Source:

Map.js, line 445

Returns:

Type: Promise.<void>