Class: Map | HT for Web

new Map(graph3dView, options)

创建一个地图实例

Parameters:

Name	Type	Attributes	Description
`graph3dView`	ht.graph3d.Graph3dView	<optional>	HT 的 3D 视图组件。
`options`	any	<optional>	配置

Members

backgroundColor :string

获取和设置地球背景颜色

baseMapLayer :any

获取当前地图底图对象

cesiumPlugin :any

地图集成的 Cesium 扩展对象

cesiumScene :any

获取 Cesium Scene

cesiumViewer :any

获取 Cesium Viewer

currentMap :string

获取当前的地图名称

dataModel :ht.DataModel

获取 DataModel

dm :ht.DataModel

获取 DataModel

earthBloom :boolean

开启和关闭地球辉光

earthCameraLimit :boolean

开启和关闭地球操作相机限制

earthCameraLimitAngle :number

获取和设置地球操作限制角度

earthClockTime :string

获取和设置地球时钟

earthDefaultCameraAnimation :Animation4Type

获取和设置地球缺省相机动画过程参数

earthDefaultCameraOrientation :Orientation4Type

获取和设置地球缺省相机方位

earthDepthTestAgainstTerrain :boolean

开启和关闭地球地形深度检测

earthEffect :EarthEffect4Type

获取和设置地球瓦片效果的信息

earthInitialCorrect :boolean

开启和关闭地球初始化正北方向的纠正

earthLighting :boolean

开启和关闭地球光照

earthVisible :boolean

开启和关闭地球可视

earthVisibleDistance :number

设置 HT 图元在地球上的可视距离

graph3dView :ht.graph3d.Graph3dView

获取 Graph3dView

onlineMap :BaseMap4Type

获取内置的在线地图类型名称

skyBox :SkyBox4Type

设置地球天空球（和地球背景颜色设置互斥）

terrainProvider :any

获取当前的地形图层

Methods

add(data, callback) → {void}

叠加数据到地图上

Parameters:

Name	Type	Attributes	Description
`data`	ht.cesium.Point \| ht.cesium.Line \| ht.cesium.Polygon \| ht.cesium.Node \| ht.cesium.Points \| ht.cesium.Pipe \| ht.cesium.Wall \| ht.cesium.Light \| ht.cesium.Scene \| ht.cesium.Tiles \| ht.cesium.GeoJSON \| ht.cesium.ArcGIS \| ht.cesium.SuperMapLayer \| ht.cesium.Cloud \| ht.cesium.Heatmap \| ht.cesium.Water \| ht.cesium.Radar \| ht.cesium.TerrainClip \| ht.cesium.ClippingPlane \| ht.cesium.MovingTrack \| ht.cesium.FloodAnalysis		要素图元或图层
`callback`	function	<optional>	回调函数

Returns:

void

addAnnotationLayer(annotationName, options) → {void}

加载注记图层

Parameters:

Name	Type	Description
`annotationName`	string	图层名称【TdtAnnotation 或 AAnnotation】
`options`	any	图层配置，一般包含授权 key

Returns:

void

addCameraInteractorListener(listener) → {void}

相机监听

Parameters:

Name	Type	Description
`listener`	function	监听函数

Returns:

void

addCesium4HTDatasRecordById(id, data) → {void}

增加 cesium 元素的 HT 数据节点记录

Parameters:

Name	Type	Description
`id`	string	唯一标识
`data`	any	数据节点

Returns:

void

addCustomBaseMap(options, callback) → {void}

新增自定义底图

Parameters:

Name	Type	Attributes	Description
`options`	object
`callback`	function	<optional>

Returns:

void

addDataModelInteractorListener(listener) → {void}

交互监听

Parameters:

Name	Type	Description
`listener`	function	监听函数

Returns:

void

addGroundSkyBox(option) → {void}

加载近景天空球

Parameters:

Name	Type	Description
`option`	SkyBox4Type	天空球的配置

Returns:

void

addSceneRain() → {void}

增加场景下雨

Returns:

void

addSceneSnow() → {void}

增加场景下雪

Returns:

void

