FixedRoute
查阅Cesium API

new mars3d.graphic.FixedRoute(options)
graphic/custom/FixedRoute.js 10

固定轨迹路线/历史轨迹路线，是由多个其他类型Graphic组合而成，方便一起控制和管理。
路线坐标是一次性postions参数或属性传入的，有开始和结束的概念。

参数名称 类型 默认值 描述信息
options object {} 可选

参数对象，包括以下：

参数名称 类型 默认值 描述信息
position BaseGraphic.TimePosition 可选

时序坐标位置
attr object 可选

矢量数据的 属性信息，可以任意附加属性
convertStyle boolean false 可选

是否兼容外部标绘功能统一修改样式，进行拆分矢量样式到style中（如options.model.url可以传options.style.model_url）
label LabelEntity.StyleOptions 可选

使用 文本 对象，及其对应的样式
billboard BillboardEntity.StyleOptions 可选

使用 图标 对象，及其对应的样式
point PointPrimitive.StyleOptions 可选

使用 图标 对象，及其对应的样式
model ModelPrimitive.StyleOptions 可选

使用 gltf模型 对象，及其对应的样式
circle CircleEntity.StyleOptions 可选

使用 圆 对象，及其对应的样式
coneTrack ConeTrack.StyleOptions 可选

使用 圆锥体 对象，及其对应的样式
path PathEntity.StyleOptions 可选

使用 path轨迹 对象，及其对应的样式
polyline PolylineEntity.StyleOptions 可选

使用 polyline路线 对象，及其对应的样式
// * @param {number} [options.polyline.maxDistance] 设置保留的轨迹长度值（单位：米），不设置时保留所有的轨迹 // * @param {boolean} [options.polyline.showAll] 在播放时,是否一直显示所有坐标
wall WallEntity.StyleOptions 可选

使用 墙体 对象，及其对应的样式
// * @param {number} [options.wall.maxDistance] 设置保留的轨迹长度值（单位：米），不设置时保留所有的轨迹
// * @param {number} [options.wall.surface] 设置墙底部高度是否贴地
highlight object 可选

鼠标移入或单击(type:'click')后的对应高亮的部分样式，创建Graphic后也可以openHighlight、closeHighlight方法来手动调用

参数名称 类型 描述信息
label LabelEntity.StyleOptions 可选

使用 文本 对象，及其对应的样式
billboard BillboardEntity.StyleOptions 可选

使用 图标 对象，及其对应的样式
point PointPrimitive.StyleOptions 可选

使用 图标 对象，及其对应的样式
model ModelPrimitive.StyleOptions 可选

使用 gltf模型 对象，及其对应的样式
circle CircleEntity.StyleOptions 可选

使用 圆 对象，及其对应的样式
coneTrack ConeTrack.StyleOptions 可选

使用 圆锥体 对象，及其对应的样式
path PathEntity.StyleOptions 可选

使用 path轨迹 对象，及其对应的样式
polyline PolylineEntity.StyleOptions 可选

使用 polyline路线 对象，及其对应的样式
wall WallEntity.StyleOptions 可选

使用 墙体 对象，及其对应的样式
orientation Cesium.Property | object 可选

自定义实体方向, 默认内部根据轨迹自动的
fixedFrameTransform Cesium.Transforms.LocalFrameToFixedFrame Cesium.Transforms.eastNorthUpToFixedFrame 可选

参考系
showStop boolean true 可选

是否在start前或stop后显示矢量对象
updateClock boolean true 可选

是否自动更新时钟，多个FixedRoute时或外部手动控制时钟时建议关闭
clockRange Cesium.ClockRange 可选

设定全局时钟播放的模式，可以设置到达终点后停止或循环播放
clockLoop boolean 可选

是否循环播放，与 clockRange: Cesium.ClockRange.LOOP_STOP 效果类似，但不改变全局时钟时间
autoStart object 可选

是否加入后就自动启动播放

参数名称 类型 默认值 描述信息
enabled boolean true 可选

是否启用
delay number 0 可选

延迟多少秒开始播放
autoStop boolean 可选

是否自动停止
frameRate number 1 可选

多少帧获取一次数据。用于控制效率，如果卡顿就把该数值调大一些。
maxCacheCount number 1000 可选

保留的坐标点数量, 当为-1时保留所有
backwardExtrapolationType Cesium.ExtrapolationType | number Cesium.ExtrapolationType.HOLD 可选

当使用addTimePosition时，在第1个开始时间之前，NONE时不显示，HOLD时显示开始时间对应坐标位置
forwardExtrapolationType Cesium.ExtrapolationType | number Cesium.ExtrapolationType.HOLD 可选

当使用addTimePosition时，在最后1个结束时间之后，NONE时不显示，HOLD时显示结束时间对应坐标位置
numberOfDerivatives number 0 可选

当使用addTimePosition设置为动画轨迹位置时，每个位置的导数的数量;即速度、加速度等。
autoMiddleTimePosition boolean 可选

当使用addTimePosition设置为动画轨迹位置时，如果中间缺少数据时是否自动添加中间点。
clampToTileset boolean 可选

是否进行贴模型。
frameRateHeight number 30 可选

clampToTileset：true时，多少帧计算一次贴模型高度
camera object 可选

视角模式设置，包括：

参数名称 类型 默认值 描述信息
type string 可选

视角模式类型，包括：'':无、'gs':跟随视角、'dy':第一视角、'sd':上帝视角
radius number 可选

'gs'跟随视角时的 初始俯仰距离值（单位：米）
heading number 可选

'gs'跟随视角时的 初始方向角度值，绕垂直于地心的轴旋转角度, 0至360
pitch number 可选

'gs'跟随视角时的 初始俯仰角度值，绕纬度线旋转角度, -90至90
followedX number 50 可选

'dy'锁定第一视角时，距离运动点的距离（后方）
followedZ number 10 可选

'dy'锁定第一视角或'sd'上帝视角时，距离运动点的高度（上方）
offsetX number 0 可选

'dy'锁定第一视角时，锁定点的本身的X轴方向（前后）偏移值
offsetY number 0 可选

'dy'锁定第一视角时，锁定点的本身的Y轴方向（横向）偏移值
offsetZ number 0 可选

'dy'锁定第一视角时，锁定点的本身的Z轴方向（高度）偏移值
popup string | Array | function 可选

绑定的popup弹窗值，也可以bindPopup方法绑定
popupOptions Popup.StyleOptions 可选

popup弹窗时的配置参数，也支持如pointerEvents等Popup构造参数
tooltip string | Array | function 可选

绑定的tooltip弹窗值，也可以bindTooltip方法绑
tooltipOptions Tooltip.StyleOptions 可选

tooltip弹窗时的配置参数，也支持如pointerEvents等Tooltip构造参数
contextmenuItems object 可选

当矢量数据支持右键菜单时，也可以bindContextMenu方法绑定
id string | number createGuid() 可选

矢量数据id标识
name string 可选

矢量数据名称
show boolean true 可选

矢量数据是否显示
eventParent BaseClass | boolean 可选

指定的事件冒泡对象，默认为所加入的图层对象，false时不冒泡事件
allowDrillPick boolean | function 可选

是否允许鼠标穿透拾取
flyTo boolean 可选

加载完成数据后是否自动飞行定位到数据所在的区域。
flyToOptions object 可选

加载完成数据后是否自动飞行定位到数据所在的区域的对应 BaseGraphic#flyTo方法参数。
参考:

继承自

属性值

allowDrillPick : boolean|function
graphic/BaseGraphic.js 595

是否允许鼠标穿透拾取

继承自:

只读 alt : number
graphic/custom/Route.js 324

当前大地高值

继承自:

attr : object|BaseGraphic.AjaxAttr
graphic/BaseGraphic.js 554

属性信息

继承自:

availability : Cesium.TimeIntervalCollection
graphic/BaseGraphic.js 412

指定时间范围内显示该对象 [提示：仅部分子类实现，非所有对象都支持]

继承自:
使用示例:
// 普通传值方式，多个【建议】
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时，是否显示
})

billboard : BillboardPrimitive
graphic/custom/Route.js 180

图标 子对象

继承自:

只读 center : Cesium.Cartesian3
graphic/primitive/BasePointPrimitive.js 201

中心点坐标 （笛卡尔坐标）

继承自:

只读 centerPoint : LngLatPoint
graphic/primitive/BasePointPrimitive.js 210

中心点坐标

继承自:

circle : CircleEntity
graphic/custom/Route.js 235

圆 子对象

继承自:

coneTrack : ConeTrack
graphic/custom/Route.js 248

圆锥体 子对象

继承自:

coord : Array.<number>|Array.<Array.<number>>|object|undefined
graphic/BaseGraphic.js 579

位置坐标, 点状数据是单个坐标，线面对象是坐标数组

继承自:

只读 currIndex : number
graphic/custom/Route.js 385

当前飞行过的positions轨迹点数组的index顺序

继承自:

只读 czmObject : Cesium.Entity|Cesium.Primitive|Cesium.GroundPrimitive|Cesium.ClassificationPrimitive|*
graphic/BaseGraphic.js 261

矢量数据对应的 Cesium内部对象 (不同子类中实现)

继承自:

debugAxis : boolean
graphic/primitive/BasePointPrimitive.js 349

是否显示3个方向轴，用于对比测试

继承自:

debugAxisLength : number
graphic/primitive/BasePointPrimitive.js 386

显示3个方向轴时的对应轴长度，用于对比测试

继承自:

只读 ellipsoid : Cesium.Ellipsoid
graphic/BaseGraphic.js 668

当前地图的ellipsoid

继承自:

enabledEvent : boolean
graphic/BaseGraphic.js 625

设置事件的启用和禁用状态

继承自:

只读 fixedFrameTransform : Cesium.Transforms.LocalFrameToFixedFrame
graphic/BaseGraphic.js 677

从参考系到所提供椭球体的固定参考系的4x4变换矩阵

继承自:

只读 geometryInstanceAttributes : object
graphic/primitive/BasePrimitive.js 145

返回实例可修改的属性。Cesium.GeometryInstance

继承自:
使用示例:
var attributes = primitiveGraphic.geometryInstanceAttributes;
attributes.color = Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA);
attributes.show = Cesium.ShowGeometryInstanceAttribute.toValue(true);

只读 groundPosition : Cesium.Cartesian3
graphic/custom/Route.js 315

求当前位置射线与地球相交点

继承自:

只读 hasAjaxAttr : boolean
graphic/BaseGraphic.js 2073

是否 后端动态属性

继承自:

只读 hasAjaxPostion : boolean
graphic/primitive/BasePointPrimitive.js 620

是否 ajax后端动态坐标

