Class PanoTagPluginController

Hierarchy

TagRender
- PanoTagPluginController

Constructors

constructor

new PanoTagPluginController(five, params?): PanoTagPluginController
Parameters
- five: Five
- Optional params: {
  config?: Pick<Tags, "globalConfig" | "contentTypeConfig">;
  debug?: boolean;
  }
  - Optional config?: Pick<Tags, "globalConfig" | "contentTypeConfig">
  - Optional debug?: boolean
Returns PanoTagPluginController
Overrides TagRender.constructor
- Defined in src/PanoTagPlugin/controller/index.ts:36

Properties

`Readonly` VERSION

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

config

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

contentTypeMap

contentTypeMap: TagContentTypeMapping = ...

five

five: Five

hooks

hooks: Subscribe<EventMap> = ...

@description: 插件事件钩子

rendererMap

rendererMap: TagRendererMap = ...

state

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

state

Type declaration

enabled: boolean
visible: boolean

`Readonly` staticPrefix

staticPrefix: string = '//vr-image-4.realsee-cdn.cn'

workUtil

workUtil: WorkUtil = ...

Accessors

workCode

get workCode(): string
Returns string
Inherited from TagRender.workCode
- Defined in src/PanoTagPlugin/controller/TagUtil.ts:45
set workCode(workCode): void
Parameters
- workCode: string
Returns void
Inherited from TagRender.workCode
- Defined in src/PanoTagPlugin/controller/TagUtil.ts:41

Methods

absoluteUrl

absoluteUrl(url): string
@description: 获取静态资源的url
Parameters
- url: string
Returns string
Inherited from TagRender.absoluteUrl
- Defined in src/base/BasePlugin.ts:126

addTag

addTag(tag, paramsConfig?): Promise<void>
@description: 添加标签
Parameters
- tag: Tag | Tag[]
- Optional paramsConfig: AddTagConfig
Returns Promise<void>
- Defined in src/PanoTagPlugin/controller/index.ts:85

`Optional` appendTo

appendTo(wrapper): void
插件自身DOM添加到父容器
Parameters
- wrapper: Element
Returns void
Inherited from TagRender.appendTo
- Defined in src/base/BasePlugin.ts:104

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 src/PanoTagPlugin/controller/TagRender.ts:69

changeConfig

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

changeContentTypeConfig

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

changeDataById

changeDataById<C>(id, data, deepMerge?): void
@description: 改变data
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
- Defined in src/PanoTagPlugin/controller/index.ts:300

changeEnabledById

changeEnabledById(id, enabled): void
Parameters
- id: TagId
- enabled: boolean
Returns void
- Defined in src/PanoTagPlugin/controller/index.ts:280

changeGlobalConfig

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

changeStickTypeById

