EarthSDK
    正在准备搜索索引...

    类 ESKml

    层级

    索引

    构造函数

    constructor

    属性

    allowPicking allowPickingChanged allowPickingReact autoResetClock autoResetClockChanged autoResetClockReact clampToGround clampToGroundChanged clampToGroundReact clockEnabled clockEnabledChanged clockEnabledReact clockRange clockRangeChanged clockRangeReact clockStep clockStepChanged clockStepReact currentTime currentTimeChanged currentTimeReact data dataChanged dataReact devTags devTagsChanged devTagsReact execOnceFuncStr execOnceFuncStrChanged execOnceFuncStrReact extras extrasChanged extrasReact loadFuncStr loadFuncStrChanged loadFuncStrReact multiplier multiplierChanged multiplierReact name nameChanged nameReact ref refChanged refReact shouldAnimate shouldAnimateChanged shouldAnimateReact show showChanged showReact startTime startTimeChanged startTimeReact stopTime stopTimeChanged stopTimeReact toDestroyFuncStr toDestroyFuncStrChanged toDestroyFuncStrReact updateFuncStr updateFuncStrChanged updateFuncStrReact uri uriChanged uriReact _lastMemId context create createFromClass createFromJson createFromUrl defaults destroySceneObject getEnv getSceneObj getSceneObjById getSceneObject getSceneObjectById getStrFromEnv innerRegister setEnv type

    访问器

    _jsonStr activeViewer activeViewerChanged attachedViewers completeJson components createdEvent defaultProps disposers flushEvent flyToEvent id json memId parentID reloadEvent resetClockEvent toDestroyEvent toDestroyFunc toDestroyFuncChanged typeName updateFunc updateFuncChanged viewerAttached viewerDetached $refs envs

    方法

    ad addToViewer autoDispose createAttachedObject d destroy destroyImp dispose disposeVar dv flush flyTo getESProperties isDestroyed registerAttachedObject registerAttachedObjectForContainer reload removefromViewer resetClock tdv tryDestory tryDisposeVar createDefaultProps getParentClass register

    构造函数

    • 参数

      • 可选id: string

      返回 ESKml

    属性

    allowPicking: boolean = false
    allowPickingChanged: Listener<[boolean, boolean]>
    allowPickingReact: ReactiveVariable<false> | ReactiveVariable<true>
    autoResetClock: boolean = true
    autoResetClockChanged: Listener<[boolean, boolean]>
    autoResetClockReact: ReactiveVariable<false> | ReactiveVariable<true>
    clampToGround: boolean = false
    clampToGroundChanged: Listener<[boolean, boolean]>
    clampToGroundReact: ReactiveVariable<false> | ReactiveVariable<true>
    clockEnabled: boolean = false
    clockEnabledChanged: Listener<[boolean, boolean]>
    clockEnabledReact: ReactiveVariable<false> | ReactiveVariable<true>
    clockRange: string = 'UNBOUNDED'
    clockRangeChanged: Listener<[string, string]>
    clockRangeReact: ReactiveVariable<string>
    clockStep: string = 'SYSTEM_CLOCK_MULTIPLIER'
    clockStepChanged: Listener<[string, string]>
    clockStepReact: ReactiveVariable<string>
    currentTime: undefined | number = ...
    currentTimeChanged: Listener<[undefined | number, undefined | number]>
    currentTimeReact: ReactiveVariable<undefined> | ReactiveVariable<number>
    data: undefined | string = ...
    dataChanged: Listener<[undefined | string, undefined | string]>
    dataReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    devTags: undefined | string[]

    对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

    devTagsChanged: Listener<[undefined | string[], undefined | string[]]>
    devTagsReact: ReactiveVariable<undefined | string[]>
    execOnceFuncStr: undefined | string

    一次性执行函数的字符串表示，默认为 undefined。

    execOnceFuncStrChanged: Listener<[undefined | string, undefined | string]>
    execOnceFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    extras: JsonValue

    扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

    extrasChanged: Listener<[JsonValue, JsonValue]>
    extrasReact: ReactiveVariable<JsonValue>
    loadFuncStr: undefined | string = ...
    loadFuncStrChanged: Listener<[undefined | string, undefined | string]>
    loadFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    multiplier: number = 1
    multiplierChanged: Listener<[number, number]>
    multiplierReact: ReactiveVariable<number>
    name: string

    对象名称，默认为 '未命名场景对象'。

    nameChanged: Listener<[string, string]>
    nameReact: ReactiveVariable<string>
    ref: undefined | string

    对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

    refChanged: Listener<[undefined | string, undefined | string]>
    refReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    shouldAnimate: boolean = false
    shouldAnimateChanged: Listener<[boolean, boolean]>
    shouldAnimateReact: ReactiveVariable<false> | ReactiveVariable<true>
    show: boolean = true
    showChanged: Listener<[boolean, boolean]>
    showReact: ReactiveVariable<false> | ReactiveVariable<true>
    startTime: undefined | number = ...
    startTimeChanged: Listener<[undefined | number, undefined | number]>
    startTimeReact: ReactiveVariable<undefined> | ReactiveVariable<number>
    stopTime: undefined | number = ...
    stopTimeChanged: Listener<[undefined | number, undefined | number]>
    stopTimeReact: ReactiveVariable<undefined> | ReactiveVariable<number>
    toDestroyFuncStr: undefined | string

    销毁函数的字符串表示，默认为 undefined。

    toDestroyFuncStrChanged: Listener<[undefined | string, undefined | string]>
    toDestroyFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    updateFuncStr: undefined | string

    更新函数的字符串表示，默认为 undefined。

    updateFuncStrChanged: Listener<[undefined | string, undefined | string]>
    updateFuncStrReact: ReactiveVariable<string> | ReactiveVariable<undefined>
    uri: undefined | string | ESJResource = ...
    uriChanged: Listener<
        [undefined | string | ESJResource, undefined | string | ESJResource],
    >
    uriReact:
        | ReactiveVariable<string>
        | ReactiveVariable<undefined>
        | ReactiveVariable<ESJResource>

    静态_lastMemId

    _lastMemId: number
    context: ESObjectsContext

    对象上下文，用于管理场景对象的创建、销毁、查找等操作。

    create: <T extends ESSceneObject>(
        sceneObjectType: string | (new (id?: string) => T),
        id?: string,
    ) => undefined | T

    创建场景对象的方法。

    createFromClass: <T extends ESSceneObject>(
        sceneObjConstructor: new (id?: string) => T,
        id?: string,
    ) => T

    根据类创建场景对象的方法。

    createFromJson: <T extends ESSceneObject>(
        sceneObjectJson: JsonValue & { type: string; [k: string]: any },
    ) => undefined | T

    根据 JSON 数据创建场景对象的方法。

    createFromUrl: (url: string, id?: string) => undefined | ESSceneObject

    根据 URL 创建场景对象的方法。

    defaults: Record<string, any>
    destroySceneObject: (sceneObject: ESSceneObject) => boolean

    销毁场景对象的方法。

    getEnv: (varName: string) => undefined | string

    获取环境变量的方法。

    类型声明

      • (varName: string): undefined | string

      • 参数

        • varName: string

        返回 undefined | string

        对应的环境变量值，如果未找到则返回 undefined。

    getSceneObj: (
        option?: string | (new (...args: any[]) => ESSceneObject),
    ) => undefined | ESSceneObject | ESSceneObject[]

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (
            option?: string | (new (...args: any[]) => ESSceneObject),
        ): undefined | ESSceneObject | ESSceneObject[]

      • 参数

        • 可选option: string | (new (...args: any[]) => ESSceneObject)

        返回 undefined | ESSceneObject | ESSceneObject[]

        对应的场景对象，如果未找到则返回 undefined。

    getSceneObjById: (id: string) => undefined | ESSceneObject

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (id: string): undefined | ESSceneObject

      • 参数

        • id: string

          对象的唯一标识符。

        返回 undefined | ESSceneObject

        对应的场景对象，如果未找到则返回 undefined。

    getSceneObject: (
        option?: string | (new (...args: any[]) => ESSceneObject),
    ) => undefined | ESSceneObject | ESSceneObject[]

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (
            option?: string | (new (...args: any[]) => ESSceneObject),
        ): undefined | ESSceneObject | ESSceneObject[]

      • 参数

        • 可选option: string | (new (...args: any[]) => ESSceneObject)

        返回 undefined | ESSceneObject | ESSceneObject[]

        对应的场景对象，如果未找到则返回 undefined。

    getSceneObjectById: (id: string) => undefined | ESSceneObject

    根据对象 ID 获取场景对象的方法。

    类型声明

      • (id: string): undefined | ESSceneObject

      • 参数

        • id: string

          对象的唯一标识符。

        返回 undefined | ESSceneObject

        对应的场景对象，如果未找到则返回 undefined。

    getStrFromEnv: (str: string) => string

    从环境变量中获取字符串值的方法。

    类型声明

      • (str: string): string

      • 参数

        • str: string

        返回 string

        对应的字符串值，如果未找到则返回 undefined。

    innerRegister: <T extends ESSceneObject>(
        sceneObjectType: string,
        sceneObjConstructor: new () => T,
        extraInfo?: { [k: string]: any },
    ) => string

    注册对象到上下文的方法。

    setEnv: (varName: string, value: undefined | string) => void

    设置环境变量的方法。

    类型声明

      • (varName: string, value: undefined | string): void

      • 参数

        • varName: string
        • value: undefined | string

          环境变量的值。

        返回 void

    type: string = ...

    访问器

    _jsonStr

    • get _jsonStr(): string

      获取对象的 JSON 字符串表示。

      返回 string

    • set _jsonStr(value: string): void

      根据 JSON 字符串设置对象的属性。

      参数

      • value: string

        JSON 字符串。

      返回 void

    • get activeViewer(): undefined | ESViewer

      返回 undefined | ESViewer

    • set activeViewer(value: undefined | ESViewer): void

      参数

      • value: undefined | ESViewer

      返回 void

    • get activeViewerChanged(): Listener<
          [undefined | ESViewer, undefined | ESViewer],
      >

      返回 Listener<[undefined | ESViewer, undefined | ESViewer]>

    • get attachedViewers(): Set<ESViewer>

      获取对象当前存在于哪些视口上的集合。

      返回 Set<ESViewer>

    • get completeJson(): JsonValue

      获取对象的 JSON 表示，包含所有属性。包括默认值

      返回 JsonValue

    • get components(): ObservableSet<ESSceneObject>

      获取对象组件集合。

      返回 ObservableSet<ESSceneObject>

    • get createdEvent(): Event<[]>

      获取对象创建事件。

      返回 Event<[]>

    • get defaultProps(): {
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          name: string;
          ref: undefined | string;
          toDestroyFuncStr: undefined | string;
          updateFuncStr: undefined | string;
      }

      获取对象的默认属性。

      返回 {
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          name: string;
          ref: undefined | string;
          toDestroyFuncStr: undefined | string;
          updateFuncStr: undefined | string;
      }

      • devTags: ReactiveVariable<undefined | string[]>

        对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

      • execOnceFuncStr: undefined | string

        一次性执行函数的字符串表示，默认为 undefined。

      • extras: ReactiveVariable<JsonValue>

        扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

      • name: string

        对象名称，默认为 '未命名场景对象'。

      • ref: undefined | string

        对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

      • toDestroyFuncStr: undefined | string

        销毁函数的字符串表示，默认为 undefined。

      • updateFuncStr: undefined | string

        更新函数的字符串表示，默认为 undefined。

    • get disposers(): (() => void)[]

      返回 (() => void)[]

    • get flushEvent(): Event<[]>

      获取刷新对象事件。

      返回 Event<[]>

    • get flyToEvent(): Listener<[undefined | number]>

      返回 Listener<[undefined | number]>

    • get id(): string

      获取对象的唯一标识符。

      返回 string

    • get json(): JsonValue

      获取对象的 JSON 表示。省略默认值属性，精简json

      返回 JsonValue

    • set json(value: JsonValue): void

      根据 JSON 数据设置对象的属性。

      参数

      • value: JsonValue

        JSON 数据。

      返回 void

    • get memId(): number

      返回 number

    • get parentID(): string

      获取当前对象指定父级对象,未指定返回自身。

      返回 string

    • set parentID(value: undefined | string): void

      参数

      • value: undefined | string

      返回 void

    • get reloadEvent(): Event<[]>

      返回 Event<[]>

    • get resetClockEvent(): Event<[]>

      返回 Event<[]>

    • get toDestroyEvent(): Listener

      返回 Listener

    • get toDestroyFunc(): undefined | ((sceneObject: ESSceneObject) => void)

      获取对象的销毁函数。

      返回 undefined | ((sceneObject: ESSceneObject) => void)

    • set toDestroyFunc(
          value: undefined | ((sceneObject: ESSceneObject) => void),
      ): void

      设置对象的销毁函数。

      参数

      • value: undefined | ((sceneObject: ESSceneObject) => void)

        销毁函数。

      返回 void

    • get toDestroyFuncChanged(): Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject) => void),
              undefined | ((sceneObject: ESSceneObject) => void),
          ],
      >

      获取销毁函数改变事件。

      返回 Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject) => void),
              undefined | ((sceneObject: ESSceneObject) => void),
          ],
      >

    • get typeName(): string

      获取对象的类型名称，由子类实现。

      返回 string

    • get updateFunc(): | undefined
      | ((sceneObject: ESSceneObject, timeStamp: number) => void)

      获取对象的更新函数。

      返回 undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void)

    • set updateFunc(
          value:
              | undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
      ): void

      设置对象的更新函数。

      参数

      • value: undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void)

        更新函数。

      返回 void

    • get updateFuncChanged(): Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
              undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void),
          ],
      >

      获取更新函数改变事件。

      返回 Listener<
          [
              undefined
              | ((sceneObject: ESSceneObject, timeStamp: number) => void),
              undefined | ((sceneObject: ESSceneObject, timeStamp: number) => void),
          ],
      >

    • get viewerAttached(): Event<[ESViewer]>

      获取对象创建在视口上的事件。

      返回 Event<[ESViewer]>

    • get viewerDetached(): Event<[ESViewer]>

      获取对象从视口移除的事件。

      返回 Event<[ESViewer]>

    • get $refs(): { [k: string]: undefined | ESSceneObject }

      获取所有引用对象的集合。

      返回 { [k: string]: undefined | ESSceneObject }

    • get envs(): { [k: string]: undefined | string }

      获取所有环境变量的集合。

      返回 { [k: string]: undefined | string }

    方法

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 将对象添加到指定视口中。

      参数

      • viewer: ESViewer

        要添加对象的视口。

      返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 创建与视口关联的对象，并返回一个销毁函数，用于手动销毁关联对象。

      参数

      • createViewerPropSceneObject: (viewer: ESViewer) => undefined | Destroyable

        一个函数，用于创建与视口关联的对象。

      返回 () => void

      一个销毁函数，调用该函数可以销毁所有关联对象。

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 返回 undefined

    • 返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 刷新对象，触发刷新事件。

      返回 void

    • 参数

      • 可选duration: number

      返回 void

    • 获取对象的 ES 属性，用于特定的 ES 相关操作。

      返回 {
          basic: Property[];
          coordinate: Property[];
          dataSource: Property[];
          defaultMenu: string;
          general: Property[];
          location: Property[];
          more: Property[];
          style: Property[];
      }

      ES 属性对象。

    • 返回 boolean

    • 注册与视口关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。

      参数

      • createViewerPropSceneObject: (viewer: ESViewer) => undefined | Destroyable

        一个函数，用于创建与视口关联的对象。

      返回 void

    • 注册与视口容器关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。

      参数

      • createContainerPropSceneObject: (viewer: ESViewer, container: HTMLDivElement) => undefined | Destroyable

        一个函数，用于创建与视口容器关联的对象。

      返回 void

    • 返回 void

    • 将对象从指定视口中移除。

      参数

      • viewer: ESViewer

        要移除对象的视口。

      返回 void

    • 返回 void

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 undefined

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 {
          allowPicking: boolean;
          autoResetClock: boolean;
          clampToGround: boolean;
          clockEnabled: boolean;
          clockRange: string;
          clockStep: string;
          currentTime: undefined | number;
          data: undefined | string;
          devTags: ReactiveVariable<undefined | string[]>;
          execOnceFuncStr: undefined | string;
          extras: ReactiveVariable<JsonValue>;
          loadFuncStr: undefined | string;
          multiplier: number;
          name: string;
          ref: undefined | string;
          shouldAnimate: boolean;
          show: boolean;
          startTime: undefined | number;
          stopTime: undefined | number;
          toDestroyFuncStr: undefined | string;
          updateFuncStr: undefined | string;
          uri: undefined | string | ESJResource;
      }

      • allowPicking: boolean
      • autoResetClock: boolean
      • clampToGround: boolean
      • clockEnabled: boolean
      • clockRange: string
      • clockStep: string
      • currentTime: undefined | number
      • data: undefined | string
      • devTags: ReactiveVariable<undefined | string[]>

        对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。

      • execOnceFuncStr: undefined | string

        一次性执行函数的字符串表示，默认为 undefined。

      • extras: ReactiveVariable<JsonValue>

        扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。

      • loadFuncStr: undefined | string
      • multiplier: number
      • name: string

        对象名称，默认为 '未命名场景对象'。

      • ref: undefined | string

        对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。

      • shouldAnimate: boolean
      • show: boolean
      • startTime: undefined | number
      • stopTime: undefined | number
      • toDestroyFuncStr: undefined | string

        销毁函数的字符串表示，默认为 undefined。

      • updateFuncStr: undefined | string

        更新函数的字符串表示，默认为 undefined。

      • uri: undefined | string | ESJResource

    • 获取父类的类型，用于创建对象时对象本身没有实现类，则使用父类的实现类，一直向上寻找，直到ESSceneObject的实现类

      类型参数

      • T extends typeof ESSceneObject

      返回 T

      父类的类型

    • 完善版注册方法

      类型参数

      • T extends typeof ESSceneObject

      参数

      • className: string
      • ctor: T & new (id?: string) => ESSceneObject
      • 可选meta: Partial<{ chsName: string; description: string; tags: string[] }>

      返回 string

    显示设置

    成员可见性

    目录

    构造函数
    属性
    allowPickingallowPickingChangedallowPickingReactautoResetClockautoResetClockChangedautoResetClockReactclampToGroundclampToGroundChangedclampToGroundReactclockEnabledclockEnabledChangedclockEnabledReactclockRangeclockRangeChangedclockRangeReactclockStepclockStepChangedclockStepReactcurrentTimecurrentTimeChangedcurrentTimeReactdatadataChangeddataReactdevTagsdevTagsChangeddevTagsReactexecOnceFuncStrexecOnceFuncStrChangedexecOnceFuncStrReactextrasextrasChangedextrasReactloadFuncStrloadFuncStrChangedloadFuncStrReactmultipliermultiplierChangedmultiplierReactnamenameChangednameReactrefrefChangedrefReactshouldAnimateshouldAnimateChangedshouldAnimateReactshowshowChangedshowReactstartTimestartTimeChangedstartTimeReactstopTimestopTimeChangedstopTimeReacttoDestroyFuncStrtoDestroyFuncStrChangedtoDestroyFuncStrReactupdateFuncStrupdateFuncStrChangedupdateFuncStrReacturiuriChangeduriReact_lastMemIdcontextcreatecreateFromClasscreateFromJsoncreateFromUrldefaultsdestroySceneObjectgetEnvgetSceneObjgetSceneObjByIdgetSceneObjectgetSceneObjectByIdgetStrFromEnvinnerRegistersetEnvtype
    访问器
    方法