View | @lcap/asl

子页面类，前端路由控制

Hierarchy

Block
- View

Index

Constructors

constructor

Properties

Constructors

constructor

new View(source?: Partial<View>): View

Inherited from Block.constructor
- Defined in page/View.ts:116
Parameters
- Optional source: Partial<View>
  
  需要合并的部分参数
Returns View

Properties

Readonly $def

$def: { lifecycles: Lifecycle[]; logics: Logic[]; params: ViewParam[]; variables: Variable[] } = ...

逻辑相关定义

Type declaration

lifecycles: Lifecycle[]
logics: Logic[]
params: ViewParam[]
variables: Variable[]

Readonly $html

$html: Element

模板 AST

Protected Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

toJSON 时需要去除的键，为了避免出现 CircularJSON

Readonly _cacheTimestamp

_cacheTimestamp: string = ...

前端记录缓存的时间戳

Protected _mutable

_mutable: boolean = true

可修改标志，内部属性标记在构造函数结束后是否可修改

Readonly _uuid

_uuid: string = ...

唯一 uuid 目前主要用于前端 Debug 区分两个实例

Readonly children

children: View[] = ...

子页面

Readonly code

code: string = ...

唯一标识码

contentPromise

contentPromise: Promise<any> = ...

正在请求的 Promise 前端 UI 状态

Readonly createdBy

createdBy: string = ...

创建人

Readonly createdTime

createdTime: string = ...

创建时间

Readonly crumb

crumb: string = ...

面包屑

Readonly definition

definition: string

定义源码

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑前端 UI 状态

expanded

expanded: boolean = false

节点是否为展开状态前端 UI 状态

Readonly first

first: string = ...

是否为默认跳转页

Readonly id

id: string = ...

子页面 Id

Readonly ideVersion

ideVersion: string = ...

IDE 版本

isLeaf

isLeaf: boolean = false

是否为叶子节点前端 UI 状态

Readonly level

level: LEVEL_ENUM = ...

概念类型

loading

loading: boolean = false

是否正在请求前端 UI 状态

Readonly moreChildrenFields

moreChildrenFields: string[] = ...

树组件的子节点字段

Readonly name

name: string = ...

子页面名称

Readonly page

page: Page = ...

所属页面

Readonly parent

parent: View = ...

父级子页面

Readonly parentId

parentId: string = ...

子页面 Id

Readonly path

path: string = ...

前端路径，不带 page 名

Readonly script

script: string = ...

附加的 script

Readonly style

style: string

样式补充最好直接在标签上添加逻辑，这里只是偶尔做额外补充

Readonly tempPath

tempPath: string = ...

前后端路径由于 name 会改的关系，尽量不要用

deprecated

template

template: string

模板源码

Readonly title

title: string = ...

标题

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Methods

Private _onChange

_onChange(): Promise<void>

- Defined in page/View.ts:131
Returns Promise<void>

Private _syncDef

_syncDef($def: { lifecycles: Lifecycle[]; logics: Logic[]; params: ViewParam[]; variables: Variable[] }): void

- Defined in page/View.ts:629
Parameters
- $def: { lifecycles: Lifecycle[]; logics: Logic[]; params: ViewParam[]; variables: Variable[] }
  - lifecycles: Lifecycle[]
  - logics: Logic[]
  - params: ViewParam[]
  - variables: Variable[]
Returns void

addView

addView(view: View): Promise<View>

- Defined in page/View.ts:394
添加子页面

Parameters
- view: View
Returns Promise<View>

assign

assign(source: any): void

Inherited from Block.assign
- Defined in common/Vertex.ts:116
Parameters
- source: any
Returns void

attachNodePath

attachNodePath(): void

- Defined in page/View.ts:213
后续改为根据 id 查找 Element

deprecated

Returns void

create

create(): Promise<View>

- Defined in page/View.ts:261
添加子页面

Returns Promise<View>

deepPick

deepPick(source: any, keys?: string[]): void

Inherited from Block.deepPick
- Defined in common/Vertex.ts:183
从对象中深度获取
example
比如一般后端返回只是添加了个 id
```
this.deepPick(result, ['id'])
```
Parameters
- source: any
- keys: string[] = ...
Returns void

