注释

src/Obj/Base/BillboardObject/index.js

@@ -48,30 +48,55 @@ class BillboardObject extends Base {
 
   /**
    * @constructor
-   * @description 创建点标注
+   * @description 点标注
-   * @param sdk {object} sdk
+   * @param options {object} 属性
-   * @param options {object} 标注参数
    * @param options.id {string} 标注id
-   * @param {object} options.positions 位置
+   * @param options.show=true {boolean} 标注整体的显隐
-   * @param {number} options.positions.lng 经度
+   * @param options.name {string} 名称
-   * @param {number} options.positions.lat 纬度
+   * @param {object} options.position={} 必填，位置
-   * @param {number} options.positions.alt 高度
+   * @param {number} options.position.lng 经度
+   * @param {number} options.position.lat 纬度
+   * @param {number} options.position.alt 高度
    * @param {number} options.heightMode=3 高度模式（0：海拔高度；1：相对地表；2：依附地表; 3：依附模型）
-   * @param [options.scaleByDistance=true] {boolean} 图标是否跟随视角变化进行字段缩放
+   * @param [options.scaleByDistance=true] {boolean} 是否开启跟随视野缩放
-   * @param [options.show=true] {boolean} 标注整体的显示/隐藏
+   * @param [options.near=2000] {number} 视野缩放最近距离
-   * @param [options.near=2000] {number} 近端可视距离 scaleByDistance为true时生效
+   * @param [options.far=100000]  {number} 视野缩放最远距离
-   * @param [options.far=100000]  {number} 远端可视距离 scaleByDistance为true时生效
+   * @param options.billboard {object} 图标参数
-   * @param options.billboard {object} 标注中图标的参数
+   * @param [options.billboard.show=true] {boolean} 图标显隐
-   * @param [options.billboard.show=true] {boolean} 标注中图标的显示与隐藏
    * @param options.billboard.image {string} 图标路径
    * @param options.billboard.defaultImage {string} 默认图标的唯一标识
-   * @param [options.billboard.scale=3] {number} 图标倍数
+   * @param [options.billboard.scale=3] {number} 图标放大倍数
-   *@param options.label {object} 标注文字的参数
+   * @param options.label {object} 文字参数
-   *@param [options.label.text] {string} 标注中文字
+   * @param [options.label.text] {string} 文字内容
-   *@param [options.label.show=true] {boolean} 标注文字显示/隐藏
+   * @param [options.label.show=true] {boolean} 文字显隐
-   *@param [options.label.fontFamily=0] {number} 标注文字字体 0：黑体；1：思源黑体；2：庞门正道标题体；3：数黑体
+   * @param [options.label.fontFamily=0] {number} 文字字体项 0：黑体；1：思源黑体；2：庞门正道标题体；3：数黑体
-   *@param [options.label.fontSize=39] {number} 标注文字大小 单位px，微软雅黑
+   * @param [options.label.fontSize=39] {number} 文字大小, 单位px
-   *@param [options.label.color=#00ffff] {string} 标注文字颜色
+   * @param [options.label.color=#00ffff] {string} 文字颜色
+   * @param options.attribute {object} 属性内容
+   * @param {object} options.attribute.link={}  链接
+   * @param options.attribute.link.content=[]] {array} 链接内容
+   * @param options.attribute.link.content[].name {string} 链接名称
+   * @param options.attribute.link.content[].url {string} 链接地址
+   * @param {object} options.attribute.vr={} 全景图
+   * @param options.attribute.vr.content=[]] {array} 全景图内容
+   * @param options.attribute.vr.content[].name {string} 名称
+   * @param options.attribute.vr.content[].url {string} 地址
+   * @param {object} ptions.attribute.camera={} 摄像头
+   * @param options.attribute.camera.content=[]] {array} 摄像头内容
+   * @param {object} options.attribute.ISC={} ISC
+   * @param options.attribute.ISC.content=[]] {array} ISC内容
+   * @param {object} options.attribute.goods={} 物资
+   * @param options.attribute.goods.content=[]] {array} 物资内容
+   * @param options.attribute.goods.content[].ID {string} ID
+   * @param options.attribute.goods.content[].name {string} 名称
+   * @param options.attribute.goods.content[].cnt {string} 数量
+   * @param options.richTextContent {string} 富文本内容
+   * 
+
+
+
+
+
    *@param _Dialog {object} 弹框事件
    *@param _Dialog.confirmCallBack {function} 弹框确认时的回调
    *@param _Dialog.instructSubmit(id,name,instruct) {function} 提交指令（ID, 名称，指令内容）

src/Obj/Base/CurvelineObject/index.js

@@ -21,30 +21,48 @@ class CurvelineObject extends Base {
   /**
    * @constructor
    * @param sdk
-   * @description 折线
+   * @description 曲线
    * @param options {object} 线属性
    * @param options.name{string} 名称
    * @param options.width=3{number} 线宽
    * @param options.color=#ff0000 {string} 颜色
-   * @param options.type=0 {number} 材质类型 0-实线 1-虚线 2-泛光
+   * @param options.type=0 {number} 材质类型 0-实线 1-虚线 2-泛光...
-   * @param options.heightMode{number} 高度模式（0：海拔高度；1：相对高度；2：依附模式）
+   * @param options.heightMode=2{number} 高度模式（0：海拔高度；1：相对高度；2：依附模式）
-   * @param options['nose-to-tail']=false {boolean} 首尾相连
+   * @param options.noseToTail=false {boolean} 首尾相连
    * @param options.extend=false {boolean} 线缓冲
-   * @param options['extend-width']=10 {number} 线缓冲宽度
+   * @param options.extendWidth=10 {number} 线缓冲宽度
-   * @param options['extend-color']=#ffde00 {number} 线缓冲颜色
+   * @param options.extendColor=rgba(255,255,80,0.3) {number} 线缓冲颜色
    * @param options.show=true {boolean} 显隐
-   * @param {Array.<object>} options.positions 坐标数组 [{lng,lat},...]
+   * @param {Array.<object>} options.positions 必填，经纬度和高度的列表，值交替 [{lon,lat,alt},...]
-   * @param options.label {object} 标注
+   * @param options.positions[].lng {number} 经度
-   * @param options.label.show=false {boolean} 标注显隐
+   * @param options.positions[].lat {number} 纬度
-   * @param options.label.fontSize=20 {number} 标注字体大小
+   * @param options.positions[].alt {number} 高度
-   * @param options.label.color=#ffffff {string} 标注字体颜色
+   * @param options.label {object} 标签对象
-   * @param options.label.lineWidth=1 {number} 标注引线宽
+   * @param options.label.text {string} 标签文本
-   * @param options.label.pixelOffset=20 {string} 标注引线长度
+   * @param options.label.show {string} 标签显隐
-   * @param options.label.backgroundColor=['#42c6ef', '#42c6ef'] {Array} 标注背景
+   * @param options.label.position {string} 标签位置
-   * @param options.label.lineColor=#fff000 {string} 标注引线颜色
+   * @param options.label.position {object} 标签位置
-   * @param options.label.scaleByDistance=false {boolean} 标注是否随视野缩放
+   * @param options.label.position.lng {number} 经度
-   * @param options.label.near=2000 {boolean} 标注随视野缩放最近距离
+   * @param options.label.position.lat {number} 纬度
-   * @param options.label.far=100000 {boolean} 标注随视野缩放最远距离
+   * @param options.label.position.alt {number} 高度
+   * @param options.label.fontSize=20 {number} 字体大小
+   * @param options.label.fontFamily=0 {number} 字体项 0：黑体；1：思源黑体；2：庞门正道标题体；3：数黑体
+   * @param options.label.color=#ffffff {string} 字体颜色
+   * @param options.label.lineWidth=4 {number} 引线宽
+   * @param options.label.lineColor=#00ffff80 {string} 引线颜色
+   * @param options.label.pixelOffset=20 {number} 字体偏移(引线长度)
+   * @param options.label.backgroundColor=['#00ffff80', '#00ffff80'] {array} 背景颜色
+   * @param options.label.scaleByDistance {boolean} 距离缩放
+   * @param options.label.near=2000 {number} 视野缩放最近距离
+   * @param options.label.far=100000 {number} 视野缩放最远距离
+   * @param options.attribute {object} 属性内容
+   * @param options.attribute.link={} {string} 链接
+   * @param options.attribute.link.content=[]] {array} 链接内容
+   * @param options.attribute.link.content[].name {string} 链接名称
+   * @param options.attribute.link.content[].url {string} 链接地址
+   * @param options.richTextContent {string} 富文本内容
+   * 
+   * 
    * @param _Dialog {object} 弹框事件
    * @param _Dialog.confirmCallBack {function} 弹框确认时的回调
    * */

src/Obj/Base/PolygonObject/index.js

@@ -19,8 +19,8 @@ import { setActiveViewer, closeRotateAround, closeViewFollow } from '../../../Gl
 class PolygonObject extends Base {
   /**
    * @constructor
-   * @param sdk
    * @description 多边形
+   * @param sdk
    * @param options {object} 属性
    * @param options.id {string} 唯一标识
    * @param options.show=true {boolean} 显示/隐藏
@@ -28,11 +28,43 @@ class PolygonObject extends Base {
    * @param options.color='rgba(255, 0, 0, 0.5)' {string} 颜色
    * @param options.height {number} 高度
    * @param options.heightMode=2{number} 高度模式（0：海拔高度；1：相对地表；2：依附模式）
+   * @param options.areaUnit='平方米' {string} 面积单位
    * @param options.line {object} 边框
    * @param options.line.width=2 {string} 边框宽
    * @param options.line.color="rgba(155, 155, 124, 0.89)" {string} 边框颜色
-   * @param {Array.<object>} options.positions 经纬度和高度的列表，值交替 [{lon,lat,alt},...]
+   * @param {Array.<object>} options.positions 必填，经纬度和高度的列表，值交替 [{lon,lat,alt},...]
-   
+   * @param options.positions[].lng {number} 经度
+   * @param options.positions[].lat {number} 纬度
+   * @param options.positions[].alt {number} 高度
+   * @param options.label {object} 标签对象
+   * @param options.label.text {string} 标签文本
+   * @param options.label.show {string} 标签显隐
+   * @param options.label.position {string} 标签位置
+   * @param options.label.position {object} 标签位置
+   * @param options.label.position.lng {number} 经度
+   * @param options.label.position.lat {number} 纬度
+   * @param options.label.position.alt {number} 高度
+   * @param options.label.fontSize=20 {number} 字体大小
+   * @param options.label.fontFamily=0 {number} 字体项 0：黑体；1：思源黑体；2：庞门正道标题体；3：数黑体
+   * @param options.label.color=#ffffff {string} 字体颜色
+   * @param options.label.lineWidth=4 {number} 引线宽
+   * @param options.label.lineColor=#00ffff80 {string} 引线颜色
+   * @param options.label.pixelOffset=20 {number} 字体偏移(引线长度)
+   * @param options.label.backgroundColor=['#00ffff80', '#00ffff80'] {array} 背景颜色
+   * @param options.label.scaleByDistance {boolean} 距离缩放
+   * @param options.label.near=2000 {number} 视野缩放最近距离
+   * @param options.label.far=100000 {number} 视野缩放最远距离
+   * @param options.attribute {object} 属性内容
+   * @param options.attribute.link={} {string} 链接
+   * @param options.attribute.link.content=[]] {array} 链接内容
+   * @param options.attribute.link.content[].name {string} 链接名称
+   * @param options.attribute.link.content[].url {string} 链接地址
+   * @param options.richTextContent {string} 富文本内容
+
+   * 
+
+
+   * 
    * @param _Dialog {object} 弹框事件
    * @param _Dialog.confirmCallBack {function} 弹框确认时的回调
    * */

src/Obj/Base/PolylineObject/index.js

@@ -25,28 +25,46 @@ class PolylineObject extends Base {
    * @description 折线
    * @param options {object} 线属性
    * @param options.name{string} 名称
-   * @param options.width   * @param options.width=3{number} 线宽
+   * @param options.width=3{number} 线宽
    * @param options.color=#ff0000 {string} 颜色
-   * @param options.type=0 {number} 材质类型 0-实线 1-虚线 2-泛光
+   * @param options.type=0 {number} 材质类型 0-实线 1-虚线 2-泛光...
    * @param options.heightMode=2{number} 高度模式（0：海拔高度；1：相对高度；2：依附模式）
-   * @param options['nose-to-tail']=false {boolean} 首尾相连
+   * @param options.noseToTail=false {boolean} 首尾相连
    * @param options.smooth=false {boolean} 线段圆滑
    * @param options.extend=false {boolean} 线缓冲
-   * @param options['extend-width']=10 {number} 线缓冲宽度
+   * @param options.extendWidth=10 {number} 线缓冲宽度
-   * @param options['extend-color']=rgba(255,255,80,0.3) {number} 线缓冲颜色
+   * @param options.extendColor=rgba(255,255,80,0.3) {number} 线缓冲颜色
    * @param options.show=true {boolean} 显隐
-   * @param {Array.<object>} options.positions 坐标数组 [{lng,lat},...]
+   * @param {Array.<object>} options.positions 必填，经纬度和高度的列表，值交替 [{lon,lat,alt},...]
-   * @param options.label {object} 标注
+   * @param options.positions[].lng {number} 经度
-   * @param options.label.show=false {boolean} 标注显隐
+   * @param options.positions[].lat {number} 纬度
-   * @param options.label.fontSize=20 {number} 标注字体大小
+   * @param options.positions[].alt {number} 高度
-   * @param options.label.color=#ffffff {string} 标注字体颜色
+   * @param options.label {object} 标签对象
-   * @param options.label.lineWidth=1 {number} 标注引线宽
+   * @param options.label.text {string} 标签文本
-   * @param options.label.pixelOffset=20 {string} 标注引线长度
+   * @param options.label.show {string} 标签显隐
-   * @param options.label.backgroundColor=['#42c6ef', '#42c6ef'] {Array} 标注背景
+   * @param options.label.position {string} 标签位置
-   * @param options.label.lineColor=#fff000 {string} 标注引线颜色
+   * @param options.label.position {object} 标签位置
-   * @param options.label.scaleByDistance=false {boolean} 标注是否随视野缩放
+   * @param options.label.position.lng {number} 经度
-   * @param options.label.near=2000 {boolean} 标注随视野缩放最近距离
+   * @param options.label.position.lat {number} 纬度
-   * @param options.label.far=100000 {boolean} 标注随视野缩放最远距离
+   * @param options.label.position.alt {number} 高度
+   * @param options.label.fontSize=20 {number} 字体大小
+   * @param options.label.fontFamily=0 {number} 字体项 0：黑体；1：思源黑体；2：庞门正道标题体；3：数黑体
+   * @param options.label.color=#ffffff {string} 字体颜色
+   * @param options.label.lineWidth=4 {number} 引线宽
+   * @param options.label.lineColor=#00ffff80 {string} 引线颜色
+   * @param options.label.pixelOffset=20 {number} 字体偏移(引线长度)
+   * @param options.label.backgroundColor=['#00ffff80', '#00ffff80'] {array} 背景颜色
+   * @param options.label.scaleByDistance {boolean} 距离缩放
+   * @param options.label.near=2000 {number} 视野缩放最近距离
+   * @param options.label.far=100000 {number} 视野缩放最远距离
+   * @param options.attribute {object} 属性内容
+   * @param options.attribute.link={} {string} 链接
+   * @param options.attribute.link.content=[]] {array} 链接内容
+   * @param options.attribute.link.content[].name {string} 链接名称
+   * @param options.attribute.link.content[].url {string} 链接地址
+   * @param options.richTextContent {string} 富文本内容
+   * 
+   * 
    * @param _Dialog {object} 弹框事件
    * @param _Dialog.confirmCallBack {function} 弹框确认时的回调
    * */