Hierarchy

  • TagRender
    • PanoTagPluginController

Constructors

  • Parameters

    • five: Five
    • Optionalparams: {
          config?: Pick<Tags, "globalConfig" | "contentTypeConfig">;
          containerZIndex?: number;
          debug?: boolean;
      }
      • Optionalconfig?: Pick<Tags, "globalConfig" | "contentTypeConfig">
      • OptionalcontainerZIndex?: number
      • Optionaldebug?: boolean

    Returns PanoTagPluginController

Properties

cache: Cache = ...
config: Pick<Tags, "globalConfig" | "contentTypeConfig"> = DefaultConfig
contentTypeMap: TagContentTypeMapping = ...
domEvents: FiveDomEvents = ...
five: Five
fiveUtil: FiveUtil
gltfObjectGroup: TagGLTFObjectGroup = ...
group: TagObjectGroup = ...
hooks: Subscribe<PluginEventMap> = ...

@description: 插件事件钩子

imagePlaneGroup: ImagePlaneGroup = ...
mediaStore: MediaStore = ...
NAME?: string
rendererMap: TagRendererMap = ...
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: {
    enabled: boolean;
    visible: boolean;
} = ...

state

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

点标签

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

临时状态

VERSION: string = __DNALOGEL_VERSION__

@realsee/dnalogel 版本号

workUtil: WorkUtil

Accessors

  • get container(): Element
  • Returns Element

  • set container(container): void
  • Parameters

    • container: Element

    Returns void

  • 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">[]

  • 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">)[]

  • 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">[]

  • set tagsLengthWillUpdate(value): void
  • Parameters

    • value: boolean

    Returns void

  • get workCode(): string
  • Returns string

  • set workCode(workCode): void
  • Parameters

    • workCode: string

    Returns void

Methods

  • @description: 获取静态资源的url

    Parameters

    • url: string

    Returns string

  • 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

  • Parameters

    Returns Promise<void>

    添加标签

  • 插件自身DOM添加到父容器

    Parameters

    • wrapper: Element

    Returns void

  • Parameters

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

    Returns void

  • Parameters

    • id: TagId
    • OptionalanimeConfig: Partial<AnimeParams>

    Returns Promise<void>

    闪烁标签

  • Parameters

    • config: Pick<Tags, "globalConfig" | "contentTypeConfig">
    • merge: boolean = true

    Returns void

    改变配置

  • Type Parameters

    Parameters

    Returns 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

    Returns void

    改变data

  • Parameters

    • id: TagId
    • enabled: boolean

    Returns void

    启用/停用指定id的标签

  • Parameters

    • globalConfig: TagConfig<
          | "Panorama"
          | "Model"
          | "Image"
          | "Link"
          | "Audio"
          | "Text"
          | "ImageText"
          | "Video"
          | "Sticker"
          | "VRLink"
          | "PanoLink"
          | "Marketing"
          | "MediaPlane"
          | "MediaModel"
          | "Custom"
          | "Unknown">
    • merge: boolean = true

    Returns 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;
                  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];
          stickType?: StickType;
      }>
    • deepMerge: boolean = true

    Returns void

    改变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
    • tag: PartialObjectDeep<Tag<C>>
    • deepMerge: boolean = true

    Returns void

    改变tag任意属性

  • 更改 tag 模型

    Parameters

    Returns Promise<void>

  • Parameters

    Returns void

    修改3D标签normal

  • Parameters

    • id: TagId
    • unfolded: boolean

    Returns void

    展开/收起指定id的标签

  • Returns void

    清除所有标签

  • Parameters

    Returns void

  • Parameters

    Returns void

    销毁tag

  • 禁用插件,让插件停止响应交互

    Parameters

    • Optionalparams: {
          userAction?: boolean;
      }
      • OptionaluserAction?: boolean

    Returns void

  • Returns void

    销毁

  • 启用插件,让插件能够响应交互

    Parameters

    • Optionalparams: {
          userAction?: boolean;
      }
      • OptionaluserAction?: boolean

    Returns void

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

    Returns State

  • 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

    Returns BaseTag<C, S>

  • 隐藏UI

    Parameters

    • Optionalparams: {
          userAction?: boolean;
      }
      • OptionaluserAction?: boolean

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    加载数据

  • 暂停当前标签内进行的所有多媒体

    Returns 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

    设置 contentType 的渲染器

    优先级低于 tag.element

  • Returns void

  • 设置state

    Parameters

    • state: Partial<State>

      插件的目标状态

    • Optionalparams: {
          userAction?: boolean;
      }
      • OptionaluserAction?: boolean

    Returns void

  • 展示UI

    Parameters

    • Optionalparams: {
          userAction?: boolean;
      }
      • OptionaluserAction?: boolean

    Returns Promise<void>

  • Parameters

    • five: Five

    Returns void

  • Returns void

  • Parameters

    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;
    }