Class PanoTagPluginController

Hierarchy

TagRender
- PanoTagPluginController

Index

Constructors

constructor

Accessors

container filter2DPointTag filterCSS3DTag filterMaskTag filterPointTag tagsLengthWillUpdate workCode

Constructors

constructor

new PanoTagPluginController(five, params?): PanoTagPluginController
Parameters
- five: Five
- Optionalparams: {
      config?: Pick<Tags, "globalConfig" | "contentTypeConfig">;
      containerZIndex?: number;
      debug?: boolean;
  }
  - Optionalconfig?: Pick<Tags, "globalConfig" | "contentTypeConfig">
  - OptionalcontainerZIndex?: number
  - Optionaldebug?: boolean
Returns PanoTagPluginController
Overrides TagRender.constructor
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:47

Properties

cache

cache: Cache = ...

config

config: Pick<Tags, "globalConfig" | "contentTypeConfig"> = DefaultConfig

contentTypeMap

contentTypeMap: TagContentTypeMapping = ...

domEvents

domEvents: FiveDomEvents = ...

five

five: Five

fiveUtil

fiveUtil: FiveUtil

globalHoverEnabled

globalHoverEnabled: boolean = true

全局 hover 启用状态，默认 true

gltfObjectGroup

gltfObjectGroup: TagGLTFObjectGroup = ...

group

group: TagObjectGroup = ...

hooks

hooks: Subscribe<PluginEventMap> = ...

@description: 插件事件钩子

imagePlaneGroup

imagePlaneGroup: ImagePlaneGroup = ...

mediaStore

mediaStore: MediaStore = ...

`Optional`NAME

NAME?: string

rendererMap

rendererMap: TagRendererMap = ...

renderQueue

renderQueue: Map<string, {
    keys: string[];
    tags: BaseTag<
        | "Panorama"
        | "Model"
        | "Image"
        | "Link"
        | "Audio"
        | "Text"
        | "ImageText"
        | "Video"
        | "Sticker"
        | "VRLink"
        | "PanoLink"
        | "Marketing"
        | "MediaPlane"
        | "MediaModel"
        | "Custom"
        | "Unknown", StickType>[];
}> = ...

state

state: {
enabled: boolean;
visible: boolean;
} = ...

state

`Readonly`staticPrefix

staticPrefix: string = DEFAULT_STATIC_PREFIX

`Optional`TagContainerSvelte

TagContainerSvelte?: SvelteComponentDev

点标签

temporaryState

temporaryState: TemporaryState = ...

临时状态

`Readonly`VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

workUtil

workUtil: WorkUtil

Accessors

container

get container(): Element
Returns Element
Inherited from TagRender.container
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:43
set container(container): void
Parameters
- container: Element
Returns void
Inherited from TagRender.container
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:47

filter2DPointTag

get filter2DPointTag(): PointTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">[]
Returns PointTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">[]
Inherited from TagRender.filter2DPointTag
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:122

filterCSS3DTag

get filterCSS3DTag(): (BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "Plane"> | BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "Model"> | BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "3DPoint">)[]
Returns (BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "Plane"> | BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "Model"> | BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", "3DPoint">)[]
Inherited from TagRender.filterCSS3DTag
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:126

filterMaskTag

get filterMaskTag(): (BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", StickType> & {
    [key: string]: any;
})[]
获取所有 Mask 类型的标签

Returns (BaseTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown", StickType> & {
    [key: string]: any;
})[]
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:1001

filterPointTag

get filterPointTag(): PointTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">[]
Returns PointTag<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">[]
Inherited from TagRender.filterPointTag
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:118

tagsLengthWillUpdate

set tagsLengthWillUpdate(value): void
Parameters
- value: boolean
Returns void
Inherited from TagRender.tagsLengthWillUpdate
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:56

workCode

get workCode(): string
Returns string
Inherited from TagRender.workCode
- Defined in plugins/src/base/BasePlugin.ts:84
set workCode(workCode): void
Parameters
- workCode: string
Returns void
Inherited from TagRender.workCode
- Defined in plugins/src/base/BasePlugin.ts:79

Methods

addRenderQueue

