Class BackgroundPluginController

plugin 的基本控制器

Hierarchy (view full)

Constructors

constructor

Properties

five hooks pluginName state staticPrefix

Methods

absoluteUrl appendTo? disable dispose enable getCurrentState hide? load setState show?

Constructors

constructor

Properties

five

five: Five

hooks

hooks: Subscribe<BackgroundPluginType.EventMap> = ...

Description

插件事件钩子

ReadonlypluginName

pluginName: "BackgroundPlugin" = 'BackgroundPlugin'

state

state: BackgroundPluginType.State

当前状态

Description

可以通过 plugin.state 和 plugin.setState 来获取和设置。
通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
来迎合一些通过数据驱动的场景。

ReadonlystaticPrefix

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

Methods

absoluteUrl

  • absoluteUrl(url): string

  • Parameters

    • url: string

    Returns string

    Description

    获取静态资源的url

OptionalappendTo

  • appendTo(wrapper): void

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

    Parameters

    • wrapper: Element

      Element元素

    Returns void

disable

  • disable(options?): void

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

    Parameters

    Returns void

dispose

  • dispose(): void

  • 插件进行销毁

    Returns void

enable

  • enable(): void

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

    Returns void

getCurrentState

Optionalhide

  • hide(options?): void | Promise<void>

  • 隐藏UI

    Parameters

    Returns void | Promise<void>

load

  • load(): Promise<void>

  • 加载插件依赖数据

    Returns Promise<void>

setState

Optionalshow

  • show(options?): void | Promise<void>

  • 展示UI

    Parameters

    Returns void | Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
""