如视 Five SDK
    Preparing search index...

    Interface ItemMaskController

    plugin 的基本控制器

    interface ItemMaskController {
        data?: ItemMaskPluginType.PluginData;
        five: Five;
        hooks: Subscribe<ItemMaskPluginType.EventMap>;
        state: ItemMaskPluginType.State;
        staticPrefix: string;
        get config(): {};
        absoluteUrl(url: string): string;
        appendTo?(wrapper: Element): void;
        disable(options?: BaseOptions): void;
        dispose(): void;
        enable(options?: BaseOptions): void;
        getCurrentState(): ItemMaskPluginType.State;
        hide?(options?: BaseOptions): void | Promise<void>;
        load(data: ItemMaskPluginType.ServerData): Promise<void>;
        select(name?: string, options?: { userAction: boolean }): void;
        selectAll(bool?: boolean): void;
        setMode(mode: "box" | "mask"): void;
        setState(
            state: Partial<ItemMaskPluginType.State>,
            options?: BaseOptions,
        ): void;
        show?(options?: BaseOptions): void | Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data? five hooks state staticPrefix

    Accessors

    config

    Methods

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

    Properties

    data?: ItemMaskPluginType.PluginData

    当前使用的数据

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

    插件事件钩子

    state: ItemMaskPluginType.State

    插件当前状态

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

    Accessors

    • get config(): {}

      Returns {}

    Methods

    • Parameters

      • url: string

      Returns string

      获取静态资源的url

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

      Parameters

      • wrapper: Element

        Element元素

      Returns void

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

      Parameters

      Returns void

    • 销毁插件，移除所有副作用，销毁后将不响应任何 API

      Returns void

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

      Parameters

      Returns void

    • 隐藏UI

      Parameters

      Returns void | Promise<void>

    • Parameters

      • Optionalname: string
      • Optionaloptions: { userAction: boolean }

      Returns void

    • Parameters

      • bool: boolean = true

      Returns void

    • Parameters

      • mode: "box" | "mask"

      Returns void

    • 展示UI

      Parameters

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods