ProcessElement | @lcap/nasl

流程元素

Hierarchy

BaseNode
- ProcessElement

Index

Constructors

constructor

Accessors

Constructors

constructor

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

Overrides BaseNode.constructor
Parameters
- Optional source: Partial<ProcessElement>
  
  需要合并的部分参数
Returns ProcessElement

Properties

Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

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

_mutable

_mutable: boolean = true

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

bindAttrs

bindAttrs: BindAttribute[] = []

元素绑定属性列表

bounds

bounds: Rect = undefined

矩形信息

branchName

branchName: string = undefined

分支名称

changedTime

changedTime: number = undefined

变动时间

concept

concept: "ProcessElement" = 'ProcessElement'

产品概念

constants

constants: Constant[] = []

常量列表

dataTreeNodeHidden

dataTreeNodeHidden: boolean = false

数据树节点是否显示前端 UI 状态

description

description: string = undefined

流程元素描述

editable

editable: boolean = undefined

是否正在编辑前端 UI 状态

editing

editing: boolean = false

是否正在编辑前端 UI 状态

expanded

expanded: boolean = false

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

flowValue

flowValue: string = undefined

flowValue

hidden

hidden: boolean = false

节点是否显示前端 UI 状态

id

id: string = ...

唯一 Id

isLeaf

isLeaf: boolean = false

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

loading

loading: boolean = false

是否正在请求前端 UI 状态

logic

logic: Logic = undefined

逻辑

logicTreeNodeExpanded

logicTreeNodeExpanded: boolean = false

数据树节点是否展开前端 UI 状态

logicTreeNodeHidden

logicTreeNodeHidden: boolean = false

逻辑树节点是否显示前端 UI 状态

name

name: string = undefined

流程元素名称

pageTreeNodeHidden

pageTreeNodeHidden: boolean = false

页面树节点是否显示前端 UI 状态

parentNode

parentNode: BaseNode = null

父节点

removable

removable: boolean = undefined

是否可以删除前端 UI 状态

returns

returns: Return[] = []

输出参数列表

sourceMap

sourceMap: SourceMap = undefined

用于挂 embeddedTS 的 sourceMap

sourceRef

sourceRef: string = undefined

sourceRef

targetRef

targetRef: string = undefined

targetRef

title

title: string = undefined

流程元素标题

tsErrorDetail

tsErrorDetail: Diagnostic = undefined

当前节点上报错详细信息

type

type: string = undefined

type

variables

variables: Variable[] = []

局部变量列表

waypoints

waypoints: Point[] = []

点信息列表

Accessors

app

get app(): App

祖先 App

Returns App

module

get module(): Module

祖先 Module

Returns Module

process

get process(): Process

祖先 Process

Returns Process

rootNode

get rootNode(): BaseNode

Inherited from BaseNode.rootNode

根节点

Returns BaseNode

upperNode

get upperNode(): BaseNode

Inherited from BaseNode.upperNode

上层节点

Returns BaseNode

Methods

activeInside

activeInside(source: any, Ctor: any, parentNode: any, parentKey: string): any

Inherited from BaseNode.activeInside

激活 JSON 内部实例

Parameters
- source: any
- Ctor: any
- parentNode: any
- parentKey: string
Returns any

addBindAttribute

addBindAttribute(bindAttributeOptions: Partial<BindAttribute>): BindAttribute
addBindAttribute(bindAttribute: BindAttribute): BindAttribute

添加元素绑定属性

Parameters
- bindAttributeOptions: Partial<BindAttribute>
  
  元素绑定属性参数
Returns BindAttribute
添加元素绑定属性

Parameters
- bindAttribute: BindAttribute
  
  已有的元素绑定属性实例
Returns BindAttribute

addConstant

addConstant(constantOptions: Partial<Constant>): Constant
addConstant(constant: Constant): Constant

添加常量

Parameters
- constantOptions: Partial<Constant>
  
  常量参数
Returns Constant
添加常量

Parameters
- constant: Constant
  
  已有的常量实例
Returns Constant

addParamsPrepare

addParamsPrepare(): Promise<any>

Inherited from BaseNode.addParamsPrepare

添加参数准备

Returns Promise<any>

addPoint

addPoint(pointOptions: Partial<Point>): Point
addPoint(point: Point): Point

添加点信息

Parameters
- pointOptions: Partial<Point>
  
  点信息参数
Returns Point
添加点信息

Parameters
- point: Point
  
  已有的点信息实例
Returns Point

addReturn

addReturn(retOptions: Partial<Return>): Return
addReturn(ret: Return): Return

添加输出参数

Parameters
- retOptions: Partial<Return>
  
  输出参数参数
Returns Return
添加输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
Returns Return

addVariable

addVariable(variableOptions: Partial<Variable>): Variable
addVariable(variable: Variable): Variable

添加局部变量

Parameters
- variableOptions: Partial<Variable>
  
  局部变量参数
Returns Variable
添加局部变量

