CanvasLabelEntity
查阅Cesium API

new mars3d.graphic.CanvasLabelEntity(options)
graphic/entity/CanvasLabelEntity.js 74

Canvas 文本点（label转图片）

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

参数对象，包括以下：

参数名称 类型 默认值 描述信息
position LngLatPoint | Cesium.Cartesian3 | Cesium.PositionProperty | BaseGraphic.AjaxPosition | BaseGraphic.TimePosition | Array.<number> | string 可选

坐标位置
style CanvasLabelEntity.StyleOptions

样式信息
attr object | BaseGraphic.AjaxAttr 可选

附件的属性信息，可以任意附加属性，导出geojson或json时会自动处理导出。
availability Cesium.TimeIntervalCollection | Cesium.TimeInterval | Array | object 可选

指定时间范围内显示该对象
description Cesium.Property | string 可选

指定此实体的HTML描述的字符串属性（infoBox中展示）。
viewFrom Cesium.Property 可选

观察这个物体时建议的初始偏移量。
parent Cesium.Entity 可选

要与此实体关联的父实体。
onBeforeCreate function 可选

在 new Cesium.Entity(addattr) 前的回调方法，可以对addattr做额外个性化处理。
drawShow boolean true 可选

绘制时，是否自动隐藏entity，可避免拾取坐标存在问题。
hasEdit boolean true 可选

是否允许编辑
hasEditContextMenu boolean true 可选

编辑时，是否绑定右键编辑菜单
hasEditRevoke boolean true 可选

编辑时，是否记录编辑步骤中坐标记录，用于还原或撤销编辑
matrixMove MatrixMove.Options 可选

右键菜单中，按轴平移时，传入给MatrixMove对象的构造参数
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方法参数。 @extends {BasePointEntity}
参考:

继承自

属性值

allowDrillPick : boolean|function
graphic/BaseGraphic.js 573

是否允许鼠标穿透拾取

继承自:

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

属性信息

继承自:

availability : Cesium.TimeIntervalCollection
graphic/BaseGraphic.js 394

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

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

只读 center : Cesium.Cartesian3
graphic/entity/BasePointEntity.js 191

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

继承自:

只读 centerPoint : LngLatPoint
graphic/entity/BasePointEntity.js 208

中心点坐标

继承自:

只读 coord
graphic/BaseGraphic.js 557

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

继承自:

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

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

继承自:

只读 dataSource : Cesium.CustomDataSource
graphic/entity/BaseEntity.js 54

加载Entity数据的内部Cesium容器

继承自:

debugAxis : boolean
graphic/entity/BasePointEntity.js 295

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

继承自:

debugAxisLength : number
graphic/entity/BasePointEntity.js 332

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

继承自:

只读 EditClass : EditPoint
graphic/entity/BasePointEntity.js 89

编辑处理类

继承自:

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

当前地图的ellipsoid

继承自:

enabledEvent : boolean
graphic/BaseGraphic.js 603

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

继承自:

只读 entity : Cesium.Entity
graphic/entity/BaseEntity.js 81

矢量数据对应的 Cesium内部对象

继承自:

只读 entityGraphic : Cesium.BillboardGraphics
graphic/entity/BillboardEntity.js 133

矢量数据对应的 Cesium内部对象的具体类型对象

继承自:

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

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

继承自:

只读 hasAjaxAttr : boolean
graphic/BaseGraphic.js 2005

是否 后端动态属性

继承自:

只读 hasAjaxPostion : boolean
graphic/entity/BasePointEntity.js 475

是否 ajax后端动态坐标

继承自:

只读 hasCluster : boolean
graphic/BaseGraphic.js 313

是否支持聚合

继承自:

hasEdit : boolean
graphic/BaseGraphic.js 585

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

继承自:

只读 hasMoveEdit : boolean
graphic/entity/BaseEntity.js 130

编辑时，是否可以整体平移

继承自:

只读 hasOpacity : boolean
graphic/BaseGraphic.js 637

是否可以调整透明度

继承自:

只读 hasTimePostion : boolean
graphic/entity/BasePointEntity.js 484

是否 time时序动态坐标

继承自:

heading : number
graphic/entity/BasePointEntity.js 230

四周方向角，0-360度角度值

继承自:

