Class ItemMaskController

plugin 的基本控制器

Hierarchy (view full)

Controller<ItemMaskPluginType.State, ItemMaskPluginType.EventMap, ItemMaskPluginType.ServerData, ItemMaskPluginType.PluginData>
- ItemMaskController

Index

Constructors

Properties

data? five hooks state staticPrefix

Accessors

Methods

absoluteUrl appendTo? disable dispose enable getCurrentState hide? load select selectAll setMode setState show?

Constructors

constructor

new ItemMaskController(five, params?): ItemMaskController
Parameters
- five: Five
- Optionalparams: ItemMaskPluginType.Params
Returns ItemMaskController
Overrides Controller.constructor
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:135

Properties

`Optional`data

data?: ItemMaskPluginType.PluginData

当前使用的数据

five

five: Five

hooks

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

Description

插件事件钩子

state

state: ItemMaskPluginType.State

插件当前状态

`Readonly`staticPrefix

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

Accessors

config

get config(): {}
Returns {}
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:91

Methods

absoluteUrl

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

`Optional`appendTo

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

disable

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

dispose

dispose(): void
销毁插件，移除所有副作用，销毁后将不响应任何 API

Returns void
Overrides Controller.dispose
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:434

enable

enable(options?): void
启用插件，让插件能够响应交互
Parameters
- Optionaloptions: BaseOptions
Returns void
Overrides Controller.enable
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:415

getCurrentState

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

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

`Optional`hide

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

load

load(data): Promise<void>
加载插件依赖数据
Parameters
- data: ItemMaskPluginType.ServerData
Returns Promise<void>
Overrides Controller.load
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:184

select

select(name?, options?): void
Parameters
- Optionalname: string
- Optionaloptions: {
  userAction: boolean;
  }
  - userAction: boolean
Returns void
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:379

selectAll

selectAll(bool?): void
Parameters
- bool: boolean = true
Returns void
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:387

setMode

setMode(mode): void
Parameters
- mode: "box" | "mask"
Returns void
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:363

setState

setState(state, options?): void
更改插件 State
Parameters
- state: Partial<ItemMaskPluginType.State>
- options: BaseOptions = {}
Returns void
Overrides Controller.setState
- Defined in lib/plugins/ItemMaskPlugin/Controller.ts:352

`Optional`show

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