地图类 ,这是构造三维地球的一切的开始起点。
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | Cesium.Viewer |
地图div容器的id 或 已构造好的Viewer对象 |
|||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
参考:
继承
成员(属性)
是否全局启用availability和Task, 如果在编辑场景不想availability、Task生效,仅播放时生效时,可以先手动关闭下,播放时再开启
-
默认值:
true
basemap : string|number|BaseTileLayer
map/Map.js 395
获取或设置当前显示的底图,设置时可以传入图层id或name
获取相机 Cesium.Camera
获取Canvas画布
获取 CesiumWidget
获取时钟 Cesium.Clock
获取地图DOM容器。
readonly contextmenu : ContextMenu
map/Map.js 538
右键菜单控件对象
获取地图上已构造的控件对象
当前时间
获取要可视化的 DataSource 实例集。
获取地图上已构造的effect特效对象
设置事件的启用和禁用状态
获取未绑定到特定数据源的实体的集合。这是 dataSourceDisplay.defaultDataSource.entities 的快捷方式。
是否固定光照, true:可避免gltf、3dtiles模型随时间存在亮度不一致。
调用了openFlyAnimation正在进行开场动画的Promise
获取globe球。 Cesium.Scene
readonly graphicLayer : GraphicLayer
map/Map.js 600
默认矢量图层,简单场景时可快捷使用
是否开启地形
是否全局启用highlight ,如果在某些场景,如标绘时,可以手动关闭下
-
默认值:
true
获取将在地球上渲染的ImageryLayer图像图层的集合
获取将在地球上渲染的ImageryLayer图像图层的集合[贴模型时]
是否有矢量图层正在绘制状态
readonly keyboardRoam : KeyboardRoam
map/Map.js 548
获取键盘漫游控制器
lang : Lang|Object
map/Map.js 681
使用的语言文本配置
获取当前地图层级(概略),一般为0-21层
readonly mouseEvent : MouseEvent
map/Map.js 516
获取鼠标事件控制器
是否只拾取模型上的点
是否只拾取地形上的点,忽略模型和矢量数据
是否开启顶点吸附功能,只拾取顶点上的点
当前类的构造参数
readonly readyPromise : Promise.<(BaseLayer|object)>
map/Map.js 284
获取地图完成解析加载完成的Promise承诺, 等价于load事件(区别在于load事件必须在load完成前绑定才能监听)。
使用示例:
map.readyPromise.then(function(map) {
console.log("load完成", map)
})
获取场景。 Cesium.Scene
图层中统一的url模版,比如可以将服务url前缀统一使用模板,方便修改或动态配置。
获取或设置当前的地形服务
获取地图上已构造的thing对象
获取ToolBar控件DOM容器, 其样式为cesium-viewer-toolbar
trackedEntity : Cesium.Entity|BaseEntity|undefined|*
map/Map.js 293
获取或设置相机当前正在跟踪的Entity实例。
地图对应的Cesium原生的 Cesium.Viewer对象
鼠标滚轮缩放的步长比例, 初始化时可传参 scene.cameraController.zoomFactor
-
默认值:
3.0
方法
addControl(control, enabledVal) → Map
map/Map.js 2255
添加控件到地图上
参数名称 | 类型 | 描述信息 |
---|---|---|
control |
BaseControl |
控件对象 |
enabledVal |
boolean |
可选
如果传值,覆盖控件的enabled属性 |
返回值:
当前对象本身,可以链式调用
addEffect(effect) → Map
map/Map.js 2362
添加特效对象到地图上
参数名称 | 类型 | 描述信息 |
---|---|---|
effect |
BaseEffect |
特效对象 |
返回值:
当前对象本身,可以链式调用
addEventParent(obj) → BaseClass
core/BaseClass.js 307
添加抛出事件到父类,它将接收传播的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
添加图层到地图上
参数名称 | 类型 | 描述信息 |
---|---|---|
layer |
BaseLayer |
图层对象 |
showVal |
boolean |
可选
如果传值,覆盖图层的show属性 |
返回值:
图层加载完成承诺
addThing(item) → Map
map/Map.js 2443
添加Thing对象到地图上
参数名称 | 类型 | 描述信息 |
---|---|---|
item |
BaseThing |
Thing对象 |
返回值:
当前对象本身,可以链式调用
bindContextMenu(content, options) → Map
map/Map.js 3732
绑定地图的默认右键菜单
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content |
Array.<object> |
右键菜单配置数组,数组中每一项包括:
|
|||||||||||||||||||
options |
object |
{}
|
可选
控制参数
|
返回值:
当前对象本身,可以链式调用
使用示例:
//内置的默认右键菜单获取方法
var defaultContextmenuItems =map.getDefaultContextMenu()
map.bindContextMenu(defaultContextmenuItems)
cancelFlyTo() → Map
map/Map.js 2867
停止视角定位等操作
返回值:
当前对象本身,可以链式调用
将相机本身定位至指定位置,同 setCameraView 方法 为了兼容老版本用户习惯和center参数名称一致而用的别名方法。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
cameraView |
object |
飞行参数,同 setCameraView 方法 |
|
options |
object |
{}
|
可选
参数对象,同 setCameraView 方法 |
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
设置鼠标操作习惯方式。 false:中键旋转,右键拉伸远近(默认); true:可以设置为右键旋转,中键拉伸远近。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
rightTilt |
boolean |
false
|
可选
是否右键旋转 |
返回值:
无
移除所有加载的图层、控件、对象。慎用
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasDestroy |
boolean |
true
|
可选
是否释放对象 |
返回值:
无
清除鼠标操作限定的Pitch范围
返回值:
无
closeContextMenu() → Map
map/Map.js 3770
关闭右键菜单
返回值:
当前对象本身,可以链式调用
清除已高亮的矢量对象
返回值:
无
closePopup() → Map
map/Map.js 3667
关闭Popup弹窗
返回值:
当前对象本身,可以链式调用
closeSmallTooltip() → Map
map/Map.js 3795
关闭小提示窗
返回值:
当前对象本身,可以链式调用
closeTooltip() → Map
map/Map.js 3695
关闭Tooltip弹窗
返回值:
当前对象本身,可以链式调用
销毁地图
返回值:
无
eachControl(method, context, reverse) → Map
map/Map.js 2323
遍历每一个控件并将其作为参数传递给回调函数
参数名称 | 类型 | 描述信息 |
---|---|---|
method |
function |
回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
reverse |
boolean |
可选
是否倒序执行 |
返回值:
当前对象本身,可以链式调用
eachEffect(method, context) → Map
map/Map.js 2410
遍历每一个Effect对象并将其作为参数传递给回调函数
参数名称 | 类型 | 描述信息 |
---|---|---|
method |
function |
回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
eachLayer(method, context, reverse) → Map
map/Map.js 1831
遍历每一个图层并将其作为参数传递给回调函数
参数名称 | 类型 | 描述信息 |
---|---|---|
method |
function |
回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
reverse |
boolean |
可选
是否倒序执行 |
返回值:
当前对象本身,可以链式调用
eachThing(method, context, reverse) → Map
map/Map.js 2507
遍历每一个Thing对象并将其作为参数传递给回调函数
参数名称 | 类型 | 描述信息 |
---|---|---|
method |
function |
回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
reverse |
boolean |
可选
是否倒序执行 |
返回值:
当前对象本身,可以链式调用
截图,导出地图场景图片
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
截图完成后的回调方法的Promise
fire(type, data, propagate) → BaseClass
core/BaseClass.js 203
触发指定类型的事件。
参数名称 | 类型 | 描述信息 |
---|---|---|
type |
EventType | string |
事件类型 |
data |
object |
可选
传输的数据或对象,可在事件回调方法中event对象中获取进行使用 |
propagate |
BaseClass |
可选
将事件传播给父类 (用addEventParent设置) |
返回值:
当前对象本身,可以链式调用
- 继承自:
飞行到默认视角, 一般为config.json中的center参数配置的视角。
参数名称 | 类型 | 默认值 | 描述信息 | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
无
飞行至Cesium相关矢量对象处,是Cesium本身的flyTo方法。
将相机移至提供的一个或多个实体或数据源。如果数据源仍在加载过程中,或者可视化仍在加载中,此方法在执行飞行之前等待数据准备就绪。 偏移量是在以边界球中心为中心的局部东北向上参考框中的航向/俯仰/范围。航向角和俯仰角是在局部的东西向北参考系中定义的。航向是从y轴到x轴的角度。间距是从xy平面开始的旋转。正螺距角度在平面上方。负俯仰角在平面下方。范围是到中心的距离。如果范围是零,则将计算范围以使整个边界球都可见。
在2D模式下,必须有一个俯视图。摄像机将被放置在目标上方并向下看。上方的高度目标将是范围。航向将根据偏移量确定。如果标题不能根据偏移量确定,航向将为北。
参数名称 | 类型 | 描述信息 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
target |
* |
需要定位的Cesium内部对象。您还可以传递一个: Cesium.Entity|Cesium.Entity[]|Cesium.EntityCollection|Cesium.DataSource|Cesium.ImageryLayer|Cesium.Cesium3DTileset|Cesium.TimeDynamicPointCloud|Promise.<Entity|Entity[]|Cesium.EntityCollection|Cesium.DataSource|Cesium.ImageryLayer|Cesium.Cesium3DTileset|Cesium.TimeDynamicPointCloud> |
||||||||||||||||
options |
object |
可选
具有以下属性的对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
相机飞行定位至矩形区域
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
extent |
object | Cesium.Rectangle |
飞行参数, Object时可以传入:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
飞行定位到 Graphic矢量对象 处
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
graphic |
BaseGraphic | Array.<BaseGraphic> |
矢量对象 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
定位至目标点(非相机位置)
参数名称 | 类型 | 默认值 | 描述信息 | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
point |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
目标点位置(视角中心点) |
||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
具有以下属性的对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
定位至坐标数组
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
positions |
Array.<Cesium.Cartesian3> |
坐标数组 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
getBasemaps(removeEmptyGroup) → Array.<BaseLayer>|Array
map/Map.js 2124
获取所有basemps底图图层
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
removeEmptyGroup |
boolean |
false
|
可选
是否移除 空图层组 |
返回值:
图层数组
取相机到屏幕中心点的距离
返回值:
相机到屏幕中心点的距离,单位:米
获取当前相机视角参数, 示例:{"lat":30.526361,"lng":116.335987,"alt":45187,"heading":0,"pitch":-45}
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
当前相机视角参数
getCenter(toCartesian) → LngLatPoint|Cesium.Cartesian3|object|undefined
map/Map.js 1184
取地图屏幕中心点坐标
参数名称 | 类型 | 描述信息 |
---|---|---|
toCartesian |
object |
可选
返回Cesium.Cartesian3格式坐标 |
返回值:
屏幕中心点坐标
获取绑定的右键菜单数组
返回值:
右键菜单数组
getControl(attrValue, attrName) → BaseControl
map/Map.js 2334
根据指定属性获取控件
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
attrValue |
string | number | boolean |
类型名称 或 属性值 |
|
attrName |
string |
'type'
|
可选
属性键,默认type |
返回值:
控件对象
获取地图的当前实时状态对应的配置参数。 同 toJSON
返回值:
地图的配置参数
获取平台内置的右键菜单,图标可以覆盖 mars3d.Icon.* 值
返回值:
右键菜单
getEffect(key, attrName) → BaseEffect
map/Map.js 2399
根据指定属性获取Thing对象
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
key |
string | EffectType | * |
类型值 或 属性值 |
|
attrName |
string |
'type'
|
可选
属性名称,默认是type |
返回值:
Thing对象
提取地球当前视域边界,示例:{ xmin: 70, xmax: 140, ymin: 0, ymax: 55, height: 0, }
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
当前视域边界
获取贴地的高度值 (仅考虑当前视域内数据和精度下的高度)
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
position |
string | Array | LngLatPoint | Cesium.Cartesian3 | * |
坐标位置 |
|||||||||||||||||
options |
object |
{}
|
可选
参数对象,具有以下属性:
|
返回值:
贴地的高度值
获取当前key对应语言的文本内容。
参数名称 | 类型 | 描述信息 |
---|---|---|
key |
string |
文本key |
返回值:
lang参数指定的对应文本内容
getLayer(attrValue, attrName) → BaseLayer|*
map/Map.js 1842
根据指定属性获取图层,包括config.json配置的图层
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
attrValue |
string | number |
属性值 |
|
attrName |
string |
'id'
|
可选
属性键 |
返回值:
图层对象
getLayerByAttr(attrValue, attrName) → BaseLayer|*
map/Map.js 1899
根据指定属性获取图层
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
attrValue |
string | number |
属性值 |
|
attrName |
string |
'id'
|
可选
属性键 |
返回值:
图层对象
getLayerById(id) → BaseLayer|*
map/Map.js 1854
根据ID或取图层 ,包括config.json配置的图层
参数名称 | 类型 | 描述信息 |
---|---|---|
id |
string | number |
图层id |
返回值:
图层对象
getLayers(options) → Array.<BaseLayer>|Array
map/Map.js 1954
获取所有图层
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数对象,包括以下:
|
返回值:
图层数组
getLayersByAttr(attrValue, attrName) → Array.<BaseLayer>|*
map/Map.js 1923
根据指定属性获取图层列表
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
attrValue |
string | number |
属性值 |
|
attrName |
string |
'id'
|
可选
属性键 |
返回值:
图层对象列表
获取所有图层的配置信息,通常用于配置图层树
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数对象,包括以下:
|
返回值:
返回值包括 { list: [id与pid关联的原始数组], tree: [按children组织好的上下级树数组]}
获取图层ID值,按顺序取值。 没有id的图层,会自动使用本方法进行id赋值处理
返回值:
图层ID
获取new Map地图的传入时options构造参数
返回值:
地图的配置参数
当存在地形夸张时,获取其实际的高度值
参数名称 | 类型 | 描述信息 |
---|---|---|
alt |
number |
鼠标拾取的高度值 |
返回值:
其实际的高度值
getThing(attrValue, attrName) → BaseThing
map/Map.js 2519
根据指定属性获取Thing对象
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
attrValue |
string | number | boolean |
属性值 |
|
attrName |
string |
'id'
|
可选
属性名称 |
返回值:
Thing对象
getTileLayers() → Array.<BaseTileLayer>|Array
map/Map.js 2144
获取所有瓦片图层,可以用于卷帘对比
返回值:
图层数组
getTimeTaskList() → TimeTaskListResult
map/Map.js 3836
获取当前地图下时序相关列表 1.subtitles:字幕控件列表; 2.task:任务列表; 3.availability:所有 图层、矢量对象、特效 绑定的availability;
返回值:
时序列表返回对象
是否有指定的控件存在(就是已经addControl的控件)
参数名称 | 类型 | 描述信息 |
---|---|---|
control |
BaseControl | string |
指定的控件或控件ID |
返回值:
是否存在
是否绑定了抛出事件到指定父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
是否绑定了抛出事件
是否有指定的图层存在(就是已经addLayer的图层)
参数名称 | 类型 | 描述信息 |
---|---|---|
layer |
string | number | BaseLayer |
指定的图层或图层ID |
返回值:
是否存在
是否有指定的Thing对象存在(就是已经addThing的图层)
参数名称 | 类型 | 描述信息 |
---|---|---|
thing |
BaseThing | string |
指定的Thing对象或Thing对象ID |
返回值:
是否存在
判断指定对象是否为当前场景中正在高亮的对象
参数名称 | 类型 | 描述信息 |
---|---|---|
target |
object |
判断的高亮的对象(如graphic或layer等) |
返回值:
无
是否有绑定指定的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
type |
EventType | string |
事件类型 |
propagate |
BaseClass |
可选
是否判断指定的父类 (用addEventParent设置的) |
返回值:
是否存在
- 继承自:
off(types, fn, context) → BaseClass
core/BaseClass.js 95
解除绑定指定类型事件监听器
参数名称 | 类型 | 描述信息 |
---|---|---|
types |
EventType | string | Array.<EventType> |
可选
事件类型,未传值时解绑所有事件 |
fn |
function |
可选
绑定的监听器回调方法,未传值时解绑所有指定类型对应事件,特殊说明:map.on监听的Cesium相关原生事件时必须传入该参数 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
on(types, fn, context) → BaseClass
core/BaseClass.js 61
绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 阻止事件冒泡
参数名称 | 类型 | 描述信息 |
---|---|---|
types |
EventType | string | Array.<EventType> | Array.<string> | object |
事件类型 |
fn |
function |
绑定的监听器回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
once(types, fn, context) → BaseClass
core/BaseClass.js 284
绑定一次性执行的指定类型事件监听器 与on类似,监听器只会被触发一次,然后被删除。
参数名称 | 类型 | 描述信息 |
---|---|---|
types |
EventType | string | Array.<EventType> |
事件类型 |
fn |
function |
绑定的监听器回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
openContextMenu(position) → Map
map/Map.js 3756
打开右键菜单
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
Cesium.Cartesian3 | LngLatPoint |
可选
显示的位置 |
返回值:
当前对象本身,可以链式调用
执行开场动画,动画播放地球飞行定位到指定区域(1.旋转地球+2.降低高度+3.指定视角)
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
高亮矢量对象
参数名称 | 类型 | 描述信息 |
---|---|---|
graphic |
BaseGraphic | * |
矢量对象 |
highlightStyle |
object |
高亮的样式,具体见各 |
event |
object |
可选
鼠标事件对象 |
返回值:
无
openPopup(position, content, options) → Map
map/Map.js 3655
打开Popup弹窗
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
矢量对象 或 显示的位置 |
content |
string | function | BaseGraphic | BaseGraphicLayer |
弹窗内容html字符串,或者 回调方法 或者矢量对象/图层。 |
options |
Popup.StyleOptions |
可选
配置参数 |
返回值:
当前对象本身,可以链式调用
openSmallTooltip(position, message) → Map
map/Map.js 3785
显示小提示窗,一般用于鼠标操作的提示。
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
Cesium.Cartesian2 | Cesium.Cartesian3 |
显示的屏幕坐标位置 或 笛卡尔坐标位置 |
message |
* |
显示的内容 |
返回值:
当前对象本身,可以链式调用
openTooltip(position, content, options) → Map
map/Map.js 3682
打开Tooltip弹窗
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
矢量对象 或 显示的位置 |
content |
string | function |
弹窗内容html字符串,或者 回调方法 |
options |
Tooltip.StyleOptions |
可选
配置参数 |
返回值:
当前对象本身,可以链式调用
暂停执行 setCameraViewList
返回值:
无
获取坐标位置的3dtiles模型对象
参数名称 | 类型 | 描述信息 |
---|---|---|
positions |
Cesium.Cartesian3 | Array.<Cesium.Cartesian3> |
坐标 或 坐标数组 |
返回值:
3dtiles模型对象
pickTilesetLayer(positions) → TilesetLayer|undefined
map/Map.js 1336
获取坐标位置的3dtiles模型图层
参数名称 | 类型 | 描述信息 |
---|---|---|
positions |
Cesium.Cartesian3 | Array.<Cesium.Cartesian3> |
坐标 或 坐标数组 |
返回值:
3dtiles模型图层
继续执行 setCameraViewList
返回值:
无
removeControl(control, hasDestroy) → Map
map/Map.js 2287
移除控件
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
control |
BaseControl |
需要移除的控件 |
|
hasDestroy |
boolean |
false
|
可选
是否释放 |
返回值:
当前对象本身,可以链式调用
removeEffect(effect, hasDestroy) → Map
map/Map.js 2385
移除特效对象
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
effect |
BaseEffect |
需要移除的特效对象 |
|
hasDestroy |
boolean |
false
|
可选
是否释放 |
返回值:
当前对象本身,可以链式调用
removeEventParent(obj) → BaseClass
core/BaseClass.js 320
移除抛出事件到父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
removeLayer(layer, hasDestroy) → Map
map/Map.js 1776
移除图层
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
layer |
BaseLayer |
需要移除的图层 |
|
hasDestroy |
boolean |
false
|
可选
是否释放 destroy |
返回值:
当前对象本身,可以链式调用
removeThing(item, hasDestroy) → Map
map/Map.js 2468
移除Thing对象
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
item |
BaseThing |
需要移除的Thing对象 |
|
hasDestroy |
boolean |
false
|
可选
是否释放 |
返回值:
当前对象本身,可以链式调用
执行旋转地球动画
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
setBasemapsOptions(arr, reload) → Array.<BaseLayer>
map/Map.js 1596
重新设置basemps底图图层,对options.basemaps重新赋值
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
arr |
Array.<Map.basemapOptions> |
底图图层配置 |
|
reload |
boolean |
true
|
可选
是否重新构造 |
返回值:
图层数组
将相机本身定位至指定位置
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cameraView |
object |
飞行参数
|
|||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
定位到多个相机视角位置,按数组顺序播放
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
arr |
Array.<object> |
视角参数数组,每个对象包含:
|
|||||||||||||||||||||||||||||||||||||||||||||
options |
object |
{}
|
可选
参数对象:
|
返回值:
无
设置鼠标的默认状态样式
参数名称 | 类型 | 描述信息 |
---|---|---|
val |
string |
可选
cursor样式 |
返回值:
无
设置相机heading值,保持地图中心位置不变。
参数名称 | 类型 | 描述信息 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
heading |
number |
方向角度值, 0-360 |
|||||||||||||||
options |
object |
可选
具有以下属性的对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
设置当前key对应语言的文本内容。
参数名称 | 类型 | 描述信息 |
---|---|---|
key |
string | object |
文本key ,如果是object时更新对应的多个键值对 |
text |
string |
文本内容 |
返回值:
setLayersOptions(arr, funOptions) → Array.<BaseLayer>
map/Map.js 1668
重新设置layers图层,对options.layers重新赋值
参数名称 | 类型 | 描述信息 | ||||||
---|---|---|---|---|---|---|---|---|
arr |
Array.<Map.layerOptions> |
可以叠加显示的图层配置 |
||||||
funOptions |
object |
可选
方法参数
|
返回值:
图层数组
setOptions(newOptions, funOptions) → Map
map/Map.js 892
设置Map所有参数构造参数
参数名称 | 类型 | 描述信息 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
newOptions |
object |
新的构造参数 |
||||||||||||
funOptions |
object |
可选
方法参数
|
返回值:
当前对象本身,可以链式调用
设置相机pitch值,保持地图中心位置不变。
参数名称 | 类型 | 描述信息 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pitch |
number |
俯仰角度值, -90至90 |
|||||||||||||||
options |
object |
可选
具有以下属性的对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
设置鼠标操作限定的Pitch范围
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
max |
number |
最大值(角度值) |
|
min |
number |
-90
|
可选
最小值(角度值) |
返回值:
无
setSceneOptions(options, funOptions) → Map
map/Map.js 1045
设置Scene场景参数
参数名称 | 类型 | 描述信息 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
options |
Map.sceneOptions |
参数 |
||||||||
funOptions |
object |
可选
方法参数
|
返回值:
当前对象本身,可以链式调用
获取地图的当前实时状态对应的参数
参数名称 | 类型 | 描述信息 | ||||||
---|---|---|---|---|---|---|---|---|
funOptions |
object |
可选
方法参数
|
返回值:
地图的配置参数
unbindContextMenu() → Map
map/Map.js 3744
解除绑定的右键菜单
返回值:
当前对象本身,可以链式调用
放大地图
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
relativeAmount |
number |
2
|
可选
相对量 |
mandatory |
boolean |
可选
是否强制更新,忽略screenSpaceCameraController的enableInputs/enableZoom限制 |
返回值:
是否有移动位置
缩小地图
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
relativeAmount |
number |
2
|
可选
相对量 |
mandatory |
boolean |
可选
是否强制更新,忽略screenSpaceCameraController的enableInputs/enableZoom限制 |
返回值:
是否有移动位置
定义的类型
底图图层配置
属性:
属性名称 | 类型 | 可选 | 描述信息 |
---|---|---|---|
type |
string | LayerType | 图层类型 |
|
多个参数 |
* |
<可选> |
每种不同type都有自己的不同属性,具体参考 |
参考:
添加到地图的控件 参数
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
homeButton |
boolean | object |
<可选> |
false | 视角复位按钮,是否显示, object时 对应 |
|||||||||||||||
zoom |
object |
<可选> |
放大缩小按钮 , 对应 |
||||||||||||||||
sceneModePicker |
boolean | object |
<可选> |
false | 二三维切换按钮,是否显示二维、三维、2.5D视图切换按钮, object时 对应 |
|||||||||||||||
projectionPicker |
boolean | object |
<可选> |
false | 投影切换按钮, 是否显示用于在透视和正投影之间进行切换按钮, object时 对应 |
|||||||||||||||
fullscreenButton |
boolean | object |
<可选> |
false | 全屏按钮,是否显示, object时 对应 |
|||||||||||||||
fullscreenElement |
Element | string | object |
<可选> |
document.body | 当按下全屏按钮时,要置于全屏模式的元素或id,也可以定义在fullscreenButton中,比如 fullscreenButton: { fullscreenElement: "mars3dContainer" } |
|||||||||||||||
vrButton |
boolean | object |
<可选> |
false | VR效果按钮,是否显示, object时 对应 |
|||||||||||||||
geocoder |
boolean | Array.<Cesium.GeocoderService> | object |
<可选> |
false | 是否显示 地名查找按钮 控件,是Cesium原生控件, object时 对应 |
|||||||||||||||
navigationHelpButton |
boolean | object |
<可选> |
false | 帮助按钮,是否显示, object时 对应 |
|||||||||||||||
navigationInstructionsInitiallyVisible |
boolean | object |
<可选> |
true | 帮助按钮 在用户明确单击按钮之前是否自动显示 |
|||||||||||||||
baseLayerPicker |
boolean | object |
<可选> |
false | 是否显示 底图切换 按钮,是Cesium原生控件, object时 对应 |
|||||||||||||||
imageryProviderViewModels |
Array.<Cesium.ProviderViewModel> |
<可选> |
baseLayerPicker底图切换面板中,用于图像的ProviderViewModel实例数组,默认自动根据basemaps数组生成。 |
||||||||||||||||
selectedImageryProviderViewModel |
Cesium.ProviderViewModel |
<可选> |
baseLayerPicker底图切换面板中,如果没有提供当前基本图像层的视图模型,则使用第一个可用的图像层。默认为show:true的basemaps图层 |
||||||||||||||||
terrainProviderViewModels |
Array.<Cesium.ProviderViewModel> |
<可选> |
baseLayerPicker底图切换面板中,用于地形的ProviderViewModel实例数组。默认自动使用terrain配置+无地形。 |
||||||||||||||||
selectedTerrainProviderViewModel |
Cesium.ProviderViewModel |
<可选> |
baseLayerPicker底图切换面板中,如果没有提供当前基础地形层的视图模型,则使用第一个可用的地形层。 |
||||||||||||||||
compass |
object |
<可选> |
导航球, 对应 |
||||||||||||||||
locationBar |
object |
<可选> |
状态栏, 对应 Properties 属性
|
||||||||||||||||
distanceLegend |
object |
<可选> |
比例尺, 对应 |
||||||||||||||||
clockAnimate |
object |
<可选> |
时钟控制, 对应 |
||||||||||||||||
animation |
boolean |
<可选> |
true | 时钟仪表控制(Cesium原生) |
|||||||||||||||
timeline |
boolean |
<可选> |
true | 时间线, 是否创建下侧时间线控件面板 |
|||||||||||||||
overviewMap |
object |
<可选> |
鹰眼地图, 对应 |
||||||||||||||||
mapSplit |
object |
<可选> |
卷帘对比, 对应 |
||||||||||||||||
keyboardRoam |
object |
<可选> |
键盘漫游, 对应 |
||||||||||||||||
subtitles |
object |
<可选> |
字幕, 对应 |
||||||||||||||||
mouseDownView |
boolean |
<可选> |
鼠标滚轮缩放美化样式(指示图标), 对应 |
||||||||||||||||
infoBox |
boolean |
<可选> |
true | 信息面板,是否显示点击要素之后显示的信息,是Cesium原生控件 |
|||||||||||||||
selectionIndicator |
boolean |
<可选> |
true | 选中框,是否显示选择模型时的绿色框,是Cesium原生控件 |
|||||||||||||||
showRenderLoopErrors |
boolean |
<可选> |
true | 是否显示WebGL渲染错误弹窗,如果正式部署系统中可以关闭,有错误时看F12控制台排查问题即可。 |
|||||||||||||||
contextmenu |
object |
<可选> |
内置 右键菜单 控制参数, 对应 Properties 属性
|
||||||||||||||||
popup |
object |
<可选> |
内置 Popup 控制参数 Properties 属性
|
||||||||||||||||
tooltip |
object |
<可选> |
内置 Tooltip 控制参数 Properties 属性
|
参考:
添加到地图的特效 参数
属性:
属性名称 | 类型 | 可选 | 描述信息 |
---|---|---|---|
bloom |
object |
<可选> |
泛光,对应 |
brightness |
object |
<可选> |
亮度,对应 |
rain |
object |
<可选> |
雨天气,对应 |
snow |
object |
<可选> |
雪天气 ,对应 |
snowCover |
object |
<可选> |
地面积雪,对应 |
fog |
object |
<可选> |
雾天气,对应 |
depthOfField |
object |
<可选> |
景深,对应 |
mosaic |
object |
<可选> |
马赛克,对应 |
nightVision |
object |
<可选> |
夜视,对应 |
blackAndWhite |
object |
<可选> |
黑白,对应 |
outline |
object |
<可选> |
对象轮廓描边,对应 |
bloomTarget |
object |
<可选> |
对象泛光,对应 |
colorCorrection |
string |
<可选> |
颜色校正 特效,对应类为: |
参考:
Map支持的EventType
事件类型
属性:
属性名称 | 类型 | 描述信息 |
---|---|---|
load |
string | 地图初始化完成事件(地形、所有图层完成初始化) |
addLayer |
string | 添加图层 |
removeLayer |
string | 移除图层 |
terrainChange |
string | 地形变化 |
tileLoadProgress |
string | 地图中瓦片加载进度变化 |
cameraMoveStart |
string | 相机开启移动前 场景事件 |
cameraMoveEnd |
string | 相机移动完成后 场景事件 |
cameraChanged |
string | 相机位置完成 场景事件 |
preUpdate |
string | 场景更新前 场景事件 |
postUpdate |
string | 场景更新后 场景事件 |
preRender |
string | 场景渲染前 场景事件 |
postRender |
string | 场景渲染后 场景事件 |
morphStart |
string | 场景模式(2D/3D/哥伦布)变换前 场景事件 |
morphComplete |
string | 完成场景模式(2D/3D/哥伦布)变换 场景事件 |
clockTick |
string | 时钟跳动 场景事件 |
renderError |
string | 场景渲染失败(需要刷新页面) |
click |
string | 左键单击 鼠标事件 |
clickGraphic |
string | 左键单击到矢量或模型数据时 鼠标事件 |
clickTileGraphic |
string | 左键单击到wms或arcgis瓦片服务的对应矢量数据时 |
clickMap |
string | 左键单击地图空白(未单击到矢量或模型数据)时 鼠标事件 |
dblClick |
string | 左键双击 鼠标事件 |
leftDown |
string | 左键鼠标按下 鼠标事件 |
leftUp |
string | 左键鼠标按下后释放 鼠标事件 |
mouseMove |
string | 鼠标移动 鼠标事件 |
mouseMoveTarget |
string | 鼠标移动(拾取目标,并延迟处理) 鼠标事件 [标绘、测量等功能会禁用该事件] |
wheel |
string | 鼠标滚轮滚动 鼠标事件 |
rightClick |
string | 右键单击 鼠标事件 |
rightDown |
string | 右键鼠标按下 鼠标事件 |
rightUp |
string | 右键鼠标按下后释放 鼠标事件 |
middleClick |
string | 中键单击 鼠标事件 |
middleDown |
string | 中键鼠标按下 鼠标事件 |
middleUp |
string | 中键鼠标按下后释放 鼠标事件 |
pinchStart |
string | 在触摸屏上两指缩放开始 鼠标事件 |
pinchEnd |
string | 在触摸屏上两指缩放结束 鼠标事件 |
pinchMove |
string | 在触摸屏上两指移动 鼠标事件 |
mouseDown |
string | 鼠标按下 [左中右3键都触发] 鼠标事件 |
mouseUp |
string | 鼠标按下后释放 [左中右3键都触发] 鼠标事件 |
mouseOver |
string | 鼠标移入 鼠标事件 |
mouseOut |
string | 鼠标移出 鼠标事件 |
keydown |
string | 按键按下 键盘事件 |
keyup |
string | 按键按下后释放 键盘事件 |
popupOpen |
string | popup弹窗打开后 |
popupClose |
string | popup弹窗关闭 |
tooltipOpen |
string | tooltip弹窗打开后 |
tooltipClose |
string | tooltip弹窗关闭 |
contextMenuOpen |
string | 右键菜单 打开后 |
contextMenuClose |
string | 右键菜单 关闭 |
contextMenuClick |
string | 右键菜单 单击某一项后 |
使用示例:
//绑定监听事件
map.on(mars3d.EventType.click, function (event) {
console.log('单击了地图对象', event)
})
参考:
可以叠加显示的图层配置,
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
---|---|---|---|---|
type |
string | LayerType | 图层类型 |
||
id |
string | number |
<可选> |
图层id标识 |
|
pid |
string | number |
<可选> |
-1 | 图层父级的id,一般图层管理中使用 |
name |
string |
<可选> |
'' | 图层名称 |
show |
boolean |
<可选> |
true | 图层是否显示 |
center |
object |
<可选> |
图层自定义定位视角,默认根据数据情况自动定位。 |
|
popup |
object |
<可选> |
当图层支持popup弹窗时,绑定的值 |
|
popupOptions |
Popup.StyleOptions |
<可选> |
popup弹窗时的配置参数 |
|
tooltip |
object |
<可选> |
当图层支持tooltip弹窗时,绑定的值 |
|
tooltipOptions |
Tooltip.StyleOptions |
<可选> |
tooltip弹窗时的配置参数 |
|
多个参数 |
* |
<可选> |
每种type都有自己的不同属性,具体参考 |
参考:
通过参数方式来构造地图后就直接执行调用Map的相关属性、方法,便于序列化
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
chinaCRS |
ChinaCRS | string |
<可选> |
"WGS84" | 标识当前地图的国内坐标系(用于部分图层内对比判断来自动纠偏或加偏),只能初始化传入 |
|||||||||||||||||||||||||||||||||||
lang |
object | Lang |
<可选> |
使用的语言文本键值对对象,可传入外部自定义的任意语言文本。 |
||||||||||||||||||||||||||||||||||||
templateValues |
object |
<可选> |
图层中统一的url模版,比如可以将服务url前缀统一使用模板,方便修改或动态配置 |
||||||||||||||||||||||||||||||||||||
token |
Map.tokenOptions |
<可选> |
覆盖SDK内的 |
||||||||||||||||||||||||||||||||||||
fixedLight |
boolean |
<可选> |
false | 是否固定光照,true:可避免gltf、3dtiles模型随时间存在亮度不一致。 |
|||||||||||||||||||||||||||||||||||
onlyPickModelPosition |
boolean |
<可选> |
false | 是否只拾取模型上的点 |
|||||||||||||||||||||||||||||||||||
onlyPickTerrainPosition |
boolean |
<可选> |
false | 是否只拾取地形上的点,忽略模型和矢量数据 |
|||||||||||||||||||||||||||||||||||
onlyVertexPosition |
boolean |
<可选> |
false | 是否开启顶点吸附功能,只拾取顶点上的点 |
|||||||||||||||||||||||||||||||||||
cursor |
string |
<可选> |
"" | 设置鼠标的默认状态cursor样式, 同 |
|||||||||||||||||||||||||||||||||||
changeMouseModel |
object |
<可选> |
false | 设置鼠标操作习惯方式。 false:中键旋转,右键拉伸远近(默认);true:可以设置为右键旋转,中键拉伸远近。, 同 |
|||||||||||||||||||||||||||||||||||
setPitchRange |
object |
<可选> |
设置鼠标操作限定的Pitch范围, 同 Properties 属性
|
||||||||||||||||||||||||||||||||||||
setCameraViewList |
object |
<可选> |
定位到多个相机视角位置,按数组顺序播放, 同 Properties 属性
|
||||||||||||||||||||||||||||||||||||
openFlyAnimation |
object |
<可选> |
执行开场动画,动画播放地球飞行定位到指定区域(1.旋转地球+2.降低高度+3.指定视角), 同 Properties 属性
|
||||||||||||||||||||||||||||||||||||
rotateAnimation |
object |
<可选> |
执行旋转地球动画, 同 Properties 属性
|
||||||||||||||||||||||||||||||||||||
availabilityEnabled |
boolean |
<可选> |
true | 是否全局启用availability和Task, 如果在编辑场景不想availability、Task生效,仅播放时生效时,可以先手动关闭下,播放时再开启 |
鼠标操作相关配置 参数
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
---|---|---|---|---|
enabledMoveTarget |
boolean |
<可选> |
true | 是否开启鼠标移动事件的拾取矢量数据 |
moveDelay |
number |
<可选> |
30 | 鼠标移动事件的延迟毫秒数 |
pickWidth |
number |
<可选> |
4 | 拾取时所选矩形的宽度,单位:像素 |
pickHeight |
number |
<可选> |
4 | 拾取时所选矩形的高度,单位:像素 |
pickLimit |
number |
<可选> |
9 | 在允许allowDrillPick穿透拾取时,限制拾取的对象个数。 |
参考:
场景参数
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
center |
object |
<可选> |
默认相机视角 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extent |
object |
<可选> |
矩形范围 相机视角,与center二选一 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeDblClick |
boolean |
<可选> |
false | 是否移除Cesium默认的双击事件 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ionToken |
string |
<可选> |
Cesium Ion服务的 Token令牌 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resolutionScale |
number |
<可选> |
1.0 | 获取或设置渲染分辨率的缩放比例。小于1.0的值可以改善性能不佳的设备上的性能,而值大于1.0则将以更高的速度呈现分辨率,然后缩小比例,从而提高视觉保真度。例如,如果窗口小部件的尺寸为640x480,则将此值设置为0.5将导致场景以320x240渲染,然后在设置时按比例放大设置为2.0将导致场景以1280x960渲染,然后按比例缩小。 以下是Cesium.Scene对象相关参数 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backgroundColor |
string |
<可选> |
背景色 ,css颜色值 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backgroundImage |
string |
<可选> |
背景图片 ,css属性值(对应的是 map.container.style.backgroundImage 值) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backgroundType |
boolean |
<可选> |
当背景色、背景图片、天空盒3个值均存在时,已哪个优先,可选值:color、image、skybox |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
showSkyBox |
boolean |
<可选> |
是否显示默认天空盒,如修改对象可以用 map.scene.skyBox |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skyBox |
Cesium.SkyBox | GroundSkyBox | MultipleSkyBox | object |
<可选> |
天空盒对象,不使用默认天空盒时设置。 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
showSun |
boolean |
<可选> |
是否显示太阳,如修改对象可以用 map.scene.sun |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
showMoon |
boolean |
<可选> |
是否显示月亮,如修改对象可以用 map.scene.moon |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
showSkyAtmosphere |
boolean |
<可选> |
是否显示地球大气层外光圈,如修改对象可以用 map.scene.skyAtmosphere |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fog |
boolean |
<可选> |
是否启用雾化效果,如修改对象可以用 map.scene.fog |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
atmosphere |
object |
<可选> |
3D贴图和模型用于渲染天空大气、地面大气和雾的常见大气设置。 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fxaa |
boolean |
<可选> |
是否开启快速抗锯齿 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
highDynamicRange |
boolean |
<可选> |
是否关闭高动态范围渲染(不关闭时地图会变暗) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logarithmicDepthBuffer |
boolean |
<可选> |
true | 是否使用对数深度缓冲区。启用此选项将允许在多截锥体中减少截锥体,提高性能。此属性依赖于所支持的fragmentDepth。 [当贴地面出现阴影体或遮挡时设置为false] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
verticalExaggeration |
number |
<可选> |
1.0 | 地形夸张倍率,用于放大地形的标量。请注意,地形夸张不会修改其他相对于椭球的图元。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
verticalExaggerationRelativeHeight |
number |
<可选> |
0.0 | 地形被夸大的高度。默认为0.0(相对于椭球表面缩放)。高于此高度的地形将向上缩放,低于此高度的地形将向下缩放。请注意,地形夸大不会修改任何其他图元,因为它们是相对于椭球体定位的。 以下是Cesium.Viewer所支持的options【控件相关的写在另外的control属性中】 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sceneMode |
Cesium.SceneMode |
<可选> |
Cesium.SceneMode.SCENE3D | 初始场景模式。可以设置进入场景后初始是2D、2.5D、3D 模式。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scene3DOnly |
boolean |
<可选> |
false | 为 true 时,每个几何实例将仅以3D渲染以节省GPU内存。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mapProjection |
Cesium.MapProjection | CRS |
<可选> |
mars3d.CRS.EPSG4326 | 在二维模式下时,地图的呈现坐标系,默认为EPSG4326坐标系,如果需要EPSG3857墨卡托坐标系展示,传 new Cesium.WebMercatorProjection() 即可 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mapMode2D |
Cesium.MapMode2D |
<可选> |
Cesium.MapMode2D.INFINITE_SCROLL | 在二维模式下时,地图是可旋转的还是可以在水平方向无限滚动。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouldAnimate |
boolean |
<可选> |
true | 是否开启时钟动画 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shadows |
boolean |
<可选> |
false | 是否启用日照阴影 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useDefaultRenderLoop |
boolean |
<可选> |
true | 如果此小部件应控制渲染循环,则为true,否则为false。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetFrameRate |
number |
<可选> |
使用默认渲染循环时的目标帧速率。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useBrowserRecommendedResolution |
boolean |
<可选> |
true | 如果为true,则以浏览器建议的分辨率渲染,并忽略 window.devicePixelRatio 。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
automaticallyTrackDataSourceClocks |
boolean |
<可选> |
true | 如果为true,则此小部件将自动跟踪新添加的数据源的时钟设置,并在数据源的时钟发生更改时进行更新。如果要独立配置时钟,请将其设置为false。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextOptions |
object |
<可选> |
{} | WebGL创建属性 传递给 Cesium.Scene 的 options 。 Properties 属性
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderIndependentTranslucency |
boolean |
<可选> |
true | 如果为true,并且配置支持它,则使用顺序无关的半透明性。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terrainShadows |
Cesium.ShadowMode |
<可选> |
Cesium.ShadowMode.RECEIVE_ONLY | 确定地形是否投射或接收来自光源的阴影。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestRenderMode |
boolean |
<可选> |
false | 是否显式渲染,如果为真,渲染帧只会在需要时发生,这是由场景中的变化决定的。启用可以减少你的应用程序的CPU/GPU使用量,并且在移动设备上使用更少的电池,但是需要使用 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximumRenderTimeChange |
number |
<可选> |
0.0 | 如果requestRenderMode为true,这个值定义了在请求渲染之前允许的模拟时间的最大变化。参见 Improving Performance with Explicit Rendering. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blurActiveElementOnCanvasFocus |
boolean |
<可选> |
true | 控制当用户点击或悬停在Viewer的画布上时,是否将焦点从当前DOM元素中移出。如果设置为true,则会自动将焦点从当前的DOM元素中移开,以便Viewer可以接收键盘事件和鼠标事件。这个属性对于在Web应用程序中使用Viewer时很有用,因为用户可能需要与其他DOM元素进行交互,例如输入文本或单击按钮。如果不把焦点从当前元素移开,用户将不能使用键盘或鼠标来与Viewer进行交互。需要注意的是,默认情况下,此属性被设置为true,因此当用户点击或悬停在Viewer的画布上时,焦点将会自动从当前的DOM元素中移开。如果您想要保留焦点,请将该属性设置为false。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
depthPlaneEllipsoidOffset |
number |
<可选> |
0.0 | 可以指定深度测试平面相对于椭球体表面的偏移量。这个属性通常用于解决多个三维模型重叠时出现的Z-fighting问题,即两个或多个物体处于同一深度位置,导致图像闪烁或不清晰。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msaaSamples |
number |
<可选> |
4 | 如果提供,该值控制多样本抗混叠的速率。典型的多采样率是每像素2、4,有时是8个采样。更高的MSAA采样率可能会影响性能,以换取更好的视觉质量。这个值只适用于支持多样本渲染目标的WebGL2上下文。 以下是Cesium.Globe对象相关参数 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
globe |
object |
<可选> |
globe地球相关参数 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cameraController |
object |
<可选> |
相机操作相关参数 Properties 属性
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clock |
object |
<可选> |
时钟相关参数 Properties 属性
|
参考:
地形服务配置
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
---|---|---|---|---|
type |
string | TerrainType |
<可选> |
"xyz" | 地形类型 |
url |
string | Cesium.Resource | 地形服务地址 |
||
show |
boolean |
<可选> |
false | 是否启用显示地形 |
requestVertexNormals |
boolean |
<可选> |
false | 是否应该从服务器请求额外的光照信息,如果可用,以每个顶点法线的形式。 |
requestWaterMask |
boolean |
<可选> |
false | 是否应该向服务器请求每个瓦的水掩膜(如果有的话)。 |
requestMetadata |
boolean |
<可选> |
true | 是否应该从服务器请求每个块元数据(如果可用)。 |
clip |
boolean |
<可选> |
false | 是否默认启用地形开挖,如果后续打开,缓存数据不会裁剪 |
flat |
boolean |
<可选> |
false | 是否默认启用地形压平 |
uplift |
boolean |
<可选> |
false | 是否默认启用地形抬升 |
flood |
boolean |
<可选> |
false | 是否默认启用地形区域材质(淹没,等高线) |
参考:
添加到地图的 Thing对象(如分析、管理类等) 参数 【提示:仅与地图一对一的类型,非所有Thing类】
属性:
属性名称 | 类型 | 可选 | 描述信息 |
---|---|---|---|
shadows |
string |
<可选> |
日照分析, 对应类为: |
sightline |
string |
<可选> |
通视分析, 对应类为: |
skyline |
string |
<可选> |
天际线描边, 对应类为: |
cameraHistory |
string |
<可选> |
相机视角记录及处理类, 对应类为: |
rotateOut |
string |
<可选> |
相机位置不动,对外四周旋转, 对应类为: |
rotatePoint |
string |
<可选> |
相机绕 固定中心点 旋转, 对应类为: |
firstPersonRoam |
string |
<可选> |
第一人称贴地漫游, 对应类为: |
streetView |
string |
<可选> |
街景视角模式控制, 对应类为: |
terrainFlat |
string |
<可选> |
地形压平, 对应类为: |
terrainClip |
string |
<可选> |
地形开挖, 对应类为: |
terrainPlanClip |
string |
<可选> |
地形开挖(基于clippingPlanes), 对应类为: |
terrainUplift |
string |
<可选> |
地形抬升, 对应类为: |
floodByMaterial |
string |
<可选> |
淹没分析(基于地球材质), 对应类为: |
floodByGraphic |
string |
<可选> |
淹没分析(基于polygon矢量面抬高), 对应类为: |
underground |
string |
<可选> |
地下模式, 对应类为: |
contourLine |
string |
<可选> |
等高线, 对应类为: |
slope |
string |
<可选> |
坡度坡向分析, 对应类为: |
limitHeight |
string |
<可选> |
模型限高分析, 对应类为: |
task |
string |
<可选> |
时序任务执行管理器, 对应类为: |
参考:
覆盖SDK内的Token
所有第3方Token默认值
属性:
属性名称 | 类型 | 可选 | 描述信息 |
---|---|---|---|
tianditu |
string | Array.<string> |
<可选> |
天地图 |
gaode |
string | Array.<string> |
<可选> |
高德 |
baidu |
string | Array.<string> |
<可选> |
百度 |
ion |
string |
<可选> |
Ion服务 |
mapbox |
string |
<可选> |
mapbox地图 |
bing |
string |
<可选> |
微软Bing地图 |