addRenderQueue(params): void
Parameters
- params: {
      keys?: string[];
      tags?: BaseTag<
          | "Panorama"
          | "Model"
          | "Image"
          | "Link"
          | "Audio"
          | "Text"
          | "ImageText"
          | "Video"
          | "Sticker"
          | "VRLink"
          | "PanoLink"
          | "Marketing"
          | "MediaPlane"
          | "MediaModel"
          | "Custom"
          | "Unknown", StickType>[];
      type: "TagContainerSvelte";
  }
  - Optionalkeys?: string[]
  - Optionaltags?: BaseTag<
        | "Panorama"
        | "Model"
        | "Image"
        | "Link"
        | "Audio"
        | "Text"
        | "ImageText"
        | "Video"
        | "Sticker"
        | "VRLink"
        | "PanoLink"
        | "Marketing"
        | "MediaPlane"
        | "MediaModel"
        | "Custom"
        | "Unknown", StickType>[]
  - type: "TagContainerSvelte"
Returns void
Inherited from TagRender.addRenderQueue
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:153

addTag

addTag(tag, options?): Promise<void>
Parameters
- tag: Tag | Tag[]
  标签或标签数组
- Optionaloptions: {
  updateMaskUrl?: boolean;
  }
  可选配置
  - OptionalupdateMaskUrl?: boolean
    是否更新 mask。若为 true 且该 panoIndex 已有 Mask 标签，仅更新其 maskUrl（不变 color、style），并添加新标签
Returns Promise<void>
Description
添加标签
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:155

appendTo

appendTo(wrapper): void
插件自身DOM添加到父容器
Parameters
- wrapper: Element
Returns void
Overrides TagRender.appendTo
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:85

bindRenderer

bindRenderer(contentType, builtInRenderer): void
Parameters
- contentType: string
- builtInRenderer:
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown"
Returns void
Inherited from TagRender.bindRenderer
- Defined in plugins/src/PanoTagPlugin/controller/TagRender.ts:54

blinkTagById

blinkTagById(id, animeConfig?): Promise<void>
Parameters
- id: TagId
- OptionalanimeConfig: Partial<AnimeParams>
Returns Promise<void>
Description
闪烁标签
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:357

changeConfig

changeConfig(config, merge?): void
Parameters
- config: Pick<Tags, "globalConfig" | "contentTypeConfig">
- merge: boolean = true
Returns void
Description
改变配置
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:225

changeContentTypeConfig

changeContentTypeConfig<T>(key, contentTypeConfig, merge?): void
Type Parameters
- T extends ContentTypeConfigKey
Parameters
- key: T
- contentTypeConfig: TagConfigByKey<T>
- merge: boolean = true
Returns void
Description
改变类型配置
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:261

changeDataById

changeDataById<C>(id, data, deepMerge?): void
Type Parameters
- C extends
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown" =
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown"
Parameters
- id: TagId
- data: PartialObjectDeep<ContentTypeMap[C]>
- deepMerge: boolean = true
Returns void
Description
改变data
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:408

changeEnabledById

changeEnabledById(id, enabled): void
Parameters
- id: TagId
- enabled: boolean
Returns void
Description
启用/停用指定id的标签
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:376

changeGlobalConfig

changeGlobalConfig(globalConfig, merge?): void
Parameters
- globalConfig: TagConfig<
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown">
- merge: boolean = true
Returns void
Description
改变全局配置
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:242

changeMask

changeMask(maskUpdates): void
Parameters
- maskUpdates: {
  index: number;
  mask: string | HTMLCanvasElement;
  }[]
  包含点位索引和对应 mask 的数组
Returns void
Description
批量更新指定点位的 Mask 图
Example
```
changeMask([
  { index: 0, mask: 'https://example.com/mask1.png' },
  { index: 1, mask: canvasElement }
])
```
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:468

changePositionById

changePositionById(id, position): void
Parameters
- id: TagId
- position:
      | ArrayPosition
      | [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition]
      | BoxPosition
      | PolygonPosition
Returns void
Description
改变data
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:398

changeStickTypeById

