KmlLayer
查阅Cesium API

new mars3d.layer.KmlLayer(options)
layer/czmFileLayer/KmlLayer.js 7

KML数据图层

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

参数对象，包括以下：

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

KML文件或服务url地址
data Document | Blob 可选

已解析的KML文档或包含二进制KMZ数据或已解析的KML文档的Blob，与url二选一即可。
zIndex number 可选

控制图层的叠加层次（部分图层），默认按加载的顺序进行叠加，但也可以自定义叠加顺序，数字大的在上面。
opacity number 1.0 可选

透明度（部分图层），取值范围：0.0-1.0
symbol object 可选

矢量数据的style样式

参数名称 类型 描述信息
styleOptions BillboardEntity.StyleOptions | PolylineEntity.StyleOptions | PolygonEntity.StyleOptions | *

数据的Style样式
styleField string 可选

按 styleField 属性设置不同样式。
styleFieldOptions object 可选

按styleField值与对应style样式的键值对象。默认与styleOptions合并，可以设置merge:false不合并
callback function 可选

自定义判断处理返回style ，示例：callback: function (attr, entity, styleOpt){ return { color: "#ff0000" }; }
popup string | Array.<Globe.getTemplateHtml_template> | function 可选

绑定的popup弹窗值，也可以bindPopup方法绑定，支持：'all'、数组、字符串模板
popupOptions Popup.StyleOptions 可选

popup弹窗时的配置参数，也支持如pointerEvents等Popup构造参数,还包括：

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

固定的标题名称
titleField string 可选

标题对应的属性字段名称
noTitle string 可选

不显示标题
showNull string false 可选

是否显示空值
tooltip string | Array.<Globe.getTemplateHtml_template> | function | object 可选

绑定的tooltip弹窗值，也可以bindTooltip方法绑定，参数与popup属性完全相同。
tooltipOptions Tooltip.StyleOptions 可选

tooltip弹窗时的配置参数，也支持如pointerEvents等Tooltip构造参数,还包括：

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

固定的标题名称
titleField string 可选

标题对应的属性字段名称
noTitle string 可选

不显示标题
showNull string false 可选

是否显示空值
contextmenuItems object 可选

绑定的右键菜单值，也可以bindContextMenu方法绑定
id string | number mars3d.Util.createGuid() 可选

图层id标识
pid string | number 可选

图层父级的id，一般图层管理中使用
name string 可选

图层名称
show boolean true 可选

图层是否显示
eventParent BaseClass | boolean 可选

指定的事件冒泡对象，默认为map对象，false时不冒泡
center object 可选

图层自定义定位视角 Map#setCameraView

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

经度值, -180至180
lat number

纬度值, -90至90
alt number 可选

高度值
heading number 可选

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

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

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

图层自定义定位的矩形区域，与center二选一即可。 Map#flyToExtent

参数名称 类型 默认值 描述信息
xmin number

最小经度值, -180 至 180
xmax number

最大经度值, -180 至 180
ymin number

最小纬度值, -90 至 90
ymax number

最大纬度值, -90 至 90
height number 0 可选

矩形高度值
flyTo boolean 可选

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

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

继承自

属性值

availability : Cesium.TimeIntervalCollection
layer/BaseLayer.js 326

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

继承自:
使用示例:
// 普通传值方式，多个【建议】
layer.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）
layer.availability = [
  { start: 0, stop: 10, isStartIncluded: true, isStopIncluded: false },
  { start:30, duration: 10 } //支持不配置stop，直接配置duration秒数时长
]

// 普通传值方式，单个
layer.availability = { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false }


// cesium原生写法, 多个
layer.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原生写法,单个
layer.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,
  isStopIncluded: false
})

只读 clampToGround : boolean
layer/czmFileLayer/CzmGeoJsonLayer.js 194

是否贴地

继承自:

只读 entities : Cesium.EntityCollection
layer/czmFileLayer/CzmGeoJsonLayer.js 122

Entity矢量数据 集合

继承自:

只读 hasOpacity : boolean
layer/BaseLayer.js 262

是否可以调整透明度

继承自:

只读 hasZIndex : boolean
layer/czmFileLayer/CzmGeoJsonLayer.js 151

是否可以调整图层顺序（在同类型图层间）

继承自:

id : string|number
layer/BaseLayer.js 90

对象的id标识

继承自:

只读 isAdded : boolean
layer/BaseLayer.js 151

是否已添加到地图

继承自:

只读 isDestroy : boolean
layer/BaseLayer.js 161

是否已经销毁了

继承自:

只读 isPrivate : boolean
layer/BaseLayer.js 170

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

继承自:

只读 labelCollection : Cesium.LabelCollection
layer/czmFileLayer/CzmGeoJsonLayer.js 135

当存在 文字primitive 数据的内部Cesium容器

继承自:

只读 layer : Cesium.GeoJsonDataSource
layer/czmFileLayer/CzmGeoJsonLayer.js 113

GeoJsonDataSource 对象

继承自:

name : string
layer/BaseLayer.js 103

名称

继承自:

opacity : number
layer/BaseLayer.js 274

透明度，取值范围：0.0-1.0