Parameters
- variable: Variable
  
  已有的局部变量实例
Returns Variable

changeName

changeName(newValue: string): Promise<any>

Inherited from BaseNode.changeName

重命名

Parameters
- newValue: string
Returns Promise<any>

create

create(parentParams: Params): void

Inherited from BaseNode.create

创建节点

Parameters
- parentParams: Params
Returns void

deepPick

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

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

delete

delete(): void

Inherited from BaseNode.delete

删除节点

Returns void

destroy

destroy(): void

Inherited from BaseNode.destroy

销毁从 Map 中删除点和子节点

Returns void

emit

emit(eventName: string, event?: EventPayload, target?: any): void

Inherited from BaseNode.emit

触发事件

Parameters
- eventName: string
  
  事件名
- Optional event: EventPayload
- Optional target: any
Returns void

findUsage

findUsage(): Promise<any>

Inherited from BaseNode.findUsage

查找引用

Returns Promise<any>

genActionListener

genActionListener(action: string): (($event: EventPayload) => void)

Inherited from BaseNode.genActionListener

为存储点生成行为监听器

Parameters
- action: string
Returns (($event: EventPayload) => void)
- - ($event: EventPayload): void
  - Parameters
    - $event: EventPayload
    Returns void

genSources

genSources(instance: BaseNode, filerFn?: ((source: Partial<BaseNode>) => {})): {}

Inherited from BaseNode.genSources

生成json

Parameters
- instance: BaseNode
- Optional filerFn: ((source: Partial<BaseNode>) => {})
  - - (source: Partial<BaseNode>): {}
    - Parameters
      - source: Partial<BaseNode>
      Returns {}
Returns {}

getAncestor

getAncestor(concept: string): BaseNode

Inherited from BaseNode.getAncestor

获取祖先节点

Parameters
- concept: string
Returns BaseNode

insertBindAttributeAt

insertBindAttributeAt(name: string, index: number): BindAttribute
insertBindAttributeAt(bindAttributeOptions: Partial<BindAttribute>, index: number): BindAttribute
insertBindAttributeAt(bindAttribute: BindAttribute, index: number): BindAttribute

插入元素绑定属性

Parameters
- name: string
  
  元素绑定属性名称，如果不填会自动生成一个唯一名称
- index: number
Returns BindAttribute
插入元素绑定属性

Parameters
- bindAttributeOptions: Partial<BindAttribute>
  
  元素绑定属性参数
- index: number
Returns BindAttribute
插入元素绑定属性

Parameters
- bindAttribute: BindAttribute
  
  已有的元素绑定属性实例
- index: number
Returns BindAttribute

insertConstantAt

insertConstantAt(name: string, index: number): Constant
insertConstantAt(constantOptions: Partial<Constant>, index: number): Constant
insertConstantAt(constant: Constant, index: number): Constant

插入常量

Parameters
- name: string
  
  常量名称，如果不填会自动生成一个唯一名称
- index: number
Returns Constant
插入常量

Parameters
- constantOptions: Partial<Constant>
  
  常量参数
- index: number
Returns Constant
插入常量

Parameters
- constant: Constant
  
  已有的常量实例
- index: number
Returns Constant

insertPointAt

insertPointAt(name: string, index: number): Point
insertPointAt(pointOptions: Partial<Point>, index: number): Point
insertPointAt(point: Point, index: number): Point

插入点信息

Parameters
- name: string
  
  点信息名称，如果不填会自动生成一个唯一名称
- index: number
Returns Point
插入点信息

Parameters
- pointOptions: Partial<Point>
  
  点信息参数
- index: number
Returns Point
插入点信息

Parameters
- point: Point
  
  已有的点信息实例
- index: number
Returns Point

insertReturnAt

insertReturnAt(name: string, index: number): Return
insertReturnAt(retOptions: Partial<Return>, index: number): Return
insertReturnAt(ret: Return, index: number): Return

插入输出参数

Parameters
- name: string
  
  输出参数名称，如果不填会自动生成一个唯一名称
- index: number
Returns Return
插入输出参数

Parameters
- retOptions: Partial<Return>
  
  输出参数参数
- index: number
Returns Return
插入输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
- index: number
Returns Return

insertVariableAt

insertVariableAt(name: string, index: number): Variable
insertVariableAt(variableOptions: Partial<Variable>, index: number): Variable
insertVariableAt(variable: Variable, index: number): Variable

插入局部变量

Parameters
- name: string
  
  局部变量名称，如果不填会自动生成一个唯一名称
- index: number
Returns Variable
插入局部变量

Parameters
- variableOptions: Partial<Variable>
  
  局部变量参数
- index: number
Returns Variable
插入局部变量

Parameters
- variable: Variable
  
  已有的局部变量实例
- index: number
Returns Variable

instantiate

instantiate(source: any, parentNode: BaseNode, parentKey: string): any

Inherited from BaseNode.instantiate

实例化一个 JSON 由于有 from，只能先实例化父级，再实例化子级

Parameters
- source: any
- parentNode: BaseNode
- parentKey: string
Returns any

off

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

Inherited from BaseNode.off

取消监听事件

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

on

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

Inherited from BaseNode.on

监听事件

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

once

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

Inherited from BaseNode.once

只监听一次事件

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

prepareDelete

prepareDelete(): Promise<any>

Inherited from BaseNode.prepareDelete

准备删除

Returns Promise<any>

removeBindAttribute

removeBindAttribute(name: string): void
removeBindAttribute(bindAttribute: BindAttribute): void

删除元素绑定属性

Parameters
- name: string
  
  元素绑定属性名称
Returns void
删除元素绑定属性

Parameters
- bindAttribute: BindAttribute
  
  已有的元素绑定属性实例
Returns void

removeBounds

removeBounds(name: string): void
removeBounds(bounds: Rect): void

删除矩形信息

Parameters
- name: string
  
  矩形信息名称
Returns void
删除矩形信息

Parameters
- bounds: Rect
  
  已有的矩形信息实例
Returns void

removeConstant

removeConstant(name: string): void
removeConstant(constant: Constant): void

删除常量

Parameters
- name: string
  
  常量名称
Returns void
删除常量

Parameters
- constant: Constant
  
  已有的常量实例
Returns void

removeLogic

removeLogic(name: string): void
removeLogic(logic: Logic): void

删除逻辑

Parameters
- name: string
  
  逻辑名称
Returns void
删除逻辑

Parameters
- logic: Logic
  
  已有的逻辑实例
Returns void

removePoint

removePoint(name: string): void
removePoint(point: Point): void

删除点信息

Parameters
- name: string
  
  点信息名称
Returns void
删除点信息

Parameters
- point: Point
  
  已有的点信息实例
Returns void

removeReturn

removeReturn(name: string): void
removeReturn(ret: Return): void

删除输出参数

Parameters
- name: string
  
  输出参数名称
Returns void
删除输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
Returns void

removeVariable

removeVariable(name: string): void
removeVariable(variable: Variable): void

删除局部变量

Parameters
- name: string
  
  局部变量名称
Returns void
删除局部变量

Parameters
- variable: Variable
  
  已有的局部变量实例
Returns void

setBounds

setBounds(bounds: Rect): void

设置矩形信息

Parameters
- bounds: Rect
Returns void

setDescription

setDescription(description: string): void

设置流程元素描述

Parameters
- description: string
Returns void

setFlowValue

setFlowValue(flowValue: string): void

设置flowValue

Parameters
- flowValue: string
Returns void

setName

setName(name: string): void

设置流程元素名称

Parameters
- name: string
Returns void

setNameWithFlowChange

setNameWithFlowChange(name: string): void

设置流程元素名称

Parameters
- name: string
Returns void

setSourceRef

setSourceRef(sourceRef: string): void

设置sourceRef

Parameters
- sourceRef: string
Returns void

setTargetRef

setTargetRef(targetRef: string): void

设置targetRef

Parameters
- targetRef: string
Returns void

setTitle

setTitle(title: string): void

设置流程元素标题

Parameters
- title: string
Returns void

toJSON

toJSON(): {}

Inherited from BaseNode.toJSON

去除循环依赖，转为纯 JSON

Returns {}

toPlainJSON

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

Inherited from BaseNode.toPlainJSON

转为单层的 JSON

Parameters
- Optional parentKey: string
  
  外面的 key，提供给 JSON.stringify 使用
- excludedKeys: string[] = []
  
  需要额外排除的 keys
Returns any

update

update(__namedParameters: any): void

Inherited from BaseNode.update

更新节点

Parameters
- __namedParameters: any
Returns void

Static getDefaultOptions

getDefaultOptions(): any

Inherited from BaseNode.getDefaultOptions

获取添加时的默认选项

Returns any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional source: Partial<ProcessElement>

Returns ProcessElement

Properties

Readonly JSON_EXCLUDED_KEYS

_mutable

bindAttrs

bounds

branchName

changedTime

concept

constants

dataTreeNodeHidden

description

editable

editing

expanded

flowValue

hidden

id

isLeaf

loading

logic

logicTreeNodeExpanded

logicTreeNodeHidden

name

pageTreeNodeHidden

parentNode

removable

returns

sourceMap

sourceRef

targetRef

title

tsErrorDetail

type

variables

waypoints

Accessors

app

Returns App

module

Returns Module

process

Returns Process

rootNode

Returns BaseNode

upperNode

Returns BaseNode

Methods

activeInside

Parameters

source: any

Ctor: any

parentNode: any

parentKey: string

Returns any

addBindAttribute

Parameters

bindAttributeOptions: Partial<BindAttribute>

Returns BindAttribute

Parameters

bindAttribute: BindAttribute

Returns BindAttribute

addConstant

Parameters

constantOptions: Partial<Constant>

Returns Constant

Parameters

constant: Constant

Returns Constant

addParamsPrepare