delete

delete(): Promise<void>

- Defined in page/View.ts:287
删除子页面

Returns Promise<void>

emit

emit(eventName: string, ...args: any[]): void

Inherited from Block.emit
- Defined in common/EventEmitter.ts:50
触发事件

Parameters
- eventName: string
  
  事件名
- Rest ...args: any[]
  
  事件参数
Returns void

emitVertexIdToNameChange

emitVertexIdToNameChange(): void

Inherited from Block.emitVertexIdToNameChange
- Defined in common/Vertex.ts:131
Returns void

findElementByAttr

findElementByAttr(name: string, value: string): Element

- Defined in page/View.ts:254
根据属性查找元素

Parameters
- name: string
- value: string
Returns Element

findElementByNodePath

findElementByNodePath(nodePath: string, node?: Element): Element

- Defined in page/View.ts:231
根据路径查找子节点
examples
- findElementByNodePath('', root) 指根节点本身
- findElementByNodePath('/', root) 指根节点本身
- findElementByNodePath('/0', root) 指第0个子节点
- findElementByNodePath('/2/1', root) 指第2个子节点的第1个子节点
Parameters
- nodePath: string
  
  节点路径，/1/2 表示根节点的第1个子节点的第2个子节点
- node: Element = ...
  
  查找的起始节点
Returns Element

findElementByTag

findElementByTag(tag: string): Element

- Defined in page/View.ts:246
根据标签查找元素

Parameters
- tag: string
Returns Element

findUsage

findUsage(): Promise<any>

Inherited from Block.findUsage
- Defined in common/Vertex.ts:242
查找引用

Returns Promise<any>

isContentLoaded

isContentLoaded(): boolean

- Defined in page/View.ts:206
Returns boolean

load

load(): Promise<any>

- Defined in page/View.ts:152
在 mergeBlock 的情况下使用在 loadDetail 的情况下使用

Returns Promise<any>

loadAll

loadAll(): Promise<any>

- Defined in page/View.ts:184
Returns Promise<any>

mergeBlock

mergeBlock(code: string, nodePath: string, position: string, parentNodePath: string): Promise<void>

- Defined in page/View.ts:484
合并代码

Parameters
- code: string
- nodePath: string
- position: string
- parentNodePath: string
Returns Promise<void>

off

off(eventName: string, listener: EventListener): void

Inherited from Block.off
- Defined in common/EventEmitter.ts:26
取消监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

on

on(eventName: string, listener: EventListener): void

Inherited from Block.on
- Defined in common/EventEmitter.ts:13
监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

once

once(eventName: string, listener: EventListener): void

Inherited from Block.once
- Defined in common/EventEmitter.ts:38
只监听一次事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

parseAll

parseAll(): void

Inherited from Block.parseAll
- Defined in page/Block.ts:93
Returns void

parseDefinition

parseDefinition(definition?: string): void

Inherited from Block.parseDefinition
- Defined in page/Block.ts:87
Parameters
- definition: string = ...
Returns void

parseTemplate

parseTemplate(template?: string): void

Inherited from Block.parseTemplate
- Defined in page/Block.ts:81
从模板解析出 AST

Parameters
- Optional template: string
  
  模板代码
Returns void

pick

pick(source: any, keys?: string[]): void

Inherited from Block.pick
- Defined in common/Vertex.ts:162
Parameters
- source: any
- keys: string[] = ...
Returns void

plainAssign

plainAssign(source: any): void

Inherited from Block.plainAssign
- Defined in common/Vertex.ts:143
Parameters
- source: any
Returns void

setAsFirst

setAsFirst(): Promise<void>

- Defined in page/View.ts:379
设置该子页面为默认跳转页

Returns Promise<void>

setCrumb

setCrumb(crumb: string): Promise<void>

- Defined in page/View.ts:366
设置子页面面包屑

Parameters
- crumb: string
  
  面包屑
Returns Promise<void>

setName

setName(name: string): Promise<void>

- Defined in page/View.ts:321
设置子页面名称如果为顶级子页面，会同时设置 Page 的属性

Parameters
- name: string
  
  名称
Returns Promise<void>

setTitle

setTitle(title: string): Promise<void>