继承自:

pid : string|number
layer/BaseLayer.js 116

对象的pid标识

继承自:

只读 readyPromise : Promise.<(BaseLayer|object)>
layer/BaseLayer.js 186

获取图层完成解析加载完成的Promise承诺, 等价于load事件(区别在于load事件必须在load完成前绑定才能监听)。

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

show : boolean
layer/BaseLayer.js 199

显示隐藏状态

继承自:

只读 state : State
layer/BaseLayer.js 141

当前对象的状态

继承自:

只读 type : string
layer/BaseLayer.js 130

图层类型

继承自:

zIndex : number
layer/czmFileLayer/CzmGeoJsonLayer.js 159

图层顺序，数字大的在上面。（当hasZIndex为true时）

继承自:

方法

addTo(map) → BaseLayer
layer/BaseLayer.js 429

添加到地图上，同 map.addThing

参数名称 类型 描述信息
map Map

地图对象
返回值:

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

继承自:

bindContextMenu(content, options) → BaseGraphicLayer
layer/BaseGraphicLayer.js 459

绑定右键菜单

参数名称 类型 默认值 描述信息
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像素值
返回值:

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

继承自:
使用示例:
//在layer上绑定右键菜单
      graphicLayer.bindContextMenu([
        {
          text: '删除对象',
          icon: 'fa fa-trash-o',
          callback: function (e) {
            let graphic = e.graphic
            if (graphic) {
              graphicLayer.removeGraphic(graphic)
            }
          },
        },
        {
          text: '计算长度',
          icon: 'fa fa-medium',
          show: function (e) {
            let graphic = e.graphic
            return graphic.type === 'polyline'
          },
          callback: function (e) {
            let graphic = e.graphic
            let strDis = mars3d.MeasureUtil.formatDistance(graphic.distance)
            alert('该对象的长度为:' + strDis)
          },
        },
      ])

bindHighlight(options) → void
layer/BaseGraphicLayer.js 139

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

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

参数：

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

事件类型，默认为鼠标移入高亮，也可以指定'click'单击高亮。
多个参数 string 可选

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

无

继承自:

bindPopup(content, options) → BaseGraphicLayer
layer/BaseGraphicLayer.js 246

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

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

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

控制参数
返回值:

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

继承自:

bindTooltip(content, options) → BaseGraphicLayer
layer/BaseGraphicLayer.js 327

绑定鼠标移入的弹窗

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

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

控制参数
返回值:

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

继承自:

clear() → CzmGeoJsonLayer
layer/czmFileLayer/CzmGeoJsonLayer.js 572

清除所有数据

返回值:

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

继承自:

closeContextMenu() → BaseGraphicLayer
layer/BaseGraphicLayer.js 507

关闭右键菜单

返回值:

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

继承自:

closeHighlight() → void
layer/czmFileLayer/CzmGeoJsonLayer.js 711

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

返回值:

无

继承自:

closePopup() → BaseGraphicLayer
layer/BaseGraphicLayer.js 291

关闭弹窗

返回值:

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

继承自:

closeSmallTooltip() → BaseGraphicLayer
layer/BaseGraphicLayer.js 536

关闭小提示窗

返回值:

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

继承自:

closeTooltip() → BaseGraphicLayer
layer/BaseGraphicLayer.js 376

关闭弹窗

返回值:

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

继承自:

async flyTo(options) → Promise.<boolean>
layer/BaseLayer.js 630

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

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

参数对象:

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

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

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

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

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

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

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

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

矩形区域时的高度值, 默认取地形高度值
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

继承自:

getAvailabilityJson() → Array.<object>
layer/BaseLayer.js 350

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

返回值:

时间对象列表

继承自:

getAvailabilityShow(time) → boolean
layer/BaseLayer.js 360

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

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

指定时间
返回值:

显示隐藏 状态

继承自:

getContextMenu() → Array.<object>
layer/BaseGraphicLayer.js 410

获取绑定的右键菜单数组

返回值:

右键菜单数组

继承自:

getEntityAttr(entity) → object
layer/czmFileLayer/KmlLayer.js 117

获取Entity矢量对象上绑定的 数据

参数名称 类型 描述信息
entity Cesium.Entity

Entity矢量对象
返回值:

数据

继承自:

getEntityById(id) → Cesium.Entity|*
layer/czmFileLayer/CzmGeoJsonLayer.js 412

根据id取矢量数据对象

参数名称 类型 描述信息
id string | number

矢量数据id
返回值:

矢量数据对象

继承自:

getRealShow(time) → boolean
layer/BaseLayer.js 245

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

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

当前时间
返回值:

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

继承自:

getRectangle(options) → Cesium.Rectangle|object
layer/czmFileLayer/CzmGeoJsonLayer.js 609

获取图层内所有数据的 矩形边界值

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

控制参数

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

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

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

继承自:

hasContextMenu() → boolean
layer/BaseGraphicLayer.js 389

是否有绑定的右键菜单

返回值:

是否有绑定

继承自:

hasPopup() → boolean
layer/BaseGraphicLayer.js 222

是否存在Popup绑定，判断图层及内部所有矢量数据

