自訂 ThingWorx Navigate > 建立自訂任務 > 在自訂任務中使用 ThingWorx Navigate 元件 > 可用元件 > 項目清單
項目清單
定義與用法
項目清單元件是一個小器具，可讓您將資料集中的項目清單顯示為一般清單或結構樹。項目清單可讓最終使用者對整個清單或特定清單項目執行動作。當資料採用一般清單時，項目清單也允許最終使用者搜尋、排序及篩選清單。
* 
在 ThingWorx Navigate 之前的版本中，項目清單元件是已包含混搭。現在，項目清單可作為小器具使用，且項目清單混搭已被取代。
以下是顯示項目清單元件的兩個範例圖像：
您可以使用下列方式配置項目清單元件：
• 啟用或禁用搜尋與篩選 (僅適用於一般清單)
• 設定初始篩選與排序選項 (僅適用於一般清單)
• 設定格點中的最大列數目
• 定義是否可從清單中選取項目，以及可以選取一個項目還是多個項目
• 設定初始展開層級 (僅適用於結構樹)
• 選擇是否顯示匯出動作並允許使用者選取匯出的檔案格式
• 選擇匯出所有資料，還是僅匯出符合篩選條件的資料
• 配置內嵌動作列中的可用動作
使用者可以使用篩選器方塊或搜尋方塊來篩選或搜尋項目清單。但是，如果在組態中未啟用篩選器方塊與搜尋方塊，則篩選與搜尋不可用。您可以按一下欄標題來依該欄排序清單。若要反轉排序順序，請再次按一下欄標題。
「項目清單」元件包含內嵌「動作列」元件。透過配置動作列，您可以啟用其他功能，例如對一個或多個清單項目執行動作。如需詳細資訊，請參閲動作列 (BETA)。依預設，「項目清單」包含「匯出」動作，可將項目匯出至 CSV 檔案。
項目清單也包含「還原預設值」按鈕。「還原預設值」按鈕還原篩選、搜尋及格點層級操作的預設設定，包含排序、交換及顯示與隱藏欄。
活動、受影響項目、附件、工程圖、零件結構與任務是適用於「項目清單」元件的預先定義組態。
一般清單與結構樹
如前所述，項目清單支援一般清單與結構樹。項目清單在使用者介面中會顯示為一般清單還是結構樹，取決於 GetItems 服務輸入的格式。如需詳細資訊，請參閱下面的 GetItems 服務。
當項目清單為結構樹時，不支援搜尋、排序與篩選，即使您使用下列組態內容進行配置時亦如此。
當項目清單為一般清單時，預設展開層級不相關。
繫結內容 
輸入
內容名稱
描述
內容類型
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
selectedItems
用於識別及選取格點項目及其屬性作為輸入。您可以將其他元件的 output 繫結內容繫結至此內容。
範例 JSON：
{
"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"
}
* 
欲讓 selectedItems 內容接受輸入，必須實行 MapItemToInput 服務。對於階層資料，也必須實行 GetImplementationSettings 服務。如需詳細資訊，請參閱下面的自訂服務部份與啟用項目清單的 selectedItems 輸入繫結內容主題。
CCO 格式的 JSON
tailoringName
唯一識別項目清單元件的實例。此值可在內部用於尋找特定實例的調整資訊。
只有為自訂任務提供了專用調整頁的情況下，才可使用此繫結內容。
輸出
內容名稱
描述
內容類型
totalItemsNumber
符合搜尋與篩選器條件的清單項目數。
* 
此繫結內容適用於一般清單而非結構樹，因為結果對於結構樹而言可能不准確。
整數
selectedItems
用來識別所選的格點項目及其屬性。此內容可繫結至其他元件的 input 繫結內容。
範例 JSON：
{
"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
必要
defaultExpansionLevel
定義結構樹的初始展開層級。接受將數字 1-9 和 -1 作為輸入。當內容設定為 -1 時，結構樹最初會完全展開，並顯示所有層級。
* 
• 對於大型結構，設定高於 3 的預設可能會影響初始載入效能。
• 如果此內容收到無效輸入，預設展開層級為 3。
3
選用
defaultSelectedFilterValue
作為篩選依據的初始選取值。若為空白，則沒有預設篩選。
此內容是 filterFields 的子內容，且僅在 filterFields 包括在組態中時相關。其容器金鑰為 itemListFilterFieldDefinition。
* 
當項目清單為結構樹時，會略過此組態內容。
N/A
選用
defaultSortDirection
預設排序的方向。選項：asc，指示遞增順序，dsc，指示遞減順序。若為空白，則排序方向為遞增。
此內容是 defaultSortField 的子內容，且僅在 defaultSortField 包括在組態中時相關。其容器金鑰為 itemListDefaultSortFieldDefinition。
* 
當項目清單為結構樹時，會略過此組態內容。
asc
選用
defaultSortField
要作為排序依據的初始欄。若為空白，則項目清單會按第一欄排序。
* 
當項目清單為結構樹時，會略過此組態內容。
N/A
選用
enableSearch
是否要顯示搜尋欄位。選項：true、false。
* 
當項目清單為結構樹時，會略過此組態內容。
true
選用
exportUnFilteredData
將「項目清單」資料匯出至檔案時，包括所有資料還是僅包括篩選的資料。選項：true、false。
設定為 true 時，無論篩選器如何設定，匯出的檔案都會包括資料。
設定為 false 時，匯出的檔案僅包含篩選的資料。
由於 maxNumberOfRowsInGrid 內容限制而在「項目清單」格點中不可見的資料仍包括在匯出的檔案中。
此內容是 showExportAction 的子內容，且僅在 showExportAction 包括在組態中時相關。其容器金鑰為 itemListExportDefinition。
false
選用
exportTypes
可用匯出類型。選項：exportToCsv、exportToExcel。包括任一選項或同時包括兩個選項皆可。
當包括 exportToCsv 時，「匯出」按鈕會包括將資料以標準格式匯出至 CSV 檔案的選項。
當包括 exportToExcel 時，「匯出」按鈕會包括將 Excel 格式的資料匯出至 CSV 檔案的選項。
當僅包括一個選項時，「匯出」按鈕會以所選格式 (標準 CSV 或 Excel 格式的 CSV) 自動匯出資料。當同時包括這兩個選項時，「匯出」按鈕會顯示為選單按鈕，可讓使用者選取所需匯出格式。
此內容是 showExportAction 的子內容，且僅在 showExportAction 包括在組態中時相關。其容器金鑰為 itemListExportDefinition。
exportToCsv、exportToExcel
選用
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
選用
* 
當包括具有 HTML 值且會在屬性欄中顯示選單按鈕的屬性時，動作必須在 PTCNav 索引鍵下。目前唯一支援的動作類型是 OpenUrl。範例：
{
"label":"",
"icon":"",
"PTCNav":{
"Action":{
"type":"openUrl",
"data":{
"url":"http://www.linkTofile.pdf"
}
}
}
}
範例組態 
如需「項目清單」元件的範例組態，請參閱活動、受影響項目、附件、工程圖、零件結構與任務。
自訂服務 
除組態以外，每個元件還支援延伸其企業邏輯以自訂元件。每個元件的企業邏輯包括物範本中可以進行延伸與取代的置換服務。此元件的置換服務會在下表中詳細說明：
如需每個服務的傳回結果與參數範例，請參閱自訂服務的輸入/輸出範例。
* 
當將 CCO 格式的 JSON 物件從企業邏輯實行元件傳回至「項目清單」元件時，僅包括單一物件類型的屬性。目前，「項目清單」不支援包括不同物件類型的屬性。
名稱
描述
ComputeMessages
計算要顯示在使用者介面中項目清單格點上方的所需訊息。它會接收目前訊息 JSON 與建議訊息 JSON，並傳回包含要顯示在項目清單中之訊息的通知訊息 JSON。
參數：
getItemsResponse (必填) - CCO 格式的 JSON 物件，其中包含從 getItems 服務傳回的項目。
currentMessages (必填) - 包含顯示在使用者介面中的目前通知訊息的 JSON 物件。
suggestedMessages (必填) - 包含一組建議訊息的 JSON 物件。推薦使用建議的訊息。
input (選用) - CCO 格式的 JSON，其中包括結構根節點中項目的輸入 ID。
configuration (選用) - 包含組態的 JSON。
scope (選用) - 表示 getItemsResponse 中資料範圍的 JSON。JSON 物件包含接受值 root 與 child 的 scope 索引鍵。與階層式資料相關範例：
{
"scope": "root"
}
返回：包含要顯示在項目清單格點中之訊息的 JSON 物件。範例：
"INFO":{
{
"messages":[
"[[PTC.Nav.ItemList.HiddenItemsBecauseAccessRightMessage]]"
]
}
}
DefHookImplementationConfigurationDefinitionGroup
傳回包含實行自訂組態的實行特定定義。
參數：無
傳回：JSON:Array
DefHookImplementationAttributesDefinition
傳回所選屬性的實行特定定義。
參數：無
傳回：JSON:Array
DefHookMaxRowsProperties
傳回要在格點區域顯示之列數上限的內容。
參數：無
傳回：JSON
GetChildren
接收項目並傳回包含該項目子項之 CCO 格式的 JSON，即在階層資料結構中位於該項目以下一個層級的所有項目。傳回的 JSON 包含一般清單形式的子項，而非階層式資料。
當使用者展開項目清單中子項尚未載入之項目時，會呼叫此服務。
此服務的預設實行假設已實行服務 MapItemToInputObject，以對項目進行輸入轉換 (如有必要)。
參數：
input (選用) - CCO 格式的 JSON，其中包括結構根節點中項目的輸入 ID。
configuration (必填) - 包含組態的 JSON。
item (必填) - 包含要傳回其子項之項目的 JSON。
傳回：CCO 格式的 JSON
GetConfigurations
傳回元件實行的可用組態。
參數：無
傳回：JSON
GetImplementationLabel
傳回元件的當地語系化名稱或可用於取得當地語系化名稱的權杖。此當地語系化名稱會顯示在 Mashup Builder 使用者介面中。
參數：無
傳回：字串
GetImplementationSettings
傳回實行的設定資料。實行可以取代此服務，以提供其自己的設定。如需詳細資訊，請參閱針對項目清單啟用 selectedItems 輸入繫結內容主題。
參數：無
傳回：JSON 物件
GetItems
傳回來自後端系統之項目的清單。
欲建立「項目清單」的自訂實行，請取代此服務以擷取自訂資料。
參數：
input (選用) - CCO 格式的 JSON，其中包括要從後端系統擷取之資料的輸入 ID，以及後端系統的轉接器資訊。
使用此參數時，請確定 waitForInput 組態內容已設定為 true。
configuration (選用) - 包含組態的 JSON。
傳回：CCO 格式的 JSON
GetItemsByExpansionPath
傳回階層結構 CCO，其包含從根節點到所請求項目之路徑上的所有項目，包括所有請求的屬性 itemIdentifierKeys 以及 itemExpansionKeys，如 GetImplementationSettings 服務中所定義。階層結構 CCO 包括路徑上的所有同等物件。
當 selectedItems 繫結內容接收指定未載入項目的輸入時，會呼叫此服務。
參數：
input (選用) - CCO 格式的 JSON，其中包括結構根節點中項目的輸入 ID。
configuration (必填) - 包含組態的 JSON。
itemExpansionValues (必填) - JSON 陣列，包含請求展開的項目的 itemExpansionKeys。陣列值會根據樹中的路徑排序，從根項目開始。
傳回：CCO 格式的 JSON
GetItemsForExport
處理 CCO 格式的組態 JSON 與輸入 JSON，並傳回 CCO 格式的 JSON，其中包含匯出時需要的所有項目。依預設，此服務會傳回空白 CCO，但實行可以取代服務以傳回其用於匯出的項目。在此情況下，用於匯出的資料即為此服務傳回的項目。
當 selectedItems 繫結內容接收指定未載入項目的輸入時，會使用此服務的結果。
參數：
input (選用) - CCO 格式的 JSON，其中包括要從後端系統擷取之資料的輸入 ID。
configuration (選用) - 包含組態的 JSON。
傳回：CCO 格式的 JSON
GetStructureSkeleton
以 CCO 格式傳回階層結構的所有層級，其中結構中的每個項目都包含 itemIdentifierKeys 與 itemExpansionKeys，如 GetImplementationSettings 服務中所定義。
參數：
input (選用) - CCO 格式的 JSON，其中包括結構根節點中項目的輸入 ID。
configuration (選用) - 包含組態的 JSON。
傳回：CCO 格式的 JSON
InitializeFilters
傳回組態中每個篩選器欄位的篩選器類型定義。
參數：
input (選用) - CCO 格式的 JSON，其中包括要從後端系統擷取之資料的輸入 ID，以及後端系統的轉接器資訊。
configuration (選用) - 包含組態的 JSON。
傳回：CCO 格式的 JSON
MapItemToInputObject
將項目對應至輸入，之後可由 GetItems 服務使用。
預設實行會傳回未進行任何變更的項目。如果需要任何變更，例如變更項目的物件類型，請取代此服務。此服務僅供 GetChildren 服務的預設實行使用。
參數：
input (選用) - CCO 格式的 JSON，其中包括結構根節點中項目的輸入 ID。
item (必填) - 包括要對應至輸入之項目的 JSON。
返回：CCO 格式的 JSON，單一項目僅包含 id 屬性。
PrepareDataForExport
接收資料負載形式的資料，並準備將其匯出。預設實行會依原樣傳回資料，但實行可以取代此服務，以視需要修改資料。
參數：
configuration (必填) - 包含組態的 JSON。
dataInfoTable (必填) - 包括要匯出之資料的資料負載。
data (選用) - CCO 格式的 JSON 物件，其中包括要匯出的資料。
gridQuery (選用) - 表示 QUERY 類型資料的 JSON 物件，其中包含項目清單格點中的查詢篩選器。
searchTerm (選用) - 要在格點的每一列中搜尋的字串。
filterOptions (選用) - 包含篩選所依據之選項的資料負載。
返回：資料負載
實行定義 
如需「項目清單」元件的實行定義，請參閱活動、受影響項目、附件、工程圖、零件結構與任務。
這是否有幫助?