I3SLayer

new mars3d.layer.I3SLayer(options)

I3S 三维模型图层。

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

参数对象, 包括以下:

参数名称 类型 默认值 描述信息
url string | Cesium.Resource

I3S 数据集主 JSON 文件的 url

geoidTiledTerrainProvider object | Cesium.ArcGISTiledElevationTerrainProvider 可选

ArcGIS 地形服务。如果定义,I3S 模型将基于此地形服务的偏移量进行移位,用于需要按重力相关高度正确定位的 I3S 数据集。

showFeatures boolean false 可选

是否显示 I3S 要素。

adjustMaterialAlphaMode boolean false 可选

是否根据顶点颜色的透明度调整材质 alpha 模式;为 true 时,未定义 alpha 模式的材质会设为 BLEND。

applySymbology boolean false 可选

是否解析并应用 I3S 符号化样式。

calculateNormals boolean false 可选

是否为没有法线的 I3S 几何体生成平面法线。

//以下是TilesetLayer图层参数

position object 可选

自定义新的中心点位置(移动模型)

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

经度值, -180 至 180

lat number 可选

纬度值, -90 至 90

alt number 可选

高度值(单位:米)

alt_offset number 可选

相对于模型本身高度的偏移值(单位:米) ,如果有alt时已alt优先。

rotation object 可选

自定义旋转方向(旋转模型)

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

X方向,角度值0至360

y number

Y方向,角度值0至360

z number

四周方向,角度值0至360

scale number 1 可选

自定义缩放比例,整体等比例缩放

scaleX number 1 可选

单独自定义缩放X轴方向比例

scaleY number 1 可选

单独自定义缩放Y轴方向比例

scaleZ number 1 可选

单独自定义缩放Z轴方向比例

//以下为 Cesium3DTileset 参数,会通过 cesium3dTilesetOptions 透传给内部 Cesium3DTileset;未列出的 1.146 选项也可直接传入。矢量瓦片专用参数(如 vectorBlendOption、heightReference、scene)不在此列。

maximumScreenSpaceError number 16 可选

用于驱动细化细节级别的最大屏幕空间错误。可以简单理解为:数值加大,能让最终成像变模糊。

maxMemory number 1024 可选

最大缓存内存大小(MB), 内部换算给 cacheBytes = maxMemory10241024、maximumCacheOverflowBytes = cacheBytes * 1.5 (另:如果同时配置了cacheBytes、maximumMemoryUsage时该参数无效)

cacheBytes number 可选

如果缓存包含当前视图不需要的块,则块缓存将被修剪到的大小(以字节为单位)

maximumCacheOverflowBytes number 可选

如果当前视图需要超过Cesium3DTileset#cacheBytes,则允许缓存净空的最大额外内存(以字节为单位)。

maximumMemoryUsage number 可选

【cesium 1.107+弃用】数据集可以使用的最大内存量(以MB计),这个参数要根据当前客户端显卡显存来配置,如果我们场景只显示这一个模型数据,这个可以设置到显存的50% 左右,比如我的显存是4G,这个可以设置到2048左右。那么既保证不超过显存限制,又可以最大利用显存缓存。

style object | Cesium.Cesium3DTileStyle | function 可选

模型样式, 使用3D Tiles Styling language.

marsJzwStyle boolean | string false 可选

开启或设置建筑物特效样式。

customShader Cesium.CustomShader 可选

自定义着色器效果

allowDrillPick boolean | function 可选

是否允许鼠标穿透拾取

shadows Cesium.ShadowMode ShadowMode.ENABLED 可选

确定瓦片集是否投射或接收来自光源的阴影。

cullWithChildrenBounds boolean true 可选

优化选择。是否使用子包围盒的并集来筛选瓦片。

cullRequestsWhileMoving boolean true 可选

优化选择。相机移动时不要请求瓦片,因为返回时可能已不再使用。此优化仅适用于固定瓦片集。

cullRequestsWhileMovingMultiplier number 60.0 可选

优化选择。相机移动时用于剔除请求的乘数。值越大剔除越激进,值越小剔除越宽松。