height : number
graphic/entity/BasePointEntity.js 269

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

继承自:

只读 id : string|number
graphic/BaseGraphic.js 175

对象的id标识

继承自:

image : string|HTMLCanvasElement
graphic/entity/BillboardEntity.js 141

图像、URI或Canvas

继承自:

只读 isAdded : boolean
graphic/BaseGraphic.js 212

是否已添加到图层

继承自:

只读 isCluster : boolean
graphic/BaseGraphic.js 322

是否被聚合

继承自:

只读 isDestroy : boolean
graphic/BaseGraphic.js 222

是否已经销毁了

继承自:

只读 isDrawing : boolean
graphic/entity/BaseEntity.js 1004

是否正在绘制状态

继承自:

只读 isEditing : boolean
graphic/entity/BaseEntity.js 121

是否正在编辑状态

继承自:

只读 isPoint : boolean
graphic/BaseGraphic.js 166

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

继承自:

只读 isPrivate : boolean
graphic/BaseGraphic.js 231

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

继承自:

只读 label : Cesium.Label|Cesium.LabelGraphics
graphic/entity/BaseEntity.js 100

附加的label文本对象

继承自:

只读 lastDrawPoint : boolean
graphic/entity/BaseEntity.js 139

正在绘制的最后一个正式点

继承自:

只读 modelMatrix : Cesium.Matrix4
graphic/entity/BasePointEntity.js 283

获取当前转换计算模型矩阵。如果方向或位置未定义，则返回undefined。

继承自:

name : string
graphic/BaseGraphic.js 520

名称

继承自:

objectsToExclude : Array.<object>|undefined
graphic/entity/BasePointEntity.js 351

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

继承自:

只读 options : object
core/BaseClass.js 18

当前类的构造参数

继承自:

只读 orientation : Cesium.Quaternion
graphic/entity/BasePointEntity.js 217

三维空间中的旋转。

继承自:

pid : string|number
graphic/BaseGraphic.js 188

对象的pid标识

继承自:

pitch : number
graphic/entity/BasePointEntity.js 243

俯仰角，上下摇摆的角度，0-360度角度值

继承自:

只读 point : LngLatPoint
graphic/entity/BasePointEntity.js 179

位置坐标

继承自:

position : Cesium.Cartesian3|LngLatPoint|BaseGraphic.AjaxPosition|BaseGraphic.TimePosition
graphic/entity/BasePointEntity.js 97

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

继承自:

只读 positionShow : Cesium.Cartesian3
graphic/entity/BasePointEntity.js 170

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

继承自:

只读 property : Cesium.SampledPositionProperty
graphic/entity/BasePointEntity.js 540

时序动态坐标对象

继承自:

roll : number
graphic/entity/BasePointEntity.js 256

滚转角，左右摆动的角度，0-360度角度值

继承自:

show : boolean
graphic/BaseGraphic.js 259

显示隐藏状态（属性值）

继承自:

只读 state : State
graphic/BaseGraphic.js 202

当前对象的状态

继承自:

style : object
graphic/BaseGraphic.js 545

样式信息

继承自:

只读 timeRange : object
graphic/entity/BasePointEntity.js 493

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

继承自:

只读 timeRangeStr : object
graphic/entity/BasePointEntity.js 502

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

继承自:

只读 type : string
graphic/BaseGraphic.js 154

矢量数据类型

继承自:

方法

addEventParent(obj) → BaseClass
core/BaseClass.js 307

添加抛出事件到父类，它将接收传播的事件

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

父类对象
返回值:

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

继承自:

addTimePosition(point, currTime) → BasePointEntity
graphic/entity/BasePointEntity.js 596

设置并添加动画轨迹位置，按“指定时间”运动到达“指定位置”。【仅文本、图标点、模型等部分子类支持】

参数名称 类型 描述信息
point LngLatPoint | Cesium.Cartesian3 | Array.<number>

指定位置坐标
currTime Cesium.JulianDate | Date | string | number 可选

指定时间, 默认为当前时间。当为String时，可以传入'2021-01-01 12:13:00'; 当为Number时，可以传入当前时间延迟的秒数。
返回值:

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

继承自:

addTo(layer) → BaseGraphic|*
graphic/BaseGraphic.js 676

添加到图层上，同 layer.addGraphic