addTerrain(options, callback) → {void}

加载地形

Parameters:

Name	Type	Attributes	Description
`options`	Terrain4Type		地形配置
`callback`	function	<optional>	回调函数

Returns:

void

addToDOM(container) → {void}

将地球追加到指定容器，缺省容器是 body

Parameters:

Name	Type	Attributes	Description
`container`	string \| HTMLElement	<optional>	容器或容器 ID

Returns:

void

clear() → {void}

清除地图上的数据

Returns:

void

coordinate2World(lng, lat, height, ellipsoid) → {any}

将经纬度转换成世界坐标

Parameters:

Name	Type	Attributes	Description
`lng`	number		经度
`lat`	number		纬度
`height`	number	<optional>	高度
`ellipsoid`	any	<optional>	投影椭球

Returns:

any

createEarth(callback, options) → {void}

创建地球

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	回调函数
`options`	CesiumOptions4Type	<optional>	Cesium 初始化参数选项（详见 defaultOptions 说明）

Returns:

void

deserialize(json) → {void}

反序列化地图数据

Parameters:

Name	Type	Description
`json`	any

Returns:

void

destroy() → {void}

销毁地图实例对象

Returns:

void

disableHTPostProcessing() → {void}

禁止 HT 的后处理效果

Returns:

void

findCustomBaseMap(id) → {ImageryLayer}

根据ID查找自定义底图

Parameters:

Name	Type	Description
`id`	any

Returns:

ImageryLayer

flyTo(options, callback, isFromCurrentView) → {void}

飞行定位

Parameters:

Name	Type	Attributes	Description
`options`	any		飞行配置，主要配置相机位置（position，必填，数组或对象，经纬度）、相机角度（orientation，可选，对象，heading、pitch 和 roll）和相关动画（animation，可选，对象）
`callback`	function	<optional>	完成动画后的回调函数
`isFromCurrentView`	boolean	<optional>	是否来自

Returns:

void

flyToCoordinate(options) → {void}

根据经纬度范围飞行定位

Parameters:

Name	Type	Description
`options`	any	经纬度和方位信息

Returns:

void

flyToTarget(target, options, callback) → {void}

根据目标物的飞行定位

Parameters:

Name	Type	Attributes	Description
`target`	ht.cesium.Node \| ht.cesium.Wall \| ht.cesium.Light \| ht.cesium.Scene \| ht.cesium.Tiles \| ht.cesium.Water \| ht.cesium.Shape \| ht.cesium.Polyline		定位目标实体
`options`	any	<optional>	配置
`callback`	function	<optional>	回调函数

Returns:

void

getClampHeightByLngLat(positions, callback) → {void}

根据经纬度获取该位置的贴地高度

Parameters:

Name	Type	Attributes	Description
`positions`	any		经纬度位置
`callback`	function	<optional>	回调函数

Returns:

void

Deprecated:

undefined

getCurrentExtent() → {CurrentExtent4Type}

获取当前的视角范围

Returns:

CurrentExtent4Type

getCurrentOrientation(isDegrees) → {CurrentOrientation4Type}

当前方位信息获取（定位使用)

Parameters:

Name	Type	Attributes	Description
`isDegrees`	boolean	<optional>	是否使用度为单位

Returns:

CurrentOrientation4Type

getDataById(id) → {any}

根据数据 uuid 获取数据节点

Parameters:

Name	Type	Description
`id`	any	唯一标识

Returns:

any

getHeightOnModel(positions, callback, model) → {void}

根据经纬度获取该位置模型上的贴地高度

Parameters:

Name	Type	Attributes	Description
`positions`	Array.<Array.<number>>		经纬度位置[[118.23,23.43],[118.65, 24.43],……]
`callback`	function	<optional>	回调函数
`model`	any	<optional>	模型对象

Returns:

void

getHeightOnTerrain(positions, callback) → {void}

根据经纬度获取该位置地形上的贴地高度

Parameters:

Name	Type	Attributes	Description
`positions`	Array.<Array.<number>>		经纬度位置 [[118.23,23.43],[118.65, 24.43],……]
`callback`	function	<optional>	回调函数

