如视 Five SDK
    Preparing search index...

    Interface BackgroundPluginController

    plugin 的基本控制器

    interface BackgroundPluginController {
        five: Five;
        hooks: Subscribe<BackgroundPluginType.EventMap>;
        pluginName: "BackgroundPlugin";
        state: BackgroundPluginType.State;
        staticPrefix: string;
        absoluteUrl(url: string): string;
        appendTo?(wrapper: Element): void;
        disable(options?: BaseOptions): void;
        dispose(): void;
        enable(): void;
        getCurrentState(): BackgroundPluginType.State;
        hide?(options?: BaseOptions): void | Promise<void>;
        load(): Promise<void>;
        setState(
            state: Partial<BackgroundPluginType.State>,
            options?: BaseOptions,
        ): void;
        show?(options?: BaseOptions): void | Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    five hooks pluginName state staticPrefix

    Methods

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

    Properties

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

    插件事件钩子

    pluginName: "BackgroundPlugin" = 'BackgroundPlugin'
    state: BackgroundPluginType.State

    当前状态

    可以通过 plugin.state 和 plugin.setState 来获取和设置。
通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
来迎合一些通过数据驱动的场景。
    staticPrefix: string = '//vr-image-4.realsee-cdn.cn'

    Methods

    • Parameters

      • url: string

      Returns string

      获取静态资源的url

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

      Parameters

      • wrapper: Element

        Element元素

      Returns void

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

      Parameters

      Returns void

    • 插件进行销毁

      Returns void

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

      Returns void

    • 隐藏UI

      Parameters

      Returns void | Promise<void>

    • 加载插件依赖数据

      Returns Promise<void>

    • 展示UI

      Parameters

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods