Class MoveController

Readonly VERSION

five

hooks

state

Readonly staticPrefix

workCode

• get workCode(): string

• Returns string

• set workCode(workCode): void

• Parameters

  • workCode: string

  Returns void

absoluteUrl

• absoluteUrl(url): string

• @description: 获取静态资源的url

  Parameters

  • url: string

  Returns string

Optional appendTo

• appendTo(wrapper): void

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

  Parameters

  • wrapper: Element

  Returns void

disable

• disable(options?): void

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

  Description

  Disable

dispose

• dispose(): void

• Returns void

  Description

  Dispose

enable

• enable(options?): void

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

  Description

  Enable

getCurrentState

• getCurrentState(): CruisePluginTypes.PluginState

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

  Returns CruisePluginTypes.PluginState

hide

• hide(options?): Promise<void>

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns Promise<void>

  Description

  Hide guide line

pause

• pause(options?): void

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

  Description

  Pause

play

• play(options?): void

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns void

  Description

  Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing

setState

• setState(state, options?): void

• Parameters

  • state: PartialObjectDeep<CruisePluginTypes.PluginState, {}>

  • Optional options: BaseOptions & Record<string, any>

  Returns void

  Description

  Set state

show

• show(options?): Promise<void>

• Parameters

  • Optional options: {
        userAction?: boolean;
    }

    • Optional userAction?: boolean

  Returns Promise<void>

  Description

  Show guide line