继承自:

只读 hasCluster : boolean
graphic/BaseGraphic.js 332

是否支持聚合

继承自:

hasEdit : boolean
graphic/BaseGraphic.js 607

是否判断内部是否允许编辑（可外部传入禁用编辑,但不允许编辑的对象传入是无效的）

继承自:

只读 hasOpacity : boolean
graphic/BaseGraphic.js 659

是否可以调整透明度

继承自:

只读 hasTimePostion : boolean
graphic/primitive/BasePointPrimitive.js 629

是否 time时序动态坐标

继承自:

heading : number
graphic/primitive/BasePointPrimitive.js 258

四周方向角，0至360度角度值
提示：父类属性，非所有子类都具备

继承自:

height : number
graphic/primitive/BasePointPrimitive.js 218

坐标对应的高度值（单位：米）

继承自:

id : string|number
graphic/BaseGraphic.js 193

对象的id标识

继承自:

只读 info : object
graphic/custom/FixedRoute.js 128

当前实时信息

只读 isAdded : boolean
graphic/BaseGraphic.js 230

是否已添加到图层

继承自:

isCluster : boolean
graphic/BaseGraphic.js 340

是否被聚合

继承自:

只读 isDestroy : boolean
graphic/BaseGraphic.js 240

是否已经销毁了

继承自:

只读 isDrawing : boolean
graphic/primitive/BasePrimitive.js 1193

是否正在绘制状态

继承自:

只读 isEditing : boolean
graphic/primitive/BasePrimitive.js 189

是否正在编辑状态，不是所有子类均支持编辑

继承自:

isPause : boolean
graphic/custom/Route.js 407

是否暂停状态 【针对全局时钟的，即 map.clock.shouldAnimate】

继承自:

只读 isPoint : boolean
graphic/BaseGraphic.js 167

是否为点状数据 true: 点状，有position坐标 false：线面，有positions坐标

继承自:

只读 isPrivate : boolean
graphic/BaseGraphic.js 249

是否Mars3D内部的私有对象，如标绘拖拽点等

继承自:

只读 isStart : boolean
graphic/custom/FixedRoute.js 119

是否已启动

label : LabelPrimitive|*
graphic/custom/Route.js 167

文本 子对象

继承自:

只读 layer : BaseLayer
graphic/BaseGraphic.js 185

当前对象所在的图层对象

继承自:

只读 map : Map
graphic/BaseGraphic.js 176

当前对象所在的地图对象

继承自:

model : ModelPrimitive
graphic/custom/Route.js 206

模型 子对象

继承自:

只读 modelMatrix : Cesium.Matrix4
graphic/custom/Route.js 302

将图元(所有几何实例)从模型转换为世界坐标的4x4变换矩阵。
提示：父类属性，非所有子类都具备

继承自:

multiplier : number
graphic/custom/Route.js 393

倍速，构造完成的对象，可以调用此属性调整速度。

继承自:

name : string
graphic/BaseGraphic.js 542

名称

继承自:

objectsToExclude : Array.<object>|undefined
graphic/custom/Route.js 426

贴模型分析时，排除的不进行贴模型计算的模型对象，默认是当前本身，可以是： primitives, entities 等

继承自:

offsetHeight : number
graphic/primitive/BasePrimitive.js 201

平移指定偏移高度（相对于原始坐标值），【提示：仅部分子类支持,如 PolygonPrimitive、RectanglePrimitive、BoxPrimitive、CylinderPrimitive、EllipsoidPrimitive、CorridorPrimitive】

继承自:

只读 options : object
core/BaseClass.js 23

当前类的构造参数

继承自:

orientation : Cesium.Quaternion
graphic/primitive/BasePointPrimitive.js 231

三维空间中的旋转 【仅部分对象支持】

继承自:

path : PathEntity
graphic/custom/Route.js 261

path路径 子对象

继承自:

pid : string|number
graphic/BaseGraphic.js 206

对象的pid标识

继承自:

pitch : number
graphic/primitive/BasePointPrimitive.js 275

俯仰角，上下摇摆的角度，0至360度角度值
提示：父类属性，非所有子类都具备

继承自:

point : PointPrimitive|*
graphic/custom/Route.js 193

像素点 子对象

继承自:

polyline : PolylineEntity
graphic/custom/Route.js 274

路线 子对象

继承自:

position : Cesium.Cartesian3|LngLatPoint|BaseGraphic.AjaxPosition|BaseGraphic.TimePosition
graphic/primitive/BasePointPrimitive.js 74

位置坐标 （笛卡尔坐标）, 赋值时可以传入LatLngPoint对象

继承自:

只读 positionShow : Cesium.Cartesian3
graphic/primitive/BasePointPrimitive.js 166

当前实时位置坐标（笛卡尔坐标）

继承自:

只读 positionsShow : Array.<Cesium.Cartesian3>
graphic/primitive/BasePointPrimitive.js 157

同 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

动态位置坐标

继承自:

只读 ready : boolean
graphic/primitive/BasePrimitive.js 99

矢量数据对应的渲染是否完成

继承自:

只读 readyPromise : Promise.<(ModelEntity|object)>
graphic/custom/Route.js 227

获取model模型子对象完成解析加载完成的Promise承诺

继承自:
使用示例:
route.readyPromise.then(function(graphic) {
    console.log("load完成", graphic)
  })

roll : number
graphic/primitive/BasePointPrimitive.js 292

