自訂 ThingWorx Navigate > 建立自訂任務 > 在自訂任務中使用 ThingWorx Navigate 元件 > 可用元件 > 項目清單
  
項目清單
定義與用法
項目清單元件是包含的混搭，可讓您在格點檢視中顯示資料集中的項目清單。它也可讓終端使用者搜尋、排序及篩選清單，以及對整個清單或特定清單項目執行動作。
以下是顯示項目清單元件的範例圖像：
您可以使用下列方式配置項目清單元件：
• 啟用或禁用搜尋與篩選
• 設定初始篩選與排序選項
• 設定格點中的最大列數目
• 定義是否可從清單中選取項目，以及可以選取一個項目還是多個項目
• 配置內嵌動作列中的可用動作
• 選擇是否要顯示匯出動作
使用者可以使用篩選器方塊或搜尋方塊來篩選或搜尋項目清單。但是，如果在組態中未啟用篩選器方塊與搜尋方塊，則篩選與搜尋不可用。您可以按一下欄標題來依該欄排序清單。若要反轉排序順序，請再次按一下欄標題。
「項目清單」元件包含內嵌「動作列」元件。透過配置動作列，您可以啟用其他功能，例如對一個或多個清單項目執行動作。如需詳細資訊，請參閲動作列 (BETA)。依預設，項目清單包含「匯出」動作，它會將符合篩選條件的所有項目匯出至 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
內嵌動作列的配置。如需詳細資訊，請參閲動作列 (BETA)。
N/A
選用
attributes
要顯示的屬性。它們會在格點中顯示為欄標題。
N/A
必要
defaultSelectedFilterValue
作為篩選依據的初始選取值。若為空白，則沒有預設篩選。
此內容是 filterFields 的子內容，且僅在 filterFields 包括在組態中時相關。其容器金鑰為 itemListFilterFieldDefinition。
N/A
選用
defaultSortDirection
預設排序的方向。選項：asc，指示遞增順序，dsc，指示遞減順序。若為空白，則排序方向為遞增。
此內容是 defaultSortField 的子內容，且僅在 defaultSortField 包括在組態中時相關。其容器金鑰為 itemListDefaultSortFieldDefinition。
asc
選用
defaultSortField
要作為排序依據的初始欄。若為空白，則項目清單會按第一欄排序。
N/A
選用
enableSearch
是否要顯示搜尋欄位。選項：true、false。
true
選用
filterFields
後端系統中篩選資料時所依據之欄位的 ID。若為空白，則沒有可篩選資料的選項。
N/A
選用
filterLabelOverride
篩選器的標籤，會取代從 GetItems 服務傳回的顯示值。
此內容是 filterFields 的子內容，且僅在 filterFields 包括在組態中時相關。其容器金鑰為 itemListFilterFieldDefinition
N/A
選用
implementationConfigurations
應用程式建構器的進入點，可傳入實行所需其他值，以進一步自訂元件。
N/A
選用
label
項目清單的標題。
[[PTC.ItemList]]
選用
maxNumberOfRowsInGrid
要在格點區域中顯示的最大列數。建議輸入小於 10,000 的值。
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
實行定義
如需項目清單元件的實行定義，請參閱活動、受影響項目、附件與任務。