changeStickTypeById<C>(id, data, deepMerge?): void
Type Parameters
- C extends
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown" =
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown"
Parameters
- id: TagId
- data: PartialObjectDeep<{
      data:
          | {
              appearance?: "line" | "plane";
              audioUrl: string;
              text?: string;
              theme?: "light" | "dark";
              title?: string;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | Object & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              appearance?: "line" | "plane";
              description?: string;
              descriptionMaxRows?: number;
              edit?: {
                  description?: {
                      inputting?: boolean;
                      placeholder?: string;
                  };
                  title?: {
                      inputting?: boolean;
                      placeholder?: string;
                  };
              };
              text?: string;
              title?: string;
              titleMaxRows?: number;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              mediaData: (MediaData & {
                  name?: string;
              })[];
              text?: string;
              title?: string;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              icon?: TagIconUrl;
              linkType?: "vr" | "normal";
              text?: string;
              title?: string;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              brandTags?: string[];
              headerPictureUrl?: string;
              highlightText?: string;
              limitWidth?: number | boolean;
              mediaData?: (MediaData & {
                  name?: string;
              })[];
              price?: {
                  unit: string;
                  value: string | number;
              };
              tags?: string[];
              theme?: "light" | "dark";
              title: string;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              autoplayConfig?: {
                  autoplayCarousel?: boolean;
                  autoplayVideo?: boolean;
                  autoplayVideoInCarousel?: boolean;
              };
              enableCarousel?: boolean;
              mediaData: MediaData[];
              objectFit?: ObjectFit;
              playIcon?: string;
          } & DeprecatedMediaPlaneProperty & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              mediaData: MediaData[];
              mediaPosition: [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
              modelUrl: string;
              objectFit?: ObjectFit;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          }
          | {
              modelUrl: string;
          } & {
              extraData?: Object;
          } & {
              [key: string]: any;
          };
      normal?: ArrayPosition;
      position:
          | ArrayPosition
          | [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition]
          | BoxPosition
          | PolygonPosition;
      stickType?: StickType;
  }>
- deepMerge: boolean = true
Returns void
Description
改变tag的stickType
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:420

changeTagById

changeTagById<C>(id, tag, deepMerge?): void
Type Parameters
- C extends
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown" =
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown"
Parameters
- id: TagId
- tag: PartialObjectDeep<Tag<C>>
- deepMerge: boolean = true
Returns void
Description
改变tag任意属性
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:431

changeTagModel

