Element | @lcap/asl

前端页面元素

example: <u-input size="small" v-model="value" @change="onChange">

Hierarchy

Vertex
- Element

Index

Constructors

constructor

Properties

Constructors

constructor

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

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

Properties

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 区分两个实例

Optional Readonly attrList

attrList: Attr[] = ...

属性列表和原来的 attrsList 不同，注意区分

Optional Readonly children

children: Element[] = ...

子元素

Readonly createdBy

createdBy: string = ...

创建人

Readonly createdTime

createdTime: string = ...

创建时间

Optional Readonly directiveList

directiveList: Directive[] = ...

指令列表

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑前端 UI 状态

Optional Readonly eventList

eventList: Event[] = ...

事件列表

expanded

expanded: boolean = false

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

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 name

name: string = ...

元素名称用户可以自定义 Vue 中的 ref

nodePath

nodePath: string = ...

当前节点路径，只在前端动态计算后使用

Optional Readonly parent

parent: Element = ...

所在父元素

Readonly parentId

parentId: string = ...

所在父元素 Id

Optional Readonly slotScope

slotScope: string = ...

插槽 scope 表达式

example: 'scope'

Optional Readonly slotTarget

slotTarget: string = ...

插槽目标

example: '"cell"'

Optional Readonly staticClass

staticClass: string = ...

静态 class 名不计划支持动态 class

Optional Readonly staticStyle

staticStyle: string = ...

静态 style 不计划支持动态样式

Readonly tag

tag: string = ...

元素标签

Readonly type

type: number = 0

元素类型去除了 expression 和 text，目前只有一种节点类型

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Optional Readonly view

view: View = ...

所在子页面

Readonly viewId

viewId: string = ...

所在父元素 Id

Methods

addAttr

addAttr(data: Attr): Promise<void>

- Defined in page/Element.ts:265
添加组件属性

Parameters
- data: Attr
Returns Promise<void>

addDirective

addDirective(data: Directive): Promise<void>

- Defined in page/Element.ts:361
添加组件指令

Parameters
- data: Directive
Returns Promise<void>

addEvent

addEvent(data: Event): Promise<Event>

- Defined in page/Element.ts:331
添加组件事件

Parameters
- data: Event
Returns Promise<Event>

assign

assign(source: any): void

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

create

create(): Promise<Element>

- Defined in page/Element.ts:145
添加元素

Returns Promise<Element>

deepPick

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

Inherited from Vertex.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/Element.ts:173
删除元素

Returns Promise<void>

deleteAttr

deleteAttr(attr: Attr): Promise<void>

- Defined in page/Element.ts:277
删除组件属性

Parameters
- attr: Attr
Returns Promise<void>

deleteDirective

deleteDirective(directive: Directive): Promise<void>

- Defined in page/Element.ts:373
删除组件属性

Parameters
- directive: Directive
Returns Promise<void>

deleteEvent

deleteEvent(event: Event): Promise<void>

- Defined in page/Element.ts:346
删除组件属性

Parameters
- event: Event
Returns Promise<void>

duplicate

duplicate(): Promise<void>

- Defined in page/Element.ts:208
添加元素副本在所在父节点的后面添加一个相同的元素

Returns Promise<void>

emit

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

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

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

emitVertexIdToNameChange

emitVertexIdToNameChange(): void

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

findElementByAttr

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

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

Parameters
- name: string
- value: string
Returns Element

findElementByTag

findElementByTag(tag: string): Element

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

Parameters
- tag: string
Returns Element

findUsage

findUsage(): Promise<any>

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

Returns Promise<any>

getAttr

getAttr(name: string): Attr

- Defined in page/Element.ts:290
获取组件属性

Parameters
- name: string
Returns Attr

off

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

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

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

on

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

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

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

once

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

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

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

pick

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

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

plainAssign

plainAssign(source: any): void

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

setAttr

setAttr(name: string, type: "string" | "static" | "dynamic", value?: any): Promise<void>

- Defined in page/Element.ts:297
设置组件属性

