earthsdk3 3.0.6 → 3.0.7-beta.10

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

@@ -1,115 +1,224 @@
-import { ESJResource, ESJVector4D } from "../../../ESJTypes";
-import { ESVisualObject } from "../../../ESObjects";
-import { UniteChanged } from "xbsj-base";
-import { ESJSplitDirectionType, ESImageryLayerOptionsType } from "./types";
-/**
- * https://www.wolai.com/earthsdk/sTpXjiETeVPfEwGfqDqUUw
- * https://c0yh9tnn0na.feishu.cn/wiki/QFTgwgCwHiG29bknJ1QcP5hJnMf
- */
-export declare class ESImageryLayer extends ESVisualObject {
-    static readonly type: string;
-    get typeName(): string;
-    get defaultProps(): {
-        url: string | ESJResource;
-        rectangle: import("xbsj-base").ReactiveVariable<ESJVector4D | undefined>;
-        options: import("xbsj-base").ReactiveVariable<ESImageryLayerOptionsType | undefined>;
-        zIndex: number;
-        actorTag: string;
-        componentTag: string;
-        maximumLevel: number;
-        minimumLevel: number;
-        targetID: string | undefined;
-        opacity: number;
-        czmSplitDirection: ESJSplitDirectionType;
-        czmAlpha: number;
-        czmBrightness: number;
-        czmContrast: number;
-        czmHue: number;
-        czmSaturation: number;
-        czmGamma: number;
-        show: boolean;
-        collision: boolean;
-        allowPicking: boolean;
-        flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
-        flyInParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyInParam | undefined>;
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-    static defaults: {
-        url: string;
-        rectangle: ESJVector4D;
-        options: {};
-        zIndex: number;
-        actorTag: string;
-        componentTag: string;
-        minimumLevel: number;
-        maximumLevel: number;
-        targetID: string;
-        opacity: number;
-        czmSplitDirection: ESJSplitDirectionType;
-        czmSplitDirectionEnum: [name: string, value: string][];
-        czmAlpha: number;
-        czmBrightness: number;
-        czmContrast: number;
-        czmHue: number;
-        czmSaturation: number;
-        czmGamma: number;
-        czmSubdomains: never[];
-        show: boolean;
-        collision: boolean;
-        allowPicking: boolean;
-        flyToParam: import("../../../ESJTypes").ESJFlyToParam;
-        flyInParam: import("../../../ESJTypes").ESJFlyInParam;
-    };
-    constructor(id?: string);
-    getESProperties(): {
-        defaultMenu: string;
-        basic: import("../../../ESJTypes").Property[];
-        dataSource: import("../../../ESJTypes").Property[];
-        general: import("../../../ESJTypes").Property[];
-        location: import("../../../ESJTypes").Property[];
-        coordinate: import("../../../ESJTypes").Property[];
-        style: import("../../../ESJTypes").Property[];
-    };
-    getProperties(language?: string): import("../../../ESJTypes").Property[];
-}
-export declare namespace ESImageryLayer {
-    const createDefaultProps: () => {
-        url: string | ESJResource;
-        rectangle: import("xbsj-base").ReactiveVariable<ESJVector4D | undefined>;
-        options: import("xbsj-base").ReactiveVariable<ESImageryLayerOptionsType | undefined>;
-        zIndex: number;
-        actorTag: string;
-        componentTag: string;
-        maximumLevel: number;
-        minimumLevel: number;
-        targetID: string | undefined;
-        opacity: number;
-        czmSplitDirection: ESJSplitDirectionType;
-        czmAlpha: number;
-        czmBrightness: number;
-        czmContrast: number;
-        czmHue: number;
-        czmSaturation: number;
-        czmGamma: number;
-        show: boolean;
-        collision: boolean;
-        allowPicking: boolean;
-        flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
-        flyInParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyInParam | undefined>;
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-}
-export interface ESImageryLayer extends UniteChanged<ReturnType<typeof ESImageryLayer.createDefaultProps>> {
-}
+import { UniteChanged } from "xbsj-base";
+import { ESJResource, ESJVector4D } from "../../../ESJTypes";
+import { ESVisualObject } from "../../../ESObjects";
+import { ESImageryLayerOptionsType, ESJSplitDirectionType } from "./types";
+/**
+* ESImageryLayer 类用于表示和操作影像图层。它继承自 ESVisualObject 类，提供了设置和获取影像图层属性的功能。
+*
+* 核心功能包括：
+* - 设置和获取影像服务地址
+* - 设置和获取影像图层的矩形范围
+* - 设置和获取影像图层的层级序号
+* - 设置和获取影像图层的透明度
+* - 设置和获取影像图层的其他视觉效果属性，如亮度、对比度、色相等
+*
+* 使用示例：
+*
+* 构造函数参数：
+* - id: 可选的实例 ID，用于唯一标识该影像图层实例。
+*
+* 特殊使用限制或潜在的副作用：
+* - 确保提供的影像服务地址是有效的，否则图层可能无法正确显示。
+* - 层级序号 (zIndex) 用于控制图层的叠加顺序，较高的层级序号表示图层在顶部。
+* - 透明度 (opacity) 设置为 0 时，图层将完全透明，不可见。
+ * 注册 ESImageryLayer 类，设置其类型名称、中文名称、标签和描述。
+ */
+export declare class ESImageryLayer extends ESVisualObject {
+    /**
+     * 注册 ESImageryLayer 类，设置其类型名称、中文名称、标签和描述。
+     */
+    static readonly type: string;
+    /**
+     * 获取对象的类型名称。
+     * @returns 类型名称 'ESImageryLayer'。
+     */
+    get typeName(): string;
+    /**
+     * 获取对象的默认属性。
+     * @returns 默认属性对象。
+     */
+    get defaultProps(): {
+        /** 影像服务地址 */
+        url: string | ESJResource;
+        /** 矩形范围 */
+        rectangle: import("xbsj-base").ReactiveVariable<ESJVector4D | undefined>;
+        /** 影像图层的选项 */
+        options: import("xbsj-base").ReactiveVariable<ESImageryLayerOptionsType | undefined>;
+        /** 层级序号 */
+        zIndex: number;
+        /** actorTag UE属性，用于绑定或创建场景中的对象 */
+        actorTag: string;
+        /** 组件标签 UE属性，用于绑定或创建场景中的对象 */
+        componentTag: string;
+        /** 最大层级 */
+        maximumLevel: number;
+        /** 最小层级 */
+        minimumLevel: number;
+        /** 目标 ID */
+        targetID: string | undefined;
+        /** 透明度 */
+        opacity: number;
+        /** 分割方向 */
+        czmSplitDirection: ESJSplitDirectionType;
+        /** czm 透明度 */
+        czmAlpha: number;
+        /** czm 亮度 */
+        czmBrightness: number;
+        /** czm 对比度 */
+        czmContrast: number;
+        /** czm 色相 */
+        czmHue: number;
+        /** czm 饱和度 */
+        czmSaturation: number;
+        /** czm 伽马值 */
+        czmGamma: number;
+        show: boolean;
+        collision: boolean;
+        allowPicking: boolean;
+        flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
+        flyInParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyInParam | undefined>;
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+    /**
+     * ESImageryLayer 类的默认属性。
+     */
+    static defaults: {
+        /** 影像服务地址 */
+        url: string;
+        /** 矩形范围，格式为 [西南经度, 西南纬度, 东北经度, 东北纬度] */
+        rectangle: ESJVector4D;
+        /** 影像图层的选项 */
+        options: {};
+        /** 层级序号 */
+        zIndex: number;
+        /** 角色标签 */
+        actorTag: string;
+        /** 组件标签 */
+        componentTag: string;
+        /** 最小层级 */
+        minimumLevel: number;
+        /** 最大层级 */
+        maximumLevel: number;
+        /** 目标 ID */
+        targetID: string;
+        /** 透明度 */
+        opacity: number;
+        /** 分割方向 */
+        czmSplitDirection: ESJSplitDirectionType;
+        /** 分割方向的枚举值 */
+        czmSplitDirectionEnum: [name: string, value: string][];
+        /** czm 透明度 */
+        czmAlpha: number;
+        /** czm 亮度 */
+        czmBrightness: number;
+        /** czm 对比度 */
+        czmContrast: number;
+        /** czm 色相 */
+        czmHue: number;
+        /** czm 饱和度 */
+        czmSaturation: number;
+        /** czm 伽马值 */
+        czmGamma: number;
+        /** czm 子域名 */
+        czmSubdomains: never[];
+        show: boolean;
+        collision: boolean;
+        allowPicking: boolean;
+        flyToParam: import("../../../ESJTypes").ESJFlyToParam;
+        flyInParam: import("../../../ESJTypes").ESJFlyInParam;
+    };
+    /**
+     * 构造函数，创建 ESImageryLayer 实例。
+     * @param id - 可选的实例 ID。
+     */
+    constructor(id?: string);
+    /**
+     * 获取 ES 属性。
+     * @returns ES 属性对象。
+     */
+    getESProperties(): {
+        /** 默认菜单为 'dataSource' */
+        defaultMenu: string;
+        basic: import("../../../ESJTypes").Property[];
+        dataSource: import("../../../ESJTypes").Property[];
+        general: import("../../../ESJTypes").Property[];
+        location: import("../../../ESJTypes").Property[];
+        coordinate: import("../../../ESJTypes").Property[];
+        style: import("../../../ESJTypes").Property[];
+    };
+    /**
+     * 获取属性列表。
+     * @param language - 可选的语言参数。
+     * @returns 属性列表。
+     */
+    getProperties(language?: string): import("../../../ESJTypes").Property[];
+}
+/**
+ * ESImageryLayer 命名空间，包含创建默认属性的方法。
+ */
+export declare namespace ESImageryLayer {
+    /**
+     * 创建 ESImageryLayer 的默认属性对象。
+     * @returns 默认属性对象。
+     */
+    const createDefaultProps: () => {
+        /** 影像服务地址 */
+        url: string | ESJResource;
+        /** 矩形范围 */
+        rectangle: import("xbsj-base").ReactiveVariable<ESJVector4D | undefined>;
+        /** 影像图层的选项 */
+        options: import("xbsj-base").ReactiveVariable<ESImageryLayerOptionsType | undefined>;
+        /** 层级序号 */
+        zIndex: number;
+        /** actorTag UE属性，用于绑定或创建场景中的对象 */
+        actorTag: string;
+        /** 组件标签 UE属性，用于绑定或创建场景中的对象 */
+        componentTag: string;
+        /** 最大层级 */
+        maximumLevel: number;
+        /** 最小层级 */
+        minimumLevel: number;
+        /** 目标 ID */
+        targetID: string | undefined;
+        /** 透明度 */
+        opacity: number;
+        /** 分割方向 */
+        czmSplitDirection: ESJSplitDirectionType;
+        /** czm 透明度 */
+        czmAlpha: number;
+        /** czm 亮度 */
+        czmBrightness: number;
+        /** czm 对比度 */
+        czmContrast: number;
+        /** czm 色相 */
+        czmHue: number;
+        /** czm 饱和度 */
+        czmSaturation: number;
+        /** czm 伽马值 */
+        czmGamma: number;
+        show: boolean;
+        collision: boolean;
+        allowPicking: boolean;
+        flyToParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyToParam | undefined>;
+        flyInParam: import("xbsj-base").ReactiveVariable<import("../../../ESJTypes").ESJFlyInParam | undefined>;
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+}
+/**
+ * ESImageryLayer 接口，继承自 UniteChanged，用于表示具有默认属性变化的对象。
+ */
+export interface ESImageryLayer extends UniteChanged<ReturnType<typeof ESImageryLayer.createDefaultProps>> {
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ESObjects/general/ESImageryLayer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESImageryLayer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4C,YAAY,EAAE,MAAM,WAAW,CAAC;AACnF,OAAO,EACW,WAAW,EAAE,WAAW,EAGzC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAc,MAAM,SAAS,CAAC;AAEvF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,cAAe,SAAQ,cAAc;IAC9C;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA0I;IAE9J;;;OAGG;IACH,IAAI,QAAQ,WAA+B;IAE3C;;;OAGG;IACH,IAAa,YAAY;QAuJrB,aAAa;aACF,MAAM,GAAG,WAAW;QAC/B,WAAW;;QAEX,cAAc;;QAEd,WAAW;;QAEX,kCAAkC;;QAElC,8BAA8B;;QAE9B,WAAW;;QAEX,WAAW;;QAEX,YAAY;kBACI,MAAM,GAAG,SAAS;QAClC,UAAU;;QAGV,WAAW;2BACkB,qBAAqB;QAClD,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,cAAc;;;;;;;;;;;;;;MAxLyD;IAE3E;;OAEG;IACH,OAAgB,QAAQ;QAEpB,aAAa;;QAEb,wCAAwC;mBACL,WAAW;QAC9C,cAAc;;QAEd,WAAW;;QAEX,WAAW;;QAEX,WAAW;;QAEX,WAAW;;QAEX,WAAW;;QAEX,YAAY;;QAEZ,UAAU;;QAGV,WAAW;2BACkB,qBAAqB;QAClD,eAAe;+BACoE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;QAClH,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,cAAc;;QAEd,cAAc;;;;;;;MAEjB;IAED;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAEvB;;;OAGG;IACM,eAAe;QAIhB,yBAAyB;;;;;;;;;IAyBjC;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA+C3C;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC5B;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,aAAa;aACF,MAAM,GAAG,WAAW;QAC/B,WAAW;;QAEX,cAAc;;QAEd,WAAW;;QAEX,kCAAkC;;QAElC,8BAA8B;;QAE9B,WAAW;;QAEX,WAAW;;QAEX,YAAY;kBACI,MAAM,GAAG,SAAS;QAClC,UAAU;;QAGV,WAAW;2BACkB,qBAAqB;QAClD,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,aAAa;;QAEb,cAAc;;QAEd,cAAc;;;;;;;;;;;;;;KAEhB,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;CAAI"}