changeStickTypeById<C>(id, data, deepMerge?): void
@description: 改变tag的stickType
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: 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;
      } | {
          appearance?: "line" | "plane";
          audioUrl: string;
          text?: string;
          theme?: "light" | "dark";
          title?: string;
      } & {
          extraData?: Object;
      } & {
          [key: string]: any;
      } | {
          mediaData: Object[];
          text?: string;
          title?: string;
      } & {
          extraData?: Object;
      } & {
          [key: string]: any;
      } | {
          icon?: TagIconUrl;
          linkType?: "normal" | "vr";
          text?: string;
          title?: string;
      } & {
          extraData?: Object;
      } & {
          [key: string]: any;
      } | {
          brandTags?: string[];
          headerPictureUrl?: string;
          highlightText?: string;
          limitWidth?: number | boolean;
          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;
      } | {
          action?: {
              type: "iframe" | "window";
              url: string;
          };
          matrix?: number[];
          mediaData: MediaData[];
          mediaPosition: [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
          modelUrl: string;
          objectFit?: ObjectFit;
      } & {
          extraData?: Object;
      } & {
          [key: string]: any;
      } | {
          action?: {
              type: "iframe" | "window" | "custom";
              url?: string;
          };
          matrix?: number[];
          modelUrl: string;
      } & {
          extraData?: Object;
      } & {
          [key: string]: any;
      };
      normal?: ArrayPosition;
      position: ArrayPosition | [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
      stickType: StickType;
  }>
- deepMerge: boolean = true
Returns void
- Defined in src/PanoTagPlugin/controller/index.ts:321

changeTagById

changeTagById<C>(id, tag, deepMerge?): void
@description: 改变tag任意属性
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
- Defined in src/PanoTagPlugin/controller/index.ts:332

changeTagModel

changeTagModel(tag, data): Promise<void>
更改 tag 模型
Parameters
- tag: TagInstance<"Model", "Model"> | TagInstance<"MediaModel", "Model">
- data: PartialObjectDeep<{
      action?: {
          type: "iframe" | "window";
          url: string;
      };
      matrix?: number[];
      mediaData: MediaData[];
      mediaPosition: [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
      modelUrl: string;
      objectFit?: ObjectFit;
  } & {
      extraData?: Object;
  } & {
      [key: string]: any;
  }>
Returns Promise<void>
- Defined in src/PanoTagPlugin/controller/index.ts:367

changeTagNormalById

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

changeUnfoldedById

changeUnfoldedById(id, unfolded): void
Parameters
- id: TagId
- unfolded: boolean
Returns void
- Defined in src/PanoTagPlugin/controller/index.ts:266

clearTags

clearTags(): void
Returns void
Inherited from TagRender.clearTags
- Defined in src/PanoTagPlugin/controller/TagRender.ts:73

destroyTagById

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

disable

disable(params?): void
Parameters
- Optional params: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns void
Overrides TagRender.disable
- Defined in src/PanoTagPlugin/controller/index.ts:218

dispose

dispose(): void
@description: 销毁

Returns void
Overrides TagRender.dispose
- Defined in src/PanoTagPlugin/controller/index.ts:243

enable

enable(params?): void
Parameters
- Optional params: {
  userAction?: boolean;
  }
  - Optional userAction?: boolean
Returns void
Overrides TagRender.enable
- Defined in src/PanoTagPlugin/controller/index.ts:211

getCurrentState

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

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

getCurrentVisibleState

getCurrentVisibleState(tag): boolean
Parameters
- tag: TagInstance
Returns boolean

Description
获取标签当前状态
Inherited from TagRender.getCurrentVisibleState
- Defined in src/PanoTagPlugin/controller/TagUtil.ts:119

getTagById

getTagById<C, S>(id): TagInstance<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 TagInstance<C, S>
Inherited from TagRender.getTagById
- Defined in src/PanoTagPlugin/controller/TagUtil.ts:89

getTagConfig

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

getUnfoldedByCamera

getUnfoldedByCamera(tag): boolean
@description: 获取是否展开
Parameters
- tag: TagInstance
Returns boolean
Inherited from TagRender.getUnfoldedByCamera
- Defined in src/PanoTagPlugin/controller/TagComputer.ts:197

getUnfoldedByPanoIndex

getUnfoldedByPanoIndex(tag, panoIndex?): boolean
@description: 获取是否展开
Parameters
- tag: TagInstance
- Optional panoIndex: number
Returns boolean
Inherited from TagRender.getUnfoldedByPanoIndex
- Defined in src/PanoTagPlugin/controller/TagComputer.ts:166

getVisible

getVisible(tag, fiveState?): boolean
@description: 获取是否可见
Parameters
- tag: TagInstance
- Optional fiveState: Partial<State>
Returns boolean
Inherited from TagRender.getVisible
- Defined in src/PanoTagPlugin/controller/TagComputer.ts:23

hide

hide(params?): Promise<void>
Parameters
- Optional params: {
  userAction?: boolean;
  withAnimation?: boolean;
  }
  - Optional userAction?: boolean
  - Optional withAnimation?: boolean
Returns Promise<void>
Overrides TagRender.hide
- Defined in src/PanoTagPlugin/controller/index.ts:204

load

load(data, config?): Promise<void>
@description: 加载数据
Parameters
- data: Tags
- Optional config: AddTagConfig
Returns Promise<void>
- Defined in src/PanoTagPlugin/controller/index.ts:58

pauseCurrentMedia

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

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

registerRenderer

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

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

setState

setState(state, params?): void
Parameters
- state: Partial<State>
- Optional params: {
  userAction?: boolean;
  visibleWithAnimation?: boolean;
  }
  - Optional userAction?: boolean
  - Optional visibleWithAnimation?: boolean
Returns void
Overrides TagRender.setState
- Defined in src/PanoTagPlugin/controller/index.ts:225

show

show(params?): Promise<void>
Parameters
- Optional params: {
  userAction?: boolean;
  withAnimation?: boolean;
  }
  - Optional userAction?: boolean
  - Optional withAnimation?: boolean
Returns Promise<void>
Overrides TagRender.show
- Defined in src/PanoTagPlugin/controller/index.ts:197

whyHide

whyHide(tagId): {
    reason: string;
    reasonObj?: undefined;
} | {
    reason: any;
    reasonObj: any;
}
Parameters
- tagId: TagId
Returns {
    reason: string;
    reasonObj?: undefined;
} | {
    reason: any;
    reasonObj: any;
}
- Defined in src/PanoTagPlugin/controller/index.ts:376

Class PanoTagPluginController

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

five: Five

Optional params: { config?: Pick<Tags, "globalConfig" | "contentTypeConfig">; debug?: boolean; }

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

Optional debug?: boolean

Returns PanoTagPluginController

Properties

Readonly VERSION

config

contentTypeMap

five

hooks

rendererMap

state

Type declaration

enabled: boolean

visible: boolean

Readonly staticPrefix

tags

workUtil

Accessors

workCode

Returns string

Parameters

workCode: string

Returns void

Methods

absoluteUrl

Parameters

url: string

Returns string

addTag

Parameters

tag: Tag | Tag[]

Optional paramsConfig: AddTagConfig

Returns Promise<void>

Optional appendTo

Parameters

wrapper: Element

Returns void

bindRenderer

Parameters

contentType: string

builtInRenderer: "Panorama" | "Model" | "Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown"

Returns void

changeConfig

Parameters

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

merge: boolean = true

Returns void

changeContentTypeConfig

Type Parameters

T extends ContentTypeConfigKey

Parameters

key: T

contentTypeConfig: TagConfigByKey<T>

merge: boolean = true

Returns void

changeDataById

Type Parameters

Parameters

id: TagId

data: PartialObjectDeep<ContentTypeMap[C]>

deepMerge: boolean = true

Returns void

changeEnabledById

Parameters

id: TagId

enabled: boolean

Returns void

changeGlobalConfig

`Optional` params: {
config?: Pick<Tags, "globalConfig" | "contentTypeConfig">;
debug?: boolean;
}

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

`Optional` debug?: boolean

`Readonly` VERSION

`Readonly` staticPrefix

`Optional` paramsConfig: AddTagConfig

`Optional` appendTo

data: PartialObjectDeep<{
action?: {
type: "iframe" | "window";
url: string;
};
matrix?: number[];
mediaData: MediaData[];
mediaPosition: [ArrayPosition, ArrayPosition, ArrayPosition, ArrayPosition];
modelUrl: string;
objectFit?: ObjectFit;
} & {
extraData?: Object;
} & {
[key: string]: any;
}>

`Optional` params: {
userAction?: boolean;
}

`Optional` userAction?: boolean

`Optional` params: {
userAction?: boolean;
}

`Optional` userAction?: boolean