1# 滚动组件通用接口
2
3滚动组件通用属性和事件目前只支持[List](ts-container-list.md)、[Grid](ts-container-grid.md)、[Scroll](ts-container-scroll.md)和[WaterFlow](ts-container-waterflow.md)组件。
4
5>  **说明：**
6>
7>  本模块从API version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9## 属性
10
11### scrollBar<sup>11+</sup>
12
13scrollBar(barState: BarState): T
14
15设置滚动条状态。
16
17**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
18
19**系统能力：** SystemCapability.ArkUI.ArkUI.Full
20
21**参数：**
22
23| 参数名   | 类型                                      | 必填 | 说明                                   |
24| -------- | ----------------------------------------- | ---- | -------------------------------------- |
25| barState | [BarState](ts-appendix-enums.md#barstate) | 是   | 滚动条状态。<br/>默认值：List、Grid、Scroll组件默认BarState.Auto，WaterFlow组件默认BarState.Off。 |
26
27### scrollBarColor<sup>11+</sup>
28
29scrollBarColor(color: Color | number | string): T
30
31设置滚动条的颜色。
32
33**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
34
35**系统能力：** SystemCapability.ArkUI.ArkUI.Full
36
37**参数：**
38
39| 参数名 | 类型                                                         | 必填 | 说明           |
40| ------ | ------------------------------------------------------------ | ---- | -------------- |
41| color  | string&nbsp;\|&nbsp;number&nbsp;\|&nbsp;[Color](ts-appendix-enums.md#color) | 是   | 滚动条的颜色。<br/>默认值：'\#182431'（40%不透明度）|
42
43### scrollBarWidth<sup>11+</sup>
44
45scrollBarWidth(value: number | string): T
46
47设置滚动条的宽度，不支持百分比设置。宽度设置后，滚动条正常状态和按压状态宽度均为滚动条的宽度值。如果滚动条的宽度超过滚动组件主轴方向的高度，则滚动条的宽度会变为默认值。
48
49**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
50
51**系统能力：** SystemCapability.ArkUI.ArkUI.Full
52
53**参数：**
54
55| 参数名 | 类型                       | 必填 | 说明                                      |
56| ------ | -------------------------- | ---- | ----------------------------------------- |
57| value  | string&nbsp;\|&nbsp;number | 是   | 滚动条的宽度。<br/>默认值：4<br/>单位：vp |
58
59### edgeEffect<sup>11+</sup>
60
61edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T
62
63设置边缘滑动效果。
64
65**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
66
67**系统能力：** SystemCapability.ArkUI.ArkUI.Full
68
69**参数：**
70
71| 参数名                | 类型                                              | 必填 | 说明                                                         |
72| --------------------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
73| edgeEffect            | [EdgeEffect](ts-appendix-enums.md#edgeeffect)     | 是   | 滚动组件的边缘滑动效果，支持弹簧效果和阴影效果。<br/>默认值：Grid、Scroll、WaterFlow组件默认EdgeEffect.None，List组件默认EdgeEffect.Spring。|
74| options | [EdgeEffectOptions](#edgeeffectoptions11对象说明) | 否   | 组件内容大小小于组件自身时，是否开启滑动效果。设置为{ alwaysEnabled: true }会开启滑动效果，{ alwaysEnabled: false }不开启。<br/>默认值：<br/>List、Grid、WaterFlow组件默认{ alwaysEnabled: false }，Scroll组件默认{ alwaysEnabled: true }|
75
76### nestedScroll<sup>11+</sup>
77
78nestedScroll(value: NestedScrollOptions): T
79
80设置向前向后两个方向上的嵌套滚动模式，实现与父组件的滚动联动。
81
82**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
83
84**系统能力：** SystemCapability.ArkUI.ArkUI.Full
85
86**参数：**
87
88| 参数名 | 类型                                                  | 必填 | 说明           |
89| ------ | ----------------------------------------------------- | ---- | -------------- |
90| value  | [NestedScrollOptions](#nestedscrolloptions10对象说明) | 是   | 嵌套滚动选项。|
91
92### enableScrollInteraction<sup>11+</sup>
93
94enableScrollInteraction(value: boolean): T
95
96设置是否支持滚动手势，当设置为false时，无法通过手指或者鼠标滚动，但不影响控制器的滚动接口。
97
98**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
99
100**系统能力：** SystemCapability.ArkUI.ArkUI.Full
101
102**参数：**
103
104| 参数名 | 类型    | 必填 | 说明                                |
105| ------ | ------- | ---- | ----------------------------------- |
106| value  | boolean | 是   | 是否支持滚动手势。<br/>默认值：true |
107
108### friction<sup>11+</sup>
109
110friction(value: number | Resource): T
111
112设置摩擦系数，手动划动滚动区域时生效，只对惯性滚动过程有影响，对惯性滚动过程中的链式效果有间接影响。设置为小于等于0的值时，按默认值处理。
113
114**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
115
116**系统能力：** SystemCapability.ArkUI.ArkUI.Full
117
118**参数：**
119
120| 参数名 | 类型                                                 | 必填 | 说明                                                      |
121| ------ | ---------------------------------------------------- | ---- | --------------------------------------------------------- |
122| value  | number&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 是   | 摩擦系数。<br/>默认值：非可穿戴设备为0.6，可穿戴设备为0.9。<br/>从API version 11开始，非可穿戴设备默认值为0.7。<br/>从API version 12开始，非可穿戴设备默认值为0.75。 |
123
124### flingSpeedLimit<sup>11+</sup>
125
126flingSpeedLimit(speedLimit: number): T
127
128限制跟手滑动结束后，Fling动效开始时的最大初始速度。设置为小于等于0的值时，按默认值处理。
129
130**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
131
132**系统能力：** SystemCapability.ArkUI.ArkUI.Full
133
134**参数：**
135
136| 参数名     | 类型   | 必填 | 说明                            |
137| ---------- | ------ | ---- | ------------------------------- |
138| speedLimit | number | 是   | Fling动效开始时的最大初始速度。<br/>默认值：12000<br/>单位：vp/s |
139
140### fadingEdge<sup>14+</sup>
141
142fadingEdge(enabled: Optional&lt;boolean&gt;, options?: FadingEdgeOptions): T
143
144设置是否开启边缘渐隐效果及设置边缘渐隐长度。
145
146**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。
147
148**系统能力：** SystemCapability.ArkUI.ArkUI.Full
149
150**参数：**
151
152| 参数名  | 类型                                              | 必填 | 说明                                                         |
153| ------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
154| enabled | Optional&lt;boolean&gt;                           | 是   | fadingEdge生效时，会覆盖原组件的.overlay()属性。<br/>fadingEdge生效时，建议不在该组件上设置background相关属性，会影响渐隐的显示效果。<br/>fadingEdge生效时，组件会裁剪到边界，设置组件的clip属性为false不生效。<br/>默认值：false。 |
155| options | [FadingEdgeOptions](#fadingedgeoptions14对象说明) | 否   | 边缘渐隐参数对象。可以通过该对象定义边缘渐隐效果属性，比如设置渐隐长度。 |
156
157### clipContent<sup>14+</sup>
158
159clipContent(clip: ContentClipMode | RectShape): T
160
161设置滚动容器的内容层裁剪区域。
162
163**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。
164
165**系统能力：** SystemCapability.ArkUI.ArkUI.Full
166
167**参数：**
168
169| 参数名  | 类型                                              | 必填 | 说明                                                         |
170| ------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
171| clip | [ContentClipMode](#contentclipmode14枚举说明)&nbsp;\|&nbsp;[RectShape](../js-apis-arkui-shape.md#rectshape)   | 是   | 裁剪只针对滚动容器的内容，即其子节点，背景不受影响。通过RectShape传入自定义矩形区域时仅支持设置宽高和相对于组件左上角的[offset](../js-apis-arkui-shape.md#offset)，不支持圆角。<br></div>默认值：Grid、Scroll的默认值为ContentClipMode.BOUNDARY，List、WaterFlow的默认值为ContentClipMode.CONTENT_ONLY。 |
172
173
174## 事件
175
176### onReachStart<sup>11+</sup>
177
178onReachStart(event: () => void): T
179
180滚动组件到达起始位置时触发。
181
182滚动组件初始化时会触发一次，滚动到起始位置时触发一次。边缘效果为弹簧效果时，划动经过起始位置时触发一次，回弹回起始位置时再触发一次。
183
184**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
185
186**系统能力：** SystemCapability.ArkUI.ArkUI.Full
187
188### onReachEnd<sup>11+</sup>
189
190onReachEnd(event: () => void): T
191
192滚动组件到达末尾位置时触发。
193
194滚动组件边缘效果为弹簧效果时，划动经过末尾位置时触发一次，回弹回末尾位置时再触发一次。
195
196**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
197
198**系统能力：** SystemCapability.ArkUI.ArkUI.Full
199
200### onScrollStart<sup>11+</sup>
201
202onScrollStart(event: () => void): T
203
204滚动开始时触发。手指拖动滚动组件或拖动滚动组件的滚动条触发的滚动开始时，会触发该事件。使用[Scroller](ts-container-scroll.md#scroller)滚动控制器触发的带动画的滚动，动画开始时会触发该事件。
205
206触发该事件的条件 ：
207
2081、滚动组件开始滚动时触发，支持键鼠操作等其他触发滚动的输入设置。
209
2102、通过滚动控制器API接口调用后开始，带过渡动效。
211
212**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
213
214**系统能力：** SystemCapability.ArkUI.ArkUI.Full
215
216### onScrollStop<sup>11+</sup>
217
218onScrollStop(event: () => void): T
219
220滚动停止时触发。手拖动滚动组件或拖动滚动组件的滚动条触发的滚动，手离开屏幕并且滚动停止时会触发该事件。使用[Scroller](ts-container-scroll.md#scroller)滚动控制器触发的带动画的滚动，动画停止时会触发该事件。
221
222触发该事件的条件 ：
223
2241、滚动组件触发滚动后停止，支持键鼠操作等其他触发滚动的输入设置。
225
2262、通过滚动控制器API接口调用后开始，带过渡动效。
227
228**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
229
230**系统能力：** SystemCapability.ArkUI.ArkUI.Full
231
232### onWillScroll<sup>12+</sup>
233
234onWillScroll(handler: Optional&lt;OnWillScrollCallback&gt;): T
235
236滚动事件回调，滚动组件滚动前触发。
237
238回调当前帧将要滚动的偏移量和当前滚动状态和滚动操作来源，其中回调的偏移量为计算得到的将要滚动的偏移量值，并非最终实际滚动偏移。可以通过该回调返回值指定滚动组件将要滚动的偏移。
239
240**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
241
242**系统能力：** SystemCapability.ArkUI.ArkUI.Full
243
244**参数：**
245
246| 参数名 | 类型 | 必填 | 说明 |
247| ------ | ------ | ------ | ------|
248| handler | Optional&lt;[OnWillScrollCallback](#onwillscrollcallback12)&gt; | 是 | 滚动组件滑动前触发的回调。 |
249
250> **说明：**
251>
252> 调用ScrollEdge和不带动画的ScrollToIndex时，不触发onWillScroll。
253
254
255### onDidScroll<sup>12+</sup>
256
257onDidScroll(handler: OnScrollCallback): T
258
259滚动组件滑动时触发，返回当前帧滑动的偏移量和当前滑动状态。
260
261**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。
262
263**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
264
265**系统能力：** SystemCapability.ArkUI.ArkUI.Full
266
267**参数：**
268
269| 参数名 | 类型 | 必填 | 说明 |
270| ------ | ------ | ------ | ------|
271| handler | [OnScrollCallback](#onscrollcallback12) | 是 | 滚动组件滑动时触发的回调。 |
272
273### onScroll<sup>(deprecated)</sup>
274
275onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T
276
277滚动组件滑动时触发。
278
279从API version11开始使用。
280
281从API version 12开始废弃不再使用，Scroll组件的onScroll事件在布局之前触发，建议使用[onWillScroll](#onwillscroll12)替代；List、Grid和WaterFlow组件的onScroll事件在布局之后触发，建议使用[onDidScroll](#ondidscroll12)替代。
282
283**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
284
285**系统能力：** SystemCapability.ArkUI.ArkUI.Full
286
287**参数：**
288
289| 参数名 | 类型 | 必填 | 说明 |
290| ------ | ------ | ------ | ------|
291| scrollOffset | number | 是 | 每帧滚动的偏移量，滚动组件的内容向上滚动时偏移量为正，向下滚动时偏移量为负。<br/>单位vp。 |
292| scrollState | [ScrollState](ts-container-list.md#scrollstate枚举说明) | 是 | 当前滑动状态。 |
293
294## ItemDragInfo对象说明
295
296**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
297
298**系统能力：** SystemCapability.ArkUI.ArkUI.Full
299
300| 名称         | 类型         |   描述         |
301| ---------- | ---------- | ---------- |
302| x | number |  当前拖拽点的x坐标，单位vp。    |
303| y | number |  当前拖拽点的y坐标，单位vp。    |
304
305## NestedScrollOptions<sup>10+</sup>对象说明
306
307**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
308
309**系统能力：** SystemCapability.ArkUI.ArkUI.Full
310
311| 名称   | 类型  | 必填 | 描述              |
312| ----- | ------ | ------ | ----------------- |
313| scrollForward | [NestedScrollMode](ts-appendix-enums.md#nestedscrollmode10) | 是 | 滚动组件往末尾端滚动时的嵌套滚动选项。 |
314| scrollBackward | [NestedScrollMode](ts-appendix-enums.md#nestedscrollmode10) | 是 | 滚动组件往起始端滚动时的嵌套滚动选项。 |
315
316## EdgeEffectOptions<sup>11+</sup>对象说明
317
318**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
319
320**系统能力：** SystemCapability.ArkUI.ArkUI.Full
321
322| 参数名   | 类型  | 必填 | 描述              |
323| ----- | ------| ------- | ----------------- |
324| alwaysEnabled | boolean | 是 | 组件内容大小小于组件自身时，设置是否开启滑动效果。|
325
326## FadingEdgeOptions<sup>14+</sup>对象说明
327
328**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。
329
330**系统能力：** SystemCapability.ArkUI.ArkUI.Full
331
332| 参数名           | 类型                                                         | 必填 | 描述                                                         |
333| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
334| fadingEdgeLength | [LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12) | 否   | 设置边缘渐隐长度。如果设置小于0的值则取默认值。默认长度为32vp。<br/>如果设置的长度超过容器高度的一半时，渐隐长度取容器高度的一半。 |
335
336## ContentClipMode<sup>14+</sup>枚举说明
337
338表示滚动容器的内容裁剪模式。
339
340**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。
341
342**系统能力：** SystemCapability.ArkUI.ArkUI.Full
343
344下图是组件配置了边距属性后的示意图，可理解每种枚举对应的裁剪区域。
345
346![ContentClipMode示意图](figures/ContentClipMode.png)
347
348| 名称     |  值  | 说明                                       |
349| ------ | ------ | ---------------------------------------- |
350| CONTENT_ONLY   |  0  | 按内容区裁剪，对应图中的绿色区域。 |
351| BOUNDARY |  1  | 按组件区域裁剪，对应图中的整个蓝色区域。 |
352| SAFE_AREA  |  2  | 按组件配置的SafeArea区域裁剪，对应图中的整个黄色区域。 |
353
354## OnWillScrollCallback<sup>12+</sup>
355
356type OnWillScrollCallback = (scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult
357
358滚动组件滑动前触发的回调。
359
360**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
361
362**系统能力：** SystemCapability.ArkUI.ArkUI.Full
363
364**参数：**
365
366| 参数名 | 类型 | 必填 | 说明 |
367| ------ | ------ | ------ | ------|
368| scrollOffset | number | 是 | 每帧滑动的偏移量，滚动组件的内容向上滚动时偏移量为正，向下滚动时偏移量为负。<br/>单位vp。 |
369| scrollState | [ScrollState](ts-container-list.md#scrollstate枚举说明) | 是 | 当前滑动状态。 |
370| scrollSource | [ScrollSource](ts-appendix-enums.md#scrollsource12) | 是 | 当前滑动操作的来源。 |
371
372**返回值：**
373
374| 类型                          | 说明                                  |
375| ----------------------------- | ------------------------------------ |
376| void \| [ScrollResult](#scrollresult12对象说明) |  返回ScrollResult时按照开发者指定的偏移量滑动；不返回时按回调参数scrollOffset滑动。 |
377
378## OnScrollCallback<sup>12+</sup>
379
380type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void
381
382滚动组件滑动时触发的回调。
383
384**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。
385
386**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
387
388**系统能力：** SystemCapability.ArkUI.ArkUI.Full
389
390| 参数名 | 类型 | 必填 | 说明 |
391| ------ | ------ | ------ | ------|
392| scrollOffset | number | 是 | 每帧滚动的偏移量，滚动组件的内容向上滚动时偏移量为正，向下滚动时偏移量为负。<br/>单位vp。 |
393| scrollState | [ScrollState](ts-container-list.md#scrollstate枚举说明) | 是 | 当前滑动状态。 |
394
395## ScrollResult<sup>12+</sup>对象说明
396
397**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
398
399**系统能力：** SystemCapability.ArkUI.ArkUI.Full
400
401| 参数名 | 类型 | 必填 | 说明 |
402| ------ | ------ | ------ | ------|
403| offsetRemain | number | 是 | 将要滑动偏移量，单位vp。 |
404
405## ChildrenMainSize<sup>12+</sup>对象说明
406
407维护List组件或ListItemGroup组件的子组件在主轴方向的大小信息，仅支持一对一绑定到List组件或ListItemGroup组件。
408
409**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
410
411### constructor<sup>12+</sup>
412
413constructor(childDefaultSize: number): void
414
415ChildrenMainSize有参构造函数。
416
417**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
418
419**系统能力：** SystemCapability.ArkUI.ArkUI.Full
420
421**参数：**
422
423| 名称   | 类型                            | 必填   | 描述                   |
424| ---- | ----------------------------- | ---- | -------------------- |
425| childDefaultSize | number | 是    | 子组件在主轴方向的默认大小。<br/>单位：vp<br/>**说明：** <br/>必须是有限的非负数值，否则抛出异常。|
426
427
428### childDefaultSize<sup>12+</sup>
429
430set childDefaultSize(value: number): void
431
432修改子组件在主轴方向的默认大小。
433
434**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
435
436**系统能力：** SystemCapability.ArkUI.ArkUI.Full
437
438**参数：**
439
440| 名称   | 类型                            | 必填   | 描述                   |
441| ---- | ----------------------------- | ---- | -------------------- |
442| value | number | 是    | 子组件在主轴方向的默认大小。<br/>单位：vp<br/>**说明：** <br/>必须是有限的非负数值，否则抛出异常。|
443
444**错误码**：
445
446以下错误码详细介绍请参考[通用错误码](../../errorcode-universal.md)。
447
448| 错误码ID | 错误信息 |
449| ------- | -------- |
450| 401      | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed.   |
451
452get childDefaultSize(): number
453
454获取子组件在主轴方向的默认大小。
455
456**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
457
458**系统能力：** SystemCapability.ArkUI.ArkUI.Full
459
460**返回值：**
461
462| 类型                                                         | 说明                                                         |
463| ------------------------------------------------------------ | ------------------------------------------------------------ |
464| number | 子组件在主轴方向的默认大小。<br/>单位：vp |
465
466### splice<sup>12+</sup>
467
468splice(start: number, deleteCount?: number, childrenSize?: Array\<number>): void
469
470批量增删改子组件在主轴方向的大小信息。
471
472**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
473
474**系统能力：** SystemCapability.ArkUI.ArkUI.Full
475
476**参数：**
477
478| 名称   | 类型                            | 必填   | 描述                   |
479| ---- | ----------------------------- | ---- | -------------------- |
480| start | number | 是    | 从0开始计算的索引值，表示要开始修改子组件在主轴方向大小信息的位置。<br/>**说明：** <br/>1. 必须是有限的非负数值，否则抛出异常。<br/>2. 非整数会被截断为整数。<br/>3. 超过最大索引值不生效。 |
481| deleteCount | number | 否    | 从start开始删除的大小信息的数量。<br/>**说明：** <br/>1.  必须是有限的非负数值，否则处理为0。<br/>2. 非整数会被截断为整数。<br/>3. start + deleteCount - 1可以超过最大索引值，会删除索引值start开始之后的所有子组件的大小信息。 |
482| childrenSize | Array\<number > | 否    | 要在start位置插入的所有子组件的主轴方向的大小。<br/>Array中各个数值单位：vp <br/>**说明：** <br/>1.数组中数值如果是有限的非负值，则认为是指定的大小，后续不随默认大小的变化而变化。<br/>2. 数组中数值如果不是有限的非负值，会被处理成默认大小，后续会随默认大小的变化而变化。  |
483
484
485**错误码**：
486
487以下错误码详细介绍请参考[通用错误码](../../errorcode-universal.md)。
488
489| 错误码ID | 错误信息 |
490| ------- | -------- |
491| 401      | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed.   |
492
493
494> **说明：**
495>
496> - 如果仅使用start参数，表示删除索引值start及之后的子组件的大小信息。
497> - 如果仅使用start和deleteCount参数，表示删除索引值start开始的deleteCount数量的子组件的大小信息。一般在删除子组件时使用。
498> - 如果使用3个参数，表示删除索引值start开始的deleteCount数量的子组件的大小信息，再在start位置插入childrenSize中所有的大小信息。一般在增加子组件或者批量更新子组件主轴方向大小的时候使用，如果仅是增加子组件，deleteCount为0，childrenSize的元素数量和增加子组件的个数应该相等；如果仅是批量更新子组件主轴方向的大小，childrenSize的元素数量应该和deleteCount相等，即为批量更新的数量。
499> - 如果想要通知某个子组件的大小为默认大小，childrenSize中对应的值不应该给一个有限的非负值，而应该给NaN，任意负值等能被处理成默认大小的值。
500
501### update<sup>12+</sup>
502
503update(index: number, childSize: number): void
504
505修改指定索引值对应的子组件的主轴方向的大小信息。
506
507**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
508
509**系统能力：** SystemCapability.ArkUI.ArkUI.Full
510
511**参数：**
512
513| 名称   | 类型                            | 必填   | 描述                   |
514| ---- | ----------------------------- | ---- | -------------------- |
515| index | number | 是    | 从0开始计算的索引值，表示要开始修改子组件在主轴方向大小信息的位置。<br/>**说明：** <br/>1. 必须是有限的非负数值，否则抛出异常。<br/>2. 非整数会被截断为整数。<br/>3. 超过最大索引值不生效。 |
516| childSize | number | 是    | 要更新成的大小。<br/>单位：vp <br/>**说明：** <br/>1.数值如果是有限的非负值，则认为是指定的大小，后续不随默认大小的变化而变化。<br/>2. 数值如果不是有限的非负值，会被处理成默认大小，后续会随默认大小的变化而变化。  |
517
518**错误码**：
519
520以下错误码详细介绍请参考[通用错误码](../../errorcode-universal.md)。
521
522| 错误码ID | 错误信息 |
523| ------- | -------- |
524| 401      | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3. Parameter verification failed.   |
525