跳到主要内容

数据列表

ListView

适用场景#

适用于从数据源中查询多条数据,并将返回列表循环展示的场景,如查询用户列表。

基本功能

数据查询、筛选、分页

数据列表组件是获取数据的核心组件之一,可快速从数据模型、APIs 中查询列表,并渲染到页面列表上,含分页等功能。

image-20221024215721765

数据使用和展示

数据列表是一个数据提供器,所提供的数据,可供所有业务组件使用。数据列表的数据可选择数据表、或绑定表达式。

1. 快速选择数据表

将需要绑定数据的组件拖入数据容器内,即可选择数据容器的数据。

2. 绑定表达式

表达式可为静态数据、变量。您可通过 Query 连接内置数据表和外部 APIs 等,然后在表达式中选择 query 进行绑定。

image-20221024215721765

下列视频展示了如何从 APIs 查询数据,并配置分页:

3. 绑定 APIs(最新版本已下架)

注意:自v2.30.0版本组件起,数据表格支持APIs调用已经下线,请通过表达式选择Query查询APIs。
调用 APIs 的参数要求
  1. 方法入参:
  • pageNo:页码(选填)
  • pageSize:每页大小(选填)
  • orderBy:排序字段名称(选填)。可传值出参 records 中的各字段
    • orderType:排序方式(选填)。升序传 asc,降序传 desc。
  1. 方法出参:
  • total:记录总条数(必填)

  • records:对象数组格式的多条数据。注:数组中对象需包含数据唯一标识 _id(文本类型) 字段,分页器翻页等功能才可以正常使用。

image-20221024221624468

属性介绍

组件接收的外部传入的属性

属性名
属性标识
类型
说明
列表模板templatestring

列表内容样式的预设模板

示例:"simpleList"

数据源dataSourceTypestring

数据源类型选择

示例:"data-model"

数据模型datasourceobject

展示模型数据的数据来源

APIsbindConnectMetadataobject

展示数据的APIs来源选择

表达式dataSourceDataarray

新特性:数据列表追加绑定表达式数据,原APIs路径优化为表达式。注意:数组中默认需包含_id字段。且当输入的表达式变化时,会触发自动生成列表字段。因此建议先输入表达式再调整样式。查看示例

数据列表展示的数据,可选择变量。

exprToFieldsSchemastring

示例:""

调用方法connectorMethodobject

方法的出入参需满足组件要求,查看文档

展示数据的APIs调用方法选择

查询入参connectorParamsstring

当配置了「每页条数」属性后,pageSize参数将不会生效

对APIs调用方法获取的数据进行筛选过滤。支持对象类型,例如 {name:'',value:''}

数据筛选queryConditionarray

对数据进行筛选过滤

排序字段orderBystring

选取对数据进行排序的字段

排序方式orderTypestring

设置升序或降序

示例:"asc"

分页方式paginationstring

数据分页样式

示例:"loadMoreButton"

每页条数pageSizenumber

设置单次加载的数据条数

示例:5

启用动态分页enableTotalboolean

默认为前端分页,启用后可实现动态加载数据

开启后,可支持动态分页

示例:false

数据总数totalnumber

默认为表达式输入的数组长度,请输入数据表实际数据总数。详见后端分页指引

默认为表达式输入的数组长度,请输入数据表实际数据总数。

空状态提示emptyTextstring

无数据时的提示说明,内容为空时则不显示该提示

示例:"暂无数据"

加载到底提示loadCompletedTextstring

加载全部数据后的提示说明,内容为空时则不显示该提示

示例:""

显示加载状态isSetLoadingboolean

是否开启数据列表的加载状态,默认显示

默认值:true

显示异常状态isSetStatusboolean

是否开启数据列表的异常状态,默认不显示

事件介绍

组件暴露的事件,可以监听组件的事件来触发一些外部的动作

事件名
事件code
事件出参 event.detail
适用情况
说明
查询为空queryEmpty兼容三端