preloadWhenHidden boolean false 可选

为 true 时,即使瓦片集的 show 为 false 也预加载数据。

preloadFlightDestinations boolean true 可选

优化选择。相机飞行时,在飞行目的地预加载瓦片。

preferLeaves boolean false 可选

优化选择。优先加载叶子节点数据。默认 false。同等条件下叶子节点会优先加载,但 Cesium 的瓦片加载优先级还受其他条件影响;如果 skipLevelOfDetail=false,此参数几乎无意义,需配合 skipLevelOfDetail=true 使用,以便尽快看到符合当前视觉精度的瓦片。

dynamicScreenSpaceError boolean true 可选

优化选择。在街景/地平线视角下,对远离相机的瓦片使用较低分辨率,从而减少加载数据量、缩短瓦片集加载时间,代价是远处视觉质量略有下降。

dynamicScreenSpaceErrorDensity number 2.0e-4 可选

与 Cesium.Fog#density 类似,控制 dynamicScreenSpaceError 优化生效的相机距离。值越大,受影响的瓦片离相机越近。

dynamicScreenSpaceErrorFactor number 24.0 可选

控制 dynamicScreenSpaceError 优化对地平线附近瓦片的强度。值越大,加载的瓦片分辨率越低,可提升运行时性能,但视觉质量略有下降。

dynamicScreenSpaceErrorHeightFalloff number 0.25 可选

瓦片集高度的比例,用于确定“街景”相机的出现位置。相机低于此高度时,dynamicScreenSpaceError 优化效果最大;高于此值后逐渐减弱。

progressiveResolutionHeightFraction number 0.3 可选

优化选择。取值在 (0.0, 0.5] 之间时,屏幕空间误差达到 progressiveResolutionHeightFraction*screenHeight 缩小分辨率阈值的瓦片会优先加载,从而快速显示一层瓦片,同时继续加载全分辨率瓦片。

foveatedScreenSpaceError boolean true 可选

优化选择。通过临时提高屏幕边缘瓦片的屏幕空间误差,优先加载屏幕中央的瓦片。当由 Cesium.Cesium3DTileset#foveatedConeSize 确定的屏幕中央瓦片全部加载后,屏幕空间误差恢复正常。

foveatedConeSize number 0.1 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制决定哪些瓦片延迟加载的锥体大小。锥体内的瓦片会立即加载;锥体外的瓦片可能根据其偏离锥体的距离和屏幕空间误差被延迟,由 Cesium.I3SDataProvider#foveatedInterpolationCallback 和 Cesium.I3SDataProvider#foveatedMinimumScreenSpaceErrorRelaxation 控制。设为 0.0 时,锥体退化为相机位置与视线方向形成的线;设为 1.0 时,锥体覆盖相机整个视场,效果关闭。

foveatedMinimumScreenSpaceErrorRelaxation number 0.0 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制中心锥体以外瓦片的初始屏幕空间误差松弛量。屏幕空间误差会从瓦片集的值开始,根据 foveatedInterpolationCallback 逐步提高到 Cesium.I3SDataProvider#maximumScreenSpaceError。

foveatedInterpolationCallback object Math.lerp 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制中心锥体以外瓦片屏幕空间误差的提高幅度,在 Cesium.I3SDataProvider#foveatedMinimumScreenSpaceErrorRelaxation 和 Cesium.I3SDataProvider#maximumScreenSpaceError 之间插值。

foveatedTimeDelay number 0.2 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制相机停止移动后等待多少秒再开始加载被延迟的瓦片。该延迟可避免相机移动时请求屏幕边缘的瓦片;设为 0.0 会立即请求当前视图中的所有瓦片。

skipLevelOfDetail boolean false 可选

优化选择。确定遍历过程中是否应用细节级别跳过。开启后可跳过部分层级,提升加载效率、减少数据占用,但可能出现加载过程中的闪烁或异常面片(相邻 LOD 数据差异较大导致)。设为 false 时过渡更平滑,但清晰数据等待更久;若某个瓦片请求失败,还可能一直无法细化。建议网络条件好、数据量小时设为 false 以提升显示质量。