参数名称 类型 描述信息
layer GraphicLayer

图层对象
返回值:

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

继承自:

autoSurfaceHeight(options) → Promise.<object>
graphic/entity/BasePointEntity.js 697

异步计算更新坐标高度进行贴地(或贴模型)，内部自动调用PointUtil#getSurfaceHeight方法处理。

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

参数对象:

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

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

贴模型分析时，排除的不进行贴模型计算的模型对象，可以是： primitives, entities, 或 3D Tiles features
返回值:

异步计算完成的Promise

继承自:

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

绑定右键菜单

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

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

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

菜单文字
icon string 可选

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

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

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

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

控制参数

参数名称 类型 描述信息
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 1497

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

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

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

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

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

无

继承自:

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

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

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

Cesium对象
返回值:

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

继承自:

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

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

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

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

控制参数
返回值:

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

继承自:

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

绑定鼠标移入的弹窗

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

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

控制参数
返回值:

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

继承自:

clearTimePostion(maxCacheCount) → void
graphic/entity/BasePointEntity.js 511

清除所有时序动态坐标

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

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

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

关闭右键菜单

返回值:

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

继承自:

closeHighlight() → void
graphic/entity/BaseEntity.js 432

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

返回值:

无

继承自:

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

关闭弹窗

返回值:

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

继承自:

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

关闭小提示窗

返回值:

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

继承自:

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

关闭弹窗

返回值:

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

继承自:

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

销毁当前对象

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

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

无

继承自:

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

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

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

是否启用
返回值:

无

继承自:

endDraw() → boolean
graphic/entity/BaseEntity.js 1319

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

返回值:

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

继承自:

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

触发指定类型的事件。

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

事件类型
data object 可选

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

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

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

继承自:

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

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

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

参数对象:

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

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

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

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

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

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

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

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

飞行时间（单位：秒）。如果省略，SDK内部会根据飞行距离计算出理想的飞行时间。
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

继承自:

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

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

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

参数

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

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

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

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

继承自:

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

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

返回值:

时间对象列表

继承自:

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

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

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

指定时间
返回值:

显示隐藏 状态

继承自:

getContextMenu(hasLayer) → Array.<object>
graphic/BaseGraphic.js 1765

获取绑定的右键菜单数组

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

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

右键菜单数组

继承自:

getCoord(options) → Object|Array.<Array>
graphic/BaseGraphic.js 1055

获取位置坐标 (其中坐标均为经纬度形式),用于导出JSON等方法 示例： [113.123456,31.123456,30.1] 或 [ [123.123456,32.654321,198.7], [111.123456,22.654321,50.7] ]

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

参数

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

是否导出ajax、time等type类型的坐标
toNum boolean 可选

坐标是time时序坐标时，time值是否转为数字秒数
noAlt boolean 可选

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

位置坐标(经纬度数组形式)

继承自:

getMaxHeight() → number
graphic/BaseGraphic.js 1313

获取数据的最大高度

返回值:

高度

继承自:

getPopup() → Popup
graphic/BaseGraphic.js 1650

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

返回值:

当前对象打开的Popup对象

继承自:

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

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

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

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

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

继承自:

getRectangle(options) → Cesium.Rectangle|object
graphic/BaseGraphic.js 1282

获取数据的矩形边界

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

控制参数

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

是否格式化，格式化时示例： { xmin: 73.16895, xmax: 134.86816, ymin: 12.2023, ymax: 54.11485 }
onePoint boolean true 可选

一个点位时是否返回边界值
返回值:

isFormat：true时，返回格式化对象，isFormat：false时返回Cesium.Rectangle对象

继承自:

getTooltip() → Tooltip
graphic/BaseGraphic.js 1744

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

返回值:

当前对象打开的Tooltip对象

继承自:

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

是否有绑定的右键菜单

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

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

是否有绑定

继承自:

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

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

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

父类对象
返回值:

是否绑定了抛出事件

继承自:

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

是否存在Popup绑定

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

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

是否存在Popup绑定

继承自:

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

是否绑定了tooltip

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

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

是否绑定

继承自:

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

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

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

坐标
options object 可选

参数

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

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

是否后端动态坐标

继承自:

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

是否有绑定指定的事件

