Class BackgroundPluginController

plugin 的基本控制器

Hierarchy (view full)

Controller<BackgroundPluginType.State, BackgroundPluginType.EventMap, any, BackgroundPluginType.PluginData>
- BackgroundPluginController

Index

Constructors

constructor

new BackgroundPluginController(five, params?): BackgroundPluginController
Parameters
- five: Five
- Optional params: BackgroundPluginType.Params
Returns BackgroundPluginController
Overrides Controller.constructor
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:12

Properties

five

five: Five

hooks

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

Description

插件事件钩子

`Readonly` pluginName

pluginName: "BackgroundPlugin" = 'BackgroundPlugin'

state

state: BackgroundPluginType.State

当前状态

Description

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

`Readonly` staticPrefix

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

Methods

absoluteUrl

absoluteUrl(url): string
Parameters
- url: string
Returns string
Description
获取静态资源的url
Inherited from Controller.absoluteUrl
- Defined in lib/plugins/BasePlugin/index.ts:132

`Optional` appendTo

appendTo(wrapper): void
插件自身DOM添加到父容器
Parameters
- wrapper: Element
  Element元素
Returns void
Inherited from Controller.appendTo
- Defined in lib/plugins/BasePlugin/index.ts:110

disable

disable(options?): void
禁用插件，让插件停止响应交互
Parameters
- options: BaseOptions = {}
Returns void
Overrides Controller.disable
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:83

dispose

dispose(): void
插件进行销毁

Returns void
Overrides Controller.dispose
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:92

enable

enable(): void
启用插件，让插件能够响应交互

Returns void
Overrides Controller.enable
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:68

getCurrentState

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

Returns BackgroundPluginType.State
Inherited from Controller.getCurrentState
- Defined in lib/plugins/BasePlugin/index.ts:102

`Optional` hide

hide(options?): void | Promise<void>
隐藏UI
Parameters
- Optional options: BaseOptions
Returns void | Promise<void>
Inherited from Controller.hide
- Defined in lib/plugins/BasePlugin/index.ts:120

load

load(): Promise<void>
加载插件依赖数据

Returns Promise<void>
Overrides Controller.load
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:66

setState

setState(state, options?): void
设置state
Parameters
- state: Partial<BackgroundPluginType.State>
  插件的目标状态
- options: BaseOptions = {}
  配置项
Returns void
Overrides Controller.setState
- Defined in lib/plugins/BackgroundPlugin/Controller.ts:67

`Optional` show

show(options?): void | Promise<void>
展示UI
Parameters
- Optional options: BaseOptions
Returns void | Promise<void>
Inherited from Controller.show
- Defined in lib/plugins/BasePlugin/index.ts:115

Class BackgroundPluginController

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BackgroundPluginController

Properties

five

hooks

Description

Readonly pluginName

state

Description

Readonly staticPrefix

Methods

absoluteUrl

Parameters

Returns string

Description

Optional appendTo

Parameters

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Returns void

getCurrentState

Returns BackgroundPluginType.State

Optional hide

Parameters

Returns void | Promise<void>

load

Returns Promise<void>

setState

Parameters

Returns void

Optional show

Parameters

Returns void | Promise<void>

Settings

Member Visibility

Theme

On This Page

`Readonly` pluginName

`Readonly` staticPrefix

`Optional` appendTo

`Optional` hide

`Optional` show