baseScreenSpaceError number 1024 可选

当 skipLevelOfDetail 为 true 时,跳过细节级别之前必须达到的屏幕空间误差。

skipScreenSpaceErrorFactor number 16 可选

当 skipLevelOfDetail 为 true 时,定义跳过所需最小屏幕空间误差的乘数,与 skipLevels 配合决定加载哪些瓦片。

skipLevels number 1 可选

当 skipLevelOfDetail 为 true 时,定义加载瓦片时最少跳过的层级数;为 0 时不跳过任何层级。与 skipScreenSpaceErrorFactor 配合决定加载哪些瓦片。

immediatelyLoadDesiredLevelOfDetail boolean false 可选

当 skipLevelOfDetail 为 true 时,只下载满足最大屏幕空间误差的瓦片,忽略跳过系数,仅加载所需瓦片。

loadSiblings boolean false 可选

当 skipLevelOfDetail 为 true 时,确定遍历过程中是否总是下载可见瓦片的兄弟瓦片。

clippingPlanes Cesium.ClippingPlaneCollection 可选

Cesium.ClippingPlaneCollection 用于选择性地禁用瓦片集的渲染。

classificationType Cesium.ClassificationType 可选

确定地形、3D Tiles 还是两者都要被此瓦片集分类。关于限制和约束的详细信息,请参阅 Cesium.Cesium3DTileset#classificationType。

pointCloudShading object 可选

用于构造 Cesium.PointCloudShading 对象以控制点云衰减和光照的选项。

lightColor Cesium.Cartesian3 可选

为模型着色时使用的光源颜色;为 undefined 时使用场景的光源颜色。该值表示 RGB 倍数,例如 new Cesium.Cartesian3(100.0, 100.0, 100.0) 表示白光增强到 100 倍。对 PBR 材质有效,倾斜摄影不生效。

environmentMapOptions object 可选

动态环境贴图的配置,用于 PBR 光照。

backFaceCulling boolean true 可选

是否剔除背面几何体。为 true 时,背面剔除由 glTF 材质的 doubleSided 属性决定;为 false 时禁用背面剔除。

enablePick boolean false 可选

是否在 WebGL1 下允许 CPU 拾取;WebGL2+ 会忽略。

asynchronouslyLoadImagery boolean false 可选

覆盖在瓦片集上的影像是否异步加载。

debugHeatmapTilePropertyName string 可选

作为热力图着色的瓦片变量名。所有渲染的瓦片都会相对于彼此的指定变量值着色。

enableDebugWireframe boolean false 可选

仅供调试。在 WebGL1 中必须为 true,debugWireframe 才能生效;瓦片集创建后不能再设置。

debugWireframe boolean false 可选

仅供调试。为 true 时,将每个瓦片的内容渲染为线框。

edgeDisplayMode Cesium.EdgeDisplayMode Cesium.EdgeDisplayMode.SURFACES_ONLY 可选

控制 glTF EXT_mesh_primitive_edge_visibility 扩展的边缘相对于表面几何的渲染方式。

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

flyTo boolean 可选

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

flyToOptions object 可选

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

参考:

继承自

属性值

availability : Cesium.TimeIntervalCollection

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

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

enabledEvent : boolean

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

继承自:

只读 hasOpacity : boolean

是否可以调整透明度

继承自:

id : string|number

对象的id标识

继承自:

只读 isAdded : boolean

是否已添加到地图

继承自:

只读 isDestroy : boolean

是否已经销毁了

继承自:

只读 isPrivate : boolean

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

继承自:

只读 layer : Cesium.I3SDataProvider

模型对应的 I3SDataProvider对象

只读 map : Map

当前图层所在的地图对象

继承自:

marsJzwStyle : boolean|object

开启或设置建筑物特效样式。

只读 modelUpAxis : Cesium.Axis

模型的向上轴,比如Cesium.Axis.Z 或 Cesium.Axis.Y

