项列表
定义和用法
作为内置混搭，“项列表”组件可用于以栅格视图显示数据集中的项列表。此组件还可供最终用户对列表进行搜索、排序和筛选，以及对整个列表或特定列表项执行相关操作。
下面是一个示例图像，其中显示了“项列表”组件：
可通过以下方式配置“项列表”组件：
• 启用或禁用搜索和筛选
• 设置初始筛选和排序选项
• 设置栅格中的最大行数
• 定义是否可以从此列表中选择项，如果可从此列表中选择项，那么是否可以选择一个或多个项
• 配置嵌入式“操作栏”中提供的操作
• 选取是否显示“导出”操作
用户可以使用筛选框或搜索框来筛选或搜索“项列表”。但是，如果配置中未启用筛选框和搜索框，则筛选和搜索功能将不可用。可单击列标题按此列对列表进行排序。要反转排序顺序，请再次单击列标题。
“项列表”组件包含嵌入式“操作栏”组件。通过配置“操作栏”，可以启用其他功能，例如对一个或多个列表项执行操作。有关详细信息，请参阅操作栏 (测试版)。默认情况下，“项列表”中包含“导出”操作，该操作可将符合筛选条件的所有项导出至 CSV 文件。
“项列表”还包括“恢复默认值”按钮。“恢复默认值”按钮恢复筛选、搜索和栅格级别操作的默认设置，包括排序、交换以及显示/隐藏列。
绑定属性
输入 | ||
|---|---|---|
属性名称 | 说明 | 属性类型 |
input | 用于标识要从后端系统中获取的数据。 需要输入时，请将 waitForInput 配置属性设置为 true。 JSON 示例： { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | CCO 格式的 JSON |
tailoringName | 用于唯一标识“项列表”组件的实例。此值在内部使用，可供查找此特定实例的定制信息。 仅当自定义任务存在专用定制页面时，才使用此绑定属性。 | |
输出 | ||
|---|---|---|
属性名称 | 说明 | 属性类型 |
totalItemsNumber | 与搜索和筛选条件匹配的列表项数。 | 整数 |
selectedItems | 用于标识选定的栅格项及其属性。此属性可绑定到其他组件的 input 绑定属性。 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" } | CCO 格式的 JSON |
配置属性
下表显示了用于配置此组件的 JSON 字段。
有关详细信息，请参阅组件配置结构。
有关子属性的详细信息，请参阅子属性和容器键。
属性名称 | 说明 | 属性类型 | 默认值 | 必需或可选 | |
|---|---|---|---|---|---|
actionBarConfiguration | 嵌入式“操作栏”的配置。有关详细信息，请参阅操作栏 (测试版)。 | 不适用 | 可选 | ||
attributes | 要显示的属性。这些属性在网格中显示为列标题。 | 不适用 | 必需 | ||
defaultSelectedFilterValue | 初始选定值或作为筛选依据的值。当其值为空时，没有默认筛选。 此属性为 filterFields 的子属性，且仅当配置中包含 filterFields 时，此属性才相关。其容器键为 itemListFilterFieldDefinition。 | 不适用 | 可选 | ||
defaultSortDirection | 默认排序的方向。选项：asc，用于指示升序；而 dsc，用于指示降序。当其值为空时，排序方向为升序。 此属性为 defaultSortField 的子属性，且仅当配置中包含 defaultSortField 时，此属性才相关。其容器键为 itemListDefaultSortFieldDefinition。 | asc | 可选 | ||
defaultSortField | 作为排序依据的初始列。当其值为空时，“项列表”将按第一列进行排序。 | 不适用 | 可选 | ||
enableSearch | 是否显示搜索字段。选项：true、false。 | true | 可选 | ||
filterFields | 后端系统中用于筛选数据的字段的 ID。当其值为空时，不存在用于筛选数据的任何选项。 | 不适用 | 可选 | ||
filterLabelOverride | 筛选器的标签，用于覆盖从 GetItems 服务返回的显示值。 此属性为 filterFields 的子属性，且仅当配置中包含 filterFields 时，此属性才相关。其容器键为 itemListFilterFieldDefinition。 | 不适用 | 可选 | ||
implementationConfigurations | 应用程序构建器的入口点，用于传递其实施过程中所需的其他值，以便进一步自定义此组件。 | 不适用 | 可选 | ||
label | “项列表”的标题。 | [[PTC.ItemList]] | 可选 | ||
maxNumberOfRowsInGrid | 要在栅格区域中显示的最大行数。建议输入一个小于 10000 的值。 | 500 | 可选 | ||
searchHintText | 在搜索框中显示的提示文本。 此属性为 enableSearch 的子属性，且仅当 enableSearch 设置为 true 时，此属性才相关。其容器键为 itemListSearchDefinition。 | Find Item | 可选 | ||
selectionType | 用于确定一次可选择网格中的多少项。选项： • none - 不能选择网格项 • single - 一次只能选择一个网格项 • multi - 一次可以选择一个或多个网格项 | multi | 可选 | ||
showExportAction | 启用或禁用导出操作。选项：true、false。 | true | 可选 | ||
waitForInput | 在触发对填充栅格的项的检索之前，是否在运行时等待值传递到“项列表”的输入混搭参数。选项：true、false。 | false | 可选 | ||
配置示例
自定义服务
除配置外，每个组件还支持通过扩展其业务逻辑来自定义组件。每个组件的业务逻辑在事物模板中都包含可改写服务，您可以对这些服务进行扩展和改写。下表对此组件的可改写服务进行了详细说明。
有关每个服务的返回值和参数的示例，请参阅自定义服务的输入/输出示例。
 | 将 CCO 格式的 JSON 对象从“业务逻辑实施”组件返回到“项列表”组件时，仅包含单一对象类型的属性。当前，项列表不支持包括不同对象类型的属性。 |
名称 | 说明 |
|---|---|
GetConfigurations | 返回组件实施的可用配置。 参数：无 返回：JSON |
GetImplementationLabel | 返回此组件的本地化名称或可用于获取此本地化名称的标记。此本地化名称显示在 Mashup Builder 用户界面中。 参数：无 返回：字符串 |
GetItems | 返回后端系统中的项列表。 要创建项列表的自定义实现，请改写此服务以检索自定义数据。 参数： input (可选) - CCO 格式的 JSON，其中包含要从后端系统获取的数据的输入 ID，以及后端系统的适配器信息。 使用此参数时，请确保将 waitForInput 配置属性设置为 true。 configuration (必需) - JSON，其中包含从“定制管理器”资源获得的最终合并配置。 返回：CCO 格式的 JSON |
InitializeFilters | 返回配置中每个筛选器字段的筛选器类型定义。 参数： input (可选) - CCO 格式的 JSON，其中包含要从后端系统获取的数据的输入 ID，以及后端系统的适配器信息。 configuration (必需) - JSON，其中包含从“定制管理器”资源获得的最终合并配置。 返回：CCO 格式的 JSON |
DefHookImplementationConfigurationDefinitionGroup | 返回特定于实施的定义，其中包含实施的自定义配置。 参数：无 返回：JSON:Array |
DefHookImplementationAttributesDefinition | 返回选定属性的特定于实施的定义。 参数：无 返回：JSON:Array |
DefHookMaxRowsProperties | 返回要在栅格区域中显示的最大行数的属性。 参数：无 返回：JSON |
实施定义