DIV点
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
参数对象,包括以下:
|
参考:
继承
成员(属性)
是否允许鼠标穿透拾取
属性信息
- 继承自:
指定时间范围内显示该对象 [提示:仅部分子类实现,非所有对象都支持]
- 继承自:
使用示例:
// 普通传值方式,多个【建议】
graphic.availability = [
{ start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false },
{ start: "2017-08-25 09:00:00", duration: 10 } //支持不配置stop,直接配置duration秒数时长
]
// 也支持相对时间的 秒数 传值(相对于map.clock.startTime)
graphic.availability = [
{ start: 0, stop: 10, isStartIncluded: true, isStopIncluded: false },
{ start:30, duration: 10 } //支持不配置stop,直接配置duration秒数时长
]
// 普通传值方式,单个
graphic.availability = { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false }
// cesium原生写法, 多个
graphic.availability = new Cesium.TimeIntervalCollection([
new Cesium.TimeInterval({
start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
isStartIncluded: true,
isStopIncluded: false
}),
])
// cesium原生写法,单个
graphic.availability = new Cesium.TimeInterval({
start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
isStartIncluded: true, //等于start时,是否显示
isStopIncluded: false //等于stop时,是否显示
})
中心点坐标(笛卡尔坐标)
- 继承自:
readonly centerPoint : LngLatPoint
graphic/BaseGraphic.js 511
中心点坐标
是否贴地
对应的DOM元素
对应的DOM元素的id
位置坐标(数组对象),示例[113.123456,31.123456,30.1]
readonly czmObject : Cesium.Entity|Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/BaseGraphic.js 209
矢量数据对应的 Cesium内部对象 (不同子类中实现)
是否打开深度判断(true时判断是否在球背面)
readonly EditClass : EditDivGraphic
graphic/div/DivGraphic.js 300
编辑处理类
当前地图的ellipsoid
设置事件的启用和禁用状态
从参考系到所提供椭球体的固定参考系的4x4变换矩阵
是否 后端动态属性
是否 后端动态坐标
是否支持聚合
是否可以编辑
- 继承自:
是否可以调整透明度
设置或获取当前对象对应的Html
对象的id标识
- 继承自:
是否已添加到图层
- 继承自:
是否被聚合
是否已经销毁了
是否正在编辑状态
是否为点状数据 true: 点状,有position坐标 false:线面,有positions坐标
- 继承自:
是否Mars3D内部的私有对象,如标绘拖拽点等
名称
- 继承自:
当前类的构造参数
- 继承自:
父容器DOM对象
父容器DOM对象的ID
readonly point : LngLatPoint
graphic/div/DivGraphic.js 174
位置坐标 (笛卡尔坐标)
DIV是否可以鼠标交互,为false时可以穿透操作及缩放地图,但无法进行鼠标交互及触发相关事件。
position : Cesium.Cartesian3|LngLatPoint
graphic/div/DivGraphic.js 126
位置坐标 (笛卡尔坐标), 赋值时可以传入LatLngPoint对象
当前实时位置坐标(笛卡尔坐标)
显示隐藏状态(属性值)
- 继承自:
readonly state : State
graphic/BaseGraphic.js 168
当前对象的状态
- 继承自:
样式信息
- 继承自:
公共部分外框部分html内容,需要加2处: (1)用于填充html的地方写上{content}标识; (2)关闭按钮加class样式:closeButton。 传空字符串或false时,不用内置模版。
是否显示测试点,可以进行用于比较测试div的位置,方便调试CSS。
矢量数据类型
- 继承自:
方法
添加指定的className的calss样式
参数名称 | 类型 | 描述信息 |
---|---|---|
className |
string |
class样式名称 |
isParent |
boolean |
可选
多个子节点时,是否在根节点添加 |
返回值:
无
addDynamicPosition(point, currTime) → DivGraphic
graphic/div/DivGraphic.js 1045
设置并添加动画轨迹位置,按“指定时间”运动到达“指定位置”。
参数名称 | 类型 | 描述信息 |
---|---|---|
point |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
指定位置坐标 |
currTime |
Cesium.JulianDate | Date | string | number |
可选
指定时间, 默认为当前时间。当为String时,可以传入'2021-01-01 12:13:00'; 当为Number时,可以传入当前时间延迟的秒数。 |
返回值:
当前对象本身,可以链式调用
addEventParent(obj) → BaseClass
core/BaseClass.js 307
添加抛出事件到父类,它将接收传播的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
addTo(layer) → BaseGraphic|*
graphic/BaseGraphic.js 555
添加到图层上,同 layer.addGraphic
参数名称 | 类型 | 描述信息 |
---|---|---|
layer |
GraphicLayer |
图层对象 |
返回值:
当前对象本身,可以链式调用
- 继承自:
异步计算更新坐标高度进行贴地(或贴模型),内部自动调用PointUtil#getSurfaceHeight
方法处理。
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
异步计算完成的Promise
bindContextMenu(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1562
绑定右键菜单
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content |
Array.<object> |
右键菜单配置数组,数组中每一项包括:
|
|||||||||||||||||||
options |
object |
{}
|
可选
控制参数
|
返回值:
当前对象本身,可以链式调用
- 继承自:
使用示例:
graphic.bindContextMenu([
{
text: '删除对象',
icon: 'fa fa-trash-o',
callback: function (e) {
let graphic = e.graphic
if (graphic) {
graphic.remove()
}
},
},
])
绑定鼠标移入或单击后的 对象高亮
参数名称 | 类型 | 描述信息 | ||||||
---|---|---|---|---|---|---|---|---|
options |
object |
高亮的样式,具体见各
|
返回值:
无
bindPickId(item) → BaseGraphic|*
graphic/BaseGraphic.js 580
绑定Cesium内部对象进行相关管理。
参数名称 | 类型 | 描述信息 |
---|---|---|
item |
* |
Cesium对象 |
返回值:
当前对象本身,可以链式调用
bindPopup(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1343
绑定鼠标单击对象后的弹窗。
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
string | function |
弹窗内容html字符串,或者回调方法。 |
options |
Popup.StyleOptions |
可选
控制参数 |
返回值:
当前对象本身,可以链式调用
bindTooltip(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1441
绑定鼠标移入的弹窗
参数名称 | 类型 | 描述信息 |
---|---|---|
content |
string | function |
弹窗内容html字符串,或者回调方法。 |
options |
Tooltip.StyleOptions |
可选
控制参数 |
返回值:
当前对象本身,可以链式调用
清除 后端动态坐标
返回值:
closeContextMenu() → BaseGraphic|*
graphic/BaseGraphic.js 1610
关闭右键菜单
返回值:
当前对象本身,可以链式调用
清除已选中的高亮,原有style的配置项需要与highlightStyle配置有一一对应关系,否则无法清除
返回值:
无
closePopup() → BaseGraphic|*
graphic/BaseGraphic.js 1396
关闭弹窗
返回值:
当前对象本身,可以链式调用
closeSmallTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1639
关闭小提示窗
返回值:
当前对象本身,可以链式调用
closeTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1490
关闭弹窗
返回值:
当前对象本身,可以链式调用
销毁当前对象
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
noDel |
boolean |
false
|
可选
false:会自动delete释放所有属性,true:不delete绑定的变量 |
返回值:
无
- 继承自:
启用或禁用popup、tooltip、contextmenu内部控件, 主要用于标绘时来关闭避免交互冲突。
参数名称 | 类型 | 描述信息 |
---|---|---|
value |
boolean |
是否启用 |
返回值:
无
完成绘制和编辑,如有未完成的绘制会自动完成。 在移动端需要调用此方法来类似PC端双击结束。
返回值:
无
fire(type, data, propagate) → BaseClass
core/BaseClass.js 203
触发指定类型的事件。
参数名称 | 类型 | 描述信息 |
---|---|---|
type |
EventType | string |
事件类型 |
data |
object |
可选
传输的数据或对象,可在事件回调方法中event对象中获取进行使用 |
propagate |
BaseClass |
可选
将事件传播给父类 (用addEventParent设置) |
返回值:
当前对象本身,可以链式调用
- 继承自:
飞行定位至 数据所在的视角
参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
- 继承自:
获取后端动态属性,当存在attr是动态属性配置时可用【attr.type === "ajax" && attr.url】
返回值:
实时获取当前的动态属性值
获取指定时间下的时序对应的 显示隐藏 状态
参数名称 | 类型 | 描述信息 |
---|---|---|
time |
Cesium.JulianDate |
指定时间 |
返回值:
显示隐藏 状态
获取绑定的右键菜单数组
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasLayer |
boolean |
true
|
可选
是获取图层上的右键菜单 |
返回值:
右键菜单数组
位置坐标(数组对象),示例[113.123456,31.123456,30.1]
参数名称 | 类型 | 描述信息 |
---|---|---|
noAlt |
boolean |
true时不导出高度值 |
返回值:
位置坐标(数组对象)
获取数据的最大高度
返回值:
高度
getPopup() → Popup
graphic/BaseGraphic.js 1407
获取当前对象打开的Popup对象
返回值:
当前对象打开的Popup对象
- 继承自:
获取当前对象真实实际的显示状态
参数名称 | 类型 | 描述信息 |
---|---|---|
time |
Cesium.JulianDate |
当前时间 |
返回值:
真实的实时显示状态,当时序范围外,被聚合时返回的是false
获取数据的矩形边界
参数名称 | 类型 | 描述信息 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
options |
boolean |
可选
控制参数
|
返回值:
isFormat:true时,返回格式化对象,isFormat:false时返回Cesium.Rectangle对象
getTooltip() → Tooltip
graphic/BaseGraphic.js 1501
获取当前对象打开的Tooltip对象
返回值:
当前对象打开的Tooltip对象
是否有绑定的右键菜单
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasLayer |
boolean |
true
|
可选
是否判断图层上的右键菜单 |
返回值:
是否有绑定
是否绑定了抛出事件到指定父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
是否绑定了抛出事件
是否存在Popup绑定
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasLayer |
boolean |
true
|
可选
是否判断图层上的Popup |
返回值:
是否存在Popup绑定
- 继承自:
是否绑定了tooltip
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasLayer |
boolean |
true
|
可选
是否判断图层上的tooltip |
返回值:
是否绑定
隐藏当前对象
返回值:
无
判断点坐标是否在球的背面 或当前视域屏幕内
参数名称 | 类型 | 描述信息 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
position |
Cesium.Cartesian3 |
可选
坐标 |
||||||||
options |
object |
可选
参数
|
返回值:
是否后端动态坐标
- 继承自:
是否有绑定指定的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
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) → BaseGraphic|*
graphic/BaseGraphic.js 1595
打开右键菜单
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
position |
Cesium.Cartesian3 |
this.center
|
可选
矢量对象 或 显示的位置 |
返回值:
当前对象本身,可以链式调用
高亮对象。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
highlightStyle |
object |
可选
高亮的样式,具体见各 |
|
closeLast |
boolean |
true
|
可选
是否清除地图上上一次的高亮对象 |
返回值:
无
openPopup(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1377
打开绑定的弹窗
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> | * |
this.center
|
可选
矢量对象 或 显示的位置 |
event |
object |
可选
用于抛出事件时的相关额外属性 |
返回值:
当前对象本身,可以链式调用
openSmallTooltip(position, message) → BaseGraphic|*
graphic/BaseGraphic.js 1627
显示小提示窗,一般用于鼠标操作的提示。
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
Cesium.Cartesian2 | Cesium.Cartesian3 |
显示的屏幕坐标位置 或 笛卡尔坐标位置 |
message |
* |
显示的内容 |
返回值:
当前对象本身,可以链式调用
openTooltip(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1473
打开绑定的tooltip弹窗
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
this.center
|
可选
显示的位置,默认为矢量对象所在点或中心点位置 |
event |
object |
可选
用于抛出事件时的相关额外属性 |
返回值:
当前对象本身,可以链式调用
重新渲染对象
返回值:
无
从图层上移除,同 layer.removeGraphic
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasDestroy |
boolean |
true
|
可选
是否调用destroy释放 |
返回值:
无
- 继承自:
移除指定的className的calss样式
参数名称 | 类型 | 描述信息 |
---|---|---|
className |
string |
class样式名称 |
isParent |
boolean |
可选
多个子节点时,是否在根节点移除 |
返回值:
无
removeEventParent(obj) → BaseClass
core/BaseClass.js 320
移除抛出事件到父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
设置后端动态坐标,当存在点状对象是动态属性配置时可用【position.type === "ajax" && position.url)】
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
BaseGraphic.AjaxPosition |
动态坐标配置 |
返回值:
是否后端动态坐标
设置整体透明度(globalAlpha值), 不是所有类型均支持,主要看数据类型和材质类型决定。 对象本身透明度请用 graphic.setStyle({ opacity: value })
参数名称 | 类型 | 描述信息 |
---|---|---|
value |
number |
透明度 |
返回值:
无
setOptions(options) → BaseGraphic|*
graphic/BaseGraphic.js 760
重新赋值参数,同构造方法参数一致。
参数名称 | 类型 | 描述信息 |
---|---|---|
options |
object |
参数,与类的构造方法参数相同 |
返回值:
当前对象本身,可以链式调用
setStyle(newStyle) → BaseGraphic|*
graphic/BaseGraphic.js 825
设置 样式信息 的钩子方法
参数名称 | 类型 | 描述信息 |
---|---|---|
newStyle |
object |
本次更新的部分样式信息,内部会合并属性 |
返回值:
当前对象本身,可以链式调用
- 继承自:
开始绘制创建矢量数据,绘制的数据会加载在layer图层。
参数名称 | 类型 | 描述信息 |
---|---|---|
layer |
GraphicLayer |
图层 |
返回值:
无
开始编辑对象
返回值:
无
停止绘制,如有未完成的绘制会自动删除
返回值:
无
停止编辑,释放正在编辑的对象。
返回值:
无
将矢量数据导出为GeoJSON格式规范对象。
参数名称 | 类型 | 描述信息 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数对象:
|
返回值:
GeoJSON格式规范对象
将矢量数据的坐标、样式及属性等信息导出为对象,可以用于存储。
返回值:
导出的坐标、样式及属性等信息
- 继承自:
unbindContextMenu(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1580
解除绑定的右键菜单
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡查找 |
返回值:
当前对象本身,可以链式调用
解绑鼠标移入或单击后的高亮处理
返回值:
无
unbindPopup(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1360
解除绑定的鼠标单击对象后的弹窗。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡往上级查找 |
返回值:
当前对象本身,可以链式调用
unbindTooltip(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1457
解除绑定的鼠标移入对象后的弹窗。
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡查找 |
返回值:
当前对象本身,可以链式调用
updateDivPosition() → DivGraphic
graphic/div/DivGraphic.js 758
更新刷新下DIV的位置,可以外部主动驱动来更新。
返回值:
当前对象本身,可以链式调用
定义的类型
DIV点 支持的样式信息
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
---|---|---|---|---|
html |
string | HTMLDivElement | function | Html文本 |
||
horizontalOrigin |
Cesium.HorizontalOrigin |
<可选> |
横向方向的定位 |
|
verticalOrigin |
Cesium.VerticalOrigin |
<可选> |
垂直方向的定位 |
|
offsetX |
number |
<可选> |
用于非规则div时,横向偏移的px像素值 |
|
offsetY |
number |
<可选> |
用于非规则div时,垂直方向偏移的px像素值 |
|
className |
string |
<可选> |
自定义的样式名 |
|
editClassName |
string |
<可选> |
"mars3d-divGraphic-edit" | 编辑状态下的的样式名 |
scaleByDistance |
boolean |
<可选> |
false | 是否按视距缩放 |
scaleByDistance_far |
number |
<可选> |
1000000 | 上限 |
scaleByDistance_farValue |
number |
<可选> |
0.1 | 比例值 |
scaleByDistance_near |
number |
<可选> |
1000 | 下限 |
scaleByDistance_nearValue |
number |
<可选> |
1 | 比例值 |
distanceDisplayCondition |
boolean |
<可选> |
false | 是否按视距显示 |
distanceDisplayCondition_far |
number |
<可选> |
Number.MAX_VALUE | 最大距离 |
distanceDisplayCondition_near |
number |
<可选> |
0 | 最小距离 |
clampToGround |
boolean |
<可选> |
false | 是否贴地 |
heightReference |
Cesium.HeightReference |
<可选> |
Cesium.HeightReference.NONE | 指定高度相对于什么的属性。 |
timeRender |
boolean |
<可选> |
是否实时刷新全部HTML,此时需要绑定html需传入回调方法。 |
|
template |
string |
<可选> |
公共外框部分html内容模版 |
|
templateEmptyStr |
string |
<可选> |
'' | html中如果存在模版时,空值时显示的内容 |
setHeight |
number | string |
<可选> |
指定坐标高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模版配置 |
|
addHeight |
number | string |
<可选> |
在现有坐标基础上增加的高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模版配置 |