forked from alibaba/lowcode-engine
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathprops.ts
More file actions
89 lines (75 loc) · 2.28 KB
/
props.ts
File metadata and controls
89 lines (75 loc) · 2.28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
import { IPublicTypeCompositeValue } from '../type';
import { IPublicModelNode, IPublicModelProp } from './';
export interface IBaseModelProps<
Prop
> {
/**
* id
*/
get id(): string;
/**
* 返回当前 props 的路径
* return path of current props
*/
get path(): string[];
/**
* 返回所属的 node 实例
*/
get node(): IPublicModelNode | null;
/**
* 获取指定 path 的属性模型实例
* get prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
*/
getProp(path: string): Prop | null;
/**
* 获取指定 path 的属性模型实例值
* get value of prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
*/
getPropValue(path: string): any;
/**
* 获取指定 path 的属性模型实例，
* 注：导出时，不同于普通属性，该属性并不挂载在 props 之下，而是与 props 同级
* get extra prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
*/
getExtraProp(path: string): Prop | null;
/**
* 获取指定 path 的属性模型实例值
* 注：导出时，不同于普通属性，该属性并不挂载在 props 之下，而是与 props 同级
* get value of extra prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
*/
getExtraPropValue(path: string): any;
/**
* 设置指定 path 的属性模型实例值
* set value of prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
* @param value 值
*/
setPropValue(path: string, value: IPublicTypeCompositeValue): void;
/**
* 设置指定 path 的属性模型实例值
* set value of extra prop by path
* @param path 属性路径，支持 a / a.b / a.0 等格式
* @param value 值
*/
setExtraPropValue(path: string, value: IPublicTypeCompositeValue): void;
/**
* 当前 props 是否包含某 prop
* check if the specified key is existing or not.
* @param key
* @since v1.1.0
*/
has(key: string): boolean;
/**
* 添加一个 prop
* add a key with given value
* @param value
* @param key
* @since v1.1.0
*/
add(value: IPublicTypeCompositeValue, key?: string | number | undefined): any;
}
export interface IPublicModelProps extends IBaseModelProps<IPublicModelProp> {};