Returns:

void

getImageryLayer4Level(level) → {any}

根据层级获取影像图层对象

Parameters:

Name	Type	Description
`level`	number	层级

Returns:

any

getLevel4ImageryLayer(imageryLayer) → {number}

根据影像图层对象获取对象的地图层级

Parameters:

Name	Type	Description
`imageryLayer`	any	影像地图对象

Returns:

number

getMapImage(type) → {string}

获取当前地图截图数据 base64

Parameters:

Name	Type	Attributes	Description
`type`	string	<optional>	类型，默认 image/png

Returns:

string

getOverviewMap() → {ht.cesium.OverviewMap}

获取鹰眼图对象

Returns:

ht.cesium.OverviewMap

getPositionHeight(position) → {number}

根据经纬度获取该位置的贴地高度（粗略计算）

Parameters:

Name	Type	Description
`position`	Array.<number>	经纬度位置[118.23,23.43]

Returns:

number

loadOfflineMap(options) → {any}

加载离线地图或以一张图片作为地图底图

Parameters:

Name	Type	Description
`options`	OfflineMap4Type	配置

Returns:

any

loadOnlineMap(mapLayer) → {any}

加载外部创建的地图底图

Parameters:

Name	Type	Description
`mapLayer`	any	地图底图图层对象

Returns:

any

Deprecated:

undefined

mi(listener) → {void}

交互监听

Parameters:

Name	Type	Description
`listener`	function	监听函数

Returns:

void

printMapImage(fileName, fileType) → {void}

截屏下载当前地图

Parameters:

Name	Type	Attributes	Description
`fileName`	string		文件名称
`fileType`	string	<optional>	文件类型，默认 'png'

Returns:

void

removeAllCustomBaseMaps() → {void}

删除所有自定义底图

Returns:

void

removeAllLayer(includeBaseMap) → {void}

Parameters:

Name	Type	Attributes	Description
`includeBaseMap`	boolean	<optional>	是否包含最底部地地图

Returns:

void

Deprecated:

移除所有图层

removeAnnotationLayer() → {void}

移除注记图层

Returns:

void

removeCameraInteractorListener() → {void}

移除相机监听函数

Returns:

void

removeCesium4HTDatasRecordById(id) → {void}

移除 cesium 元素的 HT 数据节点记录

Parameters:

Name	Type	Description
`id`	string	唯一标识

Returns:

void

removeCustomBaseMap(ids) → {void}

删除指定自定义底图

Parameters:

Name	Type	Attributes	Description
`ids`	Array.<string>	<optional>

Returns:

void

removeDataModelInteractorListener(listener) → {void}

移除交互监听函数

Parameters:

Name	Type	Description
`listener`	function	交互监听

Returns:

void

removeGroundSkyBox() → {void}

移除近景天空球

Returns:

void

removeLayer(levelOrLayer, isLevel) → {void}

移除地图图层

Parameters:

Name	Type	Attributes	Description
`levelOrLayer`	any		图层层级值或者图层对象
`isLevel`	boolean	<optional>	是否是图层层级，默认 true, 如果参数一是图层对象，需要设置为 false

Returns:

void

removeSceneRain() → {void}

移除下雨

Returns:

void

removeSceneSnow() → {void}

移除下雪

Returns:

void

removeTerrain() → {void}

移除地形

Returns:

void

serialize() → {any}

序列化地图数据

Returns:

any

setBaseMap(mapName, options) → {void}

设置地图底图

Parameters:

Name	Type	Description
`mapName`	string	地图底图名称
`options`	any	地图配置，部分地图底图需要

Returns:

void

setBaseMapFilter(invert, color, mapLevel) → {void}

设置底图滤镜

Parameters:

Name	Type	Attributes	Description
`invert`	boolean		颜色反转是否开启
`color`	string \| Array.<number>		滤镜颜色
`mapLevel`	number	<optional>	地图层级

Returns:

void

setCustomBaseMaps(baseMapConfigs) → {void}

设置自定义底图。
会清空之前的所有自定义底图

