@@ -13,46 +13,148 @@ sidebar_position: 4
1313### id
1414
1515id
16+
17+ ` @type {string} `
18+
19+
1620### path
1721
1822返回当前 props 的路径
23+
24+ ` @type {string[]} `
25+
26+
1927### node
2028
2129返回当前属性集所属的节点实例
2230
31+ ` @type {IPublicModelNode | null} `
32+
33+ 相关类型:[ IPublicModelNode] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts )
34+
2335## 方法签名
2436### getProp
2537
26- getProp(path: string): Prop | null
27-
2838获取指定 path 的属性模型实例
2939
30- ### getPropValue
40+ ``` typescript
41+ /**
42+ * 获取指定 path 的属性模型实例
43+ * get prop by path
44+ * @param path 属性路径,支持 a / a.b / a.0 等格式
45+ */
46+ getProp (path : string ): IPublicModelProp | null ;
47+ ```
48+
49+ 相关类型:[ IPublicModelProp] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/prop.ts )
3150
32- getPropValue(path: string)
51+ ### getPropValue
3352
3453获取指定 path 的属性模型实例值
3554
36- ### getExtraProp
55+ ``` typescript
56+ /**
57+ * 获取指定 path 的属性模型实例值
58+ * get value of prop by path
59+ * @param path 属性路径,支持 a / a.b / a.0 等格式
60+ */
61+ getPropValue (path : string ): any ;
62+ ```
3763
38- getExtraProp(path: string): Prop | null
64+ ### getExtraProp
3965
4066获取指定 path 的属性模型实例,注:导出时,不同于普通属性,该属性并不挂载在 props 之下,而是与 props 同级
4167
42- ### getExtraPropValue
68+ ``` typescript
69+ /**
70+ * 获取指定 path 的属性模型实例,
71+ * 注:导出时,不同于普通属性,该属性并不挂载在 props 之下,而是与 props 同级
72+ * get extra prop by path
73+ * @param path 属性路径,支持 a / a.b / a.0 等格式
74+ */
75+ getExtraProp (path : string ): IPublicModelProp | null ;
76+ ```
4377
44- getExtraPropValue(path: string)
78+ 相关类型:[ IPublicModelProp] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/prop.ts )
79+
80+ ### getExtraPropValue
4581
4682获取指定 path 的属性模型实例值,注:导出时,不同于普通属性,该属性并不挂载在 props 之下,而是与 props 同级
4783
48- ### setPropValue
84+ ``` typescript
85+ /**
86+ * 获取指定 path 的属性模型实例值
87+ * 注:导出时,不同于普通属性,该属性并不挂载在 props 之下,而是与 props 同级
88+ * get value of extra prop by path
89+ * @param path 属性路径,支持 a / a.b / a.0 等格式
90+ */
91+ getExtraPropValue (path : string ): any ;
92+ ```
4993
50- setPropValue(path: string, value: CompositeValue)
94+ ### setPropValue
5195
5296设置指定 path 的属性模型实例值
5397
98+ ``` typescript
99+ /**
100+ * 设置指定 path 的属性模型实例值
101+ * set value of prop by path
102+ * @param path 属性路径,支持 a / a.b / a.0 等格式
103+ * @param value 值
104+ */
105+ setPropValue (path : string , value : IPublicTypeCompositeValue ): void ;
106+ ```
107+
108+ 相关类型:[ IPublicTypeCompositeValue] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/composite-value.ts )
109+
54110### setExtraPropValue
55111
56- setExtraPropValue(path: string, value: CompositeValue)
112+ 设置指定 path 的属性模型实例值
113+
114+ ``` typescript
115+ /**
116+ * 设置指定 path 的属性模型实例值
117+ * set value of extra prop by path
118+ * @param path 属性路径,支持 a / a.b / a.0 等格式
119+ * @param value 值
120+ */
121+ setExtraPropValue (path : string , value : IPublicTypeCompositeValue ): void ;
122+ ```
123+
124+ 相关类型:[ IPublicTypeCompositeValue] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/composite-value.ts )
125+
126+
127+ ### has
128+
129+ 当前 props 是否包含某 prop
130+
131+ ``` typescript
132+ /**
133+ * 当前 props 是否包含某 prop
134+ * check if the specified key is existing or not.
135+ * @param key
136+ * @since v1.1.0
137+ */
138+ has (key : string ): boolean ;
139+ ```
140+
141+ ** @since v1.1.0**
142+
143+ ### add
144+
145+ 添加一个 prop
146+
147+ ``` typescript
148+ /**
149+ * 添加一个 prop
150+ * add a key with given value
151+ * @param value
152+ * @param key
153+ * @since v1.1.0
154+ */
155+ add (value : IPublicTypeCompositeValue , key ?: string | number | undefined ): any ;
156+ ```
157+
158+ 相关类型:[ IPublicTypeCompositeValue] ( https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/composite-value.ts )
57159
58- 设置指定 path 的属性模型实例值
160+ ** @ since v1.1.0 **
0 commit comments