类 ScreenManager

层级

Destroyable
- ScreenManager

构造函数

constructor

new ScreenManager(_czmViewer: ESCesiumViewer): ScreenManager
参数
- _czmViewer: ESCesiumViewer
返回 ScreenManager
重写了 Destroyable.constructor
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:39

属性

avoidanceManager

avoidanceManager: AvoidanceManager

billboardCollection

billboardCollection: ScreenObjectPool<Billboard>

canvasCollection

canvasCollection: CustomCollection = ...

collectionMap

collectionMap: Record<"label" | "billboard" | "customObject", any>

集合映射，方便统一处理

customObjectCollection

customObjectCollection: CustomCollection = ...

czmViewer

czmViewer: ESCesiumViewer

labelCollection

labelCollection: ScreenObjectPool<Label>

layers

layers: Map<string, ScreenLayer> = ...

viewer

viewer: Viewer

`静态`_lastMemId

_lastMemId: number

访问器

disposers

get disposers(): (() => void)[]
返回 (() => void)[]
继承自 Destroyable.disposers
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:17

memId

get memId(): number
返回 number
继承自 Destroyable.memId
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:15

refreshEvent

get refreshEvent(): Event<[]>
返回 Event<[]>
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:24

toDestroyEvent

get toDestroyEvent(): Listener
返回 Listener
继承自 Destroyable.toDestroyEvent
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:45

方法