Parameters
- name: string
- type: "string" | "static" | "dynamic"
- Optional value: any
Returns Promise<void>

setName

setName(name: string): Promise<void>

- Defined in page/Element.ts:250
设置组件名称

Parameters
- name: string
Returns Promise<void>

toDesignerVue

toDesignerVue(options?: ElementToVueOptions): string

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

Parameters
- Optional options: ElementToVueOptions
Returns string

toHTML

toHTML(options?: ElementToVueOptions): string

- Defined in page/Element.ts:473
同 toVue 方法

Parameters
- Optional options: ElementToVueOptions
  
  缩进等选项
Returns string

toJSON

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

Inherited from Vertex.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 Vertex.toPlainJSON
- Defined in common/Vertex.ts:225
转为单层的 JSON

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

toVue

toVue(options?: ElementToVueOptions): string

- Defined in page/Element.ts:386
转换成 Vue 的模板格式

Parameters
- Optional options: ElementToVueOptions
Returns string

update

update(data?: Element): Promise<Element>

- Defined in page/Element.ts:192
修改元素

Parameters
- Optional data: Element
Returns Promise<Element>

Private Static _fromASTNode

_fromASTNode(astNode: ASTElement, $def: any, dataSchema?: string): Element

- Defined in page/Element.ts:511
从 Vue 的 ASTNode 转换成 ASL 元素

Parameters
- astNode: ASTElement
  
  Vue 的 ASTNode
- $def: any
- Optional dataSchema: string
Returns Element

Private Static _parseExpression

_parseExpression(value: string, $def?: any, dataSchema?: string): LogicItem

- Defined in page/Element.ts:703
Parameters
- value: string
- Optional $def: any
- Optional dataSchema: string
Returns LogicItem

Static from

from(source: any, parent: Element, view: View, currentElement?: Element): Element

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

Parameters
- source: any
- parent: Element
- view: View
- Optional currentElement: Element
Returns Element

Static fromHTML

fromHTML(html: string, parent: Element, view: View): Element

- Defined in page/Element.ts:839
从模板生成规范的 Element 对象

Parameters
- html: string
- parent: Element
- view: View
Returns Element

Static getVertexByRef

getVertexByRef(ref: string): Vertex

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

Parameters
- ref: string
Returns Vertex

Static parse

parse(html: string, $def?: any): Element

- Defined in page/Element.ts:812
解析 Vue 模板该方法不会绑定 view 和 parent，如果是添加元素优先使用 fromHTML

todo

处理多个元素的问题

Parameters
- html: string
  
  Vue 的模板
- Optional $def: any
Returns Element

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional source: Partial<Element>

Returns Element

Properties

Protected Readonly JSON_EXCLUDED_KEYS

Readonly _cacheTimestamp

Protected _mutable

Readonly _uuid

Optional Readonly attrList

Optional Readonly children

Readonly createdBy

Readonly createdTime

Optional Readonly directiveList

editable

editing

Optional Readonly eventList

expanded

Readonly id

Readonly ideVersion

isLeaf

Readonly level

loading

Readonly name

nodePath

Optional Readonly parent

Readonly parentId

Optional Readonly slotScope

Optional Readonly slotTarget

Optional Readonly staticClass

Optional Readonly staticStyle

Readonly tag

Readonly type

Readonly updatedBy

Readonly updatedTime

Optional Readonly view

Readonly viewId

Methods

addAttr

Parameters

data: Attr

Returns Promise<void>

addDirective

Parameters

data: Directive

Returns Promise<void>

addEvent

Parameters

data: Event

Returns Promise<Event>

assign

Parameters

source: any

Returns void

create

Returns Promise<Element>

deepPick

Parameters

source: any

keys: string[] = ...

Returns void

delete

Returns Promise<void>

deleteAttr

Parameters

attr: Attr

Returns Promise<void>

deleteDirective

Parameters

directive: Directive

Returns Promise<void>

deleteEvent

Parameters

event: Event