滚转角，左右摆动的角度，0至360度角度值
提示：父类属性，非所有子类都具备

继承自:

show : boolean
graphic/BaseGraphic.js 278

显示隐藏状态（属性值）

继承自:

只读 startTime : Cesium.JulianDate
graphic/custom/Route.js 357

开始时间

继承自:

只读 state : State
graphic/BaseGraphic.js 220

当前对象的状态

继承自:

只读 stopTime : Cesium.JulianDate
graphic/custom/Route.js 371

结束时间

继承自:

style : object
graphic/custom/Route.js 454

样式信息 【仅用于标绘，兼容其他graphic统一处理逻辑】

继承自:

timePoints : Array.<LngLatPoint>
graphic/custom/FixedRoute.js 110

时序位置坐标数组

只读 timeRange : object
graphic/primitive/BasePointPrimitive.js 638

获取当前时序坐标的开始时间和结束时间,返回的是Cesium.JulianDate格式

继承自:

只读 timeRangeStr : object
graphic/primitive/BasePointPrimitive.js 647

获取当前时序坐标的开始时间和结束时间,返回的是时间字符串

继承自:

只读 trackedEntity : Cesium.Entity|*
graphic/primitive/BasePointPrimitive.js 327

用于 map.trackedEntity 追踪的

继承自:

只读 type : string
graphic/BaseGraphic.js 155

矢量数据类型

继承自:

只读 uniforms : object|undefined
graphic/primitive/BasePrimitive.js 166

对应材质的uniforms（当赋有材质时）, 一个对象，它的属性被用来设置片段着色器shader。

对象属性值可以是常量或函数。这个函数将在每一帧后处理阶段执行之前被调用。

常量值也可以是图像的URI、数据URI，或者可以用作纹理的HTML元素，如HTMLImageElement或HTMLCanvasElement。

继承自:

wall : WallEntity
graphic/custom/Route.js 287

墙体 子对象

继承自:

zIndex : number
graphic/primitive/BasePrimitive.js 215