参数名称 类型 描述信息
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 1838

打开右键菜单

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

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

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

继承自:

openHighlight(highlightStyle, closeLast) → void
graphic/entity/BaseEntity.js 395

高亮对象。

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

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

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

无

继承自:

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

打开绑定的弹窗

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

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

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

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

继承自:

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

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

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

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

显示的内容
返回值:

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

继承自:

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

打开绑定的tooltip弹窗

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

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

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

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

继承自:

redraw() → void
graphic/entity/BaseEntity.js 159

重新渲染对象

返回值:

无

继承自:

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

从图层上移除，同 layer.removeGraphic

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

是否调用destroy释放
返回值:

无

继承自:

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

移除抛出事件到父类

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

父类对象
返回值:

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

继承自:

removeNearPoint() → void
graphic/entity/BaseEntity.js 1296

移除绘制的坐标中的重复点，比如快速单击或双击产生的冗余坐标。

返回值:

无

继承自:

setCallbackPosition(position) → Cesium.Cartesian3
graphic/entity/BasePointEntity.js 714

按Cesium.CallbackProperty的方式 更新坐标（更加平滑）

参数名称 类型 描述信息
position string | Array | object | Cesium.Cartesian3 | * 可选

坐标
返回值:

当前坐标

继承自:

setOpacity(value) → void
graphic/entity/BillboardEntity.js 351

设置整体透明度(globalAlpha值), 不是所有类型均支持，主要看数据类型和材质类型决定。 对象本身透明度请用 graphic.setStyle({ opacity: value })

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

透明度
返回值:

无

继承自:

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

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

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

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

方法参数

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

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

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

继承自:

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

设置 样式信息 的钩子方法

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

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

方法参数

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

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

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

继承自:

startBounce(options) → void
graphic/entity/BillboardEntity.js 369

开始执行弹跳动画

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

参数，包括

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

弹跳的最大高度, 单位：像素
step number 1 可选

弹跳增量, 控制速度，单位：像素
autoStop boolean 可选

是否自动停止，true时：会逐渐减弱至停止状态
返回值:

无

继承自:

startDraw(layer) → void
graphic/entity/BaseEntity.js 1014

开始绘制矢量数据，绘制的数据会加载在layer图层。

参数名称 类型 描述信息
layer GraphicLayer

图层
返回值:

无

继承自:

startEditing() → void
graphic/entity/BaseEntity.js 1341

开始编辑对象

返回值:

无

继承自:

startFlicker(options) → FlickerEntity
graphic/entity/BaseEntity.js 974

高亮闪烁 Enity实体对象

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

参数

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

闪烁的总时长(秒)，未设置时不自动停止。
step number 10 可选

闪烁增量, 控制速度
color Cesium.Color | string 可选

高亮的颜色
maxAlpha number 0.3 可选

闪烁的最大透明度，从 0 到 maxAlpha 渐变
onEnd function 可选

播放完成后的回调方法
返回值:

高亮闪烁控制 对象

继承自:

stopBounce() → void
graphic/entity/BillboardEntity.js 421

停止弹跳动画

返回值:

无

继承自:

stopDraw() → void
graphic/entity/BaseEntity.js 1049

停止绘制

返回值:

无

继承自:

stopEditing() → void
graphic/entity/BaseEntity.js 1401

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

返回值:

无

继承自:

stopFlicker() → void
graphic/entity/BaseEntity.js 990

停止高亮闪烁

返回值:

无

继承自:

toGeoJSON(options) → object
graphic/BaseGraphic.js 1106

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

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

参数对象:

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

不导出高度值
noStyle boolean 可选

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

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

GeoJSON格式规范对象

继承自:

toJSON(options) → object
graphic/BaseGraphic.js 1176

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

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

参数对象:

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

不导出高度值
toNum boolean 可选

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

导出的坐标、样式及属性等信息

继承自:

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

解除绑定的右键菜单

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

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

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

继承自:

unbindHighlight() → void
graphic/BaseGraphic.js 1514

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

返回值:

无

继承自:

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

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

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

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

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

继承自:

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

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

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

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

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

继承自:

updateOrientation() → Cesium.Quaternion
graphic/entity/BasePointEntity.js 400

更新 三维空间中的Quaternion旋转对象。

返回值:

