earthsdk3 3.0.7-beta.9 → 3.0.8-beta.1

package/dist/types/ESObjects/general/ESDirectionMeasurement.d.ts

@@ -2,11 +2,37 @@ import { UniteChanged } from "xbsj-base";
 import { ESGeoVector } from "../base";
 import { ESJEditingBindModeType } from "../../ESJTypes";
 /**
- * https://www.wolai.com/earthsdk/37rp47JvTtZqEJESf5AuQu
+ * ESDirectionMeasurement 类用于测量和表示方位角。
+ * 该类继承自 ESGeoVector，提供了方位角测量的功能，包括设置和获取线条宽度、支持多种编辑模式等。
+ *
+ * 核心功能：
+ * - 获取和设置线条宽度
+ * - 支持多种编辑模式，如旋转、缩放、双点追加和双点修改
+ * - 初始化方位角测量对象
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 可选参数，对象的唯一标识符。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 无特殊使用限制或潜在的副作用。
  */
 export declare class ESDirectionMeasurement extends ESGeoVector {
+    /**
+     * 静态属性，用于注册该类的类型信息。
+     * 包含类名、类型、中文名称、标签和描述。
+     */
     static readonly type: string;
+    /**
+     * 获取该类的类型名称。
+     * @returns 类型名称字符串 'ESDirectionMeasurement'。
+     */
     get typeName(): string;
+    /**
+     * 重写的方法，用于获取默认属性。
+     * @returns 调用静态方法 createDefaultProps 创建的默认属性对象。
+     */
     get defaultProps(): {
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -28,11 +54,37 @@ export declare class ESDirectionMeasurement extends ESGeoVector {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 获取线条的宽度。
+     * @returns 线条的宽度值。
+     */
     get strokeWidth(): number;
+    /**
+     * 设置线条的宽度。
+     * @param value - 要设置的线条宽度值。
+     */
     set strokeWidth(value: number);
+    private _direction;
+    get direction(): number;
+    set direction(value: number);
+    get directionChanged(): import("xbsj-base").Listener<[number, number]>;
+    /**
+     * 静态属性，重写支持的编辑模式。
+     * 包含父类支持的编辑模式以及新增的旋转、缩放、双点追加和双点修改模式。
+     */
     static supportEditingModes: string[];
+    /**
+     * 重写的编辑绑定模式，设置为 'doublePoints'。
+     */
     editingBindMode: ESJEditingBindModeType;
+    /**
+     * 构造函数，初始化方位角测量对象。
+     * @param id - 可选参数，对象的唯一标识符。
+     */
     constructor(id?: string);
+    /**
+     * 静态属性，重写默认值，包含父类的默认值。
+     */
     static defaults: {
         points: import("../../ESJTypes").ESJVector3DArray;
         pointStyle: import("../../ESJTypes").ESJPointStyle;
@@ -47,9 +99,21 @@ export declare class ESDirectionMeasurement extends ESGeoVector {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 重写的方法，用于获取属性信息。
+     * @param language - 可选参数，语言类型。
+     * @returns 包含父类属性信息的数组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESDirectionMeasurement 类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESDirectionMeasurement {
+    /**
+     * 创建默认属性的方法。
+     * @returns 包含父类默认属性的对象。
+     */
     const createDefaultProps: () => {
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -72,6 +136,9 @@ export declare namespace ESDirectionMeasurement {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * ESDirectionMeasurement 类的接口，继承自 UniteChanged 类型。
+ */
 export interface ESDirectionMeasurement extends UniteChanged<ReturnType<typeof ESDirectionMeasurement.createDefaultProps>> {
 }
 //# sourceMappingURL=ESDirectionMeasurement.d.ts.map

package/dist/types/ESObjects/general/ESDirectionMeasurement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESDirectionMeasurement.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDirectionMeasurement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAkB,MAAM,yBAAyB,CAAC;AACjF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoJ;IACxK,IAAI,QAAQ,WAAuC;IACnD,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;MAA0D;IAEnF,IAAa,WAAW,IACQ,MAAM,CADuB;IAC7D,IAAa,WAAW,CAAC,KAAK,EAAE,MAAM,EAA8D;IACpG,OAAgB,mBAAmB,WAMjC;IACO,eAAe,EAAE,sBAAsB,CAAkB;gBACtD,EAAE,CAAC,EAAE,MAAM;IAgBvB,OAAgB,QAAQ;;;;;;;;;;;;;MAEtB;IAEO,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAK3C;AAED,yBAAiB,sBAAsB,CAAC;IAC7B,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;KAE7B,CAAC;CACN;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESDirectionMeasurement.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDirectionMeasurement.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAkB,MAAM,yBAAyB,CAAC;AAEjF;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACnD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAoJ;IAExK;;;OAGG;IACH,IAAI,QAAQ,WAAuC;IAEnD;;;OAGG;IACH,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;MAA0D;IAEnF;;;OAGG;IACH,IAAa,WAAW,IAMQ,MAAM,CANuB;IAE7D;;;OAGG;IACH,IAAa,WAAW,CAAC,KAAK,EAAE,MAAM,EAA8D;IAEpG,OAAO,CAAC,UAAU,CAAqC;IACvD,IAAI,SAAS,IACQ,MAAM,CADsB;IACjD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAAoC;IAC/D,IAAI,gBAAgB,mDAAsC;IAE1D;;;OAGG;IACH,OAAgB,mBAAmB,WAMjC;IAEF;;OAEG;IACM,eAAe,EAAE,sBAAsB,CAAkB;IAElE;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAwBvB;;OAEG;IACH,OAAgB,QAAQ;;;;;;;;;;;;;MAEtB;IAEF;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAK3C;AAED;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IACpC;;;OAGG;IACI,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;KAE7B,CAAC;CACN;AAKD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESDistanceMeasurement.d.ts

@@ -2,12 +2,40 @@ import { ESJColor, ESJStrokeStyle } from "../../ESJTypes";
 import { ESGeoLineString } from "./ESGeoLineString";
 import { UniteChanged } from "xbsj-base";
 /**
- * https://www.wolai.com/earthsdk/wxeuk8gv9v4PzHBZ6pURww
+ * ESDistanceMeasurement 类用于测量和表示地理空间中的距离。
+ * 该类继承自 ESGeoLineString，提供了一系列方法和属性来定义和管理距离测量对象。
+ * 核心功能包括设置和获取线条颜色、定义线条样式、以及获取和设置对象的属性。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param {string} [id] - 可选参数，实例的唯一标识符。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 该类依赖于 ESGeoLineString 类，因此需要确保 ESGeoLineString 已被正确导入和使用。
+ * - 在设置线条颜色时，需要传入一个包含四个元素的数组，分别表示 RGBA 颜色值。
  */
 export declare class ESDistanceMeasurement extends ESGeoLineString {
+    /**
+     * 静态属性，用于注册 ESDistanceMeasurement 类，包含类的类型名称、中文名称、标签和描述信息。
+     * 类型名称用于唯一标识该类，中文名称用于友好显示，标签用于分类和查找，描述信息用于简要说明该类的功能。
+     */
     static readonly type: string;
+    /**
+     * 获取该对象的类型名称，固定返回 'ESDistanceMeasurement'。
+     * @returns {string} 类型名称 'ESDistanceMeasurement'。
+     */
     get typeName(): string;
+    /**
+     * 获取该对象的默认属性，调用 createDefaultProps 方法创建默认属性。
+     * @returns {ReturnType<typeof ESDistanceMeasurement.createDefaultProps>} 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 线条样式属性，使用 reactJson 包装，使其成为响应式对象。
+         * 包含线条的宽度、颜色、材质等信息。
+         * @type {ESJStrokeStyle}
+         */
         strokeStyle: import("xbsj-base").ReactiveVariable<ESJStrokeStyle>;
         stroked: boolean;
         pointed: boolean;
@@ -28,8 +56,20 @@ export declare class ESDistanceMeasurement extends ESGeoLineString {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 获取线条的颜色，从 strokeStyle 中获取颜色属性。
+     * @returns {ESJColor} 线条的颜色。
+     */
     get strokeColor(): ESJColor;
+    /**
+     * 设置线条的颜色，更新 strokeStyle 中的颜色属性。
+     * @param {ESJColor} value - 要设置的线条颜色。
+     */
     set strokeColor(value: ESJColor);
+    /**
+     * 静态默认属性，继承自 ESGeoLineString 的默认属性，并添加了线条样式的默认属性。
+     * 线条样式包含宽度、宽度类型、颜色、材质、材质参数和是否贴地等信息。
+     */
     static defaults: {
         strokeStyle: ESJStrokeStyle;
         stroked: boolean;
@@ -44,11 +84,32 @@ export declare class ESDistanceMeasurement extends ESGeoLineString {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，用于创建 ESDistanceMeasurement 实例。
+     * @param {string} [id] - 可选参数，实例的唯一标识符。
+     */
     constructor(id?: string);
+    /**
+     * 获取该对象的属性列表，继承自父类的属性列表。
+     * @param {string} [language] - 可选参数，指定语言，用于国际化显示属性名称等信息。
+     * @returns {any[]} 属性列表。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESDistanceMeasurement 类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESDistanceMeasurement {
+    /**
+     * 创建默认属性的方法，继承自 ESGeoLineString 的默认属性，并将线条样式属性转换为响应式 JSON 对象。
+     * @returns {ReturnType<typeof ESDistanceMeasurement.createDefaultProps>} 默认属性对象。
+     */
     const createDefaultProps: () => {
+        /**
+         * 线条样式属性，使用 reactJson 包装，使其成为响应式对象。
+         * 包含线条的宽度、颜色、材质等信息。
+         * @type {ESJStrokeStyle}
+         */
         strokeStyle: import("xbsj-base").ReactiveVariable<ESJStrokeStyle>;
         stroked: boolean;
         pointed: boolean;
@@ -70,6 +131,9 @@ export declare namespace ESDistanceMeasurement {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESDistanceMeasurement 类的接口，继承自 UniteChanged 接口，用于处理属性变更事件。
+ */
 export interface ESDistanceMeasurement extends UniteChanged<ReturnType<typeof ESDistanceMeasurement.createDefaultProps>> {
 }
 //# sourceMappingURL=ESDistanceMeasurement.d.ts.map

package/dist/types/ESObjects/general/ESDistanceMeasurement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESDistanceMeasurement.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDistanceMeasurement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACtD,gBAAyB,IAAI,SAAiJ;IAC9K,IAAa,QAAQ,WAAsC;IAC3D,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;MAAyD;IAElF,IAAa,WAAW,IACQ,QAAQ,CADqB;IAC7D,IAAa,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAmE;IAG3G,OAAgB,QAAQ;qBASf,cAAc;;;;;;;;;;;;MACrB;gBACU,EAAE,CAAC,EAAE,MAAM;IAId,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAK3C;AAED,yBAAiB,qBAAqB,CAAC;IAC5B,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;KAG7B,CAAC;CACN;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESDistanceMeasurement.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDistanceMeasurement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACtD;;;OAGG;IACH,gBAAyB,IAAI,SAAiJ;IAE9K;;;OAGG;IACH,IAAa,QAAQ,WAAsC;IAE3D;;;OAGG;IACH,IAAa,YAAY;QA4DrB;;;;WAIG;;;;;;;;;;;;;;;;;;;;MAhE2E;IAElF;;;OAGG;IACH,IAAa,WAAW,IAMQ,QAAQ,CANqB;IAE7D;;;OAGG;IACH,IAAa,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAmE;IAE3G;;;OAGG;IACH,OAAgB,QAAQ;qBASf,cAAc;;;;;;;;;;;;MACrB;IAEF;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAIvB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAK3C;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACnC;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;;;WAIG;;;;;;;;;;;;;;;;;;;;KAEL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESDynamicWater.d.ts

@@ -1,22 +1,69 @@
 import { ESJColor } from "../../ESJTypes";
 import { UniteChanged } from "xbsj-base";
 import { ESLocalPolygon } from "./ESLocalPolygon";
+/**
+ * ESDynamicWater 类用于表示和渲染动态水面效果。
+ * 该类继承自 ESLocalPolygon 类，提供了多种属性和方法来控制水面的外观和行为。
+ * 主要功能包括设置水面的颜色、波动频率、振幅、镜面反射强度、流动方向和速度等。
+ *
+ * 核心功能或关键方法：
+ * - 设置水域类型（waterType）：决定使用预设效果或自定义效果。
+ * - 设置频率（frequency）：控制波数的数值，单位为次/千米。
+ * - 设置波动速率（waveVelocity）：控制水波纹扰动的速率。
+ * - 设置振幅（amplitude）：控制水波振幅的数值。
+ * - 设置镜面反射强度（specularIntensity）：控制镜面反射的强度。
+ * - 设置流动方向（flowDirection）：控制水流方向，局部坐标方向。
+ * - 设置流动速度（flowSpeed）：控制水流速度，单位为米/秒。
+ * - 设置水体浑浊度（murkiness）：控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - id: 可选参数，实例的唯一标识符。
+ *
+ * 特殊的使用限制或潜在的副作用：
+ * - 当水域类型（waterType）不为 custom 时，其他控制效果的参数不会生效，而是使用对应水域类型的预定效果。
+ * - 水体浑浊度（murkiness）的取值范围应在 0 到 10 之间，超出该范围可能导致不可预知的行为。
+ */
 export declare class ESDynamicWater extends ESLocalPolygon {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     * 类型名称为 'ESDynamicWater'，中文名称为 '动态水面'，包含多个标签，描述为 '局部多边形水面'。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns 返回类型名称 'ESDynamicWater'。
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @returns 返回包含默认属性的对象。
+     */
     get defaultProps(): {
+        /**是否允许拾取 默认为true */
         allowPicking: boolean;
+        /**水的图片*/
         waterImage: import("xbsj-base").ReactiveVariable<{
             [xx: string]: any;
         } | undefined>;
+        /**水体颜色 */
         waterColor: ESJColor;
+        /**频率, 控制波数的数值(次/千米) */
         frequency: number;
+        /**波动频率, 控制水波纹扰动的速率 */
         waveVelocity: number;
+        /**振幅, 控制水波振幅的数值 */
         amplitude: number;
+        /**镜面反射强度, 控制镜面反射强度的数值 */
         specularIntensity: number;
+        /**水域类型 [["river", "river"], ["ocean", "ocean"], ["lake", "lake"], ["custom", "custom"]] 当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果 */
         waterType: string;
+        /**流向, 控制水流方向，局部坐标方向 */
         flowDirection: number;
+        /**水流速度, 控制水流速度，单位 米/秒 */
         flowSpeed: number;
+        /**水体浑浊度, 控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。 */
         murkiness: number;
         points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
         pointed: boolean;
@@ -43,16 +90,16 @@ export declare class ESDynamicWater extends ESLocalPolygon {
         toDestroyFuncStr: string | undefined;
     };
     /**
-     *  默认属性
+     * 默认属性说明：
      * baseWaterColor: [0.1497, 0.165, 0.0031, 1] 水的底色
      * frequency: 1000 频率：控制波数的数值,单位 次/千米
      * waveVelocity: 0.5 波动速率：控制水波纹扰动的速率
      * amplitude: 0.1 振幅：控制水波振幅的数值
      * specularIntensity: 0.8 镜面反射强度：控制镜面反射强度的数值
-     * waterType:river 水域类型，当为custom是其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果
+     * waterType:river 水域类型，当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果
      * flowDirection: [0, 0, 0] 流动方向：控制水流方向，局部坐标方向
      * flowSpeed: 1 流动速度：控制水流速度，单位 米/秒
-     * murkiness: 5 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围0-10。
+     * murkiness: 5 水体浑浊度，控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。
      */
     static defaults: {
         waterColor: ESJColor;
@@ -79,7 +126,15 @@ export declare class ESDynamicWater extends ESLocalPolygon {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，创建 ESDynamicWater 实例。
+     * @param id - 可选参数，实例的唯一标识符。
+     */
     constructor(id?: string);
+    /**
+     * 获取 ES 属性列表。
+     * @returns 返回包含 ES 属性的对象。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         coordinate: import("../../ESJTypes").Property[];
@@ -89,22 +144,45 @@ export declare class ESDynamicWater extends ESLocalPolygon {
         general: import("../../ESJTypes").Property[];
         dataSource: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取属性列表。
+     * @param language - 可选参数，语言类型。
+     * @returns 返回包含属性的数组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESDynamicWater 命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESDynamicWater {
+    /**
+     * 创建默认属性对象。
+     * @returns 返回包含默认属性的对象。
+     */
     const createDefaultProps: () => {
+        /**是否允许拾取 默认为true */
         allowPicking: boolean;
+        /**水的图片*/
         waterImage: import("xbsj-base").ReactiveVariable<{
             [xx: string]: any;
         } | undefined>;
+        /**水体颜色 */
         waterColor: ESJColor;
+        /**频率, 控制波数的数值(次/千米) */
         frequency: number;
+        /**波动频率, 控制水波纹扰动的速率 */
         waveVelocity: number;
+        /**振幅, 控制水波振幅的数值 */
         amplitude: number;
+        /**镜面反射强度, 控制镜面反射强度的数值 */
         specularIntensity: number;
+        /**水域类型 [["river", "river"], ["ocean", "ocean"], ["lake", "lake"], ["custom", "custom"]] 当为 custom 时其他控制效果的参数生效，否则不生效，使用对应水域类型的预定效果 */
         waterType: string;
+        /**流向, 控制水流方向，局部坐标方向 */
         flowDirection: number;
+        /**水流速度, 控制水流速度，单位 米/秒 */
         flowSpeed: number;
+        /**水体浑浊度, 控制水体的浑浊程度，数值越大，浑浊程度越大，取值范围 0 - 10。 */
         murkiness: number;
         points: import("xbsj-base").ReactiveVariable<[number, number][] | undefined>;
         pointed: boolean;
@@ -131,6 +209,9 @@ export declare namespace ESDynamicWater {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * ESDynamicWater 接口，继承自 UniteChanged 类型。
+ */
 export interface ESDynamicWater extends UniteChanged<ReturnType<typeof ESDynamicWater.createDefaultProps>> {
 }
 //# sourceMappingURL=ESDynamicWater.d.ts.map

package/dist/types/ESObjects/general/ESDynamicWater.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESDynamicWater.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDynamicWater.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,QAAQ,EAAsD,MAAM,gBAAgB,CAAC;AAC3H,OAAO,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,qBAAa,cAAe,SAAQ,cAAc;IAC9C,gBAAyB,IAAI,SAA6I;IAC1K,IAAa,QAAQ,WAA+B;IACpD,IAAa,YAAY;;;;;oBA2EqB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA3E4B;IAClF;;;;;;;;;;;OAWG;IACH,OAAgB,QAAQ;oBAGsB,QAAQ;;;;;oBAK8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;;;;;;;;;;MAMlI;gBACW,EAAE,CAAC,EAAE,MAAM;IAKd,eAAe;;;;;;;;;IAmBf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAe3C;AAED,yBAAiB,cAAc,CAAC;IACrB,MAAM,kBAAkB;;;;;oBAKe,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KASpD,CAAC;CACN;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESDynamicWater.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESDynamicWater.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,QAAQ,EAAsD,MAAM,gBAAgB,CAAC;AAC3H,OAAO,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAe,SAAQ,cAAc;IAC9C;;;OAGG;IACH,gBAAyB,IAAI,SAA6I;IAE1K;;;OAGG;IACH,IAAa,QAAQ,WAA+B;IAEpD;;;OAGG;IACH,IAAa,YAAY;QAgGrB,oBAAoB;;QAEpB,SAAS;;;;QAET,UAAU;oBACgC,QAAQ;QAClD,uBAAuB;;QAEvB,sBAAsB;;QAEtB,mBAAmB;;QAEnB,yBAAyB;;QAEzB,sIAAsI;;QAEtI,uBAAuB;;QAEvB,yBAAyB;;QAEzB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;MApH+B;IAElF;;;;;;;;;;;OAWG;IACH,OAAgB,QAAQ;oBAGsB,QAAQ;;;;;oBAK8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;;;;;;;;;;MAMlI;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAMvB;;;OAGG;IACM,eAAe;;;;;;;;;IAoBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAe3C;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC5B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,oBAAoB;;QAEpB,SAAS;;;;QAET,UAAU;oBACgC,QAAQ;QAClD,uBAAuB;;QAEvB,sBAAsB;;QAEtB,mBAAmB;;QAEnB,yBAAyB;;QAEzB,sIAAsI;;QAEtI,uBAAuB;;QAEvB,yBAAyB;;QAEzB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;KAEjD,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESEntityCluster.d.ts

@@ -1,6 +1,14 @@
-import { ESVisualObject } from "../base";
 import { Event, UniteChanged } from "xbsj-base";
 import { ESJResource } from "../../ESJTypes";
+import { ESVisualObject } from "../base";
+/**
+ * 小部件事件信息类型定义
+ * @typedef {Object} WidgetEventInfo
+ * @property {"leftClick" | "rightClick" | "mouseEnter" | "mouseLeave" | "childMouseLeave" | "childMouseEnter"} type - 事件类型
+ * @property {Object} [add] - 附加信息
+ * @property {string[]} [add.children] - 子元素列表
+ * @property {[number, number]} [add.mousePos] - 鼠标位置
+ */
 export type WidgetEventInfo = {
     type: "leftClick" | "rightClick" | "mouseEnter" | "mouseLeave" | "childMouseLeave" | "childMouseEnter";
     add?: {
@@ -8,6 +16,19 @@ export type WidgetEventInfo = {
         mousePos?: [number, number];
     };
 };
+/**
+ * ESEntityCluster的样式类型定义
+ * @typedef {Object} ESEntityClusterStyle
+ * @property {Array<Object>} [cluster] - 聚合样式配置
+ * @property {number} [cluster[].value] - 聚合值
+ * @property {number} [cluster[].minValue] - 最小聚合值
+ * @property {number} [cluster[].maxValue] - 最大聚合值
+ * @property {string} [cluster[].mode] - 聚合模式
+ * @property {Object} [cluster[].style] - 聚合样式
+ * @property {Object} [nonCluster] - 非聚合样式配置
+ * @property {string} [nonCluster.mode] - 非聚合模式
+ * @property {Object} [nonCluster.style] - 非聚合样式
+ */
 export type ESEntityClusterStyle = {
     cluster?: {
         value?: number;
@@ -26,21 +47,62 @@ export type ESEntityClusterStyle = {
     };
 };
 /**
- * 聚合POI标注
- * ESEntityCluster - https://www.wolai.com/earthsdk/5drKAUgDrTcQq4zGVtbbYj
- * https://c0yh9tnn0na.feishu.cn/wiki/VUajwIvg2iPLozkx3QdcZ0vUnXc
+ * ESEntityCluster 类用于聚合POI（兴趣点）标注，以提高性能。该类继承自 ESVisualObject，并提供了多种属性和方法来配置和管理POI聚合的显示和行为。
+ *
+ * 核心功能包括：
+ * - 注册类类型，用于标识该类。
+ * - 获取类的类型名称。
+ * - 获取和设置默认属性。
+ * - 管理小部件事件。
+ * - 管理数据对象，包括获取和设置数据值以及数据变更事件。
+ * - 获取特征数据。
+ * - 获取ES属性和属性列表。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - `id`：对象的ID，可选。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 在设置 `url` 属性时，如果 `url` 是一个对象或JSON字符串，数据将直接被解析和设置。如果是URL字符串，数据将通过 `fetch` 方法异步加载。
+ * - 数据加载失败时，会在控制台输出警告信息。
  */
 export declare class ESEntityCluster extends ESVisualObject {
+    /**
+     * 注册类类型，用于标识该类
+     *
+     * @readonly
+     * @type {any}
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称
+     * @returns {string} 类的类型名称
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性
+     * @override
+     * @returns {any} 默认属性对象
+     */
     get defaultProps(): {
+        /**数据服务或数据体
+         * @type {string | ESJResource | { [xx: string]: any }}
+         */
         url: string | ESJResource | {
             [xx: string]: any;
         };
+        /**用于扩展屏幕空间边界框的像素范围 */
         pixelRange: number;
+        /**可以聚合的屏幕空间对象的最小数量 */
         minimumClusterSize: number;
+        /**用于设置聚合和非聚合的显示样式
+         * @type {ESEntityClusterStyle}
+        */
         style: import("xbsj-base").ReactiveVariable<ESEntityClusterStyle | undefined>;
+        /**高度获取模式  ["None", "CLAMP_TO_GROUND", "CLAMP_TO_TERRAIN"]*/
         heightReference: string;
+        /**是否启用透视效果，自动缩放远处标签 */
         perspective: boolean;
         show: boolean;
         collision: boolean;
@@ -55,13 +117,49 @@ export declare class ESEntityCluster extends ESVisualObject {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 小部件事件
+     * @private
+     * @type {Event<[WidgetEventInfo]>}
+     */
     private _widgetEvent;
+    /**
+     * 获取小部件事件
+     * @returns {Event<[WidgetEventInfo]>} 小部件事件对象
+     */
     get widgetEvent(): Event<[WidgetEventInfo]>;
+    /**
+     * 数据对象
+     * @private
+     * @type {react<Object | undefined>}
+     */
     private _data;
+    /**
+     * 获取数据值
+     * @returns {Object | undefined} 数据值
+     */
     get data(): Object | undefined;
+    /**
+     * 设置数据值
+     * @param {Object | undefined} value - 要设置的数据值
+     */
     set data(value: Object | undefined);
+    /**
+     * 获取数据变更事件
+     * @returns {any} 数据变更事件对象
+     */
     get dataChanged(): import("xbsj-base").Listener<[Object | undefined, Object | undefined]>;
+    /**
+     * 获取特征数据
+     * @returns {any} 特征数据对象，如果数据未加载完成则输出提示信息
+     */
     getFeatures(): import("xbsj-base").ReactiveVariable<Object | undefined> | undefined;
+    /**
+     * 类的默认属性
+     *
+     * @override
+     * @type {Object}
+     */
     static defaults: {
         url: string;
         pixelRange: number;
@@ -75,7 +173,16 @@ export declare class ESEntityCluster extends ESVisualObject {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数
+     * @param {string} [id] - 对象的ID
+     */
     constructor(id?: string);
+    /**
+     * 获取ES属性
+     * @override
+     * @returns {Object} ES属性对象
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         defaultMenu: string;
@@ -85,17 +192,37 @@ export declare class ESEntityCluster extends ESVisualObject {
         coordinate: import("../../ESJTypes").Property[];
         style: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取属性列表
+     * @override
+     * @param {string} [language] - 语言
+     * @returns {Array<any>} 属性列表
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
 export declare namespace ESEntityCluster {
+    /**
+     * 创建默认属性对象
+     * @returns {Object} 默认属性对象
+     */
     const createDefaultProps: () => {
+        /**数据服务或数据体
+         * @type {string | ESJResource | { [xx: string]: any }}
+         */
         url: string | ESJResource | {
             [xx: string]: any;
         };
+        /**用于扩展屏幕空间边界框的像素范围 */
         pixelRange: number;
+        /**可以聚合的屏幕空间对象的最小数量 */
         minimumClusterSize: number;
+        /**用于设置聚合和非聚合的显示样式
+         * @type {ESEntityClusterStyle}
+        */
         style: import("xbsj-base").ReactiveVariable<ESEntityClusterStyle | undefined>;
+        /**高度获取模式  ["None", "CLAMP_TO_GROUND", "CLAMP_TO_TERRAIN"]*/
         heightReference: string;
+        /**是否启用透视效果，自动缩放远处标签 */
         perspective: boolean;
         show: boolean;
         collision: boolean;
@@ -111,6 +238,9 @@ export declare namespace ESEntityCluster {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 扩展接口，用于联合变更类型
+ */
 export interface ESEntityCluster extends UniteChanged<ReturnType<typeof ESEntityCluster.createDefaultProps>> {
 }
 //# sourceMappingURL=ESEntityCluster.d.ts.map

package/dist/types/ESObjects/general/ESEntityCluster.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESEntityCluster.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESEntityCluster.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,cAAc,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,KAAK,EAAmD,YAAY,EAAE,MAAM,WAAW,CAAC;AAEjG,OAAO,EAAiC,WAAW,EAA+C,MAAM,gBAAgB,CAAC;AACzH,MAAM,MAAM,eAAe,GAAG;IAC1B,IAAI,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;IACvG,GAAG,CAAC,EAAE;QACF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/B,CAAA;CACJ,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG;IAC/B,OAAO,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAChC,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAChC,CAAA;CACJ,CAAA;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,cAAc;IAC/C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAuJ;IAC3K,IAAI,QAAQ,WAAgC;IAC5C,IAAa,YAAY;aAqGV,MAAM,GAAG,WAAW,GAAG;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE;;;;;;;;;;;;;;;;;;MArGiB;IAE5E,OAAO,CAAC,YAAY,CAA2C;IAC/D,IAAI,WAAW,6BAAgC;IAE/C,OAAO,CAAC,KAAK,CAAiD;IAC9D,IAAI,IAAI,IACQ,MAAM,GAAG,SAAS,CADK;IACvC,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAA+B;IACjE,IAAI,WAAW,2EAAiC;IAChD,WAAW;IAOX,OAAgB,QAAQ;;;;eAiBf,oBAAoB;0BACiG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;MAG5J;gBAEW,EAAE,CAAC,EAAE,MAAM;IA2Bd,eAAe;;;;;;;;;IAcf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAgB3C;AAED,yBAAiB,eAAe,CAAC;IACtB,MAAM,kBAAkB;aAEhB,MAAM,GAAG,WAAW,GAAG;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE;;;;;;;;;;;;;;;;;;KAMzD,CAAC;CACN;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESEntityCluster.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESEntityCluster.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAmD,YAAY,EAAE,MAAM,WAAW,CAAC;AACjG,OAAO,EAAiC,WAAW,EAA+C,MAAM,gBAAgB,CAAC;AACzH,OAAO,EAAiB,cAAc,EAAE,MAAM,SAAS,CAAC;AAGxD;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B,IAAI,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;IACvG,GAAG,CAAC,EAAE;QACF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/B,CAAA;CACJ,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,OAAO,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAChC,EAAE,CAAC;IACJ,UAAU,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAChC,CAAA;CACJ,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,SAAQ,cAAc;IAC/C;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAuJ;IAE3K;;;OAGG;IACH,IAAI,QAAQ,WAAgC;IAE5C;;;;OAIG;IACH,IAAa,YAAY;QAiKrB;;WAEG;aACQ,MAAM,GAAG,WAAW,GAAG;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE;QACvD,sBAAsB;;QAEtB,sBAAsB;;QAEtB;;UAEE;;QAEF,4DAA4D;;QAE5D,uBAAuB;;;;;;;;;;;;;;MA/KiD;IAE5E;;;;OAIG;IACH,OAAO,CAAC,YAAY,CAA2C;IAE/D;;;OAGG;IACH,IAAI,WAAW,6BAAgC;IAE/C;;;;OAIG;IACH,OAAO,CAAC,KAAK,CAAiD;IAE9D;;;OAGG;IACH,IAAI,IAAI,IAMQ,MAAM,GAAG,SAAS,CANK;IAEvC;;;OAGG;IACH,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAA+B;IAEjE;;;OAGG;IACH,IAAI,WAAW,2EAAiC;IAEhD;;;OAGG;IACH,WAAW;IAOX;;;;;OAKG;IACH,OAAgB,QAAQ;;;;eAiBf,oBAAoB;0BACiG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;MAE5J;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IA2BvB;;;;OAIG;IACM,eAAe;;;;;;;;;IAexB;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAgB3C;AAED,yBAAiB,eAAe,CAAC;IAC7B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;WAEG;aACQ,MAAM,GAAG,WAAW,GAAG;YAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE;QACvD,sBAAsB;;QAEtB,sBAAsB;;QAEtB;;UAEE;;QAEF,4DAA4D;;QAE5D,uBAAuB;;;;;;;;;;;;;;KAEzB,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}