earthsdk3 3.0.7-beta.8 → 3.0.7

package/dist/types/ESViewer/ESViewer.d.ts

@@ -1,24 +1,102 @@
 import { Destroyable, Event, JsonValue, ReactiveVariable, UniteChanged } from "xbsj-base";
 import { EngineObject } from "../EngineObject";
-import { ESJColor, ESJFlyToParam, ESJLonLatFormatType, ESJNavigationMode, ESJStatusInfoType, ESJVector2D, ESJVector2DArray, ESJVector3D, ESJVector4D, ESVOption, PickedResult, Property, ViewerStatus } from "../ESJTypes";
+import { ESJColor, ESJFlyToParam, ESJLonLatFormatType, ESJNavigationMode, ESJPickedResult, ESJStatusInfoType, ESJVector2D, ESJVector2DArray, ESJVector3D, ESJVector4D, ESVOption, Property, ViewerStatus } from "../ESJTypes";
 import { ESSceneObject } from "../ESObjects";
 import { ViewerContainer } from "./ViewerContainer";
 import { ViewerContext } from "./ViewerContext";
+/**
+ * ESViewer 类是一个抽象类，用于表示和操作视口。它继承自 Destroyable 类，提供了视口的基本功能和管理。
+ *
+ * 核心功能包括：
+ * - 视口的注册和管理
+ * - 视口容器的设置和获取
+ * - 视口状态的设置和获取
+ * - 视口事件的监听和处理
+ * - 场景对象的管理（添加、删除、查询）
+ * - 视口的更新和销毁
+ * - 视口的属性设置和获取
+ * - 视口的交互管理
+ * - 视口的同步和编辑功能
+ *
+ * 使用方式：
+ * - 创建视口实例时需要提供视口的选项，包括 ID 和容器。
+ * - 通过视口实例可以设置和获取视口的容器、状态、属性等。
+ * - 可以通过视口实例的方法来添加、删除和管理场景对象。
+ * - 视口实例提供了丰富的事件，可以监听和处理视口的各种交互和变化。
+ *
+ * 构造函数参数：
+ * - option: 视口的参数，包括 ID 和容器等。
+ *
+ * 特殊限制或副作用：
+ * - 视口的 ID 是只读的，一旦设置无法更改。
+ * - 视口的容器必须是 HTMLDivElement 或其 ID。
+ * - 视口的某些属性和功能可能需要特定的环境或依赖。
+ *
+ * 示例代码：
+ */
 export declare abstract class ESViewer extends Destroyable {
+    /**
+     * 视口的上下文对象。
+     */
     static readonly context: ViewerContext;
+    /**
+     * 注册视口的方法。
+     */
     static readonly register: <T extends ESViewer>(viewerType: string, viewerConstructor: new (option: ESVOption) => T) => string;
+    /**
+     * 强制重新创建视口的事件。
+     */
     private _forceRecreateEvent;
+    /**
+     * 强制重新创建视口。
+     */
     forceRecreate(): void;
+    /**
+     * 视口的容器，使用响应式变量存储。
+     */
     protected _container: ReactiveVariable<HTMLDivElement | undefined>;
+    /**
+     * 获取视口的容器。
+     */
     get container(): HTMLDivElement | undefined;
+    /**
+     * 设置视口的容器。
+     * @param value 容器元素或 undefined。
+     */
     set container(value: HTMLDivElement | undefined);
+    /**
+     * 设置视口的容器或容器 ID。
+     * @param value 容器元素或容器 ID。
+     */
     set containerOrId(value: HTMLDivElement | string);
+    /**
+     * 获取容器变化的事件。
+     */
     get containerChanged(): import("xbsj-base").Listener<[HTMLDivElement | undefined, HTMLDivElement | undefined]>;
+    /**
+     * 视口容器的大小，使用响应式变量存储。
+     */
     private _containerSize;
+    /**
+     * 获取视口容器的大小。
+     */
     get containerSize(): ESJVector2D | undefined;
+    /**
+     * 设置视口容器的大小。
+     * @param value 容器大小或 undefined。
+     */
     set containerSize(value: ESJVector2D | undefined);
+    /**
+     * 获取容器大小变化的事件。
+     */
     get containerSizeChanged(): import("xbsj-base").Listener<[ESJVector2D | undefined, ESJVector2D | undefined]>;
+    /**
+     * 编辑事件，包含编辑的相关信息。
+     */
     private _editingEvent;
+    /**
+     * 获取编辑事件。
+     */
     get editingEvent(): Event<[{
         et?: string;
         eid?: string;
@@ -32,75 +110,283 @@ export declare abstract class ESViewer extends Destroyable {
             error?: string;
         };
     }]>;
+    /**
+     * 视口的状态，使用响应式变量存储。
+     */
     private _status;
+    /**
+     * 获取视口的状态。
+     */
     get status(): ViewerStatus;
+    /**
+     * 获取视口状态变化的事件。
+     */
     get statusChanged(): import("xbsj-base").Listener<[ViewerStatus, ViewerStatus]>;
+    /**
+     * 设置视口的状态。
+     * @param value 视口的状态。
+     */
     setStatus(value: ViewerStatus): void;
+    /**
+     * 视口的状态日志，使用响应式变量存储。
+     */
     private _statusLog;
+    /**
+     * 获取视口的状态日志。
+     */
     get statusLog(): string;
+    /**
+     * 获取视口状态日志变化的事件。
+     */
     get statusLogChanged(): import("xbsj-base").Listener<[string, string]>;
+    /**
+     * 设置视口的状态日志。
+     * @param value 状态日志内容。
+     */
     setStatusLog(value: string): void;
+    /**
+     * 视口的状态容器。
+     */
     private _statusContainer;
+    /**
+     * 是否使用自定义交互，使用响应式变量存储。
+     */
     private _useCustomInteraction;
+    /**
+     * 获取是否使用自定义交互。
+     */
     get useCustomInteraction(): boolean;
+    /**
+     * 设置是否使用自定义交互。
+     * @param value 是否使用自定义交互。
+     */
     set useCustomInteraction(value: boolean);
+    /**
+     * 重置交互事件，根据容器变化、使用自定义交互变化和强制重新创建事件触发。
+     */
     private _resetInteractionEvent;
+    /**
+     * 交互重置对象，根据重置交互事件进行重置。
+     */
     private _interactionResetting;
+    /**
+     * 视口变化事件，当视口内部发生变化时触发。
+     */
     private _viewerChanged;
+    /**
+     * 获取视口变化事件。
+     */
     get viewerChanged(): Event<[innerViewer: any]>;
+    /**
+     * 容器重置事件，根据容器变化和强制重新创建事件触发。
+     */
     private _containerResetEvent;
+    /**
+     * 获取容器重置事件。
+     */
     get containerResetEvent(): import("xbsj-base").NextAnimateFrameEvent;
+    /**
+     * 容器重置对象，根据容器重置事件进行重置。
+     */
     private _containerResetting;
+    /**
+     * 获取子容器。
+     */
     get subContainer(): HTMLDivElement | undefined;
+    /**
+     * 获取子容器变化的事件。
+     */
     get subContainerChanged(): import("xbsj-base").Listener<[ViewerContainer | undefined, ViewerContainer | undefined]>;
+    /**
+     * 获取覆盖层容器。
+     */
     get overlayContainer(): HTMLDivElement | undefined;
+    /**
+     * 获取覆盖层容器变化的事件。
+     */
     get overlayContainerChanged(): import("xbsj-base").Listener<[ViewerContainer | undefined, ViewerContainer | undefined]>;
     /**
-       * 获取当前视口中的所有对象
-       */
+     * 场景对象映射表，存储场景对象和对应的引擎对象。
+     */
     private _sceneObjectsMap;
+    /**
+     * 获取场景对象映射表。
+     */
     get sceneObjectsMap(): Map<ESSceneObject, EngineObject<ESSceneObject, ESViewer> | undefined>;
+    /**
+     * 获取场景对象的迭代器。
+     */
     get sceneObjects(): MapIterator<ESSceneObject>;
+    /**
+     * 根据场景对象获取对应的引擎对象。
+     * @param sceneObject 场景对象。
+     */
     getEngineObject(sceneObject: ESSceneObject): EngineObject<ESSceneObject, ESViewer> | undefined;
+    /**
+     * 向视口中添加场景对象。
+     * @param sceneObjects 要添加的场景对象数组。
+     */
     add<T extends ESSceneObject>(...sceneObjects: T[]): void;
+    /**
+     * 从视口中删除场景对象。
+     * @param sceneObjects 要删除的场景对象数组。
+     */
     delete<T extends ESSceneObject>(...sceneObjects: T[]): void;
+    /**
+     * 一次性添加场景对象，并返回一个用于删除这些对象的函数。
+     * @param sceneObjects 要添加的场景对象数组。
+     */
     disposableAdd<T extends ESSceneObject>(...sceneObjects: T[]): () => void;
+    /**
+     * 别名，同 disposableAdd。
+     * @param sceneObjects 要添加的场景对象数组。
+     */
     disAdd<T extends ESSceneObject>(...sceneObjects: T[]): () => void;
+    /**
+     * 判断视口中是否包含某个场景对象。
+     * @param sceneObject 要判断的场景对象。
+     */
     has<T extends ESSceneObject>(sceneObject: T): boolean;
+    /**
+     * 清空视口中的所有场景对象。
+     */
     clearAllSceneObjects(): void;
+    /**
+     * 视口的 ID。
+     */
     private _id;
+    /**
+     * 获取视口的 ID。
+     */
     get id(): string;
+    /**
+     * 设置视口的 ID，该属性为只读。
+     * @param value 要设置的 ID。
+     */
     set id(value: string);
+    /**
+     * 视口的类型名称。
+     */
     private _typeName;
+    /**
+     * 获取视口的类型名称。
+     */
     get typeName(): string;
+    /**
+     * 初始化视口的名称。
+     */
     private _initName;
+    /**
+     * 获取视口的默认属性。
+     */
     get defaultProps(): {
+        /**
+         * 是否显示地球，默认值为 true。
+         */
         globeShow: boolean;
+        /**
+         * Ion 访问令牌，用于访问相关资源，初始值为空字符串。
+         */
         ionAccessToken: string;
+        /**
+         * 经纬度格式，默认为 'DECIMAL_DEGREE'（十进制度）。
+         */
         lonLatFormat: ESJLonLatFormatType;
+        /**
+         * 定义的相机视椎体夹角，默认值为 60。
+         */
         fov: number;
+        /**
+         * 是否开启文字避让，默认值为 false。
+         */
         textAvoidance: boolean;
+        /**
+         * 默认飞行定位时对象包围球所占的屏幕像素大小，默认值为 256。
+         */
         flyToBoundingSize: number | undefined;
+        /**
+         * 鼠标悬停时间，用于触发 hover 事件，单位为秒，默认值为 2。
+         */
         hoverTime: number;
+        /**
+         * 当前时间，用于控制光照，初始值为当前时间戳。
+         */
         currentTime: number;
+        /**
+         * 仿真时间，用于控制场景动画，初始值为当前时间戳。
+         */
         simulationTime: number;
+        /**
+         * 时间同步开关，false 表示禁用，true 表示启用，用于控制当前时间和仿真时间的同步，默认值为 false。
+         */
         timeSync: boolean;
+        /**
+         * 雨的强度，取值范围为 0~1，默认值为 0。
+         */
         rain: number;
+        /**
+         * 雪的强度，取值范围为 0~1，默认值为 0。
+         */
         snow: number;
+        /**
+         * 云的强度，取值范围为 0~1，默认值为 0。
+         */
         cloud: number;
+        /**
+         * 雾的强度，取值范围为 0~1，默认值为 0。
+         */
         fog: number;
+        /**
+         * 景深的强度，取值范围为 0~1，默认值为 0。
+         */
         depthOfField: number;
+        /**
+         * 是否显示大气效果，默认值为 true。
+         */
         atmosphere: boolean;
+        /**
+         * 编辑点的大小，可选值，初始值为 undefined。
+         */
         editingPointSize: number | undefined;
+        /**
+         * 编辑点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑辅助点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑线的宽度，可选值，初始值为 undefined。
+         */
         editingLineWidth: number | undefined;
+        /**
+         * 编辑线的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingLineColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑坐标轴的大小，可选值，初始值为 undefined。
+         */
         editingAxisSize: number | undefined;
+        /**
+         * 编辑辅助点的大小，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointSize: number | undefined;
+        /**
+         * 编辑高度偏移，可选值，默认值为 0。
+         */
         editingHeightOffset: number | undefined;
+        /**
+         * 是否显示编辑线，默认值为 true。
+         */
         editingLineShow: boolean;
+        /**
+         * 是否开启编辑事件监听，默认值为 true。
+         */
         editingEventListening: boolean;
+        /**
+         * 地形着色器配置，初始值为 ESViewer 的默认地形着色器配置。
+         */
         terrainShader: {
             slope: {
                 show: boolean;
@@ -121,37 +407,120 @@ export declare abstract class ESViewer extends Destroyable {
                 width: number;
             };
         };
+        /**
+         * 场景对象的名称，默认为 '未命名场景对象'。
+         */
         name: string;
+        /**
+         * 额外的 JSON 数据，使用响应式变量存储，初始值为 undefined。
+         */
         extras: ReactiveVariable<JsonValue>;
+        /**
+         * 开发标签数组，使用响应式变量存储，初始值为 undefined。
+         */
         devTags: ReactiveVariable<string[] | undefined>;
+        /**
+         * 是否开启调试模式，可选布尔值，初始值为 undefined。
+         */
         debug: boolean | undefined;
+        /**
+         * 视口是否可见，可选布尔值，初始值为 undefined。
+         */
         show: boolean | undefined;
+        /**
+         * 视口的透明度，可选数值，初始值为 undefined。
+         */
         opacity: number | undefined;
+        /**
+         * 视口的 z-index，可选字符串，初始值为 undefined。
+         */
         zIndex: string | undefined;
+        /**
+         * 是否使用默认的状态面板容器，即状态提示，布尔值，默认为 true。
+         */
         useDefaultStatusDiv: boolean;
+        /**
+         * 一次性执行的函数代码字符串，可选字符串，初始值为 undefined。
+         */
         execOnceFuncStr: string | undefined;
+        /**
+         * 更新函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         updateFuncStr: string | undefined;
+        /**
+         * 销毁函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 获取视口的 JSON 表示。
+     * @param ignoreDefaults 是否忽略默认属性。
+     */
     private _getJson;
+    /**
+     * 根据 JSON 数据设置视口的属性。
+     * @param value JSON 数据。
+     * @param filterKeys 过滤的属性键数组。
+     * @param partialSetting 是否部分设置。
+     */
     private _setJson;
+    /**
+     * 获取视口的 JSON 表示。
+     */
     get json(): JsonValue;
+    /**
+     * 根据 JSON 数据设置视口的属性。
+     * @param value JSON 数据。
+     */
     set json(value: JsonValue);
+    /**
+     * 更新函数，使用响应式变量存储。
+     */
     private _updateFuncReact;
+    /**
+     * 获取更新函数。
+     */
     get updateFunc(): ((sceneObject: ESViewer, timeStamp: number) => void) | undefined;
+    /**
+     * 设置更新函数。
+     * @param value 更新函数。
+     */
     set updateFunc(value: ((sceneObject: ESViewer, timeStamp: number) => void) | undefined);
+    /**
+     * 获取更新函数变化的事件。
+     */
     get updateFuncChanged(): import("xbsj-base").Listener<[((sceneObject: ESViewer, timeStamp: number) => void) | undefined, ((sceneObject: ESViewer, timeStamp: number) => void) | undefined]>;
+    /**
+     * 销毁函数，使用响应式变量存储。
+     */
     private _toDestroyFuncReact;
+    /**
+     * 获取销毁函数。
+     */
     get toDestroyFunc(): ((sceneObject: ESViewer) => void) | undefined;
+    /**
+     * 设置销毁函数。
+     * @param value 销毁函数。
+     */
     set toDestroyFunc(value: ((sceneObject: ESViewer) => void) | undefined);
+    /**
+     * 获取销毁函数变化的事件。
+     */
     get toDestroyFuncChanged(): import("xbsj-base").Listener<[((sceneObject: ESViewer) => void) | undefined, ((sceneObject: ESViewer) => void) | undefined]>;
+    /**
+     * 构造函数，初始化视口。
+     * @param option 视口的选项。
+     */
     constructor(option: ESVOption);
+    /**
+     * 视口的默认属性。
+     */
     static defaults: {
         show: boolean;
         debug: boolean;
         statusInfo: ESJStatusInfoType;
         /**
-         * elevationRamp中color可以是颜色数组或画布，设置为数组时长度<=7，缺失部分由默认颜色代替
+         * elevationRamp 中 color 可以是颜色数组或画布，设置为数组时长度<=7，缺失部分由默认颜色代替
          * 第一个颜色为最低高度的颜色，
          * 最后一个颜色为最高高度的颜色，
          * 中间的颜色为线性插值
@@ -178,155 +547,518 @@ export declare abstract class ESViewer extends Destroyable {
         };
         globeShow: boolean;
     };
+    /**
+     * 视口的状态信息。
+     */
     protected _statusInfo: ESJStatusInfoType;
-    protected _navigationMode: ReactiveVariable<ESJNavigationMode>;
+    /**
+     * 导航模式，使用响应式变量存储。
+     */
+    private _navigationMode;
+    /**
+     * 获取导航模式。
+     */
     get navigationMode(): ESJNavigationMode;
+    /**
+     * 获取导航模式变化的事件。
+     */
     get navigationModeChanged(): import("xbsj-base").Listener<[ESJNavigationMode, ESJNavigationMode]>;
+    /**
+     * 获取导航模式。
+     */
     getNavigationMode(): ESJNavigationMode;
+    /**
+     * 获取引擎类型。
+     */
     getEngineType(): string;
+    /**
+     * 同步的视口，使用响应式变量存储。
+     */
     private _syncViewer;
+    /**
+     * 获取同步的视口。
+     */
     get syncViewer(): ESViewer | undefined;
+    /**
+     * 设置同步的视口。
+     * @param value 要同步的视口。
+     */
     set syncViewer(value: ESViewer | undefined);
+    /**
+     * 获取同步视口变化的事件。
+     */
     get syncViewerChanged(): import("xbsj-base").Listener<[ESViewer | undefined, ESViewer | undefined]>;
+    /**
+     * 同步事件重置对象，根据同步视口变化事件进行重置。
+     */
     private _syncEventDon;
+    /**
+     * 同步另一个视口的属性。
+     * @param viewer 要同步的视口，undefined 时解绑。
+     */
     syncOtherViewer(viewer: ESViewer | undefined): void;
+    /**
+     * 时间同步重置对象，根据时间同步变化事件进行重置。
+     */
     private _timeSyncdon;
     /**
-     * 设置当前时间
+     * 设置当前时间。
      * @param value 时间戳(毫秒)数值或者时间格式字符串
-     * 字符串格式 2024 06 26 12:34:56 或者 2023-09-29或者2023/09/29 12:34:56
+     * 字符串格式 2024 06 26 12:34:56 或者 2023-09-29 或者 2023/09/29 12:34:56
      */
     setCurrentTime(value: number | string): void;
-    abstract pick(screenPosition: ESJVector2D, attachedInfo?: any, parentInfo?: boolean): Promise<PickedResult | undefined>;
+    /**
+     * 在屏幕位置进行拾取操作。
+     * @param screenPosition 屏幕位置。
+     * @param attachedInfo 附加信息。
+     * @param parentInfo 是否包含父信息。
+     */
+    abstract pick(screenPosition: ESJVector2D, attachedInfo?: any, parentInfo?: boolean): Promise<ESJPickedResult | undefined>;
+    /**
+     * 在屏幕位置拾取三维坐标。
+     * @param screenPosition 屏幕位置。
+     */
     abstract pickPosition(screenPosition: ESJVector2D): Promise<ESJVector3D | undefined>;
+    /**
+     * 飞行到指定位置。
+     * @param position 目标位置。
+     * @param rotation 目标旋转角度。
+     * @param duration 飞行持续时间。
+     * @param flyMode 飞行模式。
+     */
     abstract flyIn(position: ESJVector3D, rotation?: ESJVector3D, duration?: number, flyMode?: "default" | "uniform"): void;
+    /**
+     * 根据飞行参数飞行到指定位置。
+     * @param flyToParam 飞行参数。
+     * @param position 目标位置。
+     * @param flyMode 飞行模式。
+     */
     abstract flyTo(flyToParam: ESJFlyToParam, position: ESJVector3D, flyMode?: "default" | "uniform"): void;
+    /**
+     * 飞行到指定边界球。
+     * @param rectangle 边界球的矩形区域。
+     * @param distance 距离。
+     * @param duration 飞行持续时间。
+     */
     abstract flyToBoundingSphere(rectangle: ESJVector4D, distance?: number, duration?: number | undefined): void;
+    /**
+     * 获取当前相机的信息。
+     */
     abstract getCurrentCameraInfo(): {
         position: ESJVector3D;
         rotation: ESJVector3D;
     } | undefined;
+    /**
+     * 获取像素对应的长度。
+     */
     abstract getLengthInPixel(): number | undefined;
+    /**
+     * 切换到步行模式。
+     * @param position 位置。
+     * @param jumpZVelocity 跳跃的 Z 轴速度。
+     */
     abstract changeToWalk(position: ESJVector3D, jumpZVelocity: number): void;
+    /**
+     * 切换到地图模式。
+     */
     abstract changeToMap(): void;
+    /**
+     * 切换到旋转地球模式。
+     * @param latitude 纬度。
+     * @param height 高度。
+     * @param cycleTime 周期时间。
+     */
     abstract changeToRotateGlobe(latitude?: number, height?: number, cycleTime?: number): void;
+    /**
+     * 切换到沿线路径模式。
+     * @param geoLineStringId 地理线字符串 ID。
+     * @param speed 速度。
+     * @param heightOffset 高度偏移。
+     * @param loop 是否循环。
+     * @param turnRateDPS 转弯速率（度/秒）。
+     * @param lineMode 线路模式。
+     */
     abstract changeToLine(geoLineStringId: string, speed?: number, heightOffset?: number, loop?: boolean, turnRateDPS?: number, lineMode?: "auto" | "manual"): void;
+    /**
+     * 切换到用户自定义模式。
+     * @param userDefinedPawn 用户自定义的角色。
+     */
     abstract changeToUserDefined(userDefinedPawn: string): void;
+    /**
+     * 切换到绕点旋转模式。
+     * @param position 旋转点的位置。
+     * @param distance 距离。
+     * @param orbitPeriod 轨道周期。
+     * @param heading 航向。
+     * @param pitch 俯仰角。
+     */
     abstract changeToRotatePoint(position: ESJVector3D, distance?: number, orbitPeriod?: number, heading?: number, pitch?: number): void;
+    /**
+     * 切换到跟随模式。
+     * @param objectId 要跟随的对象 ID。
+     * @param distance 距离。
+     * @param heading 航向。
+     * @param pitch 俯仰角。
+     * @param relativeRotation 是否相对旋转。
+     */
     abstract changeToFollow(objectId: string, distance?: number, heading?: number, pitch?: number, relativeRotation?: boolean): void;
+    /**
+     * 获取帧率。
+     */
     abstract getFPS(): number;
+    /**
+     * 获取指定 ID 对象的边界球信息。
+     * @param id 对象的 ID。
+     */
     abstract getBoundSphere(id: string): Promise<{
         center?: [number, number, number];
         radius?: number;
         tips?: string;
     } | undefined>;
+    /**
+     * 获取版本信息。
+     */
     getVersion(): Promise<any>;
+    /**
+     * 根据经纬度获取高度。
+     * @param lon 经度。
+     * @param lat 纬度。
+     * @param channel 通道，UE特有属性。
+     */
     abstract getHeightByLonLat(lon: number, lat: number, channel?: string): Promise<number | null>;
+    /**
+     * 根据经纬度数组获取高度数组。
+     * @param lonLats 经纬度数组。
+     * @param channel 通道，UE特有属性。
+     */
     abstract getHeightsByLonLats(lonLats: ESJVector2DArray, channel?: string): Promise<(number | null)[] | undefined>;
+    /**
+     * 捕获视口的图像。
+     * @param resx 图像的宽度。
+     * @param resy 图像的高度。
+     */
     abstract capture(resx?: number, resy?: number): Promise<string | undefined>;
+    /**
+     * 将经纬度高度坐标转换为屏幕位置。
+     * @param position 经纬度高度坐标。
+     */
     abstract lonLatAltToScreenPosition(position: ESJVector3D): Promise<ESJVector2D | undefined>;
+    /**
+     * 开始编辑场景对象。
+     * @param sceneObject 要编辑的场景对象。
+     * @param modes 编辑模式数组或单个模式。
+     * @param options 编辑选项。
+     */
     abstract startEditing(sceneObject: ESSceneObject, modes: string[] | string, options?: {
         useKeyToSwitch?: boolean;
         callSource?: "outer" | "inner";
     }): void;
+    /**
+     * 停止编辑。
+     */
     abstract stopEditing(): void;
+    /**
+     * 移动场景对象。
+     * @param sceneObjects 要移动的场景对象数组。
+     */
     abstract moveObjects(sceneObjects: ESSceneObject[]): void;
     /**
-     * 鼠标悬停事件 悬停时长可由hoverTime属性控制
+     * 鼠标悬停事件 悬停时长可由 hoverTime 属性控制。
      */
     get hoverEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标悬停事件。
+     */
     private _hoverEvent;
+    /**
+     * 鼠标指针进入事件。
+     */
     private _pointerOverEvent;
+    /**
+     * 获取鼠标指针进入事件。
+     */
     get pointerOverEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标指针移动事件。
+     */
     private _pointerMoveEvent;
+    /**
+     * 获取鼠标指针移动事件。
+     */
     get pointerMoveEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标指针按下事件。
+     */
     private _pointerDownEvent;
+    /**
+     * 获取鼠标指针按下事件。
+     */
     get pointerDownEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标指针抬起事件。
+     */
     private _pointerUpEvent;
+    /**
+     * 获取鼠标指针抬起事件。
+     */
     get pointerUpEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标指针移出事件。
+     */
     private _pointerOutEvent;
+    /**
+     * 获取鼠标指针移出事件。
+     */
     get pointerOutEvent(): Event<[{
         screenPosition: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标单击事件。
+     */
     private _clickEvent;
+    /**
+     * 获取鼠标单击事件。
+     */
     get clickEvent(): Event<[{
         screenPosition?: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 鼠标双击事件。
+     */
     private _dblclickEvent;
+    /**
+     * 获取鼠标双击事件。
+     */
     get dblclickEvent(): Event<[{
         screenPosition?: ESJVector2D;
         pointerEvent?: PointerEvent;
     }]>;
+    /**
+     * 键盘按下事件。
+     */
     protected _keyDownEvent: Event<[KeyboardEvent]>;
+    /**
+     * 获取键盘按下事件。
+     */
     get keyDownEvent(): Event<[KeyboardEvent]>;
+    /**
+     * 键盘抬起事件。
+     */
     protected _keyUpEvent: Event<[KeyboardEvent]>;
+    /**
+     * 获取键盘抬起事件。
+     */
     get keyUpEvent(): Event<[KeyboardEvent]>;
+    /**
+     * 滚轮事件。
+     */
     protected _wheelEvent: Event<[WheelEvent]>;
+    /**
+     * 获取滚轮事件。
+     */
     get wheelEvent(): Event<[WheelEvent]>;
+    /**
+     * 获取视口的属性列表。
+     * @param language 语言。
+     */
     getProperties(language?: string): Property[];
+    /**
+     * 视口是否激活，使用响应式变量存储。
+     */
     private _actived;
+    /**
+     * 获取视口是否激活。
+     */
     get actived(): boolean;
+    /**
+     * 设置视口是否激活。
+     * @param value 是否激活。
+     */
     set actived(value: boolean);
+    /**
+     * 获取视口激活状态变化的事件。
+     */
     get activedChanged(): import("xbsj-base").Listener<[boolean, boolean]>;
 }
 export declare namespace ESViewer {
+    /**
+     * 创建视口的基础属性。
+     */
     const createBaseProps: () => {
+        /**
+         * 场景对象的名称，默认为 '未命名场景对象'。
+         */
         name: string;
+        /**
+         * 额外的 JSON 数据，使用响应式变量存储，初始值为 undefined。
+         */
         extras: ReactiveVariable<JsonValue>;
+        /**
+         * 开发标签数组，使用响应式变量存储，初始值为 undefined。
+         */
         devTags: ReactiveVariable<string[] | undefined>;
+        /**
+         * 是否开启调试模式，可选布尔值，初始值为 undefined。
+         */
         debug: boolean | undefined;
+        /**
+         * 视口是否可见，可选布尔值，初始值为 undefined。
+         */
         show: boolean | undefined;
+        /**
+         * 视口的透明度，可选数值，初始值为 undefined。
+         */
         opacity: number | undefined;
+        /**
+         * 视口的 z-index，可选字符串，初始值为 undefined。
+         */
         zIndex: string | undefined;
+        /**
+         * 是否使用默认的状态面板容器，即状态提示，布尔值，默认为 true。
+         */
         useDefaultStatusDiv: boolean;
+        /**
+         * 一次性执行的函数代码字符串，可选字符串，初始值为 undefined。
+         */
         execOnceFuncStr: string | undefined;
+        /**
+         * 更新函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         updateFuncStr: string | undefined;
+        /**
+         * 销毁函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 创建视口的通用属性。
+     * @returns 包含视口通用属性的对象。
+     */
     const createCommonProps: () => {
+        /**
+         * 是否显示地球，默认值为 true。
+         */
         globeShow: boolean;
+        /**
+         * Ion 访问令牌，用于访问相关资源，初始值为空字符串。
+         */
         ionAccessToken: string;
+        /**
+         * 经纬度格式，默认为 'DECIMAL_DEGREE'（十进制度）。
+         */
         lonLatFormat: ESJLonLatFormatType;
+        /**
+         * 定义的相机视椎体夹角，默认值为 60。
+         */
         fov: number;
+        /**
+         * 是否开启文字避让，默认值为 false。
+         */
         textAvoidance: boolean;
+        /**
+         * 默认飞行定位时对象包围球所占的屏幕像素大小，默认值为 256。
+         */
         flyToBoundingSize: number | undefined;
+        /**
+         * 鼠标悬停时间，用于触发 hover 事件，单位为秒，默认值为 2。
+         */
         hoverTime: number;
+        /**
+         * 当前时间，用于控制光照，初始值为当前时间戳。
+         */
         currentTime: number;
+        /**
+         * 仿真时间，用于控制场景动画，初始值为当前时间戳。
+         */
         simulationTime: number;
+        /**
+         * 时间同步开关，false 表示禁用，true 表示启用，用于控制当前时间和仿真时间的同步，默认值为 false。
+         */
         timeSync: boolean;
+        /**
+         * 雨的强度，取值范围为 0~1，默认值为 0。
+         */
         rain: number;
+        /**
+         * 雪的强度，取值范围为 0~1，默认值为 0。
+         */
         snow: number;
+        /**
+         * 云的强度，取值范围为 0~1，默认值为 0。
+         */
         cloud: number;
+        /**
+         * 雾的强度，取值范围为 0~1，默认值为 0。
+         */
         fog: number;
+        /**
+         * 景深的强度，取值范围为 0~1，默认值为 0。
+         */
         depthOfField: number;
+        /**
+         * 是否显示大气效果，默认值为 true。
+         */
         atmosphere: boolean;
+        /**
+         * 编辑点的大小，可选值，初始值为 undefined。
+         */
         editingPointSize: number | undefined;
+        /**
+         * 编辑点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑辅助点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑线的宽度，可选值，初始值为 undefined。
+         */
         editingLineWidth: number | undefined;
+        /**
+         * 编辑线的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingLineColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑坐标轴的大小，可选值，初始值为 undefined。
+         */
         editingAxisSize: number | undefined;
+        /**
+         * 编辑辅助点的大小，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointSize: number | undefined;
+        /**
+         * 编辑高度偏移，可选值，默认值为 0。
+         */
         editingHeightOffset: number | undefined;
+        /**
+         * 是否显示编辑线，默认值为 true。
+         */
         editingLineShow: boolean;
+        /**
+         * 是否开启编辑事件监听，默认值为 true。
+         */
         editingEventListening: boolean;
+        /**
+         * 地形着色器配置，初始值为 ESViewer 的默认地形着色器配置。
+         */
         terrainShader: {
             slope: {
                 show: boolean;
@@ -348,33 +1080,117 @@ export declare namespace ESViewer {
             };
         };
     };
+    /**
+     * 创建视口的默认属性。
+     */
     const createDefaultProps: () => {
+        /**
+         * 是否显示地球，默认值为 true。
+         */
         globeShow: boolean;
+        /**
+         * Ion 访问令牌，用于访问相关资源，初始值为空字符串。
+         */
         ionAccessToken: string;
+        /**
+         * 经纬度格式，默认为 'DECIMAL_DEGREE'（十进制度）。
+         */
         lonLatFormat: ESJLonLatFormatType;
+        /**
+         * 定义的相机视椎体夹角，默认值为 60。
+         */
         fov: number;
+        /**
+         * 是否开启文字避让，默认值为 false。
+         */
         textAvoidance: boolean;
+        /**
+         * 默认飞行定位时对象包围球所占的屏幕像素大小，默认值为 256。
+         */
         flyToBoundingSize: number | undefined;
+        /**
+         * 鼠标悬停时间，用于触发 hover 事件，单位为秒，默认值为 2。
+         */
         hoverTime: number;
+        /**
+         * 当前时间，用于控制光照，初始值为当前时间戳。
+         */
         currentTime: number;
+        /**
+         * 仿真时间，用于控制场景动画，初始值为当前时间戳。
+         */
         simulationTime: number;
+        /**
+         * 时间同步开关，false 表示禁用，true 表示启用，用于控制当前时间和仿真时间的同步，默认值为 false。
+         */
         timeSync: boolean;
+        /**
+         * 雨的强度，取值范围为 0~1，默认值为 0。
+         */
         rain: number;
+        /**
+         * 雪的强度，取值范围为 0~1，默认值为 0。
+         */
         snow: number;
+        /**
+         * 云的强度，取值范围为 0~1，默认值为 0。
+         */
         cloud: number;
+        /**
+         * 雾的强度，取值范围为 0~1，默认值为 0。
+         */
         fog: number;
+        /**
+         * 景深的强度，取值范围为 0~1，默认值为 0。
+         */
         depthOfField: number;
+        /**
+         * 是否显示大气效果，默认值为 true。
+         */
         atmosphere: boolean;
+        /**
+         * 编辑点的大小，可选值，初始值为 undefined。
+         */
         editingPointSize: number | undefined;
+        /**
+         * 编辑点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑辅助点的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑线的宽度，可选值，初始值为 undefined。
+         */
         editingLineWidth: number | undefined;
+        /**
+         * 编辑线的颜色，使用响应式数组存储，可选值，初始值为 undefined。
+         */
         editingLineColor: ReactiveVariable<ESJVector4D | undefined>;
+        /**
+         * 编辑坐标轴的大小，可选值，初始值为 undefined。
+         */
         editingAxisSize: number | undefined;
+        /**
+         * 编辑辅助点的大小，可选值，初始值为 undefined。
+         */
         editingAuxiliaryPointSize: number | undefined;
+        /**
+         * 编辑高度偏移，可选值，默认值为 0。
+         */
         editingHeightOffset: number | undefined;
+        /**
+         * 是否显示编辑线，默认值为 true。
+         */
         editingLineShow: boolean;
+        /**
+         * 是否开启编辑事件监听，默认值为 true。
+         */
         editingEventListening: boolean;
+        /**
+         * 地形着色器配置，初始值为 ESViewer 的默认地形着色器配置。
+         */
         terrainShader: {
             slope: {
                 show: boolean;
@@ -395,19 +1211,55 @@ export declare namespace ESViewer {
                 width: number;
             };
         };
+        /**
+         * 场景对象的名称，默认为 '未命名场景对象'。
+         */
         name: string;
+        /**
+         * 额外的 JSON 数据，使用响应式变量存储，初始值为 undefined。
+         */
         extras: ReactiveVariable<JsonValue>;
+        /**
+         * 开发标签数组，使用响应式变量存储，初始值为 undefined。
+         */
         devTags: ReactiveVariable<string[] | undefined>;
+        /**
+         * 是否开启调试模式，可选布尔值，初始值为 undefined。
+         */
         debug: boolean | undefined;
+        /**
+         * 视口是否可见，可选布尔值，初始值为 undefined。
+         */
         show: boolean | undefined;
+        /**
+         * 视口的透明度，可选数值，初始值为 undefined。
+         */
         opacity: number | undefined;
+        /**
+         * 视口的 z-index，可选字符串，初始值为 undefined。
+         */
         zIndex: string | undefined;
+        /**
+         * 是否使用默认的状态面板容器，即状态提示，布尔值，默认为 true。
+         */
         useDefaultStatusDiv: boolean;
+        /**
+         * 一次性执行的函数代码字符串，可选字符串，初始值为 undefined。
+         */
         execOnceFuncStr: string | undefined;
+        /**
+         * 更新函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         updateFuncStr: string | undefined;
+        /**
+         * 销毁函数的代码字符串，可选字符串，初始值为 undefined。
+         */
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * ESViewer 接口，继承自 UniteChanged 并使用 createDefaultProps 的返回类型。
+ */
 export interface ESViewer extends UniteChanged<ReturnType<typeof ESViewer.createDefaultProps>> {
 }
 //# sourceMappingURL=ESViewer.d.ts.map