name : string

名称

继承自:

opacity : number

透明度,取值范围:0.0-1.0

继承自:

只读 options : object

当前类的构造参数

继承自:

pid : string|number

对象的pid标识

继承自:

只读 readyPromise : Promise.<(BaseLayer|object)>

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

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

show : boolean

显示隐藏状态

继承自:

只读 state : State

当前对象的状态

继承自:

只读 type : string

图层类型

继承自:

方法

abstract _mountedHook() → void

对象添加到地图前创建一些对象的钩子方法, 只会调用一次

返回值:

无

继承自:

addEventParent(obj) → BaseClass

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

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

父类对象

返回值:

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

继承自:

addTo(map) → BaseLayer

添加到地图上,同 map.addThing

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

地图对象

返回值:

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

继承自:

bindContextMenu(content, options) → BaseGraphicLayer

绑定右键菜单

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

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

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

参数:

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

事件类型,默认为鼠标移入高亮,也可以指定'click'单击高亮。

多个参数 string 可选

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

返回值:

无

继承自:

bindPopup(content, options) → BaseGraphicLayer

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

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

弹窗内容html字符串,或者回调方法。

options Popup.StyleOptions 可选

控制参数

返回值:

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

继承自:

bindTooltip(content, options) → BaseGraphicLayer

绑定鼠标移入的弹窗

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

弹窗内容html字符串,或者回调方法。

options Tooltip.StyleOptions 可选

控制参数

返回值:

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

继承自:

closeContextMenu() → BaseGraphicLayer

关闭右键菜单

返回值:

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

继承自:

closeHighlight() → void

清除已高亮的矢量对象

返回值:

无

继承自:

closePopup() → BaseGraphicLayer

关闭弹窗

返回值:

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

继承自:

closeSmallTooltip() → BaseGraphicLayer

关闭小提示窗

返回值:

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

继承自:

closeTooltip() → BaseGraphicLayer

关闭弹窗

返回值:

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

继承自:

destroy(noDel) → void

销毁当前对象

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

false:会自动delete释放所有属性,true:不delete绑定的变量

返回值:

无

继承自:

eachTilesetLayer(method, context) → I3SLayer|undefined

遍历每一个Tileset子图层并将其作为参数传递给回调函数

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

回调方法

context object 可选

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

返回值:

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

fire(type, data, propagate) → BaseClass

触发指定类型的事件。

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

事件类型

data object 可选

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

propagate boolean false 可选

将事件传播给父类 (用addEventParent设置)

返回值:

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

继承自:

async flyTo(options) → Promise.<boolean>

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

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

参数对象:

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

点状数据时,相机距离目标点的距离(单位:米)

scale number 1.2 可选

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

heading number 可选

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

pitch number 可选

俯仰角度值,绕纬度线旋转角度, -90至90, 提示:该参数仅3D视图下有效

roll number 可选

翻滚角度值,绕经度线旋转角度, -90至90, 提示:该参数仅3D视图下有效

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>

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

返回值:

时间对象列表

继承自:

getAvailabilityShow(time) → boolean

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

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

指定时间

返回值:

显示隐藏 状态

继承自:

getContextMenu() → Array.<object>

获取绑定的右键菜单数组

返回值:

右键菜单数组

继承自:

getRealShow(time) → boolean

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

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

当前时间

返回值:

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

继承自:

hasContextMenu() → boolean

是否有绑定的右键菜单

返回值:

是否有绑定

继承自:

hasEventParent(obj) → boolean

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

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

父类对象

返回值:

是否绑定了抛出事件

继承自:

hasPopup() → boolean

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

返回值:

是否存在Popup绑定

继承自:

hasTooltip() → boolean

是否绑定了tooltip

返回值:

是否绑定

继承自:

listens(type, propagate) → boolean

是否有绑定指定的事件

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

事件类型

propagate boolean false 可选

是否判断指定的父类 (用addEventParent设置的)

返回值:

是否存在

继承自:

off(types, fn, context) → BaseClass

解除绑定指定类型事件监听器