数据查询为空时触发

查询成功querySuccess兼容三端

数据查询成功时触发

查询失败queryFailobject
  • error: object 错误信息

    组件内部抛出的错误信息

    • requestid: string请求 id

      如果是接口相关错误会提供请求 id

    • message: string错误提示信息
    • code: string错误码
兼容三端

数据查询失败时触发

分页变化onPagingChangeobject
  • query: object 分页信息

    分页信息

    • pageNo: number
    • pageSize: number
兼容三端

分页变化

属性 API

通过属性 API,可以获取组件内部的状态和属性值,可以通过$w.componentId.propertyName 来访问组件内部的值,如 $w.input1.value ,详请请参考 属性 API

只读属性名
属性标识
类型
说明
列表记录recordsarray

列表记录

记录总条数totalnumber

记录总条数

页码pageNonumber

当前页码

每页大小pageSizenumber

每页大小

错误信息errorobject

组件内部抛出的错误信息

方法 API

通过方法 API,可以通过程序触发组件内部的方法,比如提交表单,显示弹窗等, 可以通过$w.componentId.methodName来调用组件方法,如 $w.form1.submit()

方法名
方法标识
参数
方法说明
刷新refreshstring刷新方式 默认值:refreshFromStart 可选值:refreshFromStart(刷新并回到第1页) refreshKeepPage(刷新当前页)

-

删除单条数据deleteOnestring删除数据的标识

-

应用示例

以下示例展示模型用户列表:

1. 添加一个数据容器

image-20221024211426230

2. 选择数据源

数据源支持数据模型和 APIs。

image-20221024205037841

3. 将组件拖入数据列表内,点击绑定字段接口选择数据。

image-20221024205548537

4.  将组件与数据字段绑定,展示用户信息

image-20221024210014699

如此,查询用户列表功能就完成了!完整如下: img

常见问题

使用数据容器类组件,一定要将组件放在数据容器类组件内部么?

数据容器(Data Container)是页面与数据交互的核心组件,它能直接查询并展示数据。在我们的平台中,有多种数据容器组件可供选择,如数据列表(ListView)、数据详情(DataView)、表单容器(WdForm)以及数据表格(WdTable)。

数据容器可实现数据与页面组件的深度整合。这大大简化了数据操作流程。除了提供数据,数据容器还支持常见的页面交互功能,例如分页加载、加载状态以及错误提示等。

在使用数据容器时,若组件依赖于数据容器返回的数据,建议将组件置于数据容器类组件内部。例如,若要展示某条数据详情中的某个字段的图片,将组件放在相应的数据容器内部会更好。这样,数据容器可以自动处理加载中、加载失败等情况,无需关注渲染时机。

如果只需使用数据容器获取数据,而无需进行 UI 交互,您可以直接使用 Query 功能来查询数据。

数据容器中如何展示通用选项集中文标签

通用选项集支持根据 key 查询 value 功能已上线,有需要使用的可参考文档:https://cloud.tencent.com/document/product/1301/95807

如何在某个事件触发时刷新其他组件?

当需要在某个事件触发时刷新其他组件时,可以在目标组件的属性上绑定一个变量,例如筛选参数的表达式中引用这个变量。然后在触发事件中改变这个变量的值,从而重新更新对应的目标组件的内容。

数据列表中添加了多选框,怎么获取选中的行数据

为了获取数据列表中多选的数据,您可以在多选的change事件上绑定一个自定义方法。首先,新建一个页面数组变量,例如selectedIds。在自定义方法中,您可以根据选中状态来处理数据:

  1. 当复选框被选中时,将当前行的数据加入到selectedIds数组中。
  2. 当复选框被取消选中时,从selectedIds数组中移除当前行的数据。

建议在绑定自定义方法时,将当前行的数据标识(例如_id)作为参数传递给自定义方法,以便于处理选中行的数据。