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

package/dist/types/ESObjects/general/ESGeoJson/index.d.ts

@@ -3,31 +3,116 @@ import { BooleanProperty, ColorProperty, EnumProperty, ESJFillStyle, ESJFlyInPar
 import { ESVisualObject } from "../../../ESObjects/base";
 import { ESJImageStyle, ESJTextStyle } from "./type";
 /**
- * GeoJson数据加载
- * https://www.wolai.com/earthsdk/uU8Lc9viWAjB7xnAxBabjx
- * https://c0yh9tnn0na.feishu.cn/wiki/GvNFwCXBgi4FXqk3sWocyyaEnze
+ * ESGeoJson 类用于加载和处理 GeoJson 数据，提供了一系列方法和属性来操作和管理 GeoJson 要素。
+ *
+ * 核心功能包括：
+ * - 加载 GeoJson 数据
+ * - 飞行到指定要素或要素索引
+ * - 获取和设置 GeoJson 要素数据
+ * - 监听和触发要素数据变更事件
+ * - 配置样式，包括线样式、面样式、图片样式和文本样式
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param {string | undefined} id - 对象的 ID，可选
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 暂不支持编辑状态变更
+ * - 当数据未加载完成时，调用 getFeatures 方法会在控制台输出提示信息
  */
 export declare class ESGeoJson extends ESVisualObject {
+    /**
+     * 注册 ESGeoJson 类，设置其类型名称、中文名称、标签和描述信息
+     */
     static readonly type: string;
+    /**
+     * 获取类型名称
+     * @returns {string} 类型名称
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性
+     * @returns {any} 默认属性对象
+     */
     get defaultProps(): {
+        /**
+         * 控制对象是否显示的布尔值。
+         * @default true
+         */
         show: boolean;
+        /**
+         * 控制对象是否允许被拾取的布尔值。
+         * @default true
+         */
         allowPicking: boolean;
+        /**
+         * 用于加载数据的函数的字符串表示。
+         * @default undefined
+         */
         loadFuncStr: string | undefined;
+        /**
+         * 数据来源的 URL，可以是字符串或对象。
+         * @default undefined
+         */
         url: string | undefined | {
             [xx: string]: any;
         };
+        /**
+         * 控制线条是否显示的布尔值。
+         * @default true
+         */
         stroked: boolean;
+        /**
+         * 线条样式的配置对象。
+         */
         strokeStyle: import("xbsj-base").ReactiveVariable<ESJStrokeStyle>;
+        /**
+         * 控制面是否显示的布尔值。
+         * @default true
+         */
         filled: boolean;
+        /**
+         * 面样式的配置对象。
+         */
         fillStyle: import("xbsj-base").ReactiveVariable<ESJFillStyle>;
+        /**
+         * 控制图片是否显示的布尔值。
+         * @default true
+         */
         imageShow: boolean;
+        /**
+         * 图片样式的配置对象。
+         */
         imageStyle: import("xbsj-base").ReactiveVariable<ESJImageStyle>;
+        /**
+         * 控制文本是否显示的布尔值。
+         * @default true
+         */
         textShow: boolean;
+        /**
+         * 文本样式的配置对象。
+         */
         textStyle: import("xbsj-base").ReactiveVariable<ESJTextStyle>;
+        /**
+         * 要素可见的最小距离，0表示不限制。
+         * @default 0
+         */
         minFeatureVisibleDistance: number;
+        /**
+         * 要素可见的最大距离，0表示不限制。
+         * @default 0
+         */
         maxFeatureVisibleDistance: number;
+        /**
+         * 飞入参数配置对象，用于控制相机飞入效果。
+         * @default undefined
+         */
         flyInParam: import("xbsj-base").ReactiveVariable<ESJFlyInParam | undefined>;
+        /**
+         * 高度参考模式，可选 'NONE'、'RELATIVE_TO_GROUND' 或 'CLAMP_TO_GROUND'。
+         * @default "NONE"
+         */
         heightReference: "NONE" | "RELATIVE_TO_GROUND" | "CLAMP_TO_GROUND";
         collision: boolean;
         flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
@@ -39,29 +124,84 @@ export declare class ESGeoJson extends ESVisualObject {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 飞行到指定要素的事件
+     */
     private _flyToFeatureEvent;
+    /**
+     * 获取飞行到指定要素的事件监听器
+     * @returns {Listener<[string, any, number | undefined]>} 事件监听器
+     */
     get flyToFeatureEvent(): Listener<[string, any, number | undefined]>;
+    /**
+     * 触发飞行到指定要素的事件
+     * @param {string} key - 要素的键
+     * @param {any} value - 要素的值
+     * @param {number | undefined} duration - 飞行持续时间，可选
+     */
     flyToFeature(key: string, value: any, duration?: number): void;
+    /**
+     * 飞行到指定要素索引的事件
+     */
     private _flyToFeatureIndexEvent;
+    /**
+     * 获取飞行到指定要素索引的事件监听器
+     * @returns {Listener<[number, number | undefined]>} 事件监听器
+     */
     get flyToFeatureIndexEvent(): Listener<[number, number | undefined]>;
+    /**
+     * 触发飞行到指定要素索引的事件
+     * @param {number} index - 要素的索引
+     * @param {number | undefined} duration - 飞行持续时间，可选
+     */
     flyToFeatureIndex(index: number, duration?: number): void;
+    /**
+     * GeoJSON 要素数据，使用 reactJsonWithUndefined 进行响应式处理
+     */
     private _features;
+    /**
+     * 获取 GeoJSON 要素数据
+     * @returns {{ [xx: string]: any } | undefined} GeoJSON 要素数据
+     */
     get features(): {
         [xx: string]: any;
     } | undefined;
+    /**
+     * 设置 GeoJSON 要素数据
+     * @param {{ [xx: string]: any } | undefined} value - GeoJSON 要素数据
+     */
     set features(value: {
         [xx: string]: any;
     } | undefined);
+    /**
+     * 获取要素数据变更事件
+     * @returns {UniteChanged<{ [xx: string]: any } | undefined>} 要素数据变更事件
+     */
     get featuresChanged(): Listener<[{
         [xx: string]: any;
     } | undefined, {
         [xx: string]: any;
     } | undefined]>;
+    /**
+     * 拾取信息的类型，默认为 "FeatureCollection"
+     */
     pickedInfoType: string;
+    /**
+     * 获取 GeoJSON 要素数据
+     * 如果数据未加载完成，会在控制台输出提示信息
+     * @returns {{ [xx: string]: any } | undefined} GeoJSON 要素数据
+     */
     getFeatures(): {
         [xx: string]: any;
     } | undefined;
+    /**
+     * 构造函数
+     * @param {string | undefined} id - 对象的 ID，可选
+     */
     constructor(id?: string);
+    /**
+     * 默认属性值
+     */
     static defaults: {
         show: boolean;
         allowPicking: boolean;
@@ -120,6 +260,10 @@ export declare class ESGeoJson extends ESVisualObject {
         collision: boolean;
         flyToParam: import("../../../ESJTypes").ESJFlyToParam;
     };
+    /**
+     * 获取 ES 属性配置
+     * @returns {any} ES 属性配置对象
+     */
     getESProperties(): {
         defaultMenu: string;
         basic: never[];
@@ -129,99 +273,457 @@ export declare class ESGeoJson extends ESVisualObject {
         coordinate: never[];
         style: (BooleanProperty | StringProperty | NumberProperty | Number2Property | ColorProperty | GroupProperty | EnumProperty<string> | JsonProperty<string> | JsonProperty<{}>)[];
     };
+    /**
+     * 获取属性配置
+     * @param {string | undefined} language - 语言，可选
+     * @returns {any[]} 属性配置数组
+     */
     getProperties(language?: string): import("../../../ESJTypes").Property[];
+    /**
+     * 获取线宽
+     * @returns {number} 线宽
+     */
     get strokeWidth(): number;
+    /**
+     * 设置线宽
+     * @param {number} value - 线宽值
+     */
     set strokeWidth(value: number);
+    /**
+     * 获取线宽变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线宽变更事件
+     */
     get strokeWidthChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取线宽类型
+     * @returns {ESJRenderType} 线宽类型
+     */
     get strokeWidthType(): ESJRenderType;
+    /**
+     * 设置线宽类型
+     * @param {ESJRenderType} value - 线宽类型值
+     */
     set strokeWidthType(value: ESJRenderType);
+    /**
+     * 获取线宽类型变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线宽类型变更事件
+     */
     get strokeWidthTypeChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取线颜色
+     * @returns {ESJVector4D} 线颜色
+     */
     get strokeColor(): ESJVector4D;
+    /**
+     * 设置线颜色
+     * @param {ESJVector4D} value - 线颜色值
+     */
     set strokeColor(value: ESJVector4D);
+    /**
+     * 获取线颜色变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线颜色变更事件
+     */
     get strokeColorChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取线材质
+     * @returns {string} 线材质
+     */
     get strokeMaterial(): string;
+    /**
+     * 设置线材质
+     * @param {string} value - 线材质值
+     */
     set strokeMaterial(value: string);
+    /**
+     * 获取线材质变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线材质变更事件
+     */
     get strokeMaterialChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取线材质参数
+     * @returns {JsonValue} 线材质参数
+     */
     get strokeMaterialParams(): JsonValue;
+    /**
+     * 设置线材质参数
+     * @param {JsonValue} value - 线材质参数值
+     */
     set strokeMaterialParams(value: JsonValue);
+    /**
+     * 获取线材质参数变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线材质参数变更事件
+     */
     get strokeMaterialParamsChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取线是否贴地
+     * @returns {boolean} 线是否贴地
+     */
     get strokeGround(): boolean;
+    /**
+     * 设置线是否贴地
+     * @param {boolean} value - 线是否贴地的值
+     */
     set strokeGround(value: boolean);
+    /**
+     * 获取线贴地状态变更事件
+     * @returns {UniteChanged<ESJStrokeStyle>} 线贴地状态变更事件
+     */
     get strokeGroundChanged(): Listener<[ESJStrokeStyle, ESJStrokeStyle]>;
+    /**
+     * 获取填充颜色
+     * @returns {ESJVector4D} 填充颜色
+     */
     get fillColor(): ESJVector4D;
+    /**
+     * 设置填充颜色
+     * @param {ESJVector4D} value - 填充颜色值
+     */
     set fillColor(value: ESJVector4D);
+    /**
+     * 获取填充颜色变更事件
+     * @returns {UniteChanged<ESJFillStyle>} 填充颜色变更事件
+     */
     get fillColorChanged(): Listener<[ESJFillStyle, ESJFillStyle]>;
+    /**
+     * 获取填充材质
+     * @returns {string} 填充材质
+     */
     get fillMaterial(): string;
+    /**
+     * 设置填充材质
+     * @param {string} value - 填充材质值
+     */
     set fillMaterial(value: string);
+    /**
+     * 获取填充材质变更事件
+     * @returns {UniteChanged<ESJFillStyle>} 填充材质变更事件
+     */
     get fillMaterialChanged(): Listener<[ESJFillStyle, ESJFillStyle]>;
+    /**
+     * 获取填充材质参数
+     * @returns {JsonValue | undefined} 填充材质参数
+     */
     get fillMaterialParams(): JsonValue | undefined;
+    /**
+     * 设置填充材质参数
+     * @param {JsonValue | undefined} value - 填充材质参数值
+     */
     set fillMaterialParams(value: JsonValue | undefined);
+    /**
+     * 获取填充材质参数变更事件
+     * @returns {UniteChanged<ESJFillStyle>} 填充材质参数变更事件
+     */
     get fillMaterialParamsChanged(): Listener<[ESJFillStyle, ESJFillStyle]>;
+    /**
+     * 获取面是否贴地
+     * @returns {boolean} 面是否贴地
+     */
     get fillGround(): boolean;
+    /**
+     * 设置面是否贴地
+     * @param {boolean} value - 面是否贴地的值
+     */
     set fillGround(value: boolean);
+    /**
+     * 获取面贴地状态变更事件
+     * @returns {UniteChanged<ESJFillStyle>} 面贴地状态变更事件
+     */
     get fillGroundChanged(): Listener<[ESJFillStyle, ESJFillStyle]>;
+    /**
+     * 获取标注文本显示属性
+     * @returns {string} 标注文本显示属性
+     */
     get textProperty(): string;
+    /**
+     * 设置标注文本显示属性
+     * @param {string} value - 标注文本显示属性值
+     */
     set textProperty(value: string);
+    /**
+     * 获取标注文本显示属性变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本显示属性变更事件
+     */
     get textPropertyChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注默认文本
+     * @returns {string} 标注默认文本
+     */
     get textDefaultText(): string;
+    /**
+     * 设置标注默认文本
+     * @param {string} value - 标注默认文本值
+     */
     set textDefaultText(value: string);
+    /**
+     * 获取标注默认文本变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注默认文本变更事件
+     */
     get textDefaultTextChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本颜色
+     * @returns {ESJVector4D} 标注文本颜色
+     */
     get textColor(): ESJVector4D;
+    /**
+     * 设置标注文本颜色
+     * @param {ESJVector4D} value - 标注文本颜色值
+     */
     set textColor(value: ESJVector4D);
+    /**
+     * 获取标注文本颜色变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本颜色变更事件
+     */
     get textColorChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本背景颜色
+     * @returns {ESJVector4D | undefined} 标注文本背景颜色
+     */
     get textBackgroundColor(): ESJVector4D | undefined;
+    /**
+     * 设置标注文本背景颜色
+     * @param {ESJVector4D | undefined} value - 标注文本背景颜色值
+     */
     set textBackgroundColor(value: ESJVector4D | undefined);
+    /**
+     * 获取标注文本背景颜色变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本背景颜色变更事件
+     */
     get textBackgroundColorChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本字体
+     * @returns {string} 标注文本字体
+     */
     get textFontFamily(): string;
+    /**
+     * 设置标注文本字体
+     * @param {string} value - 标注文本字体值
+     */
     set textFontFamily(value: string);
+    /**
+     * 获取标注文本字体变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本字体变更事件
+     */
     get textFontFamilyChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本字体样式
+     * @returns {string} 标注文本字体样式
+     */
     get textFontStyle(): string;
+    /**
+     * 设置标注文本字体样式
+     * @param {string} value - 标注文本字体样式值
+     */
     set textFontStyle(value: string);
+    /**
+     * 获取标注文本字体样式变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本字体样式变更事件
+     */
     get textFontStyleChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本字体粗细
+     * @returns {string} 标注文本字体粗细
+     */
     get textFontWeight(): string;
+    /**
+     * 设置标注文本字体粗细
+     * @param {string} value - 标注文本字体粗细值
+     */
     set textFontWeight(value: string);
+    /**
+     * 获取标注文本字体粗细变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本字体粗细变更事件
+     */
     get textFontWeightChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本字体大小
+     * @returns {number} 标注文本字体大小
+     */
     get textFontSize(): number;
+    /**
+     * 设置标注文本字体大小
+     * @param {number} value - 标注文本字体大小值
+     */
     set textFontSize(value: number);
+    /**
+     * 获取标注文本字体大小变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本字体大小变更事件
+     */
     get textFontSizeChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本锚点
+     * @returns {ESJVector2D} 标注文本锚点
+     */
     get textAnchor(): ESJVector2D;
+    /**
+     * 设置标注文本锚点
+     * @param {ESJVector2D} value - 标注文本锚点值
+     */
     set textAnchor(value: ESJVector2D);
+    /**
+     * 获取标注文本锚点变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本锚点变更事件
+     */
     get textAnchorChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注文本像素偏移
+     * @returns {ESJVector2D} 标注文本像素偏移
+     */
     get textOffset(): ESJVector2D;
+    /**
+     * 设置标注文本像素偏移
+     * @param {ESJVector2D} value - 标注文本像素偏移值
+     */
     set textOffset(value: ESJVector2D);
+    /**
+     * 获取标注文本像素偏移变更事件
+     * @returns {UniteChanged<ESJTextStyle>} 标注文本像素偏移变更事件
+     */
     get textOffsetChanged(): Listener<[ESJTextStyle, ESJTextStyle]>;
+    /**
+     * 获取标注图片地址
+     * @returns {string | ESJResource} 标注图片地址
+     */
     get imageUrl(): string | ESJResource;
+    /**
+     * 设置标注图片地址
+     * @param {string | ESJResource} value - 标注图片地址值
+     */
     set imageUrl(value: string | ESJResource);
+    /**
+     * 获取标注图片地址变更事件
+     * @returns {UniteChanged<ESJImageStyle>} 标注图片地址变更事件
+     */
     get imageUrlChanged(): Listener<[ESJImageStyle, ESJImageStyle]>;
+    /**
+     * 获取标注图片大小
+     * @returns {ESJVector2D} 标注图片大小
+     */
     get imageSize(): ESJVector2D;
+    /**
+     * 设置标注图片大小
+     * @param {ESJVector2D} value - 标注图片大小值
+     */
     set imageSize(value: ESJVector2D);
+    /**
+     * 获取标注图片大小变更事件
+     * @returns {UniteChanged<ESJImageStyle>} 标注图片大小变更事件
+     */
     get imageSizeChanged(): Listener<[ESJImageStyle, ESJImageStyle]>;
+    /**
+     * 获取标注图片锚点
+     * @returns {ESJVector2D} 标注图片锚点
+     */
     get imageAnchor(): ESJVector2D;
+    /**
+     * 设置标注图片锚点
+     * @param {ESJVector2D} value - 标注图片锚点值
+     */
     set imageAnchor(value: ESJVector2D);
+    /**
+     * 获取标注图片锚点变更事件
+     * @returns {UniteChanged<ESJImageStyle>} 标注图片锚点变更事件
+     */
     get imageAnchorChanged(): Listener<[ESJImageStyle, ESJImageStyle]>;
+    /**
+     * 获取标注图片像素偏移
+     * @returns {ESJVector2D} 标注图片像素偏移
+     */
     get imageOffset(): ESJVector2D;
+    /**
+     * 设置标注图片像素偏移
+     * @param {ESJVector2D} value - 标注图片像素偏移值
+     */
     set imageOffset(value: ESJVector2D);
+    /**
+     * 获取标注图片像素偏移变更事件
+     * @returns {UniteChanged<ESJImageStyle>} 标注图片像素偏移变更事件
+     */
     get imageOffsetChanged(): Listener<[ESJImageStyle, ESJImageStyle]>;
 }
 export declare namespace ESGeoJson {
+    /**
+     * 创建 ESGeoJson 对象的默认属性配置。
+     *
+     * @returns {Object} 包含 ESGeoJson 对象默认属性的配置对象。
+     */
     const createDefaultProps: () => {
+        /**
+         * 控制对象是否显示的布尔值。
+         * @default true
+         */
         show: boolean;
+        /**
+         * 控制对象是否允许被拾取的布尔值。
+         * @default true
+         */
         allowPicking: boolean;
+        /**
+         * 用于加载数据的函数的字符串表示。
+         * @default undefined
+         */
         loadFuncStr: string | undefined;
+        /**
+         * 数据来源的 URL，可以是字符串或对象。
+         * @default undefined
+         */
         url: string | undefined | {
             [xx: string]: any;
         };
+        /**
+         * 控制线条是否显示的布尔值。
+         * @default true
+         */
         stroked: boolean;
+        /**
+         * 线条样式的配置对象。
+         */
         strokeStyle: import("xbsj-base").ReactiveVariable<ESJStrokeStyle>;
+        /**
+         * 控制面是否显示的布尔值。
+         * @default true
+         */
         filled: boolean;
+        /**
+         * 面样式的配置对象。
+         */
         fillStyle: import("xbsj-base").ReactiveVariable<ESJFillStyle>;
+        /**
+         * 控制图片是否显示的布尔值。
+         * @default true
+         */
         imageShow: boolean;
+        /**
+         * 图片样式的配置对象。
+         */
         imageStyle: import("xbsj-base").ReactiveVariable<ESJImageStyle>;
+        /**
+         * 控制文本是否显示的布尔值。
+         * @default true
+         */
         textShow: boolean;
+        /**
+         * 文本样式的配置对象。
+         */
         textStyle: import("xbsj-base").ReactiveVariable<ESJTextStyle>;
+        /**
+         * 要素可见的最小距离，0表示不限制。
+         * @default 0
+         */
         minFeatureVisibleDistance: number;
+        /**
+         * 要素可见的最大距离，0表示不限制。
+         * @default 0
+         */
         maxFeatureVisibleDistance: number;
+        /**
+         * 飞入参数配置对象，用于控制相机飞入效果。
+         * @default undefined
+         */
         flyInParam: import("xbsj-base").ReactiveVariable<ESJFlyInParam | undefined>;
+        /**
+         * 高度参考模式，可选 'NONE'、'RELATIVE_TO_GROUND' 或 'CLAMP_TO_GROUND'。
+         * @default "NONE"
+         */
         heightReference: "NONE" | "RELATIVE_TO_GROUND" | "CLAMP_TO_GROUND";
         collision: boolean;
         flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
@@ -234,6 +736,9 @@ export declare namespace ESGeoJson {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * ESGeoJson 类的扩展接口，用于支持属性变更事件
+ */
 export interface ESGeoJson extends UniteChanged<ReturnType<typeof ESGeoJson.createDefaultProps>> {
 }
 //# sourceMappingURL=index.d.ts.map