ad(disposeFunc: () => void): () => void
参数
- disposeFunc: () => void
返回 () => void
继承自 Destroyable.ad
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:36
ad<T extends { destroy(): void }>(obj: T): T
类型参数
- T extends { destroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.ad
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:37

addImage

addImage(
    id: string,
    layer: string,
    style: Partial,
    objectInfo: ESJScreenObjectInfo,
): { id: string; layer: string; screenObjectId: string }
参数
- id: string
- layer: string
- style: Partial
- objectInfo: ESJScreenObjectInfo
返回 { id: string; layer: string; screenObjectId: string }
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:99

addLabel

addLabel(
    id: string,
    layer: string,
    style: Partial,
    objectInfo: ESJScreenObjectInfo,
): { id: string; layer: string; screenObjectId: string }
参数
- id: string
- layer: string
- style: Partial
- objectInfo: ESJScreenObjectInfo
返回 { id: string; layer: string; screenObjectId: string }
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:92

addRectangle

addRectangle(
    id: string,
    layer: string,
    style: { [xx: string]: any },
    objectInfo: ESJScreenObjectInfo,
    callback: Function,
): { id: string; layer: string; screenObjectId: string }
参数
- id: string
- layer: string
- style: { [xx: string]: any }
- objectInfo: ESJScreenObjectInfo
- callback: Function
返回 { id: string; layer: string; screenObjectId: string }
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:106

autoDispose

autoDispose(disposeFunc: () => void): () => void
参数
- disposeFunc: () => void
返回 () => void
继承自 Destroyable.autoDispose
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:32
autoDispose<T extends { destroy(): void }>(obj: T): T
类型参数
- T extends { destroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.autoDispose
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:33

d

d(disposeFunc: () => void): () => void
参数
- disposeFunc: () => void
返回 () => void
继承自 Destroyable.d
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:19

destroy

destroy(): undefined
返回 undefined
继承自 Destroyable.destroy
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:6

destroyImp

destroyImp(): void
返回 void
继承自 Destroyable.destroyImp
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:40

dispose

dispose(disposeFunc: () => void): () => void
参数
- disposeFunc: () => void
返回 () => void
继承自 Destroyable.dispose
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:18

disposeVar

disposeVar<T extends { destroy(): void }>(obj: T): T
类型参数
- T extends { destroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.disposeVar
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:20

dv

dv<T extends { destroy(): void }>(obj: T): T
类型参数
- T extends { destroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.dv
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:23

getLayer

getLayer(layerName: string): ScreenLayer
参数
- layerName: string
返回 ScreenLayer
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:82

isDestroyed

isDestroyed(): boolean
返回 boolean
继承自 Destroyable.isDestroyed
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:5

refresh

refresh(): void
返回 void
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:28

remove

remove(
    layer: string,
    id: string,
    removeInfo:
        | string
        | Set<string>
        | Partial<
            Record<"label" | "billboard" | "customObject", string | Set<string>>,
        >,
    forceRemove?: boolean,
): void
参数
- layer: string
- id: string
- removeInfo:
      | string
      | Set<string>
      | Partial<
          Record<"label" | "billboard" | "customObject", string | Set<string>>,
      >
- forceRemove: boolean = false
返回 void
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:121

setRules

setRules(rules: ESJScreenRules, layer?: string): void
参数
- rules: ESJScreenRules
- 可选layer: string
返回 void
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:135

tdv

tdv<T extends { tryDestroy(): void }>(obj: T): T
类型参数
- T extends { tryDestroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.tdv
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:29

tryDestory

tryDestory(): undefined
返回 undefined
继承自 Destroyable.tryDestory
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:41

tryDisposeVar

tryDisposeVar<T extends { tryDestroy(): void }>(obj: T): T
类型参数
- T extends { tryDestroy(): void }
参数
- obj: T
返回 T
继承自 Destroyable.tryDisposeVar
- 定义于 earthsdk/earthsdk3/dist/types/xbsj-base/xr-base-utils/Destroyable/index.d.ts:26

update

update(
    layer: string,
    id: string,
    screenObjectIds: string | Set<string>,
    style: Partial<
        Record<
            "label"
            | "all"
            | "billboard"
            | "customObject",

                | Record<string, any>
                | Partial<
                    {
                        allowOverlap: boolean;
                        avoidancePadding: number;
                        backgroundColor: Color;
                        backgroundPadding: Cartesian2;
                        disableDepthTestDistance: number;
                        distanceDisplayCondition: DistanceDisplayCondition;
                        eyeOffset: Cartesian3;
                        fillColor: Color;
                        font: string;
                        heightReference: HeightReference;
                        horizontalOrigin: HorizontalOrigin;
                        id: any;
                        ignorePlacement: boolean;
                        letterSpacing: number;
                        outlineColor: Color;
                        outlineWidth: number;
                        pixelOffset: Cartesian2;
                        pixelOffsetScaleByDistance: NearFarScalar;
                        position: Cartesian3;
                        positions: Cartesian3[];
                        rotation: number;
                        scale: number;
                        scaleByDistance: NearFarScalar;
                        show: boolean;
                        showBackground: boolean;
                        style: LabelStyle;
                        text: string;
                        textJustify: string;
                        translucencyByDistance: NearFarScalar;
                        verticalOrigin: VerticalOrigin;
                    },
                >
                | Partial<
                    {
                        alignedAxis: Cartesian3;
                        allowOverlap: boolean;
                        avoidancePadding: ESJVector4D;
                        color: Color;
                        disableDepthTestDistance: number;
                        distanceDisplayCondition: DistanceDisplayCondition;
                        eyeOffset: Cartesian3;
                        height: number;
                        heightReference: HeightReference;
                        horizontalOrigin: HorizontalOrigin;
                        id: any;
                        ignorePlacement: boolean;
                        image: string
                        | HTMLImageElement
                        | HTMLCanvasElement;
                        imageId?: string;
                        imageSubRegion: BoundingRectangle;
                        pixelOffset: Cartesian2;
                        pixelOffsetScaleByDistance: NearFarScalar;
                        position: Cartesian3;
                        rotation: number;
                        scale: number;
                        scaleByDistance: NearFarScalar;
                        show: boolean;
                        sizeInMeters: boolean;
                        splitDirection: SplitDirection;
                        translucencyByDistance: NearFarScalar;
                        verticalOrigin: VerticalOrigin;
                        width: number;
                    },
                >,
        >,
    >,
): boolean
参数
- layer: string
- id: string
- screenObjectIds: string | Set<string>
- style: Partial<
      Record<
          "label"
          | "all"
          | "billboard"
          | "customObject",
  
              | Record<string, any>
              | Partial<
                  {
                      allowOverlap: boolean;
                      avoidancePadding: number;
                      backgroundColor: Color;
                      backgroundPadding: Cartesian2;
                      disableDepthTestDistance: number;
                      distanceDisplayCondition: DistanceDisplayCondition;
                      eyeOffset: Cartesian3;
                      fillColor: Color;
                      font: string;
                      heightReference: HeightReference;
                      horizontalOrigin: HorizontalOrigin;
                      id: any;
                      ignorePlacement: boolean;
                      letterSpacing: number;
                      outlineColor: Color;
                      outlineWidth: number;
                      pixelOffset: Cartesian2;
                      pixelOffsetScaleByDistance: NearFarScalar;
                      position: Cartesian3;
                      positions: Cartesian3[];
                      rotation: number;
                      scale: number;
                      scaleByDistance: NearFarScalar;
                      show: boolean;
                      showBackground: boolean;
                      style: LabelStyle;
                      text: string;
                      textJustify: string;
                      translucencyByDistance: NearFarScalar;
                      verticalOrigin: VerticalOrigin;
                  },
              >
              | Partial<
                  {
                      alignedAxis: Cartesian3;
                      allowOverlap: boolean;
                      avoidancePadding: ESJVector4D;
                      color: Color;
                      disableDepthTestDistance: number;
                      distanceDisplayCondition: DistanceDisplayCondition;
                      eyeOffset: Cartesian3;
                      height: number;
                      heightReference: HeightReference;
                      horizontalOrigin: HorizontalOrigin;
                      id: any;
                      ignorePlacement: boolean;
                      image: string
                      | HTMLImageElement
                      | HTMLCanvasElement;
                      imageId?: string;
                      imageSubRegion: BoundingRectangle;
                      pixelOffset: Cartesian2;
                      pixelOffsetScaleByDistance: NearFarScalar;
                      position: Cartesian3;
                      rotation: number;
                      scale: number;
                      scaleByDistance: NearFarScalar;
                      show: boolean;
                      sizeInMeters: boolean;
                      splitDirection: SplitDirection;
                      translucencyByDistance: NearFarScalar;
                      verticalOrigin: VerticalOrigin;
                      width: number;
                  },
              >,
      >,
  >
返回 boolean
- 定义于 earthsdk/earthsdk3-cesium/src/ESCesiumViewer/ViewerExtensions/ScreenManager/index.ts:113

类 ScreenManager

层级

索引

构造函数

属性

访问器

方法

构造函数

constructor

参数

返回 ScreenManager

属性

avoidanceManager

billboardCollection

canvasCollection

collectionMap

customObjectCollection

czmViewer

labelCollection

layers

viewer

静态_lastMemId

访问器

disposers

返回 (() => void)[]

memId

返回 number

refreshEvent

返回 Event<[]>

toDestroyEvent

返回 Listener

方法

ad

参数

返回 () => void

类型参数

参数

返回 T

addImage

参数

返回 { id: string; layer: string; screenObjectId: string }

addLabel

参数

返回 { id: string; layer: string; screenObjectId: string }

addRectangle

参数

返回 { id: string; layer: string; screenObjectId: string }

autoDispose

参数

返回 () => void

类型参数

参数

返回 T

d

参数

返回 () => void

destroy

返回 undefined

destroyImp

返回 void

dispose

参数

返回 () => void

disposeVar

类型参数

参数

返回 T

dv

类型参数

参数

返回 T

getLayer

参数

返回 ScreenLayer

isDestroyed

返回 boolean

refresh

返回 void

remove

参数

`静态`_lastMemId