Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EntityProperty

实体属性类

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly $ref

$ref: string = ...

数据类型

Readonly $refId

$refId: string = ...

数据结构Id

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 createdBy

createdBy: string = ...

创建人

Readonly createdTime

createdTime: string = ...

创建时间

Readonly defaultValue

defaultValue: string | number | boolean = ...

默认值

Readonly description

description: string = ...

描述

Readonly display

display: Display = ...

UI 展示

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑 前端 UI 状态

Readonly entityId

entityId: string = ...

父级 Id

existingNames

existingNames: string[] = ...

周边存在的名称

expanded

expanded: boolean = false

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

Readonly format

format: string = ...

数据格式

Readonly id

id: string = ...

Id

Readonly ideVersion

ideVersion: string = ...

IDE 版本

isLeaf

isLeaf: boolean = true

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

Readonly label

label: string = ...

标题

level

level: LEVEL_ENUM = ...

概念类型

loading

loading: boolean = false

是否正在请求 前端 UI 状态

Readonly name

name: string = ...

名称

Readonly relationship

relationship: string = ...

引用关系（多对一、一对多等）

Readonly required

required: boolean = ...

是否必须

root

root: Entity = ...

父级引用

Readonly rules

rules: string[] = ...

规则

Readonly type

type: string = ...

type

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Methods

addEntityInterfaceParams

  • 添加接口逻辑相关参数

    Parameters

    Returns Promise<void[]>

assign

  • assign(source: any): void

  • Parameters

    • source: any

    Returns void

create

  • 添加实体属性

    Returns Promise<EntityProperty>

deepPick

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

  • 从对象中深度获取

    example

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

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

    Parameters

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

    Returns void

delete

  • delete(): Promise<void>

  • 删除实体属性

    Returns Promise<void>

emit

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

  • 触发事件

    Parameters

    • eventName: string

      事件名

    • Rest ...args: any[]

      事件参数

    Returns void

emitVertexIdToNameChange

  • emitVertexIdToNameChange(): void

findUsage

  • findUsage(): Promise<any>

  • 查找引用

    Returns Promise<any>

getSchemaUsage

  • getSchemaUsage(): Promise<any>

  • 查找schema 顶点被引用的逻辑顶点列表

    Returns Promise<any>

moveDown

  • moveDown(): Promise<void>

  • 属性下移

    Returns Promise<void>

moveTo

  • moveTo(index: number, oldIndex?: number): Promise<void>

  • 移动位置

    Parameters

    • index: number

      目标位置

    • Optional oldIndex: number

    Returns Promise<void>

moveUp

  • moveUp(): Promise<void>

  • 上移实体属性

    Returns Promise<void>

off

  • 取消监听事件

    Parameters

    Returns void

on

  • 监听事件

    Parameters

    Returns void

once

  • 只监听一次事件

    Parameters

    Returns void

pick

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

  • Parameters

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

    Returns void

plainAssign

  • plainAssign(source: any): void

  • Parameters

    • source: any

    Returns void

removeEntityInterfaceParams

  • Parameters

    Returns Promise<any[]>

setDataType

  • setDataType($ref: string): Promise<void>

  • 设置实体属性的数据类型

    Parameters

    • $ref: string

    Returns Promise<void>

setDefaultValue

  • setDefaultValue(defaultValue: string): Promise<void>

  • 设置实体属性的默认值

    Parameters

    • defaultValue: string

    Returns Promise<void>

setDescription

  • setDescription(description: string): Promise<void>

  • 设置实体属性描述

    Parameters

    • description: string

      描述

    Returns Promise<void>

setDisplay

  • setDisplay(display: Display): Promise<void>

  • Parameters

    Returns Promise<void>

setLabel

  • setLabel(label: string): Promise<void>

  • 设置实体属性标题

    Parameters

    • label: string

      标题

    Returns Promise<void>

setName

  • setName(name: string): Promise<void>

  • 设置实体属性名称

    Parameters

    • name: string

      名称

    Returns Promise<void>

setRelationship

  • setRelationship(relationship: string): Promise<void>

  • 设置实体属性关系

    Parameters

    • relationship: string

    Returns Promise<void>

setRequired

  • setRequired(required: boolean): Promise<void>

  • 设置实体属性是否必须

    Parameters

    • required: boolean

      必须

    Returns Promise<void>

setRules

  • setRules(rules: any): Promise<void>

  • Parameters

    • rules: any

    Returns Promise<void>

toJSON

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

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

    Parameters

    • Optional parentKey: string

      外面的 key

    • excludedKeys: string[] = ...

      需要额外排除的 keys

    Returns any

toPlainJSON

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

  • 转为单层的 JSON

    Parameters

    • Optional parentKey: string

      外面的 key

    • excludedKeys: string[] = ...

      需要额外排除的 keys

    Returns any

update

  • 修改实体属性

    Returns Promise<EntityProperty>

updateLogicParamsForName

  • 只更改Entity Property的名称

    Parameters

    Returns Promise<void>

Static getVertexByRef

  • getVertexByRef(ref: string): Vertex

  • 通过 Ref 去查找点

    Parameters

    • ref: string

    Returns Vertex

Generated using TypeDoc