gltf小模型 Primitive图元矢量对象
| 参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象,包括以下:
|
参考:
继承自
属性值
是否允许鼠标穿透拾取
attr : object|BaseGraphic.AjaxAttr
graphic/BaseGraphic.js 554
属性信息
- 继承自:
指定时间范围内显示该对象 [提示:仅部分子类实现,非所有对象都支持]
- 继承自:
使用示例:
// 普通传值方式,多个【建议】
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时,是否显示
})
中心点坐标 (笛卡尔坐标)
只读 centerPoint : LngLatPoint
graphic/primitive/BasePointPrimitive.js 210
中心点坐标
只读 colorCorrection : TilesetColorCorrection
graphic/primitive/ModelPrimitive.js 263
颜色校正 对象
位置坐标, 点状数据是单个坐标,线面对象是坐标数组
- 继承自:
只读 czmObject : Cesium.Entity|Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/BaseGraphic.js 261
矢量数据对应的 Cesium内部对象 (不同子类中实现)
是否显示3个方向轴,用于对比测试
显示3个方向轴时的对应轴长度,用于对比测试
当前地图的ellipsoid
设置事件的启用和禁用状态
从参考系到所提供椭球体的固定参考系的4x4变换矩阵
返回实例可修改的属性。Cesium.GeometryInstance
- 继承自:
使用示例:
var attributes = primitiveGraphic.geometryInstanceAttributes;
attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);
是否 后端动态属性
是否 ajax后端动态坐标
是否支持聚合
是否判断内部是否允许编辑(可外部传入禁用编辑,但不允许编辑的对象传入是无效的)
- 继承自:
是否可以调整透明度
是否 time时序动态坐标
四周方向角,0至360度角度值
提示:父类属性,非所有子类都具备
坐标对应的高度值(单位:米)
对象的id标识
- 继承自:
是否已添加到图层
- 继承自:
是否被聚合
是否已经销毁了
是否正在绘制状态
是否正在编辑状态,不是所有子类均支持编辑
是否为点状数据 true: 点状,有position坐标 false:线面,有positions坐标
- 继承自:
是否Mars3D内部的私有对象,如标绘拖拽点等
附加的label文本对象
- 继承自:
只读 layer : BaseLayer
graphic/BaseGraphic.js 185
当前对象所在的图层对象
- 继承自:
只读 map : Map
graphic/BaseGraphic.js 176
当前对象所在的地图对象
- 继承自:
将图元(所有几何实例)从模型转换为世界坐标的4x4变换矩阵。
提示:父类属性,非所有子类都具备
名称
- 继承自:
贴模型分析时,排除的不进行贴模型计算的模型对象,默认是当前本身,可以是: primitives, entities 等
平移指定偏移高度(相对于原始坐标值),【提示:仅部分子类支持,如 PolygonPrimitive、RectanglePrimitive、BoxPrimitive、CylinderPrimitive、EllipsoidPrimitive、CorridorPrimitive】
当前类的构造参数
- 继承自:
三维空间中的旋转 【仅部分对象支持】
对象的pid标识
- 继承自:
俯仰角,上下摇摆的角度,0至360度角度值
提示:父类属性,非所有子类都具备
只读 point : LngLatPoint
graphic/primitive/BasePointPrimitive.js 186
位置坐标
position : Cesium.Cartesian3|LngLatPoint|BaseGraphic.AjaxPosition|BaseGraphic.TimePosition
graphic/primitive/BasePointPrimitive.js 74
位置坐标 (笛卡尔坐标), 赋值时可以传入LatLngPoint对象
当前实时位置坐标(笛卡尔坐标)
同 positions只是为了兼容entity的同名属性
只读 primitive : Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/primitive/BasePrimitive.js 90
矢量数据对应的 Cesium内部对象
只读 primitiveCollection : Cesium.PrimitiveCollection|Cesium.LabelCollection|Cesium.BillboardCollection|Cesium.PointPrimitiveCollection|Cesium.CloudCollection
graphic/primitive/BasePrimitive.js 80
当加载primitive数据的内部Cesium容器
property : Cesium.SampledPositionProperty|Cesium.CallbackProperty
graphic/primitive/BasePointPrimitive.js 547
动态位置坐标
矢量数据对应的渲染是否完成
- 继承自:
获取模型完成解析加载完成的Promise承诺, 等价于load事件(区别在于load事件必须在load完成前绑定才能监听)。
滚转角,左右摆动的角度,0至360度角度值
提示:父类属性,非所有子类都具备
模型整体的缩放比例
X轴方向缩放比例
Y轴方向缩放比例
Z轴方向缩放比例
显示隐藏状态(属性值)
- 继承自:
卷帘对比时,设置所在的屏幕,NONE时不分屏
只读 state : State
graphic/BaseGraphic.js 220
当前对象的状态
- 继承自:
样式信息
- 继承自:
获取当前时序坐标的开始时间和结束时间,返回的是Cesium.JulianDate格式
获取当前时序坐标的开始时间和结束时间,返回的是时间字符串
用于 map.trackedEntity 追踪的
矢量数据类型
- 继承自:
对应材质的uniforms(当赋有材质时), 一个对象,它的属性被用来设置片段着色器shader。
对象属性值可以是常量或函数。这个函数将在每一帧后处理阶段执行之前被调用。
常量值也可以是图像的URI、数据URI,或者可以用作纹理的HTML元素,如HTMLImageElement或HTMLCanvasElement。
图层顺序,数字大的在上面。
只对 同类型 + 贴地(clampToGround: true) 的部分线面矢量对象间有效
- 继承自:
方法
对象添加到图层前创建一些对象的钩子方法, 只会调用一次
返回值:
无
addEventParent(obj) → BaseClass
core/BaseClass.js 309
添加抛出事件到父类,它将接收传播的事件
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
addTimePosition(point, currTime) → BasePointPrimitive
graphic/primitive/BasePointPrimitive.js 668
设置并添加动画轨迹位置,按“指定时间”运动到达“指定位置”。 【仅LabelPrimitive、PointPrimitive、BillboardPrimitive、ModelPrimitive 等部分子类支持】
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
point |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
指定位置坐标 |
|
currTime |
Cesium.JulianDate | Date | string | number |
Cesium.JulianDate.now()
|
可选
指定时间。当为String时,可以传入'2021-01-01 12:13:00'; 当为Number时,可以传入当前时间延迟的秒数。 |
返回值:
当前对象本身,可以链式调用
addTo(layer) → BaseGraphic|*
graphic/BaseGraphic.js 702
添加到图层上,同 layer.addGraphic
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
layer |
GraphicLayer |
图层对象 |
返回值:
当前对象本身,可以链式调用
- 继承自:
异步计算更新坐标高度进行贴地(或贴模型),内部自动调用PointUtil#getSurfaceHeight方法处理。
| 参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
异步计算完成的Promise
bindContextMenu(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1877
绑定右键菜单
| 参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 727
绑定Cesium内部对象进行相关管理。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
item |
* |
Cesium对象 |
返回值:
当前对象本身,可以链式调用
bindPopup(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1651
绑定鼠标单击对象后的弹窗。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
content |
string | function |
弹窗内容html字符串,或者回调方法。 |
options |
Popup.StyleOptions |
可选
控制参数, 另外支持传入open:true自动打开 |
返回值:
当前对象本身,可以链式调用
bindTooltip(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1755
绑定鼠标移入的弹窗
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
content |
string | function |
弹窗内容html字符串,或者回调方法。 |
options |
Tooltip.StyleOptions |
可选
控制参数 |
返回值:
当前对象本身,可以链式调用
清除所有时序动态坐标
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
maxCacheCount |
number |
可选
保留的坐标数量,默认清除所有。 |
返回值:
closeContextMenu() → BaseGraphic|*
graphic/BaseGraphic.js 1925
关闭右键菜单
返回值:
当前对象本身,可以链式调用
清除已选中的高亮,原有style的配置项需要与highlightStyle配置有一一对应关系,否则无法清除
返回值:
无
closePopup() → BaseGraphic|*
graphic/BaseGraphic.js 1710
关闭弹窗
返回值:
当前对象本身,可以链式调用
closeSmallTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1954
关闭小提示窗
返回值:
当前对象本身,可以链式调用
closeTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1804
关闭弹窗
返回值:
当前对象本身,可以链式调用
销毁当前对象
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
noDel |
boolean |
false
|
可选
false:会自动delete释放所有属性,true:不delete绑定的变量 |
返回值:
无
- 继承自:
启用或禁用所有内部控件(含tooltip、popup、contextmenu)
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
value |
boolean |
是否启用 |
返回值:
无
完成绘制和编辑,如有未完成的绘制会自动完成。 在移动端需要调用此方法来类似PC端双击结束。
返回值:
是否正常结束了矢量对象绘制
fire(type, data, propagate) → BaseClass
core/BaseClass.js 202
触发指定类型的事件。
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
type |
EventType | string |
事件类型 |
|
data |
object |
可选
传输的数据或对象,可在事件回调方法中event对象中获取进行使用 |
|
propagate |
boolean |
false
|
可选
将事件传播给父类 (用addEventParent设置) |
返回值:
当前对象本身,可以链式调用
- 继承自:
飞行定位至 数据所在的视角
| 参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数对象:
|
返回值:
如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise
- 继承自:
获取后端动态属性,当存在attr是动态属性配置时可用【attr.type === "ajax"】
| 参数名称 | 类型 | 描述信息 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
funOptions |
object |
可选
参数
|
返回值:
实时获取当前的动态属性值
获取时间范围的简单对象数组(转为相对map.clock.startTime的相对数字)
返回值:
时间对象列表
获取指定时间下的时序对应的 显示隐藏 状态
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
time |
Cesium.JulianDate |
指定时间 |
返回值:
显示隐藏 状态
获取绑定的右键菜单数组
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
hasLayer |
boolean |
true
|
可选
是获取图层上的右键菜单 |
返回值:
右键菜单数组;无有效结果时可能返回null。
获取位置坐标 (其中坐标均为经纬度形式),用于导出JSON等方法 示例: [113.123456,31.123456,30.1] 或 [ [123.123456,32.654321,198.7], [111.123456,22.654321,50.7] ]
| 参数名称 | 类型 | 描述信息 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数
|
返回值:
位置坐标(经纬度数组形式)
- 继承自:
获取数据的最大高度
返回值:
高度
getPopup() → Popup
graphic/BaseGraphic.js 1721
获取当前对象打开的Popup对象
返回值:
当前对象打开的Popup对象
- 继承自:
获取当前对象真实实际的显示状态
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
time |
Cesium.JulianDate |
可选
当前时间,不传时不做availability判断 |
返回值:
真实的实时显示状态,当时序范围外,被聚合时返回的是false
获取数据的矩形边界
| 参数名称 | 类型 | 描述信息 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
boolean |
可选
控制参数
|
返回值:
isFormat:true时,返回格式化对象,isFormat:false时返回Cesium.Rectangle对象;未满足执行条件时可能无返回值。
getTooltip() → Tooltip
graphic/BaseGraphic.js 1815
获取当前对象打开的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 |
boolean |
false
|
可选
是否判断指定的父类 (用addEventParent设置的) |
返回值:
是否存在
- 继承自:
off(types, fn, context) → BaseClass
core/BaseClass.js 101
解除绑定指定类型事件监听器
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
types |
string | EventType | Array.<string> | Array.<EventType> |
可选
事件类型,tip:多个事件也可以数组或空格间隔的字符串 , 传入空值时解绑所有事件 |
fn |
function |
可选
绑定的监听器回调方法,未传值时解绑所有指定类型对应事件,特殊说明:map.on监听的Cesium相关原生事件时必须传入该参数 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
on(types, fn, context) → BaseClass
core/BaseClass.js 71
绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 阻止事件冒泡
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
types |
string | EventType | Array.<string> | Array.<EventType> |
事件类型,tip:多个事件也可以数组或空格间隔的字符串 |
fn |
function |
绑定的监听器回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
once(types, fn, context) → BaseClass
core/BaseClass.js 283
绑定一次性执行的指定类型事件监听器 与on类似,监听器只会被触发一次,然后被删除。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
types |
EventType | string | Array.<EventType> |
事件类型 |
fn |
function |
绑定的监听器回调方法 |
context |
object |
可选
侦听器的上下文(this关键字将指向的对象)。 |
返回值:
当前对象本身,可以链式调用
- 继承自:
openContextMenu(position) → BaseGraphic|*
graphic/BaseGraphic.js 1910
打开右键菜单
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
position |
Cesium.Cartesian3 |
this.center
|
可选
矢量对象 或 显示的位置 |
返回值:
当前对象本身,可以链式调用
高亮对象。
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
highlightStyle |
object |
可选
高亮的样式,具体见各 |
|
closeLast |
boolean |
true
|
可选
是否清除地图上一次的高亮对象 |
返回值:
无
openPopup(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1691
打开绑定的弹窗
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> | * |
this.center
|
可选
矢量对象 或 显示的位置 |
event |
object |
可选
用于抛出事件时的相关额外属性 |
返回值:
当前对象本身,可以链式调用
openSmallTooltip(position, message) → BaseGraphic|*
graphic/BaseGraphic.js 1942
显示小提示窗,一般用于鼠标操作的提示。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
position |
Cesium.Cartesian2 | Cesium.Cartesian3 |
显示的屏幕坐标位置 或 笛卡尔坐标位置 |
message |
* |
显示的内容 |
返回值:
当前对象本身,可以链式调用
openTooltip(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1787
打开绑定的tooltip弹窗
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
position |
LngLatPoint | Cesium.Cartesian3 | Array.<number> |
this.center
|
可选
显示的位置,默认为矢量对象所在点或中心点位置 |
event |
object |
可选
用于抛出事件时的相关额外属性 |
返回值:
当前对象本身,可以链式调用
redraw(style) → BasePrimitive
graphic/primitive/BasePrimitive.js 828
重新渲染
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
style |
object |
可选
新的样式信息 |
返回值:
当前对象本身
- 继承自:
从图层上移除,同 layer.removeGraphic
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
hasDestroy |
boolean |
true
|
可选
是否调用destroy释放 |
返回值:
无
- 继承自:
removeEventParent(obj) → BaseClass
core/BaseClass.js 326
移除抛出事件到父类
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
obj |
object |
父类对象 |
返回值:
当前对象本身,可以链式调用
平移指定偏移高度(相对于原始坐标值),【提示:仅部分子类支持】
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
height |
number |
可选
平移的高度值(单位:米),为空时取每个对象的offsetHeight值 |
返回值:
无
设置整体透明度(globalAlpha值), 不是所有类型均支持,主要看数据类型和材质类型决定。 对象本身透明度请用 graphic.setStyle({ opacity: value })
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
value |
number |
透明度 |
返回值:
无
setOptions(options, funOptions) → BaseGraphic|*
graphic/BaseGraphic.js 937
重新赋值参数,同构造方法参数一致。
| 参数名称 | 类型 | 描述信息 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
参数,与类的构造方法参数相同 |
||||||||
funOptions |
object |
可选
方法参数
|
返回值:
当前对象本身,可以链式调用
setStyle(newStyle, funOptions) → BaseGraphic|*
graphic/BaseGraphic.js 1021
设置 样式信息 的钩子方法
| 参数名称 | 类型 | 描述信息 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
newStyle |
object |
本次更新的部分样式信息,内部会合并属性 |
||||||||
funOptions |
object |
可选
方法参数
|
返回值:
当前对象本身,可以链式调用
- 继承自:
startDraw(layer) → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1204
开始绘制矢量数据,绘制的数据会加载在layer图层。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
layer |
GraphicLayer |
图层 |
返回值:
已处于绘制状态时返回当前对象;正常启动绘制后无返回值。
Throws:
-
Error :
绘制时_map不能为空,请将对象添加到图层,并且图层已添加到Map
startEditing() → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1360
开始编辑对象
返回值:
已处于编辑状态时返回当前对象;正常启动编辑后无返回值。
Throws:
-
Error :
编辑时_map不能为空,请将对象添加到图层,并且图层已添加到Map
startFlicker(options) → FlickerEntity
graphic/primitive/ModelPrimitive.js 596
高亮闪烁
| 参数名称 | 类型 | 默认值 | 描述信息 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
{}
|
可选
参数
|
返回值:
高亮闪烁控制 对象
stopDraw() → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1257
停止绘制
返回值:
无需结束绘制时返回当前对象;实际结束绘制时无返回值。
stopEditing() → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1454
停止编辑,释放正在编辑的对象。
返回值:
无需停止编辑时返回当前对象;实际停止编辑时无返回值。
stopFlicker() → FlickerEntity|null
graphic/primitive/ModelPrimitive.js 615
停止高亮闪烁
返回值:
存在闪烁控制器时返回该控制器,否则返回null。
样式转换为 JSON 的扩展点。 子类可覆写本方法,或继续兼容覆写 _style2Json。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
style |
object |
样式对象 |
styleJson |
object |
可选
已有样式 JSON |
返回值:
转换后的样式 JSON
将当前矢量对象在图层中层级进行 置底 (只对同类型图层间+贴地对象 有效)。
返回值:
无
将矢量数据导出为GeoJSON格式规范对象。
| 参数名称 | 类型 | 描述信息 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数对象:
|
返回值:
GeoJSON格式规范对象;未满足执行条件时可能无返回值。
将矢量数据的坐标、样式及属性等信息导出为对象,可以用于存储。
| 参数名称 | 类型 | 描述信息 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
可选
参数对象:
|
返回值:
导出的坐标、样式及属性等信息;未满足执行条件时可能无返回值。
- 继承自:
导出 JSON 的扩展点。 子类可覆写本方法,或继续兼容覆写 _toJSON_Ex。
| 参数名称 | 类型 | 描述信息 |
|---|---|---|
json |
object |
待导出的 JSON 对象 |
options |
object |
可选
导出参数 |
返回值:
传入的 JSON 对象
- 继承自:
将当前矢量对象在图层中层级进行 置顶 (只对同类型图层间+贴地对象 有效)。
返回值:
无
- 继承自:
unbindContextMenu(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1895
解除绑定的右键菜单
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡查找 |
返回值:
当前对象本身,可以链式调用
解绑鼠标移入或单击后的高亮处理
返回值:
无
unbindPopup(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1673
解除绑定的鼠标单击对象后的弹窗。
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡往上级查找 |
返回值:
当前对象本身,可以链式调用
unbindTooltip(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1771
解除绑定的鼠标移入对象后的弹窗。
| 参数名称 | 类型 | 默认值 | 描述信息 |
|---|---|---|---|
bubbling |
boolean |
false
|
可选
单击事件中是否继续冒泡查找 |
返回值:
当前对象本身,可以链式调用
定义的类型
gltf小模型 支持的样式信息
属性:
| 属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
|---|---|---|---|---|
url |
string | Cesium.Resource |
<可选> |
glTF模型的URI的字符串或资源属性。 |
|
basePath |
string |
<可选> |
'' | glTF JSON 中相对路径的基准路径。 |
scale |
number |
<可选> |
1.0 | 缩放比例 |
minimumPixelSize |
number |
<可选> |
0.0 | 指定模型的近似最小像素大小,而不考虑scale缩放,内部会计算像素对应的实际scale值。 |
maximumScale |
number |
<可选> |
内部计算minimumPixelSize对应的实际scale值时,限定的最大的scale缩放比例。 |
|
scaleX |
number |
<可选> |
1 | X轴方向缩放比例 |
scaleY |
number |
<可选> |
1 | Y轴方向缩放比例 |
scaleZ |
number |
<可选> |
1 | Z轴方向缩放比例 |
heading |
number |
<可选> |
0 | 方向角 (度数值,0至360度),优先级高于orientation |
pitch |
number |
<可选> |
0 | 俯仰角(度数值,0至360度),优先级高于orientation |
roll |
number |
<可选> |
0 | 翻滚角(度数值,0至360度),优先级高于orientation |
mergeOrientation |
boolean |
<可选> |
false | 当存在orientation时(如addTimePosition等),设置为true时,可以在orientation基础的方式值上叠加设置是heading、pitch、roll值,比如用于设置模型不是标准的方向时的处理 |
fill |
boolean |
<可选> |
false | 是否填充,指定与模型渲染颜色混合 |
color |
string | Cesium.Color |
<可选> |
"#ffffff" | 颜色 |
opacity |
number |
<可选> |
1.0 | 透明度,取值范围:0.0-1.0 |
colorBlendMode |
Cesium.ColorBlendMode |
<可选> |
ColorBlendMode.HIGHLIGHT | 指定颜色如何与模型混合。 |
colorBlendAmount |
number |
<可选> |
0.5 | 当colorBlendMode为MIX时指定颜色强度的数字属性。0.0的值表示模型渲染的颜色,1.0的值表示纯色,任何介于两者之间的值表示两者的混合。 |
silhouette |
boolean |
<可选> |
false | 是否轮廓 |
silhouetteColor |
string | Cesium.Color |
<可选> |
"#ff0000" | 轮廓颜色 |
silhouetteSize |
number |
<可选> |
2 | 轮廓宽度 |
silhouetteAlpha |
number |
<可选> |
0.8 | 轮廓透明度 |
enableShowOutline |
boolean |
<可选> |
true | 是否启用使用 CESIUM_primitive_outline 扩展的模型轮廓。设为 false 可避免在加载时对几何体进行额外处理;为 false 时,showOutline 和 outlineColor 选项将被忽略。 |
showOutline |
boolean |
<可选> |
true | 是否显示使用 CESIUM_primitive_outline 扩展的模型轮廓。为 true 时显示轮廓,为 false 时不显示。 |
outlineColor |
Cesium.Color |
<可选> |
Cesium.Color.BLACK | 渲染轮廓时使用的颜色。 |
distanceDisplayCondition |
boolean | Cesium.DistanceDisplayCondition |
<可选> |
false | 是否按视距显示,或指定此对象在距摄像机多远时显示。 |
distanceDisplayCondition_near |
number |
<可选> |
0 | 最小距离 |
distanceDisplayCondition_far |
number |
<可选> |
Number.MAX_VALUE | 最大距离 |
distanceDisplayPoint |
PointEntity.StyleOptions |
<可选> |
当视角距离超过 distanceDisplayCondition_far 后,显示为像素点对象的样式;仅在设置 distanceDisplayCondition 时有效。 |
|
distanceDisplayBillboard |
BillboardEntity.StyleOptions |
<可选> |
当视角距离超过 distanceDisplayCondition_far 后,显示为图标对象的样式;仅在设置 distanceDisplayCondition 时有效。 |
|
hasShadows |
boolean |
<可选> |
true | 是否投射阴影 |
shadows |
Cesium.ShadowMode |
<可选> |
ShadowMode.ENABLED | 指定模型是投射还是接收来自光源的阴影。 |
clampToGround |
boolean |
<可选> |
false | 是否贴地 |
heightReference |
Cesium.HeightReference |
<可选> |
Cesium.HeightReference.NONE | 指定高度的参考方式。 |
enableVerticalExaggeration |
boolean |
<可选> |
true | 当存在地形夸张(map.scene.verticalExaggeration)时,模型是否沿椭球法线被夸大。 |
incrementallyLoadTextures |
boolean |
<可选> |
true | 确定模型加载后纹理是否继续流式加载。 |
runAnimations |
boolean |
<可选> |
true | 指定是否启动模型中的 glTF 动画。 |
clampAnimations |
boolean |
<可选> |
true | 指定在没有关键帧时,glTF 动画是否保持最后一个姿势。 |
releaseGltfJson |
boolean |
<可选> |
false | 为 true 时,glTF 加载完成后释放 glTF JSON。对于 3D Tiles 等每个 .gltf 模型都唯一的场景尤其有用,因为缓存 glTF JSON 并不会带来收益。 |
lightColor |
Cesium.Color | number |
<可选> |
控制模型自身接收的光源颜色的参数,核心作用是为模型的光照计算指定一个 “滤镜色”—— 所有照射到该模型上的光源(定向光、环境光、太阳光等)都会先与这个颜色相乘,最终改变模型呈现的整体色调和亮度。 |
|
imageBasedLighting |
Cesium.ImageBasedLighting |
<可选> |
用于管理此模型基于图像的光照(IBL)的属性。 |
|
environmentMapOptions |
object |
<可选> |
动态环境贴图的配置,用于 PBR 光照,可传入 Cesium.DynamicEnvironmentMapManager 构造参数。 |
|
nodeTransformations |
Cesium.PropertyBag | object.<string, Cesium.TranslationRotationScale> |
<可选> |
一个对象,其中键是节点名称,值是 |
|
articulations |
Cesium.PropertyBag | object.<string, number> |
<可选> |
一个对象,键由“关节名称 + 单个空格 + 阶段名称”组成,值为数值属性。 |
|
clippingPlanes |
Cesium.ClippingPlaneCollection |
<可选> |
用于裁剪模型的平面集合。 |
|
clippingPolygons |
Cesium.ClippingPolygonCollection |
<可选> |
用于按多边形裁剪模型的集合。 |
|
allowPicking |
boolean |
<可选> |
true | 为 true 时,每个 glTF 和 Primitive 都可以用 |
enablePick |
boolean |
<可选> |
false | WebGL1 下是否允许 CPU 拾取;WebGL2+ 忽略,开启会增加内存占用。 |
asynchronous |
boolean |
<可选> |
true | 确定模型 WebGL 资源的创建是否分散在多帧或分块进行,直到所有 glTF 文件加载完成。 |
dequantizeInShader |
boolean |
<可选> |
true | 确定 Draco 编码的模型是否在 GPU 上反量化。这可减少编码模型的总内存占用。 |
backFaceCulling |
boolean |
<可选> |
true | 是否剔除背面几何体。为 true 时,背面剔除由材质的 doubleSided 属性决定;为 false 时禁用背面剔除。如果 |
debugShowBoundingVolume |
boolean |
<可选> |
false | 仅供调试。显示模型的包围球。 |
enableDebugWireframe |
boolean |
<可选> |
false | 仅供调试。是否可以通过 debugWireframe 切换查看模型的三角网线框。 |
debugWireframe |
boolean |
<可选> |
false | 仅供调试。是否打开模型的三角网线框。 |
cull |
boolean |
<可选> |
true | 是否使用视锥/地平线剔除来剔除模型。如果模型属于 3D Tiles 瓦片集,此属性始终为 false,因为此时使用 3D Tiles 的剔除系统。 |
opaquePass |
object | number |
<可选> |
Cesium.Pass.OPAQUE | 设置渲染通道。在实际使用中,模型的不透明部分应将 DrawCommand 的 pass 属性设置为 Cesium.Pass.OPAQUE,这样 Cesium 渲染器会在处理不透明物体的阶段渲染该部分,保证渲染顺序和深度检测等机制正常工作。 |
upAxis |
Cesium.Axis |
<可选> |
Cesium.Axis.Y | glTF 模型的上轴方向。 |
forwardAxis |
Cesium.Axis |
<可选> |
Cesium.Axis.Z | glTF 模型的前轴方向。 |
edgeDisplayMode |
Cesium.EdgeDisplayMode |
<可选> |
Cesium.EdgeDisplayMode.SURFACES_ONLY | 控制 glTF EXT_mesh_primitive_edge_visibility 扩展的边缘渲染方式。 |
customShader |
Cesium.CustomShader |
<可选> |
自定义着色器。它会把用户定义的 GLSL 代码添加到顶点着色器和片元着色器中。将自定义着色器与 |
|
content |
Cesium.Cesium3DTileContent |
<可选> |
此模型所属的瓦片内容。如果模型不是作为瓦片集的一部分加载的,此属性为 undefined。 |
|
credit |
Cesium.Credit | string |
<可选> |
数据源版权信息。 |
|
showCreditsOnScreen |
boolean |
<可选> |
false | 是否在屏幕上显示此模型的版权信息。 |
splitDirection |
Cesium.SplitDirection |
<可选> |
Cesium.SplitDirection.NONE | 应用于此模型的分屏方向。 |
projectTo2D |
boolean |
<可选> |
false | 是否将模型位置精确投影到 2D。为 true 时,模型会精确投影到 2D,但会占用更多内存;为 false 时,内存占用更少,仍可在 2D/CV 模式下渲染,但位置可能不准确。此选项会禁用 minimumPixelSize,并阻止后续修改模型矩阵;模型加载后也不能再设置此选项。 |
featureIdLabel |
string | number |
<可选> |
"featureId_0" | 用于拾取和样式的要素 ID 集标签。对于 EXT_mesh_features,它是要素 ID 的 label 属性;未指定时为 "featureId_N"(N 为 featureIds 数组中的索引)。EXT_feature_metadata 没有 label 字段,因此此类要素 ID 集始终标记为 "featureId_N",其中 N 为所有要素 ID 列表中的索引,要素 ID 属性排在要素 ID 纹理之前。如果 featureIdLabel 是整数 N,会自动转换为字符串 "featureId_N"。如果同时存在逐图元和逐实例的要素 ID,则实例要素 ID 优先。 |
instanceFeatureIdLabel |
string | number |
<可选> |
"instanceFeatureId_0" | 用于拾取和样式的实例要素 ID 集标签。如果 instanceFeatureIdLabel 设置为整数 N,会自动转换为字符串 "instanceFeatureId_N"。如果同时存在逐图元和逐实例的要素 ID,则实例要素 ID 优先。 |
pointCloudShading |
object |
<可选> |
构造 |
|
classificationType |
Cesium.ClassificationType |
<可选> |
确定地形、3D Tiles 还是两者都要被此模型分类。模型加载后不能再设置。 |
|
gltfCallback |
function |
<可选> |
模型加载完成后,以加载的 gltf 对象为参数调用的回调函数。 模型动画相关 |
|
startTime |
Cesium.JulianDate |
<可选> |
场景时间开始播放动画。为 undefined 时,动画从下一帧开始。 |
|
delay |
number |
<可选> |
0.0 | 从startTime开始播放的延迟,以秒为单位。 |
stopTime |
Cesium.JulianDate |
<可选> |
场景时间停止播放动画。为 undefined 时,动画会播放完整时长。 |
|
removeOnStop |
boolean |
<可选> |
false | 当true时,动画在停止播放后被删除。 |
multiplier |
number |
<可选> |
1.0 | 大于 1.0 的值会相对于场景时钟加快动画播放速度;小于 1.0 会降低速度。 |
reverse |
boolean |
<可选> |
false | 当true时,动画会反向播放。 |
loop |
Cesium.ModelAnimationLoop |
<可选> |
Cesium.ModelAnimationLoop.REPEAT | 决定动画是否循环以及如何循环。 |
setHeight |
number | string |
<可选> |
指定坐标高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模板配置 |
|
addHeight |
number | string |
<可选> |
在现有坐标基础上增加的高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模板配置 |
|
highlight |
ModelPrimitive.StyleOptions |
<可选> |
鼠标移入或单击(type:'click')后的高亮样式。提示:原有 style 的配置项需要与 highlight 配置一一对应,否则无法清除。 // * @param {string} [highlight.type] 事件方式,鼠标移入高亮 或 单击高亮(type:'click') // * @param {boolean} [highlight.enabled=true] 是否启用 |
|
label |
LabelEntity.StyleOptions |
<可选> |
支持附带文字的显示 |