更新后的Quaternion旋转对象

继承自:

定义的类型

mars3d.graphic.CanvasLabelEntity.StyleOptions
graphic/entity/CanvasLabelEntity.js 7

Canvas 文本点（label转图片） 支持的样式信息

属性:
属性名称 类型 可选 默认值 描述信息
text string <可选>
 "文字"

文本内容
scale number <可选>
 1.0

指定缩放比例。
horizontalOrigin Cesium.HorizontalOrigin <可选>

横向方向的定位
verticalOrigin Cesium.VerticalOrigin <可选>

垂直方向的定位
spacing number <可选>

字间距
font_family string <可选>
 "楷体"

字体 ,可选项：微软雅黑,宋体,楷体,隶书,黑体 等
font_size number <可选>
 18

字体大小，单位：像素
font_weight string <可选>
 "normal"

是否加粗 ,可选项：bold (解释：是),normal (解释：否),
font_style string <可选>
 "normal"

是否斜体 ,可选项：italic (解释：是),normal (解释：否),
font string <可选>
 '30px normal normal 楷体'

上叙4个属性的一次性指定CSS字体的属性。
fill boolean <可选>
 true

是否填充
color string | Cesium.Color <可选>
 "#ffffff"

文本颜色
opacity number <可选>
 1.0

透明度，取值范围：0.0-1.0
stroke boolean <可选>
 false

是否衬色
strokeColor string | Cesium.Color <可选>
 "#000000"

衬色颜色
strokeWidth number <可选>
 2

衬色宽度
outline boolean <可选>
 false

是否矩形边框
outlineColor string | Cesium.Color <可选>
 "#000000"

矩形边框的颜色。
outlineWidth number <可选>
 4

边框的宽度
background boolean <可选>
 false

是否背景
backgroundColor string | Cesium.Color <可选>
 "#000000"

背景颜色
backgroundPadding number <可选>
 0

背景内边距，指定文字与填充边界内容之间的空间(以像素为单位)。
hasPixelOffset boolean <可选>
 false

是否存在偏移量
pixelOffsetX number <可选>
 0

横向偏移像素
pixelOffsetY number <可选>
 0

纵向偏移像素
pixelOffset Cesium.Cartesian2 | Array.<number> <可选>
 Cartesian2.ZERO

指定像素偏移量。
scaleByDistance boolean | Cesium.NearFarScalar <可选>
 false

是否按视距缩放 或 设定基于与相机的距离设置比例。
scaleByDistance_far number <可选>
 1000000

上限
scaleByDistance_farValue number <可选>
 0.1

比例值
scaleByDistance_near number <可选>
 1000

下限
scaleByDistance_nearValue number <可选>
 1

比例值
distanceDisplayCondition boolean | Cesium.DistanceDisplayCondition <可选>
 false

是否按视距显示 或 指定此框将显示在与摄像机的多大距离。
distanceDisplayCondition_far number <可选>
 Number.MAX_VALUE

最大距离
distanceDisplayCondition_near number <可选>
 0

最小距离
clampToGround boolean <可选>
 false

是否贴地
heightReference Cesium.HeightReference <可选>
 Cesium.HeightReference.NONE

指定高度相对于什么的属性。
visibleDepth boolean <可选>
 true

是否被遮挡
disableDepthTestDistance number <可选>

指定从相机到禁用深度测试的距离。
translucencyByDistance Cesium.NearFarScalar <可选>

用于基于与相机的距离设置半透明度。
setHeight number | string <可选>

指定坐标高度值（对编辑时无效，仅初始化传入有效，常用于图层中配置）,也支持字符串模版配置
addHeight number | string <可选>

在现有坐标基础上增加的高度值（对编辑时无效，仅初始化传入有效，常用于图层中配置）,也支持字符串模版配置
highlight CanvasLabelEntity.StyleOptions <可选>

鼠标移入或单击(type:'click')后的对应高亮的部分样式，提示：原有style的配置项需要与highlightStyle配置有一一对应关系，否则无法清除 // * @param {string} [highlight.type] 事件方式，鼠标移入高亮 或 单击高亮(type:'click') // * @param {boolean} [highlight.enabled=true] 是否启用
参考:
  • Cesium.LabelGraphics.ConstructorOptions
下载离线API文档