图层顺序，数字大的在上面。
只对 同类型 + 贴地(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

图层对象
返回值:

当前对象本身，可以链式调用

继承自:

autoSurfaceHeight(options) → Promise.<object>
graphic/custom/FixedRoute.js 467

计算贴地线

参数名称 类型 描述信息
options object 可选

控制参数

参数名称 类型 默认值 描述信息
splitNum number 100 可选

插值数，等比分割的个数(概略值，有经纬网网格来插值)
minDistance number 可选

插值最小间隔(单位：米)，提示：优先级高于splitNum，用于计算splitNum（非严格按这个值分割）
exact boolean false 可选

是否进行精确计算， 传false时是否快速概略计算方式，该方式计算精度较低，但计算速度快，仅能计算在当前视域内坐标的高度
has3dtiles boolean auto 可选

是否在3dtiles模型上分析（模型分析较慢，按需开启）,默认内部根据点的位置自动判断（但可能不准）
objectsToExclude Array.<object> 可选

贴模型分析时，排除的不进行贴模型计算的模型对象，可以是： primitives, entities, 或 3D Tiles features
offset number 0 可选

可以按需增加偏移高度（单位：米），便于可视
返回值:

异步计算完成的Promise

bindContextMenu(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1873

绑定右键菜单

参数名称 类型 默认值 描述信息
content Array.<object>

右键菜单配置数组，数组中每一项包括：

参数名称 类型 描述信息
text string | function 可选

菜单文字
icon string 可选

图标,可以是：图片url路径、base64字符串、svg字符串、字体图标class名
show function | boolean 可选

菜单项是否显示的回调方法
callback function 可选

菜单项单击后的回调方法
children Array.<object> 可选

当有二级子菜单时，配置数组。
options object {} 可选

控制参数

参数名称 类型 描述信息
mergeMap boolean 可选

是否合并一起显示map默认右键菜单
offsetX number 可选

用于非规则对象时，横向偏移的px像素值
offsetY number 可选

用于非规则对象时，垂直方向偏移的px像素值
返回值:

当前对象本身，可以链式调用

继承自:
使用示例:
graphic.bindContextMenu([
        {
          text: '删除对象',
          icon: 'fa fa-trash-o',
          callback: function (e) {
            let graphic = e.graphic
            if (graphic) {
              graphic.remove()
            }
          },
        },
      ])

bindHighlight(options) → void
graphic/BaseGraphic.js 1558

绑定鼠标移入或单击后的 对象高亮

参数名称 类型 描述信息
options object

高亮的样式，具体见各GraphicType矢量数据的style参数。

参数名称 类型 描述信息
type string 可选

事件类型，默认为鼠标移入高亮，也可以指定'click'单击高亮.
返回值:

无

继承自:

bindPickId(item) → BaseGraphic|*
graphic/BaseGraphic.js 727

绑定Cesium内部对象进行相关管理。

参数名称 类型 描述信息
item *

Cesium对象
返回值:

当前对象本身，可以链式调用

继承自:

bindPopup(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1647

绑定鼠标单击对象后的弹窗。

参数名称 类型 描述信息
content string | function

弹窗内容html字符串，或者回调方法。
options Popup.StyleOptions 可选

控制参数, 另外支持传入open:true自动打开
返回值:

当前对象本身，可以链式调用

继承自:

bindTooltip(content, options) → BaseGraphic|*
graphic/BaseGraphic.js 1751

绑定鼠标移入的弹窗

参数名称 类型 描述信息
content string | function

弹窗内容html字符串，或者回调方法。
options Tooltip.StyleOptions 可选

控制参数
返回值:

当前对象本身，可以链式调用

继承自:

clearTimePostion(maxCacheCount) → void
graphic/primitive/BasePointPrimitive.js 656

清除所有时序动态坐标

参数名称 类型 描述信息
maxCacheCount number 可选

保留的坐标数量，默认清除所有。
返回值:
继承自:

closeContextMenu() → BaseGraphic|*
graphic/BaseGraphic.js 1921

关闭右键菜单

返回值:

当前对象本身，可以链式调用

继承自:

closeHighlight() → void
graphic/primitive/BasePrimitive.js 1162

清除已选中的高亮，原有style的配置项需要与highlightStyle配置有一一对应关系，否则无法清除

返回值:

无

继承自:

closePopup() → BaseGraphic|*
graphic/BaseGraphic.js 1706

关闭弹窗

返回值:

当前对象本身，可以链式调用

继承自:

closeSmallTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1950

关闭小提示窗

返回值:

当前对象本身，可以链式调用

继承自:

closeTooltip() → BaseGraphic|*
graphic/BaseGraphic.js 1800

关闭弹窗

返回值:

当前对象本身，可以链式调用

继承自:

computeModelMatrix(offest) → Cesium.Matrix4|undefined
graphic/custom/Route.js 1228

获取当前矩阵

参数名称 类型 描述信息
offest object

偏移值

参数名称 类型 描述信息
x number

X轴方向偏移值,单位：米
y number

Y轴方向偏移值,单位：米
z number

Z轴方向偏移值,单位：米
返回值:

当前矩阵；未满足执行条件时可能无返回值。

继承自:

destroy(noDel) → void
core/BaseClass.js 52

销毁当前对象

参数名称 类型 默认值 描述信息
noDel boolean false 可选

false:会自动delete释放所有属性，true：不delete绑定的变量
返回值:

无

继承自:

eachChildGraphic(method, context) → Route|undefined
graphic/custom/Route.js 916

遍历所有矢量数据并将其作为参数传递给回调函数

参数名称 类型 描述信息
method function

回调方法
context object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

当前对象本身,可以链式调用；未满足执行条件时可能无返回值。

继承自:

enableControl(value) → void
graphic/BaseGraphic.js 917

启用或禁用所有内部控件（含tooltip、popup、contextmenu）

参数名称 类型 描述信息
value boolean

是否启用
返回值:

无

继承自:

endDraw() → boolean
graphic/primitive/BasePrimitive.js 1293

完成绘制和编辑，如有未完成的绘制会自动完成。 在移动端需要调用此方法来类似PC端双击结束。

返回值:

是否正常结束了矢量对象绘制

继承自:

fire(type, data, propagate) → BaseClass
core/BaseClass.js 202

触发指定类型的事件。

参数名称 类型 默认值 描述信息
type EventType | string

事件类型
data object 可选

传输的数据或对象，可在事件回调方法中event对象中获取进行使用
propagate boolean false 可选

将事件传播给父类 (用addEventParent设置)
返回值:

当前对象本身,可以链式调用

继承自:

flyTo(options) → Promise.<boolean>
graphic/BaseGraphic.js 1418

飞行定位至 数据所在的视角

参数名称 类型 默认值 描述信息
options object {} 可选

参数对象:

参数名称 类型 默认值 描述信息
radius number 可选

点状数据时，相机距离目标点的距离（单位：米）
scale number 1.2 可选

线面数据时，缩放比例，可以控制视角比矩形略大一些，这样效果更友好。
minHeight number 可选

定位时相机的最小高度值，用于控制避免异常数据
maxHeight number 可选

定位时相机的最大高度值，用于控制避免异常数据
heading number 可选

方向角度值，绕垂直于地心的轴旋转角度, 0至360, 提示：该参数仅3D视图下有效
pitch number 可选

俯仰角度值，绕纬度线旋转角度, -90至90, 提示：该参数仅3D视图下有效
roll number 可选

翻滚角度值，绕经度线旋转角度,-90至90, 提示：该参数仅3D视图下有效
duration number 可选

飞行时间（单位：秒）。如果省略，SDK内部会根据飞行距离计算出理想的飞行时间。
onBefore function 可选

飞行前对相关坐标等参数做额外的回调处理，比如目标点做自定义偏移处理。
complete Cesium.Camera.FlightCompleteCallback 可选

飞行完成后要执行的函数。
cancel Cesium.Camera.FlightCancelledCallback 可选

飞行取消时要执行的函数。
endTransform Cesium.Matrix4 可选

变换矩阵表示飞行结束时相机所处的参照系。
maximumHeight number 可选

飞行高峰时的最大高度。
pitchAdjustHeight number 可选

如果相机飞得比这个值高，在飞行过程中调整俯仰以向下看，并保持地球在视口。
flyOverLongitude number 可选

地球上的两点之间总有两条路。这个选项迫使相机选择战斗方向飞过那个经度。
flyOverLongitudeWeight number 可选

仅在通过flyOverLongitude指定的lon上空飞行，只要该方式的时间不超过flyOverLongitudeWeight的短途时间。
convert boolean true 可选

是否将目的地从世界坐标转换为场景坐标（仅在不使用3D时相关）。
easingFunction Cesium.EasingFunction.Callback 可选

控制在飞行过程中如何插值时间。
返回值:

如果飞行成功则解析为true的承诺，如果当前未在场景中可视化目标或取消飞行，则为false的Promise

继承自:

flyToPoint(options) → void
graphic/custom/Route.js 1500

定位至当前时间所在的位置 (非相机位置)

参数名称 类型 默认值 描述信息
options object {} 可选

具有以下属性的对象:

参数名称 类型 描述信息
radius number 可选

相机距离目标点的距离（单位：米）
heading number 可选

方向角度值，绕垂直于地心的轴旋转角度, 0至360
pitch number 可选

俯仰角度值，绕纬度线旋转角度, 0至360
roll number 可选

翻滚角度值，绕经度线旋转角度, 0至360
duration number 可选

飞行持续时间（秒）。如果省略，内部会根据飞行距离计算出理想的飞行时间。
endTransform Cesium.Matrix4 可选

表示飞行完成后摄像机将位于的参考帧的变换矩阵。
maximumHeight number 可选

飞行高峰时的最大高度。
pitchAdjustHeight number 可选

如果相机的飞行角度高于该值，请在飞行过程中调整俯仰角度以向下看，并将地球保持在视口中。
flyOverLongitude number 可选

地球上2点之间总是有两种方式。此选项会迫使相机选择战斗方向以在该经度上飞行。
flyOverLongitudeWeight number 可选

仅在通过flyOverLongitude指定的lon上空飞行，只要该方式的时间不超过flyOverLongitudeWeight的短途时间。
easingFunction Cesium.EasingFunction.Callback 可选

控制在飞行过程中如何插值时间。
返回值:

无

继承自:

async getAjaxAttr(funOptions) → object
graphic/BaseGraphic.js 2084

获取后端动态属性，当存在attr是动态属性配置时可用【attr.type === "ajax"】

参数名称 类型 描述信息
funOptions object 可选

参数

参数名称 类型 描述信息
merge boolean 可选

是否合并已有静态属性，优先级高于attr.merge
formatData function 可选

可以对加载的数据进行格式化或转换操作
返回值:

实时获取当前的动态属性值

继承自:

getAvailabilityJson() → Array.<object>
graphic/BaseGraphic.js 431

获取时间范围的简单对象数组（转为相对map.clock.startTime的相对数字）

返回值:

时间对象列表

继承自:

getAvailabilityShow(time) → boolean
graphic/BaseGraphic.js 444

获取指定时间下的时序对应的 显示隐藏 状态

参数名称 类型 描述信息
time Cesium.JulianDate

指定时间
返回值:

显示隐藏 状态

继承自:

getContextMenu(hasLayer) → Array.<object>|null
graphic/BaseGraphic.js 1832

获取绑定的右键菜单数组

参数名称 类型 默认值 描述信息
hasLayer boolean true 可选

是获取图层上的右键菜单
返回值:

右键菜单数组；无有效结果时可能返回null。

继承自:

getCoord(options) → Object|Array.<Array>|null
graphic/custom/Route.js 1468

获取位置坐标 (其中坐标均为经纬度形式),用于导出JSON等方法

参数名称 类型 描述信息
options object 可选

参数

参数名称 类型 描述信息
noAlt boolean 可选

true时不导出高度值
返回值:

位置坐标(经纬度数组形式)；无有效结果时可能返回null。

继承自:

getMaxHeight() → number
graphic/BaseGraphic.js 1373

获取数据的最大高度

返回值:

高度

继承自:

getPopup() → Popup
graphic/BaseGraphic.js 1717

获取当前对象打开的Popup对象

返回值:

当前对象打开的Popup对象

继承自:

getRealShow(time) → boolean
graphic/BaseGraphic.js 315

获取当前对象真实实际的显示状态

参数名称 类型 描述信息
time Cesium.JulianDate 可选

当前时间，不传时不做availability判断
返回值:

真实的实时显示状态，当时序范围外，被聚合时返回的是false

继承自:

getRectangle(options) → Cesium.Rectangle|object|undefined
graphic/custom/Route.js 1445

获取数据的矩形边界

参数名称 类型 描述信息
options boolean 可选

控制参数

参数名称 类型 默认值 描述信息
isFormat boolean false 可选

是否格式化，格式化时示例： { xmin: 73.16895, xmax: 134.86816, ymin: 12.2023, ymax: 54.11485 }
返回值:

isFormat：true时，返回格式化对象，isFormat：false时返回Cesium.Rectangle对象；未满足执行条件时可能无返回值。

继承自:

getTerrainHeight(options) → Promise.<object>
graphic/custom/FixedRoute.js 567

获取剖面数据

参数名称 类型 描述信息
options object 可选

控制参数

参数名称 类型 默认值 描述信息
splitNum number 100 可选

插值数，等比分割的个数(概略值，有经纬网网格来插值)
minDistance number 可选

插值最小间隔(单位：米)，提示：优先级高于splitNum，用于计算splitNum（非严格按这个值分割）
has3dtiles boolean auto 可选

是否在3dtiles模型上分析（模型分析较慢，按需开启）,默认内部根据点的位置自动判断（但可能不准）
objectsToExclude Array.<object> 可选

贴模型分析时，排除的不进行贴模型计算的模型对象，可以是： primitives, entities, 或 3D Tiles features
offset number 0 可选

可以按需增加偏移高度（单位：米），便于可视
返回值:

异步计算完成的Promise

getTooltip() → Tooltip
graphic/BaseGraphic.js 1811

获取当前对象打开的Tooltip对象

返回值:

当前对象打开的Tooltip对象

继承自:

hasContextMenu(hasLayer) → boolean
graphic/BaseGraphic.js 1823

是否有绑定的右键菜单

参数名称 类型 默认值 描述信息
hasLayer boolean true 可选

是否判断图层上的右键菜单
返回值:

是否有绑定

继承自:

hasEventParent(obj) → boolean
core/BaseClass.js 336

是否绑定了抛出事件到指定父类

参数名称 类型 描述信息
obj object

父类对象
返回值:

是否绑定了抛出事件

继承自:

hasPopup(hasLayer) → boolean
graphic/BaseGraphic.js 1625

是否存在Popup绑定

参数名称 类型 默认值 描述信息
hasLayer boolean true 可选

是否判断图层上的Popup
返回值:

是否存在Popup绑定

继承自:

hasTooltip(hasLayer) → boolean
graphic/BaseGraphic.js 1729

是否绑定了tooltip

参数名称 类型 默认值 描述信息
hasLayer boolean true 可选

是否判断图层上的tooltip
返回值:

是否绑定

继承自:

isInView(position, options) → boolean
graphic/BaseGraphic.js 1964

判断点坐标是否在球的背面 或当前视域屏幕内

参数名称 类型 描述信息
position Cesium.Cartesian3 可选

坐标
options object 可选

参数

参数名称 类型 默认值 描述信息
inWindow boolean false 可选

是否判断是否在屏幕内,默认不计算判断，可以按需开启
返回值:

是否在球的背面 或当前视域屏幕内

继承自:

listens(type, propagate) → boolean
core/BaseClass.js 256

是否有绑定指定的事件

参数名称 类型 默认值 描述信息
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 1906

打开右键菜单

参数名称 类型 默认值 描述信息
position Cesium.Cartesian3 this.center 可选

矢量对象 或 显示的位置
返回值:

当前对象本身，可以链式调用

继承自:

openHighlight(highlightStyle, closeLast) → void
graphic/primitive/BasePrimitive.js 1128

高亮对象。

参数名称 类型 默认值 描述信息
highlightStyle object 可选

高亮的样式，具体见各GraphicType矢量数据的style参数。
closeLast boolean true 可选

是否清除地图上上一次的高亮对象
返回值:

无

继承自:

openPopup(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1687

打开绑定的弹窗

参数名称 类型 默认值 描述信息
position LngLatPoint | Cesium.Cartesian3 | Array.<number> | * this.center 可选

矢量对象 或 显示的位置
event object 可选

用于抛出事件时的相关额外属性
返回值:

当前对象本身，可以链式调用

继承自:

openSmallTooltip(position, message) → BaseGraphic|*
graphic/BaseGraphic.js 1938

显示小提示窗，一般用于鼠标操作的提示。

参数名称 类型 描述信息
position Cesium.Cartesian2 | Cesium.Cartesian3

显示的屏幕坐标位置 或 笛卡尔坐标位置
message *

显示的内容
返回值:

当前对象本身，可以链式调用

继承自:

openTooltip(position, event) → BaseGraphic|*
graphic/BaseGraphic.js 1783

打开绑定的tooltip弹窗

参数名称 类型 默认值 描述信息
position LngLatPoint | Cesium.Cartesian3 | Array.<number> this.center 可选

显示的位置,默认为矢量对象所在点或中心点位置
event object 可选

用于抛出事件时的相关额外属性
返回值:

当前对象本身，可以链式调用

继承自:

pause() → void
graphic/custom/Route.js 1571

暂停 【针对全局时钟的，即 map.clock.shouldAnimate】

返回值:

无

继承自:

proceed() → void
graphic/custom/Route.js 1584

继续 【针对全局时钟的，即 map.clock.shouldAnimate】

返回值:

无

继承自:

redraw(style) → BasePrimitive
graphic/primitive/BasePrimitive.js 828

重新渲染

参数名称 类型 描述信息
style object 可选

新的样式信息
返回值:

当前对象本身

继承自:

remove(hasDestroy) → void
graphic/BaseGraphic.js 715

从图层上移除，同 layer.removeGraphic

参数名称 类型 默认值 描述信息
hasDestroy boolean true 可选

是否调用destroy释放
返回值:

无

继承自:

removeEventParent(obj) → BaseClass
core/BaseClass.js 322

移除抛出事件到父类

参数名称 类型 描述信息
obj object

父类对象
返回值:

当前对象本身,可以链式调用

继承自:

setCameraOptions(cameraOptions) → void
graphic/custom/Route.js 1540

更新视角模式,传入空值代表取消。

参数名称 类型 描述信息
cameraOptions object 可选

参数，包括：

参数名称 类型 默认值 描述信息
type string 可选

视角模式类型，包括：'':无、'gs':跟随视角、'dy':第一视角、'sd':上帝视角
radius number 可选

'gs'跟随视角时的 离目标的距离值（单位：米）
heading number 可选

'gs'跟随视角时的 初始方向角度值，绕垂直于地心的轴旋转角度, 0至360
pitch number 可选

'gs'跟随视角时的 初始俯仰角度值，绕纬度线旋转角度, 0至360 *
followedX number 50 可选

'dy'锁定第一视角时，距离运动点的距离（后方）
followedZ number 10 可选

'dy'锁定第一视角或'sd'上帝视角时，距离运动点的高度（上方）
返回值:

无

继承自:

setOffsetHeight(height) → void
graphic/primitive/BasePrimitive.js 511

平移指定偏移高度（相对于原始坐标值），【提示：仅部分子类支持】

参数名称 类型 描述信息
height number 可选

平移的高度值（单位：米）,为空时取每个对象的offsetHeight值
返回值:

无

继承自:

setOpacity(value) → void
graphic/primitive/BasePrimitive.js 710

设置整体透明度(globalAlpha值) , 非全部矢量数据都支持，具体需要对应Graphic支持才有效 对象本身透明度请修改 graphic.setStyle({ opacity: value })

参数名称 类型 描述信息
value number

透明度
返回值:

无

继承自:

setOptions(options, funOptions) → BaseGraphic|*
graphic/BaseGraphic.js 937

重新赋值参数，同构造方法参数一致。

参数名称 类型 描述信息
options object

参数,与类的构造方法参数相同
funOptions object 可选

方法参数

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options，请传入false
返回值:

当前对象本身，可以链式调用

继承自:

setStyle(newStyle, funOptions) → BaseGraphic|*
graphic/BaseGraphic.js 1021

设置 样式信息 的钩子方法

参数名称 类型 描述信息
newStyle object

本次更新的部分样式信息,内部会合并属性
funOptions object 可选

方法参数

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options，请传入false
返回值:

当前对象本身，可以链式调用

继承自:

start() → void
graphic/custom/FixedRoute.js 183

开始飞行漫游

返回值:

无

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

继承自:

stop() → void
graphic/custom/FixedRoute.js 253

停止飞行漫游

返回值:

无

stopDraw() → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1257

停止绘制

返回值:

无需结束绘制时返回当前对象；实际结束绘制时无返回值。

继承自:

stopEditing() → BasePrimitive|undefined
graphic/primitive/BasePrimitive.js 1454

停止编辑，释放正在编辑的对象。

返回值:

无需停止编辑时返回当前对象；实际停止编辑时无返回值。

继承自:

styleToJSON(style, styleJson) → object
graphic/BaseGraphic.js 1212

样式转换为 JSON 的扩展点。 子类可覆写本方法，或继续兼容覆写 _style2Json。

参数名称 类型 描述信息
style object

样式对象
styleJson object 可选

已有样式 JSON
返回值:

转换后的样式 JSON

继承自:

toBottom() → void
graphic/primitive/BasePrimitive.js 265

将当前矢量对象在图层中层级进行 置底 (只对同类型图层间+贴地对象 有效)。

返回值:

无

继承自:

toGeoJSON(options) → object|undefined
graphic/BaseGraphic.js 1144

将矢量数据导出为GeoJSON格式规范对象。

参数名称 类型 描述信息
options object 可选

参数对象:

参数名称 类型 描述信息
noAlt boolean 可选

不导出高度值
closure boolean 可选

是否闭合，true时增加第1个点 【仅对Polygon类型有效】
noStyle boolean 可选

不导出style样式，后期使用时在图层配置symbol
standard boolean 可选

不导出options等mars3d属性，仅导出坐标和attr属性的标准简洁GeoJSON
返回值:

GeoJSON格式规范对象；未满足执行条件时可能无返回值。

继承自:

toJSON(options) → object|undefined
graphic/BaseGraphic.js 1240

将矢量数据的坐标、样式及属性等信息导出为对象，可以用于存储。

参数名称 类型 描述信息
options object 可选

参数对象:

参数名称 类型 描述信息
noAlt boolean 可选

不导出高度值
toNum boolean 可选

坐标是time时序坐标时，time值是否转为数字秒数
返回值:

导出的坐标、样式及属性等信息；未满足执行条件时可能无返回值。

继承自:

toJSONEx(json, options) → object
graphic/BaseGraphic.js 1226

导出 JSON 的扩展点。 子类可覆写本方法，或继续兼容覆写 _toJSON_Ex。

参数名称 类型 描述信息
json object

待导出的 JSON 对象
options object 可选

导出参数
返回值:

传入的 JSON 对象

继承自:

toTop() → void
graphic/primitive/BasePrimitive.js 254

将当前矢量对象在图层中层级进行 置顶 (只对同类型图层间+贴地对象 有效)。

返回值:

无

继承自:

unbindContextMenu(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1891

解除绑定的右键菜单

参数名称 类型 默认值 描述信息
bubbling boolean false 可选

单击事件中是否继续冒泡查找
返回值:

当前对象本身，可以链式调用

继承自:

unbindHighlight() → void
graphic/BaseGraphic.js 1575

解绑鼠标移入或单击后的高亮处理

返回值:

无

继承自:

unbindPopup(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1669

解除绑定的鼠标单击对象后的弹窗。

参数名称 类型 默认值 描述信息
bubbling boolean false 可选

单击事件中是否继续冒泡往上级查找
返回值:

当前对象本身，可以链式调用

继承自:

unbindTooltip(bubbling) → BaseGraphic|*
graphic/BaseGraphic.js 1767

解除绑定的鼠标移入对象后的弹窗。

参数名称 类型 默认值 描述信息
bubbling boolean false 可选

单击事件中是否继续冒泡查找
返回值:

当前对象本身，可以链式调用

继承自:
下载离线API文档