earthsdk3 3.0.7-beta.9 → 3.0.7

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

@@ -1,8 +1,38 @@
 import { ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
 import { ESObjectWithLocation } from "../base";
+import { ESJColor, ESJVector4D } from "../../ESJTypes";
+/**
+ * ESGeoDivTextPoi 类用于表示带有文本标签的地理点对象，通常用于在地图或三维场景中显示文本信息。
+ * 该类继承自 ESObjectWithLocation，并扩展了与文本显示相关的属性和方法。
+ *
+ * 核心功能包括：
+ * - 设置和获取文本内容、样式和位置。
+ * - 支持文本编辑交互。
+ * - 自定义文本的宽度、颜色、背景、边框等样式。
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * - `id`：场景对象的键，可选参数，用于唯一标识该对象。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 该类依赖于 ESObjectWithLocation 类，因此需要确保在使用 ESGeoDivTextPoi 之前已经正确引入并初始化了 ESObjectWithLocation。
+ * - 文本编辑交互功能可能会影响性能，特别是在大量文本对象同时存在时。
+ */
 export declare class ESGeoDivTextPoi extends ESObjectWithLocation {
+    /**
+     * 静态属性，用于注册 ESGeoDivTextPoi 类，包含中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取对象的类型名称。
+     * @returns 类型名称 'ESGeoDivTextPoi'。
+     */
     get typeName(): string;
+    /**
+     * 重写默认属性获取方法，返回 ESGeoDivTextPoi 的默认属性。
+     * @returns ESGeoDivTextPoi 的默认属性。
+     */
     get defaultProps(): {
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -21,34 +51,82 @@ export declare class ESGeoDivTextPoi extends ESObjectWithLocation {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * 文本内容，初始值为未定义。
+         */
         text: string | undefined;
+        /**
+         * 文本的宽度，初始值为未定义。
+         */
         width: number | undefined;
+        /**
+         * 是否允许文本编辑交互，初始值为 false。
+         */
         textEditingInteraction: boolean;
+        /**
+         * 是否处于文本编辑状态，初始值为 false。
+         */
         textEditing: boolean;
+        /**
+         * 原点比例和偏移，格式为 [左比例, 上比例, 左偏移, 上偏移]，初始值为 [0.5, 1, 0, 0]。
+         */
         originRatioAndOffset: import("xbsj-base").ReactiveVariable<[leftRatio: number, topRatio: number, leftOffset: number, topOffset: number]>;
+        /**
+         * 文本的透明度，初始值为 1。
+         */
         opacity: number;
+        /**
+         * 文本的字体大小，初始值为 14。
+         */
         fontSize: number;
+        /**
+         * 文本的对齐方式，初始值为 'left'（左对齐）。
+         */
         textAlign: string;
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        backgroundColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        padding: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        borderRadius: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本的颜色，格式为 RGBA 数组，初始值为 [1, 1, 1, 1]（白色不透明）。
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本背景的颜色，格式为 RGBA 数组，初始值为 [0, 0, 0, 0.8]（黑色 80% 透明度）。
+         */
+        backgroundColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本的内边距，格式为 [上, 右, 下, 左]，初始值为 [5, 5, 5, 5]。
+         */
+        padding: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本边框的圆角，格式为 [左上, 右上, 右下, 左下]，初始值为 [6, 6, 6, 6]。
+         */
+        borderRadius: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本边框的宽度，初始值为 0。
+         */
         borderWidth: number;
-        borderColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本边框的颜色，格式为 RGBA 数组，初始值为 [1, 1, 1, 1]（白色不透明）。
+         */
+        borderColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本边框的样式，初始值为 "solid"（实线）。
+         */
         borderStyle: string;
     };
+    /**
+     * 静态重写的默认属性对象，包含了 ESGeoDivTextPoi 的各种默认属性值。
+     */
     static defaults: {
         allowTextEditing: boolean;
         width: number;
         text: string;
-        originRatioAndOffset: [number, number, number, number];
+        originRatioAndOffset: ESJVector4D;
         opacity: number;
         fontSize: number;
-        color: [number, number, number, number];
-        backgroundColor: [number, number, number, number];
-        padding: [number, number, number, number];
-        borderRadius: [number, number, number, number];
-        borderColor: [number, number, number, number];
+        color: ESJColor;
+        backgroundColor: ESJColor;
+        padding: ESJVector4D;
+        borderRadius: ESJVector4D;
+        borderColor: ESJColor;
         borderWidth: number;
         textAlign: string;
         borderStyle: string;
@@ -58,10 +136,26 @@ export declare class ESGeoDivTextPoi extends ESObjectWithLocation {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 构造函数，用于创建 ESGeoDivTextPoi 实例。
+     * @param id - 场景对象的键，可选参数。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 重写获取属性的方法，返回 ESGeoDivTextPoi 的属性列表。
+     * @param language - 语言参数，可选参数。
+     * @returns 属性列表。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESGeoDivTextPoi 的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESGeoDivTextPoi {
+    /**
+     * 创建 ESGeoDivTextPoi 的默认属性对象。
+     * @returns ESGeoDivTextPoi 的默认属性对象。
+     */
     const createDefaultProps: () => {
         position: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJVector3D>;
@@ -80,23 +174,71 @@ export declare namespace ESGeoDivTextPoi {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * 文本内容，初始值为未定义。
+         */
         text: string | undefined;
+        /**
+         * 文本的宽度，初始值为未定义。
+         */
         width: number | undefined;
+        /**
+         * 是否允许文本编辑交互，初始值为 false。
+         */
         textEditingInteraction: boolean;
+        /**
+         * 是否处于文本编辑状态，初始值为 false。
+         */
         textEditing: boolean;
+        /**
+         * 原点比例和偏移，格式为 [左比例, 上比例, 左偏移, 上偏移]，初始值为 [0.5, 1, 0, 0]。
+         */
         originRatioAndOffset: import("xbsj-base").ReactiveVariable<[leftRatio: number, topRatio: number, leftOffset: number, topOffset: number]>;
+        /**
+         * 文本的透明度，初始值为 1。
+         */
         opacity: number;
+        /**
+         * 文本的字体大小，初始值为 14。
+         */
         fontSize: number;
+        /**
+         * 文本的对齐方式，初始值为 'left'（左对齐）。
+         */
         textAlign: string;
-        color: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        backgroundColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        padding: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
-        borderRadius: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本的颜色，格式为 RGBA 数组，初始值为 [1, 1, 1, 1]（白色不透明）。
+         */
+        color: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本背景的颜色，格式为 RGBA 数组，初始值为 [0, 0, 0, 0.8]（黑色 80% 透明度）。
+         */
+        backgroundColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本的内边距，格式为 [上, 右, 下, 左]，初始值为 [5, 5, 5, 5]。
+         */
+        padding: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本边框的圆角，格式为 [左上, 右上, 右下, 左下]，初始值为 [6, 6, 6, 6]。
+         */
+        borderRadius: import("xbsj-base").ReactiveVariable<ESJVector4D>;
+        /**
+         * 文本边框的宽度，初始值为 0。
+         */
         borderWidth: number;
-        borderColor: import("xbsj-base").ReactiveVariable<[number, number, number, number]>;
+        /**
+         * 文本边框的颜色，格式为 RGBA 数组，初始值为 [1, 1, 1, 1]（白色不透明）。
+         */
+        borderColor: import("xbsj-base").ReactiveVariable<ESJColor>;
+        /**
+         * 文本边框的样式，初始值为 "solid"（实线）。
+         */
         borderStyle: string;
     };
 }
+/**
+ * ESGeoDivTextPoi 接口，继承自 ReactivePropsToNativePropsAndChanged 类型。
+ */
 export interface ESGeoDivTextPoi extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESGeoDivTextPoi.createDefaultProps>> {
 }
 //# sourceMappingURL=ESGeoDivTextPoi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESGeoDivTextPoi.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESGeoDivTextPoi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/C,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAC7J,IAAI,QAAQ,WAAgC;IAC5C,IAAa,YAAY;;;;;;;;;;;;;;;;;;cAmDF,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;MApDkC;IAE5E,OAAgB,QAAQ;;;;8BAKoB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;eAGjD,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;yBACpB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;iBAC1C,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;sBAC3B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;qBACjC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;;;;;;;;;MAIhE;gBACW,EAAE,CAAC,EAAE,cAAc;IAItB,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAwB3C;AAED,yBAAiB,eAAe,CAAC;IACtB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;cACR,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;KAexC,CAAC;CACN;AAED,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESGeoDivTextPoi.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESGeoDivTextPoi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,oCAAoC,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAgD,QAAQ,EAAE,WAAW,EAAsE,MAAM,gBAAgB,CAAC;AAEzK;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAgB,SAAQ,oBAAoB;IACrD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAyI;IAE7J;;;OAGG;IACH,IAAI,QAAQ,WAAgC;IAE5C;;;OAGG;IACH,IAAa,YAAY;;;;;;;;;;;;;;;;;;QAuEzB;;WAEG;cACgB,MAAM,GAAG,SAAS;QACrC;;WAEG;eACiB,MAAM,GAAG,SAAS;QACtC;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;MAjIyE;IAE5E;;OAEG;IACH,OAAgB,QAAQ;;;;8BAKoB,WAAW;;;eAG5B,QAAQ;yBACI,QAAQ;iBAClB,WAAW;sBACN,WAAW;qBACZ,QAAQ;;;;;;;;;MAIxC;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAI/B;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAwB3C;AAED;;GAEG;AACH,yBAAiB,eAAe,CAAC;IACjC;;;OAGG;IACI,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;QAC3B;;WAEG;cACgB,MAAM,GAAG,SAAS;QACrC;;WAEG;eACiB,MAAM,GAAG,SAAS;QACtC;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAML,CAAC;CACF;AAOD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAAI"}