changeTagModel(tag, data): Promise<void>
更改 tag 模型
Parameters
- tag: any
- data: PartialObjectDeep<{
      mediaData: MediaData[];
      mediaPosition: [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
      modelUrl: string;
      objectFit?: ObjectFit;
  } & {
      extraData?: Object;
  } & {
      [key: string]: any;
  }>
Returns Promise<void>
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:516

changeTagNormalById

changeTagNormalById(id, normal): void
Parameters
- id: TagId
- normal: ArrayPosition
Returns void
Description
修改3D标签normal
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:388

changeUnfoldedById

changeUnfoldedById(id, unfolded): void
Parameters
- id: TagId
- unfolded: boolean
Returns void
Description
展开/收起指定id的标签
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:366

clearMaskTagCache

clearMaskTagCache(): void
清理所有 MaskTag 纹理缓存（用于内存管理）注意：这会释放所有纹理缓存，谨慎使用

Returns void
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:1029

clearTags

clearTags(): void
Returns void
Description
清除所有标签
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:532

clickhandler

clickhandler(params): void
Parameters
- params: TagClickParams
Returns void
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:706

destroyTagById

destroyTagById(id): void
Parameters
- id: TagId | TagId[]
Returns void
Description
销毁tag
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:510

disable

disable(params?): void
禁用插件，让插件停止响应交互
Parameters
- Optionalparams: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Overrides TagRender.disable
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:300

dispose

dispose(): void
Returns void
Description
销毁
Overrides TagRender.dispose
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:324

enable

enable(params?): void
启用插件，让插件能够响应交互
Parameters
- Optionalparams: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Overrides TagRender.enable
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:293

getCurrentState

getCurrentState(): State
获取当前的插件状态，如果当初插件内存在需要通过动画变更的 state 值，则通过此方法可以得到中间状态

Returns State
Inherited from TagRender.getCurrentState
- Defined in plugins/src/base/BasePlugin.ts:122

getGlobalHoverEnabled

getGlobalHoverEnabled(): boolean
获取全局 hover 启用状态

Returns boolean
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:932

getMaskTagPerformanceStats

getMaskTagPerformanceStats(): {
    currentPanoIndex: number;
    textureCache: {
        cacheEntries: {
            refCount: number;
            sizeMB: number;
            source: string;
        }[];
        estimatedMemoryMB: number;
        totalCached: number;
        totalRefCount: number;
    };
    totalMaskTags: number;
    visibleMaskTags: number;
}
获取 MaskTag 性能统计信息（用于性能监控和调试）

Returns {
    currentPanoIndex: number;
    textureCache: {
        cacheEntries: {
            refCount: number;
            sizeMB: number;
            source: string;
        }[];
        estimatedMemoryMB: number;
        totalCached: number;
        totalRefCount: number;
    };
    totalMaskTags: number;
    visibleMaskTags: number;
}
性能统计信息
- currentPanoIndex: number
- textureCache: {
      cacheEntries: {
          refCount: number;
          sizeMB: number;
          source: string;
      }[];
      estimatedMemoryMB: number;
      totalCached: number;
      totalRefCount: number;
  }
  - cacheEntries: {
        refCount: number;
        sizeMB: number;
        source: string;
    }[]
  - estimatedMemoryMB: number
  - totalCached: number
  - totalRefCount: number
- totalMaskTags: number
- visibleMaskTags: number
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:1009

getTagById

getTagById<C, S>(id): BaseTag<C, S>
Type Parameters
- C extends
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown" =
      | "Panorama"
      | "Model"
      | "Image"
      | "Link"
      | "Audio"
      | "Text"
      | "ImageText"
      | "Video"
      | "Sticker"
      | "VRLink"
      | "PanoLink"
      | "Marketing"
      | "MediaPlane"
      | "MediaModel"
      | "Custom"
      | "Unknown"
- S extends StickType = StickType
Parameters
- id: TagId
Returns BaseTag<C, S>
Inherited from TagRender.getTagById
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:165

getTagConfig

getTagConfig(tag, params?): TagConfig<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">
Parameters
- tag: Tag
- Optionalparams: {
  fiveMode?: Mode;
  useCache?: boolean;
  }
  - OptionalfiveMode?: Mode
  - OptionaluseCache?: boolean
Returns TagConfig<
    | "Panorama"
    | "Model"
    | "Image"
    | "Link"
    | "Audio"
    | "Text"
    | "ImageText"
    | "Video"
    | "Sticker"
    | "VRLink"
    | "PanoLink"
    | "Marketing"
    | "MediaPlane"
    | "MediaModel"
    | "Custom"
    | "Unknown">
Description
获取标签配置
Inherited from TagRender.getTagConfig
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:193

getTagHoverEnabled

getTagHoverEnabled(id): boolean
Parameters
- id: TagId
Returns boolean
Description
获取标签 hover 启用状态
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:917

hide

hide(params?): Promise<void>
隐藏UI
Parameters
- Optionalparams: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Overrides TagRender.hide
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:286

load

load(data): Promise<void>
Parameters
- data: Tags
Returns Promise<void>
Description
加载数据
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:100

pauseCurrentMedia

pauseCurrentMedia(): void
暂停当前标签内进行的所有多媒体

Returns void
Inherited from TagRender.pauseCurrentMedia
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:186

registerRenderer

registerRenderer(contentType, renderer, config?): void
Parameters
- contentType: string
  如果是 TagContentType 中的类型，将会覆盖掉插件内部默认的渲染器, 如果是其他任意 string 如：'Foo'，则可以将类似 {id: 1, contentType: 'Foo', position: [0,0,0]} 的 tag 交给插件渲染
- renderer: ElementRenderer
- Optionalconfig: {
  usePoint?: boolean;
  }
  - OptionalusePoint?: boolean
    是否需要标签点, 默认为 false
Returns void
Description
设置 contentType 的渲染器

Note
优先级低于 tag.element
Inherited from TagRender.registerRenderer
- Defined in plugins/src/PanoTagPlugin/controller/TagRender.ts:50

render

render(): void
Returns void
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:862

setGlobalHoverEnabled

setGlobalHoverEnabled(enabled): void
设置全局 hover 启用状态
Parameters
- enabled: boolean
Returns void
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:925

setState

setState(state, params?): void
设置state
Parameters
- state: Partial<State>
  插件的目标状态
- Optionalparams: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns void
Overrides TagRender.setState
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:307

setTagHoverEnabled

setTagHoverEnabled(id, enabled): void
Parameters
- id: TagId
- enabled: boolean
Returns void
Description
设置标签 hover 启用状态
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:909

show

show(params?): Promise<void>
展示UI
Parameters
- Optionalparams: {
  userAction?: boolean;
  }
  - OptionaluserAction?: boolean
Returns Promise<void>
Overrides TagRender.show
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:279

updateFive

updateFive(five): void
Parameters
- five: Five
Returns void
Inherited from TagRender.updateFive
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:147

updateRenderAllTags

updateRenderAllTags(): void
Returns void
Deprecated
- Defined in plugins/src/PanoTagPlugin/controller/index.ts:524

whyHide

whyHide(tagId): {
    info: undefined;
    reason: string;
} | {
    info: {
        reason?: any;
        tagInstance: BaseTag<
            | "Panorama"
            | "Model"
            | "Image"
            | "Link"
            | "Audio"
            | "Text"
            | "ImageText"
            | "Video"
            | "Sticker"
            | "VRLink"
            | "PanoLink"
            | "Marketing"
            | "MediaPlane"
            | "MediaModel"
            | "Custom"
            | "Unknown", StickType>;
        value: boolean;
    };
    reason: any;
}
Parameters
- tagId: TagId
Returns {
    info: undefined;
    reason: string;
} | {
    info: {
        reason?: any;
        tagInstance: BaseTag<
            | "Panorama"
            | "Model"
            | "Image"
            | "Link"
            | "Audio"
            | "Text"
            | "ImageText"
            | "Video"
            | "Sticker"
            | "VRLink"
            | "PanoLink"
            | "Marketing"
            | "MediaPlane"
            | "MediaModel"
            | "Custom"
            | "Unknown", StickType>;
        value: boolean;
    };
    reason: any;
}
Inherited from TagRender.whyHide
- Defined in plugins/src/PanoTagPlugin/controller/TagUtil.ts:177

Class PanoTagPluginController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalconfig?: Pick<Tags, "globalConfig" | "contentTypeConfig">

OptionalcontainerZIndex?: number

Optionaldebug?: boolean

Returns PanoTagPluginController

Properties

cache

config

contentTypeMap

domEvents

five

fiveUtil

globalHoverEnabled

gltfObjectGroup

group

hooks

imagePlaneGroup

mediaStore

OptionalNAME

rendererMap

renderQueue

state

ReadonlystaticPrefix

OptionalTagContainerSvelte

tags

temporaryState

ReadonlyVERSION

workUtil

Accessors

container

Returns Element

Parameters

Returns void

filter2DPointTag

Returns PointTag< | "Panorama" | "Model" | "Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[]

filterCSS3DTag

filterMaskTag

Returns (BaseTag< | "Panorama" | "Model" | "Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown", StickType> & { [key: string]: any; })[]

filterPointTag

Returns PointTag< | "Panorama" | "Model" | "Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[]

tagsLengthWillUpdate

Parameters

Returns void

workCode

Returns string

Parameters

Returns void

Methods

addRenderQueue

Parameters

Optionalkeys?: string[]

Optionaltags?: BaseTag< | "Panorama" | "Model" | "Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown", StickType>[]

type: "TagContainerSvelte"

Returns void

addTag

Parameters

OptionalupdateMaskUrl?: boolean

Returns Promise<void>

Description

appendTo

Parameters

Returns void

bindRenderer

Parameters

Returns void

blinkTagById

Parameters

Returns Promise<void>

Description

changeConfig

Parameters

`Optional`config?: Pick<Tags, "globalConfig" | "contentTypeConfig">

`Optional`containerZIndex?: number

`Optional`debug?: boolean

`Optional`NAME

`Readonly`staticPrefix

`Optional`TagContainerSvelte

`Readonly`VERSION

Returns PointTag<
| "Panorama"
| "Model"
| "Image"
| "Link"
| "Audio"
| "Text"
| "ImageText"
| "Video"
| "Sticker"
| "VRLink"
| "PanoLink"
| "Marketing"
| "MediaPlane"
| "MediaModel"
| "Custom"
| "Unknown">[]

Returns (BaseTag<
| "Panorama"
| "Model"
| "Image"
| "Link"
| "Audio"
| "Text"
| "ImageText"
| "Video"
| "Sticker"
| "VRLink"
| "PanoLink"
| "Marketing"
| "MediaPlane"
| "MediaModel"
| "Custom"
| "Unknown", StickType> & {
[key: string]: any;
})[]

Returns PointTag<
| "Panorama"
| "Model"
| "Image"
| "Link"
| "Audio"
| "Text"
| "ImageText"
| "Video"
| "Sticker"
| "VRLink"
| "PanoLink"
| "Marketing"
| "MediaPlane"
| "MediaModel"
| "Custom"
| "Unknown">[]

`Optional`keys?: string[]

`Optional`tags?: BaseTag<
| "Panorama"
| "Model"
| "Image"
| "Link"
| "Audio"
| "Text"
| "ImageText"
| "Video"
| "Sticker"
| "VRLink"
| "PanoLink"
| "Marketing"
| "MediaPlane"
| "MediaModel"
| "Custom"
| "Unknown", StickType>[]

`Optional`updateMaskUrl?: boolean

`Optional`userAction?: boolean