LazyForEach
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
开发者指南见：LazyForEach开发者指南。
接口
LazyForEach(dataSource: IDataSource, itemGenerator: (item: any, index: number) => void, keyGenerator?: (item: any, index: number) => string)
LazyForEach从提供的数据源中按需迭代数据，并在每次迭代过程中创建相应的组件。当在滚动容器中使用了LazyForEach，框架会根据滚动容器可视区域按需创建组件，当组件滑出可视区域外时，框架会进行组件销毁回收以降低内存占用。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dataSource | IDataSource | 是 | LazyForEach数据源，需要开发者实现相关接口。 |
| itemGenerator | (item: any, index: number) => void | 是 | 子组件生成函数，为数组中的每一个数据项创建一个子组件。 说明： - item是当前数据项（可选），index是数据项索引值（可选）。 - itemGenerator的函数体必须使用大括号{...}。 - itemGenerator每次迭代只能并且必须生成一个子组件。 - itemGenerator中可以使用if语句，但是必须保证if语句每个分支都会创建一个相同类型的子组件。 |
| keyGenerator | (item: any, index: number) => string | 否 | 键值生成函数，用于给数据源中的每一个数据项生成唯一且固定的键值。修改数据源中的一个数据项若不影响其生成的键值，则对应组件不会被更新，否则此处组件就会被重建更新。keyGenerator参数是可选的，但是，为了使开发框架能够更好地识别数组更改并正确更新组件，建议提供。说明： - item是当前数据项（可选），index是数据项索引值（可选）。 - 数据源中的每一个数据项生成的键值不能重复。 - keyGenerator缺省时，使用默认的键值生成函数，即(item: Object, index: number) => { return viewId + '-' + index.toString(); }，生成键值仅受索引值index影响。 |
说明：
应避免在
keyGenerator和itemGenerator函数中执行耗时操作，以此来减少应用滑动时卡顿丢帧问题，最佳实践请参考主线程耗时操作优化-循环渲染。例如，不推荐使用JSON.stringify函数。在复杂的业务场景中，使用JSON.stringify会对item对象进行序列化，该过程会消耗大量时间与计算资源，从而降低页面性能，最佳实践请参考懒加载优化性能-键值生成规则。
IDataSource
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
totalCount
totalCount(): number
获得数据总数。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
返回值：
| 类型 | 说明 |
|---|---|
| number | 获得数据总数，由数据源决定实际大小。 |
getData
getData(index: number): any
获取索引值index对应的数据。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 获取数据对应的索引值。取值范围是[0, 数据源长度-1]。 |
返回值：
| 类型 | 说明 |
|---|---|
| any | 获取索引值index对应的数据，由数据源决定具体类型。 |
说明：
应避免在
getData函数中执行执行耗时操作，以此来减少应用滑动时卡顿丢帧问题，最佳实践请参考主线程耗时操作优化-循环渲染。
registerDataChangeListener
registerDataChangeListener(listener: DataChangeListener): void
注册数据改变的监听器。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| listener | DataChangeListener | 是 | 数据变化监听器。 |
unregisterDataChangeListener
unregisterDataChangeListener(listener: DataChangeListener): void
注销数据改变的监听器。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| listener | DataChangeListener | 是 | 数据变化监听器。 |
DataChangeListener7+
数据变化监听器。
说明：
DataChangeListener除onDatasetChange以外的方法中，当参数包含index且值为负数时，会默认用0来替换。onDatasetChange中，当单个DataOperation参数包含index且值在数据源索引范围之外（DataAddOperation中index可以等于数据源长度），则对应DataOperation不会生效。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onDataReloaded
onDataReloaded(): void
通知组件重新加载所有数据。键值没有变化的数据项会使用原先的子组件，键值发生变化的会重建子组件。重新加载数据完成后调用。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onDataAdded(deprecated)
onDataAdded(index: number): void
通知组件index的位置有数据添加。添加数据完成后调用。
从API version 8开始，建议使用onDataAdd。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据添加位置的索引值。取值范围是[0, 数据源长度-1]。 |
onDataMoved(deprecated)
onDataMoved(from: number, to: number): void
通知组件数据有移动。将from和to位置的数据进行交换。
从API version 8开始，建议使用onDataMove。
说明：
数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。数据移动起始位置与数据移动目标位置交换完成后调用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| from | number | 是 | 数据移动起始位置。取值范围是[0, 数据源长度-1]。 |
| to | number | 是 | 数据移动目标位置。取值范围是[0, 数据源长度-1]。 |
onDataDeleted(deprecated)
onDataDeleted(index: number): void
通知组件删除index位置的数据并刷新LazyForEach的展示内容。删除数据完成后调用。
从API version 8开始，建议使用onDataDelete。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据删除位置的索引值。取值范围是[0, 数据源长度-1]。 |
onDataChanged(deprecated)
onDataChanged(index: number): void
通知组件index的位置有数据变化。改变数据完成后调用。
从API version 8开始，建议使用onDataChange。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据变化监听器。取值范围是[0, 数据源长度-1]。 |
onDataAdd8+
onDataAdd(index: number): void
通知组件index的位置有数据添加。添加数据完成后调用
卡片能力： 从API version 10开始，该接口支持在ArkTS卡片中使用。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据添加位置的索引值。取值范围是[0, 数据源长度-1]。 |
onDataMove8+
onDataMove(from: number, to: number): void
通知组件数据有移动。将from和to位置的数据进行交换。数据移动起始位置与数据移动目标位置交换完成后调用。
说明：
数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| from | number | 是 | 数据移动起始位置。取值范围是[0, 数据源长度-1]。 |
| to | number | 是 | 数据移动目标位置。取值范围是[0, 数据源长度-1]。 |
onDataDelete8+
onDataDelete(index: number): void
通知组件删除index位置的数据并刷新LazyForEach的展示内容。删除数据完成后调用。
说明：
需要保证dataSource中的对应数据已经在调用onDataDelete前删除，否则页面渲染将出现未定义的行为。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据删除位置的索引值。取值范围是[0, 数据源长度-1]。 |
onDataChange8+
onDataChange(index: number): void
通知组件index的位置有数据有变化。改变数据完成后调用。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 数据变化位置的索引值。取值范围是[0, 数据源长度-1]。 |
onDatasetChange12+
onDatasetChange(dataOperations: DataOperation[]): void
进行批量的数据处理后，调用onDatasetChange接口通知组件按照dataOperations刷新组件。
说明：
onDatasetChange接口不能与其他DataChangeListener的更新接口混用。例如，在同一个LazyForEach中，调用过onDataAdd接口后，不能再调用onDatasetChange接口；反之，调用过onDatasetChange接口后，也不能调用onDataAdd等其他更新接口。页面中不同LazyForEach之间互不影响。在同一个onDatasetChange批量处理数据时，如果多个DataOperation操作同一个index，只有第一个DataOperation生效。 原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dataOperations | DataOperation[] | 是 | 一次处理数据的操作。 |
DataOperation12+
说明
本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
DataAddOperation
添加数据操作。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.ADD | 是 | 数据添加类型。 |
| index | number | 是 | 插入数据索引值。取值范围是[0, 数据源长度-1]。 |
| count | number | 否 | 插入数量，默认为1。 |
| key | string | Array<string> | 否 | 为插入的数据分配键值。 |
DataDeleteOperation
删除数据操作。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.DELETE | 是 | 数据删除类型。 |
| index | number | 是 | 起始删除位置索引值。取值范围是[0, 数据源长度-1]。 |
| count | number | 否 | 删除数据数量，默认为1。 |
DataChangeOperation
改变数据操作。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.CHANGE | 是 | 数据改变类型。 |
| index | number | 是 | 改变的数据的索引值。取值范围是[0, 数据源长度-1]。 |
| key | string | 否 | 为改变的数据分配新的键值，默认使用原键值。 |
DataMoveOperation
移动数据操作。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.MOVE | 是 | 数据移动类型。 |
| index | MoveIndex | 是 | 移动位置。取值范围是[0, 数据源长度-1]。 |
| key | string | 否 | 为被移动的数据分配新的键值，默认使用原键值。 |
DataExchangeOperation
交换数据操作。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.EXCHANGE | 是 | 数据交换类型。 |
| index | ExchangeIndex | 是 | 交换位置。取值范围是[0, 数据源长度-1]。 |
| key | ExchangeKey | 否 | 分配新的键值，默认使用原键值。 |
DataReloadOperation
重载所有数据操作。当onDatasetChange含有DataOperationType.RELOAD操作时，其余操作全部失效，框架会自己调用keyGenerator进行键值比对。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | DataOperationType.RELOAD | 是 | 数据全部重载类型。 |
DataOperationType枚举说明
枚举类型，数据操作说明。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| ADD | add | 数据添加。 |
| DELETE | delete | 数据删除。 |
| CHANGE | change | 数据改变。 |
| MOVE | move | 数据移动。 |
| EXCHANGE | exchange | 数据交换。 |
| RELOAD | reload | 全部数据重载。 |
MoveIndex
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| from | number | 是 | 起始移动位置。取值范围是[0, 数据源长度-1]。 |
| to | number | 是 | 目的移动位置。取值范围是[0, 数据源长度-1]。 |
ExchangeIndex
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start | number | 是 | 第一个交换位置。取值范围是[0, 数据源长度-1]。 |
| end | number | 是 | 第二个交换位置。取值范围是[0, 数据源长度-1]。 |
ExchangeKey
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start | string | 是 | 为第一个交换的位置分配新的键值，默认使用原键值。 |
| end | string | 是 | 为第二个交换的位置分配新的键值，默认使用原键值。 |