Primitive图元 矢量对象 基类
参数名称 | 类型 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
中心点坐标
readonly czmObject : Cesium.Entity|Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/BaseGraphic.js 209
矢量数据对应的 Cesium内部对象 (不同子类中实现)
当前地图的ellipsoid
设置事件的启用和禁用状态
从参考系到所提供椭球体的固定参考系的4x4变换矩阵
返回实例可修改的属性。Cesium.GeometryInstance
使用示例:
var attributes = primitiveGraphic.geometryInstanceAttributes;
attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
readonly groundPrimitiveCollection : Cesium.PrimitiveCollection
graphic/primitive/BasePrimitive.js 89
当加载贴地primitive数据的内部Cesium容器
是否 后端动态属性
是否 后端动态坐标
是否支持聚合
是否可以编辑
- 继承自:
是否可以调整透明度
对象的id标识
- 继承自:
是否已添加到图层
- 继承自:
是否被聚合
是否已经销毁了
是否正在编辑状态,不是所有子类均支持编辑
是否为点状数据 true: 点状,有position坐标 false:线面,有positions坐标
- 继承自:
是否Mars3D内部的私有对象,如标绘拖拽点等
附加的label文本对象
名称
- 继承自:
平移指定偏移高度(相对于原始坐标值),【提示:仅部分子类支持,如 PolygonPrimitive
、RectanglePrimitive
、BoxPrimitive
、CylinderPrimitive
、EllipsoidPrimitive
、CorridorPrimitive
】
当前类的构造参数
- 继承自:
readonly primitive : Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/primitive/BasePrimitive.js 103
矢量数据对应的 Cesium内部对象
readonly primitiveCollection : Cesium.PrimitiveCollection|Cesium.LabelCollection|Cesium.BillboardCollection|Cesium.PointPrimitiveCollection|Cesium.CloudCollection
graphic/primitive/BasePrimitive.js 80
当加载primitive数据的内部Cesium容器
矢量数据对应的渲染是否完成
获取Primitive对象渲染完成的Promise承诺(仅部分支持,不支持对象会打印log)
显示隐藏状态(属性值)
- 继承自:
readonly state : State
graphic/BaseGraphic.js 168
当前对象的状态
- 继承自:
样式信息
- 继承自:
矢量数据类型
- 继承自:
对应材质的uniforms(当赋有材质时), 一个对象,它的属性被用来设置片段着色器shader。
对象属性值可以是常量或函数。这个函数将在每一帧后处理阶段执行之前被调用。
常量值也可以是图像的URI、数据URI,或者可以用作纹理的HTML元素,如HTMLImageElement或HTMLCanvasElement。
图层顺序,数字大的在上面。
只对 同类型 + 贴地(clampToGround: true) 的部分线面矢量对象间有效
方法
对象添加到图层前创建一些对象的钩子方法, 只会调用一次
返回值:
无
addEventParent(obj) → BaseClass
core/BaseClass.js 307
添加抛出事件到父类,它将接收传播的事件
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
addTo(layer) → BaseGraphic|*
graphic/BaseGraphic.js 555
添加到图层上,同 layer.addGraphic
参数名称 | 类型 | 描述信息 |
---|---|---|
layer |
GraphicLayer |
图层对象 |
返回值:
当前对象本身,可以链式调用
- 继承自:
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绑定的变量 |
返回值:
无
- 继承自:
启用或禁用所有内部控件(含tooltip、popup、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
|
可选
是获取图层上的右键菜单 |
返回值:
右键菜单数组
获取数据的最大高度
返回值:
高度
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 |
可选
用于抛出事件时的相关额外属性 |
返回值:
当前对象本身,可以链式调用
redraw(style) → BasePrimitive
graphic/primitive/BasePrimitive.js 855
重新渲染
参数名称 | 类型 | 描述信息 |
---|---|---|
style |
object |
可选
新的样式信息 |
返回值:
当前对象本身
从图层上移除,同 layer.removeGraphic
参数名称 | 类型 | 默认值 | 描述信息 |
---|---|---|---|
hasDestroy |
boolean |
true
|
可选
是否调用destroy释放 |
返回值:
无
- 继承自:
removeEventParent(obj) → BaseClass
core/BaseClass.js 320
移除抛出事件到父类
参数名称 | 类型 | 描述信息 |
---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
设置后端动态坐标,当存在点状对象是动态属性配置时可用【position.type === "ajax" && position.url)】
参数名称 | 类型 | 描述信息 |
---|---|---|
position |
BaseGraphic.AjaxPosition |
动态坐标配置 |
返回值:
是否后端动态坐标
平移指定偏移高度(相对于原始坐标值),【提示:仅部分子类支持】
参数名称 | 类型 | 描述信息 |
---|---|---|
height |
number |
可选
平移的高度值(单位:米),为空时取每个对象的offsetHeight值 |
index |
number | undefined |
可选
Combine大数据对象中,更新的instances对象index值,为空时更新所有对象。 |
返回值:
无
设置整体透明度(globalAlpha值) , 非全部矢量数据都支持,具体需要对应Graphic支持才有效 对象本身透明度请修改 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
|
可选
单击事件中是否继续冒泡查找 |
返回值:
当前对象本身,可以链式调用