参数名称 类型 描述信息
types string | EventType | Array.<string> | Array.<EventType> 可选

事件类型,tip:多个事件也可以数组或空格间隔的字符串 , 传入空值时解绑所有事件

fn function 可选

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件,特殊说明:map.on监听的Cesium相关原生事件时必须传入该参数

context object 可选

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

返回值:

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

继承自:

on(types, fn, context) → BaseClass

绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 阻止事件冒泡

参数名称 类型 描述信息
types string | EventType | Array.<string> | Array.<EventType>

事件类型,tip:多个事件也可以数组或空格间隔的字符串

fn function

绑定的监听器回调方法

context object 可选

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

返回值:

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

继承自:

once(types, fn, context) → BaseClass

绑定一次性执行的指定类型事件监听器 与on类似,监听器只会被触发一次,然后被删除。

参数名称 类型 描述信息
types EventType | string | Array.<EventType>

事件类型

fn function

绑定的监听器回调方法

context object 可选

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

返回值:

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

继承自:

openContextMenu(position) → BaseGraphicLayer

打开右键菜单

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

矢量对象 或 显示的位置

返回值:

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

继承自:

openHighlight(graphic, event) → void

高亮对象

参数名称 类型 描述信息
graphic BaseGraphic

高亮的矢量对,类型支持GraphicType

event object 可选

事件对象

返回值:

无

继承自:

openPopup(position) → BaseGraphicLayer

打开绑定的弹窗

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

矢量对象 或 显示的位置

返回值:

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

继承自:

openSmallTooltip(position, message) → BaseGraphicLayer

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

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

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

message *

显示的内容

返回值:

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

继承自:

openTooltip(position) → BaseGraphicLayer

打开绑定的tooltip弹窗

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

graphic矢量对象 或 显示的位置

返回值:

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

继承自:

reload() → void

重新加载模型

返回值:

remove(destroy) → void

从地图上移除,同map.removeThing

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

是否调用destroy释放

返回值:

无

继承自:

removeEventParent(obj) → BaseClass

移除抛出事件到父类

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

父类对象

返回值:

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

继承自:

setOptions(options, funOptions) → BaseLayer

更新图层参数

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

与类的构造方法参数相同

funOptions object 可选

方法参数

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

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

返回值:

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

继承自:

toJSON(options) → object|undefined

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

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

参数对象:

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

(tileset模型时)导出冗余的完整参数,包含完整position、transform等信息。

noAlt boolean 可选

(矢量图层中)不导出高度值

toNum boolean 可选

(矢量图层中)坐标是time时序坐标时,time值是否转为数字秒数

stopEdit boolean false 可选

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

返回值:

Json简单对象;未满足执行条件时可能无返回值。

继承自:

unbindContextMenu(bubbling) → BaseGraphicLayer

解除绑定的右键菜单

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

单击事件中是否继续冒泡查找

返回值:

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

继承自:

unbindHighlight() → void

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

返回值:

无

继承自:

unbindPopup(bubbling) → BaseGraphicLayer

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

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

单击事件中是否继续冒泡查找

返回值:

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

继承自:

unbindTooltip(bubbling) → BaseGraphicLayer

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

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

单击事件中是否继续冒泡查找

返回值:

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

继承自:

定义的类型

mars3d.layer.I3SLayer.EventType

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
add string

添加对象

remove string

移除对象

show string

显示了对象

hide string

隐藏了对象

click string

左键单击 鼠标事件

rightClick string

右键单击 鼠标事件

mouseOver string

鼠标移入 鼠标事件

mouseOut string

鼠标移出 鼠标事件

popupOpen string

popup弹窗打开后

popupClose string

popup弹窗关闭

tooltipOpen string

tooltip弹窗打开后

tooltipClose string

tooltip弹窗关闭

loadBefore string

完成加载,但未做任何其他处理前

load string

完成加载,执行所有内部处理后

使用示例:
//绑定监听事件
layer.on(mars3d.EventType.load, function (event) {
  console.log('矢量数据对象加载完成', event)
})
参考: