Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EntityProperty

实体字段

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

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

_mutable

_mutable: boolean = true

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

branchName

branchName: string = undefined

分支名称

changedTime

changedTime: number = undefined

变动时间

columnName

columnName: string = undefined

数据库列名

concept

concept: "EntityProperty" = 'EntityProperty'

产品概念

dataTreeNodeHidden

dataTreeNodeHidden: boolean = false

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

defaultValue

defaultValue: string = undefined

默认值

deletable

deletable: boolean = undefined

是否可删除

deleteRule

deleteRule: "protect" | "cascade" = undefined

删除关联属性记录时

description

description: string = undefined

实体字段描述

display

display: {} = ...

显示方式

Type declaration

  • [name: string]: boolean

editable

editable: boolean = undefined

是否正在编辑 前端 UI 状态

editing

editing: boolean = false

是否正在编辑 前端 UI 状态

expanded

expanded: boolean = false

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

generationRule

generationRule: "auto" | "autoIncrement" | "manual" = 'auto'

生成规则

hidden

hidden: boolean = false

节点是否显示 前端 UI 状态

id

id: string = ...

唯一 Id

isLeaf

isLeaf: boolean = false

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

label

label: string = undefined

实体字段标题

loading

loading: boolean = false

是否正在请求 前端 UI 状态

logicTreeNodeExpanded

logicTreeNodeExpanded: boolean = false

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

logicTreeNodeHidden

logicTreeNodeHidden: boolean = false

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

name

name: string = undefined

实体字段名称

pageTreeNodeHidden

pageTreeNodeHidden: boolean = false

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

parentNode

parentNode: BaseNode = null

父节点

primaryKey

primaryKey: boolean = undefined

当前字段是否为主键

relationEntity

relationEntity: string = undefined

关联实体

relationNamespace

relationNamespace: string = undefined

关联实体的命名空间

relationProperty

relationProperty: string = undefined

关联属性

removable

removable: boolean = undefined

是否可以删除 前端 UI 状态

required

required: boolean = undefined

是否必填

rules

rules: string[] = []

验证规则

sequence

sequence: string = undefined

表示 Oracle 主键自增时的序列名称

sourceMap

sourceMap: SourceMap = undefined

用于挂 embeddedTS 的 sourceMap

tsErrorDetail

tsErrorDetail: Diagnostic = undefined

当前节点上报错详细信息

typeAnnotation

typeAnnotation: TypeAnnotation = undefined

类型

Accessors

app

  • 祖先 App

    Returns App

entity

module

nodeReadonly

  • get nodeReadonly(): boolean

  • 是否可编辑

    Returns boolean

rootNode

  • 根节点

    Returns BaseNode

upperNode

  • 上层节点

    Returns BaseNode

Methods

activeInside

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

  • 激活 JSON 内部实例

    Parameters

    • source: any
    • Ctor: any
    • parentNode: any
    • parentKey: string

    Returns any

addParamsPrepare

  • addParamsPrepare(): Promise<any>

changeName

  • changeName(newValue: string): Promise<any>

  • 重命名

    Parameters

    • newValue: string

    Returns Promise<any>

changeSort

  • changeSort(arr: any[], index: number, type: changeType): any[]

  • 数组移动位置

    Parameters

    • arr: any[]
    • index: number
    • type: changeType

    Returns any[]

clearReference

  • clearReference(): void

  • 关联属性

    Returns void

create

  • create(parentParams: Params): void

  • 创建节点

    Parameters

    • parentParams: Params

    Returns void

deepPick

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

  • 从对象中深度获取

    example

    比如一般后端返回只是添加了个 id

    this.deepPick(result, ['id'])

    Parameters

    • source: any
    • keys: string[] = []

    Returns void

delete

  • delete(): void

destroy

  • destroy(): void

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

    Returns void

emit

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

  • 触发事件

    Parameters

    • eventName: string

      事件名

    • Optional event: EventPayload
    • Optional target: any

    Returns void

findUsage

  • findUsage(): Promise<any>

genActionListener

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

  • 为存储点生成行为监听器

    Parameters

    • action: string

    Returns (($event: EventPayload) => void)

      • ($event: EventPayload): void

      • Parameters

        • $event: EventPayload

        Returns void

genSources

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

getAncestor

instantiate

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

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

    Parameters

    • source: any
    • parentNode: BaseNode
    • parentKey: string

    Returns any

moveDown

  • moveDown(): void

  • 属性下移

    Returns void

moveUp

  • moveUp(): void

  • 属性上移

    Returns void

off

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

  • 取消监听事件

    Parameters

    • eventName: string

      事件名

    • listener: EventListener

      监听器

    Returns void

on

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

  • 监听事件

    Parameters

    • eventName: string

      事件名

    • listener: EventListener

      监听器

    Returns void

once

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

  • 只监听一次事件

    Parameters

    • eventName: string

      事件名

    • listener: EventListener

      监听器

    Returns void

prepareDelete

  • prepareDelete(): Promise<any>

removeTypeAnnotation

  • removeTypeAnnotation(name: string): void
  • removeTypeAnnotation(typeAnnotation: TypeAnnotation): void

  • 删除类型标注

    Parameters

    • name: string

      类型标注名称

    Returns void

  • 删除类型标注

    Parameters

    Returns void

setColumnName

  • setColumnName(columnName: string): void

  • 设置数据库列名

    Parameters

    • columnName: string

    Returns void

setDataType

  • setDataType(typeAnnotation: TypeAnnotation): void
  • setDataType(typeKey: string): void

  • 设置数据类型

    Parameters

    Returns void

  • 设置数据类型

    Parameters

    • typeKey: string

    Returns void

setDefaultValue

  • setDefaultValue(defaultValue: string): void

  • 设置默认值

    Parameters

    • defaultValue: string

    Returns void

setDescription

  • setDescription(description: string): void

  • 设置实体字段描述

    Parameters

    • description: string

    Returns void

setDisplay

  • setDisplay(display: {}): void

  • 设置是否必填

    Parameters

    • display: {}
      • [name: string]: boolean

    Returns void

setGenerationRule

  • setGenerationRule(generationRule: "auto" | "autoIncrement" | "manual"): void

  • 设置生成规则

    Parameters

    • generationRule: "auto" | "autoIncrement" | "manual"

    Returns void

setLabel

  • setLabel(label: string): void

  • 设置实体字段标题

    Parameters

    • label: string

    Returns void

setName

  • setName(name: string): void

  • 设置实体字段名称

    Parameters

    • name: string

    Returns void

setPrimaryKey

  • setPrimaryKey(primaryKey: boolean): void

  • 设置当前字段是否为主键

    Parameters

    • primaryKey: boolean

    Returns void

setRelationEntity

  • setRelationEntity(relationEntity: string): void

  • 设置关联实体实体名称

    Parameters

    • relationEntity: string

    Returns void

setRelationProperty

  • setRelationProperty(relationProperty: string): void

  • 设置关联实体字段名称

    Parameters

    • relationProperty: string

    Returns void

setRequired

  • setRequired(required: boolean): void

  • 设置是否必填

    Parameters

    • required: boolean

    Returns void

toJSON

  • toJSON(): {}

  • 去除循环依赖，转为纯 JSON

    Returns {}

    toPlainJSON

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

    • 转为单层的 JSON

      Parameters

      • Optional parentKey: string

        外面的 key，提供给 JSON.stringify 使用

      • excludedKeys: string[] = []

        需要额外排除的 keys

      Returns any

    update

    • update(__namedParameters: any): void

    • 更新节点

      Parameters

      • __namedParameters: any

      Returns void