Parameters:

Name	Type	Description
`baseMapConfigs`	Array.<object>

Returns:

void

setDevicePixelRatio(dbr, useBrowserRecommendedResolution) → {void}

设置地球的分辨率

Parameters:

Name	Type	Attributes	Description
`dbr`	number		分辨率
`useBrowserRecommendedResolution`	boolean	<optional>	是否使用浏览器的分辨率，默认值 true

Returns:

void

setEarthRotation(isAutoRotation, angle) → {void}

设置地球自动旋转

Parameters:

Name	Type	Attributes	Description
`isAutoRotation`	boolean		是否制动旋转
`angle`	number	<optional>	自转角度步长

Returns:

void

setHomeView(options, completeCallback) → {void}

设置初始视图位置

Parameters:

Name	Type	Attributes	Description
`options`	ViewOptions4Type	<optional>	配置
`completeCallback`	function	<optional>	回调函数

Returns:

void

setNSInteractionLimits(isLimit) → {void}

设置地球南北极的交互限制

Parameters:

Name	Type	Attributes	Description
`isLimit`	boolean	<optional>	是否取消南北极的交互限制

Returns:

void

setOverviewMap(overviewMap) → {void}

设置鹰眼图

Parameters:

Name	Type	Description
`overviewMap`	ht.cesium.OverviewMap	鹰眼图对象

Returns:

void

setSceneBlackWhite(isOpen, options) → {void}

设置场景灰度化

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启灰度化后处理
`options`	PostProcessStage4Type	<optional>	配置

Returns:

void

setSceneBloom(isOpen, options) → {void}

设置场景的辉光

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启辉光后处理
`options`	PostProcessStageComposite4Type	<optional>	配置

Returns:

void

setSceneBlur(isOpen, options) → {void}

场景模糊（高斯）

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启模糊后处理
`options`	PostProcessStageComposite4Type	<optional>	配置

Returns:

void

setSceneBrightness(isOpen, options) → {void}

场景亮度设置

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启亮度后处理
`options`	PostProcessStage4Type	<optional>	配置

Returns:

void

setSceneDof(isOpen, options) → {void}

场景景深设置

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启景深后处理
`options`	PostProcessStageComposite4Type	<optional>	配置

Returns:

void

setSceneOutline(isOpen, options) → {void}

设置场景物体的描边

Parameters:

Name	Type	Attributes	Description
`isOpen`	boolean		是否开启物体描边后处理
`options`	PostProcessStageComposite4Type	<optional>	配置

Returns:

void

setView(options) → {void}

根据经纬度或区间范围设置视图

Parameters:

Name	Type	Attributes	Description
`options`	any	<optional>	配置，主要有 positions、heading、pitch 和 roll

Returns:

void

startRoamByPoint(center, distance, pitchAngle, angleStep) → {void}

开启定点漫游

Parameters:

Name	Type	Attributes	Description
`center`	Array.<number>		中心点位置（经纬度）
`distance`	number	<optional>	相机和中心点的距离
`pitchAngle`	number	<optional>	漫游时的角度值
`angleStep`	number	<optional>	漫游角度步长

Returns:

void

stopRoamByPoint() → {void}

关闭定点漫游

Returns:

void

syncCustomBaseMaps() → {void}

根据 dm 中自定义底图的配置，同步这些底图到 Cesium

Returns:

void

umi(listener) → {void}

移除交互监听

Parameters:

Name	Type	Description
`listener`	function	监听函数

Returns:

void

world2Coordinate(x, y, z, ellipsoid) → {any}

Parameters:

Name	Type	Attributes	Description
`x`	number		世界 X 轴坐标
`y`	number		世界 Y 轴坐标
`z`	number		世界 Z 轴坐标
`ellipsoid`	any	<optional>	投影椭球

Returns:

any

zoomIn(distance) → {void}

放大

Parameters:

Name	Type	Description
`distance`	number	放大距离

Returns:

void

zoomOut(distance) → {void}

缩小

Parameters:

Name	Type	Description
`distance`	number	缩小距离

Returns:

void