项列表
定义和用法
项列表可重用组件是包含的混搭，可用于在栅格视图中显示来自数据集的项列表。它还允许用户对列表进行搜索、排序和筛选，以及对整个列表或特定列表项执行操作。
您可以通过以下方式配置“项列表”可重用组件：
• 定义为列表提供输入的模型事物
• 启用或禁用搜索和筛选
• 设置初始筛选和排序选项
• 设置栅格中的最大行数
• 设置列表的选择类型
• 配置嵌入操作栏中可用的操作。有关详细信息，请参阅“操作栏”
您可以使用筛选器下拉菜单或搜索框来筛选或搜索项列表。但是，如果 JSON 配置文件中未启用筛选器下拉菜单和搜索框，则筛选和搜索功能将不可用。您可以单击属性名称，按属性对列表排序。要反转排序顺序，请再次单击属性名称。
“项列表”可重用组件还包含嵌入的“操作栏”可重用组件。通过配置操作栏，可以启用其他功能，例如对一个或多个列表项执行操作。有关详细信息，请参阅
操作栏。默认情况下，项列表中的操作栏包含
“导出”操作，该操作会将符合筛选条件的所有属性值导出至 CSV 文件。
项列表还包括“恢复默认值”按钮。“恢复默认值”按钮恢复筛选、搜索和栅格级别操作的默认设置，包括排序、交换以及显示/隐藏列。
下面是一个显示“项列表”可重用组件格式的示例图像：
“项列表”可重用组件有四个预定义的配置：任务列表、受影响的项列表、附件列表和活动列表。有关特定预定义配置的详细信息，请参阅其主题页面。
绑定属性
项列表组件具有四个可用于绑定的属性：
• input - 此 JSON 需要从后端系统获取数据的输入 ID。此信息以 CCO (公用通信对象) 格式提供。此 JSON 中包含的密钥取决于项列表作为输入接收的数据。例如，附件列表与受影响的项列表需要不同的输入。
• tailoringName - 此字符串是组件的实例名称。它与定制紧密相关。tailoringName 用于获取每个组件的已保存定制信息。
• totalItemsNumber - 此整数是与搜索和筛选条件匹配的列表项的总数。
• selectedItems - 此 JSON 在栅格中具有选定项的列表。以下是示例：
{
"timeStamp":"2019-08-25 18:53:33.476",
"data":[
{
"itemListsData":[
{
"items":[
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143921"
}
},
{
"workItem":{
"value":"OR:wt.workflow.work.WorkItem:143928"
}
}
],
"objectType":"PTC.Workflow.WorkItem"
}
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
],
"version":"1.0.0",
"statusMessage":"OK",
"status":"200"
}
配置字段
下表显示了用于配置此组件的 JSON 字段。
属性名称 | 说明 | 类型 | 默认值 | 必需或可选 |
maxNumberOfRowsInGrid | 要在栅格区域中显示的最大行数。建议输入一个小于或等于 10,000 的值。 | 整数 | 50 | 可选 |
modelThingName | 获取数据的模型事物的名称。 | 字符串 | PTC.ItemListModelThing. | 必需 |
label | 项列表的标题。 | 字符串 | [[PTC.ItemList]] | 可选 |
selectionType | 用于确定一次可选择栅格中的多少项。可用选项：none、single 或 multi。 | 字符串 | multi | 可选 |
waitForInput | 在触发对填充网格的项的检索之前，是否在运行时等待值传递到项列表的输入混搭参数。可用选项：true、false。 | 布尔型 | false | 可选 |
filterFieldID | 要筛选的后端系统中的字段 ID。当为空时，不筛选选项。 | MultiValueSelector | 不适用 | 可选 |
filterLabelOverride | 过滤器的标签，用于覆盖从模型返回的显示值。 | 字符串 | 不适用 | 可选 |
defaultSelectedFilterValue | 初始选定值或作为筛选依据的值。当为空时，没有默认筛选。 | 字符串 | 不适用 | 可选 |
defaultSortField | 作为排序依据的初始列。当为空时，项列表将按第一列进行排序。 | MultiValueSelector | 不适用 | 可选 |
defaultSortDirection | 默认排序的方向 (如果适用)。可用选项：asc 表示升序，dsc 表示降序。当字段留空时，排序方向为升序。 | 字符串 | asc | 可选 |
enableSearch | 是否显示搜索字段。选项：true、false。 | 布尔型 | true | 可选 |
findHintText | 在搜索框中显示的提示文本。 | 字符串 | "[[PTC.ItemListFindHintText]]" | 可选 |
attributes | 在栅格中显示的属性。有关详细信息，请参阅 MultiValueSelector 文档。请参阅其他子属性： | MultiValueSelector | 不适用 | 必需 |
fieldTitleOverride | 属性的替代显示名称，它将覆盖从模型中提取的字段名称。 | 字符串 | 不适用 | 可选 |
showExportAction | 启用或禁用导出操作。选项：true、false。 | 布尔型 | true | 可选 |
actionBarConfiguration | | JSON | 不适用 | 可选 |
modelConfigurations | 应用程序构建器的入口点，用于将其他值传递给模型，以便进一步自定义组件。 | JSON | 不适用 | 可选 |
配置示例
{
"modelConfigurations":{
},
"filterFieldId":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSortField":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"actionBarConfiguration":{
"maxItemsToShow":{
"value":2
},
"modelThingName":{
"entityName":"PTC.ActionBarModel.Thing"
},
"actions":{
"selectedValues":{
"data":[
{
"itemListsData":[
],
"adapter":{
"instanceName":"windchill",
"thingName":"PTC.WCAdapter"
}
}
]
}
}
},
"modelThingName":{
"entityName":"PTC.ItemListModelThing"
},
"label":{
"value":"[[PTC.ItemListLabel]]"
},
"showExportAction":{
"value":true
},
"selectionType":{
"selectedKey":"multi"
},
"waitForInput":{
"value":false
},
"filterLabelOverride":{
"value":""
},
"defaultSortDirection":{
"selectedKey":"asc"
},
"attributes":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":"",
"additionalData":{
"fieldTitleOverride":{
"value":""
}
}
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"defaultSelectedFilterValue":{
"selectedValues":{
"data":[
{
"itemListsData":[
{
"items":[
{
"id":""
}
],
"objectType":""
}
],
"adapter":{
"instanceName":"",
"thingName":""
}
}
]
}
},
"enableSearch":{
"value":true
},
"maxNumberOfRowsInGrid":{
"value":50
}
}