- Defined in page/View.ts:348
设置子页面标题如果为顶级子页面，会同时设置 Page 的属性

Parameters
- title: string
  
  标题
Returns Promise<void>

toDesignerVue

toDesignerVue(options?: ElementToVueOptions): string

- Defined in page/View.ts:459
转换成设计器中使用的 Vue 文件

Parameters
- Optional options: ElementToVueOptions
Returns string

toJSON

toJSON(parentKey?: string, excludedKeys?: string[]): any

Inherited from Block.toJSON
- Defined in common/Vertex.ts:209
去除循环依赖，转为纯 JSON

Parameters
- Optional parentKey: string
  
  外面的 key
- excludedKeys: string[] = ...
  
  需要额外排除的 keys
Returns any

toPlainJSON

toPlainJSON(parentKey?: string, excludedKeys?: string[]): any

Inherited from Block.toPlainJSON
- Defined in common/Vertex.ts:225
转为单层的 JSON

Parameters
- Optional parentKey: string
  
  外面的 key
- excludedKeys: string[] = ...
  
  需要额外排除的 keys
Returns any

toScript

toScript(options?: ElementToVueOptions): string

- Defined in page/View.ts:409
转换成 Vue 中需要的 JS 代码

todo

这一版先做成 componentOptions 式的，后面再美化

Parameters
- Optional options: ElementToVueOptions
Returns string

toVue

toVue(options?: ElementToVueOptions): string

- Defined in page/View.ts:445
转换成 Vue 文件

Parameters
- Optional options: ElementToVueOptions
Returns string

toVueOptions

toVueOptions(options?: ElementToVueOptions): { script: string; template: string }

- Defined in page/View.ts:473
转换成 VueOptions

todo

后面 template 可以优化成 render 函数

Parameters
- Optional options: ElementToVueOptions
Returns { script: string; template: string }
- script: string
- template: string

update

update(): Promise<View>

- Defined in page/View.ts:306
修改子页面

Returns Promise<View>

Static from

from(source: any, parent: View, page: Page, currentView?: View): View

- Defined in page/View.ts:651
从后端 JSON 生成规范的 View 对象

Parameters
- source: any
- parent: View
- page: Page
- Optional currentView: View
  
  方便构建子对象时关联，主要在 load 中使用
Returns View

Static fromTemplate

fromTemplate(templateName: string, source: any, parent: View, page: Page): Promise<View>

- Defined in page/View.ts:679
按照模板创建

Parameters
- templateName: string
- source: any
- parent: View
- page: Page
Returns Promise<View>

Static getVertexByRef

getVertexByRef(ref: string): Vertex

Inherited from Block.getVertexByRef
- Defined in common/Vertex.ts:256
通过 Ref 去查找点

Parameters
- ref: string
Returns Vertex

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional source: Partial<View>

Returns View

Properties

Readonly $def

Type declaration

lifecycles: Lifecycle[]

logics: Logic[]

params: ViewParam[]

variables: Variable[]

Readonly $html

Protected Readonly JSON_EXCLUDED_KEYS

Readonly _cacheTimestamp

Protected _mutable

Readonly _uuid

Readonly children

Readonly code

contentPromise

Readonly createdBy

Readonly createdTime

Readonly crumb

Readonly definition

editable

editing

expanded

Readonly first

Readonly id

Readonly ideVersion

isLeaf

Readonly level

loading

Readonly moreChildrenFields

Readonly name

Readonly page

Readonly parent

Readonly parentId

Readonly path

Readonly script

Readonly style

Readonly tempPath

template

Readonly title

Readonly updatedBy

Readonly updatedTime

Methods

Private _onChange

Returns Promise<void>

Private _syncDef

Parameters

$def: { lifecycles: Lifecycle[]; logics: Logic[]; params: ViewParam[]; variables: Variable[] }

lifecycles: Lifecycle[]

logics: Logic[]

params: ViewParam[]

variables: Variable[]

Returns void

addView

Parameters

view: View

Returns Promise<View>

assign

Parameters

source: any

Returns void

attachNodePath

Returns void

create

Returns Promise<View>

deepPick

Parameters

source: any

keys: string[] = ...

Returns void

delete