返回值:

是否存在Popup绑定

继承自:

hasTooltip() → boolean
layer/BaseGraphicLayer.js 304

是否绑定了tooltip

返回值:

是否绑定

继承自:

lblAddFun(position, labelattr, attr) → Cesium.Label
layer/czmFileLayer/CzmGeoJsonLayer.js 460

添加label文本注记

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

坐标位置
labelattr object

label文本的属性
attr object

属性信息
返回值:

label文本对象

继承自:

load(newOptions) → KmlLayer
layer/czmFileLayer/KmlLayer.js 82

加载新数据 或 刷新数据

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

新设定的参数，会与类的构造参数合并。

参数名称 类型 描述信息
data Document | Blob 可选

已解析的KML文档或包含二进制KMZ数据或已解析的KML文档的Blob，与url二选一即可。
url string 可选

KML文件或服务url地址
options.proxy string 可选

加载资源时要使用的代理服务url。
options.queryParameters object 可选

一个对象，其中包含在检索资源时将发送的查询参数。比如：queryParameters: {'access_token': '123-435-456-000'}
options.headers object 可选

一个对象，将发送的其他HTTP标头。比如：headers: { 'X-My-Header': 'valueOfHeader' }
newOptions.类参数 object 可选

包含当前类支持的所有参数
返回值:

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

继承自:

openContextMenu(position) → BaseGraphicLayer
layer/BaseGraphicLayer.js 491

打开右键菜单

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

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

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

继承自:

openHighlight(highlightStyle, closeLast, pickedObject) → void
layer/czmFileLayer/CzmGeoJsonLayer.js 686

高亮对象。 提示：该方法不支持 outlineEffect: true 高亮，因为outlineEffect需要鼠标拾取构件。

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

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

是否清除地图上上一次的高亮对象
pickedObject Cesium.Entity 可选

需要高亮的entity, 如果是mars3d的相关事件内时，可以取 event.pickedObject
返回值:

无

继承自:

openPopup(position) → BaseGraphicLayer
layer/BaseGraphicLayer.js 277

打开绑定的弹窗

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

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

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

继承自:

openSmallTooltip(position, message) → BaseGraphicLayer
layer/BaseGraphicLayer.js 524

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

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

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

显示的内容
返回值:

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

继承自:

openTooltip(position) → BaseGraphicLayer
layer/BaseGraphicLayer.js 360

打开绑定的tooltip弹窗

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

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

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

继承自:

process(diejiaData, options) → Promise.<object>
layer/czmFileLayer/CzmGeoJsonLayer.js 592

追加数据，处理提供的url或数据对象，而不清除任何现有数据。

参数名称 类型 描述信息
diejiaData Cesium.Resource | string | object

要处理的url或对象。
options object 可选

控制参数
返回值:

加载完成后的回调方法的Promise

继承自:

remove(destroy) → void
layer/BaseLayer.js 442

从地图上移除，同map.removeThing

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

是否调用destroy释放
返回值:

无

继承自:

setOpacity(value) → void
layer/czmFileLayer/CzmGeoJsonLayer.js 496

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

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

透明度
返回值:

无

继承自:

setOptions(options, funOptions) → BaseLayer
layer/BaseLayer.js 669

更新图层参数

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

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

方法参数

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

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

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

继承自:

toJSON(options) → object
layer/BaseLayer.js 710

将图层转为Json简单对象，用于存储后再传参加载

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

参数对象:

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

（tileset模型时）导出冗余的完整参数，包含完整position、transform等信息。
noAlt boolean 可选

(矢量图层中)不导出高度值
toNum boolean 可选

(矢量图层中)坐标是time时序坐标时，time值是否转为数字秒数
stopEdit boolean false 可选

(矢量图层中)是否停止绘制或编辑
返回值:

Json简单对象

继承自:

unbindContextMenu(bubbling) → BaseGraphicLayer
layer/BaseGraphicLayer.js 474

解除绑定的右键菜单

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

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

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

继承自:

unbindHighlight() → void
layer/BaseGraphicLayer.js 156

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

返回值:

无

继承自:

unbindPopup(bubbling) → BaseGraphicLayer
layer/BaseGraphicLayer.js 261

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

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

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

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

继承自:

unbindTooltip(bubbling) → BaseGraphicLayer
layer/BaseGraphicLayer.js 343

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

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

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

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

继承自:

updateStyle(symbol) → CzmGeoJsonLayer
layer/czmFileLayer/CzmGeoJsonLayer.js 431

加载新数据 或 刷新数据

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

设置新的symbol 矢量数据样式. GraphicType

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

Style样式，每种不同类型数据都有不同的样式，具体见各矢量数据的style参数。GraphicType
styleField string 可选

按 styleField 属性设置不同样式。
styleFieldOptions object 可选

按styleField值与对应style样式的键值对象。键支持对attr的JS语法字符串，如 "attr.floors>10 && attr.floors<20": { color: "#ff0000" } 或 "floors>10 && floors<20": { color: "#ff0000" } ，默认与styleOptions合并，可以设置merge:false不合并。
返回值:

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

继承自:
下载离线API文档