Class: guide_manage
index / guide_manage
Class: guide_manage
引导管理器
Remarks
支持多实例
支持任意步骤的(插入/删除)
支持(暂停/完成)引导
支持任意步骤跳转后的状态还原(操作单元)
引导步骤脚本分离，支持组件式挂载
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new guide_manage(init_)
Parameters
| Name | Type |
|---|---|
init_ | init_config |
Defined in
assets/@framework/guide/mk_guide_manage.ts:23
Properties
event
• event: event_target<event_protocol>
事件
Defined in
assets/@framework/guide/mk_guide_manage.ts:35
step_map
• step_map: Map<number, guide_step_base<any>>
步骤表
Defined in
assets/@framework/guide/mk_guide_manage.ts:37
Accessors
pause_b
• get pause_b(): boolean
暂停状态
Returns
boolean
Defined in
assets/@framework/guide/mk_guide_manage.ts:39
• set pause_b(value_b_): void
Parameters
| Name | Type |
|---|---|
value_b_ | boolean |
Returns
void
Defined in
assets/@framework/guide/mk_guide_manage.ts:43
finish_b
• get finish_b(): boolean
完成状态
Returns
boolean
Defined in
assets/@framework/guide/mk_guide_manage.ts:48
end_step_n
• get end_step_n(): number
结束步骤
Returns
number
Defined in
assets/@framework/guide/mk_guide_manage.ts:53
Methods
regis
▸ regis(step_): void
注册步骤
Parameters
| Name | Type | Description |
|---|---|---|
step_ | guide_step_base<any> | guide_step_base<any>[] | 步骤实例 |
Returns
void
Defined in
assets/@framework/guide/mk_guide_manage.ts:77
run
▸ run(): Promise<void>
运行引导
Returns
Promise<void>
Remarks
自动取消暂停状态，且更新当前步骤视图
Defined in
assets/@framework/guide/mk_guide_manage.ts:94
set_step
▸ set_step(step_n_, init_data_?): Promise<void>
设置当前步骤
Parameters
| Name | Type | Description |
|---|---|---|
step_n_ | number | 步骤 |
init_data_? | any | 初始化数据 |
Returns
Promise<void>
Remarks
暂停状态：更新步骤数据
正常状态：更新步骤数据，执行步骤生命周期
Defined in
assets/@framework/guide/mk_guide_manage.ts:212
get_step
▸ get_step(): number
获取步骤
Returns
number
Defined in
assets/@framework/guide/mk_guide_manage.ts:254
finish
▸ finish(): void
完成引导
Returns
void