getPicklistValues
指定した項目の選択リスト値を取得するには、このワイヤーアダプターを使用します。
getPicklistValues
は、このユーザーインターフェース API リソースを使用します。
-
recordTypeId
— (必須) レコードタイプの ID。getObjectInfo
から返されるオブジェクト情報defaultRecordTypeId
プロパティを使用します。デフォルトのレコードタイプがない場合、この値はマスターレコードタイプ (012000000000000AAA
) となります。 -
fieldApiName
— (必須) サポートされているオブジェクトの選択リスト項目の API 参照名。 -
propertyOrFunction
— ワイヤーサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが@wire
でデコレートされている場合、結果はそのプロパティのdata
プロパティまたはerror
プロパティに返されます。関数が@wire
でデコレートされている場合、結果はdata
プロパティとerror
プロパティを持つオブジェクトで返されます。
このワイヤーアダプターと組み合わせた objectApiName
の使用はサポートされていません。これは、この情報もすでに fieldApiName
と一緒に含まれているためです。
data
— 選択リスト値error
— FetchResponse
選択リストの値は、レコードタイプを範囲とします。連動選択リストの場合、getPicklistValues
は、項目および項目を選択リストに対応付ける方法を制御するためのデータを返します。詳細は、「選択リストの UI の構築」を参照してください。
レコードタイプのすべての選択リストを取得するには、代わりに getPicklistValuesByRecordType
を使用します。
recordTypeId
パラメーターと fieldApiName
パラメーターの両方が必須です。recordTypeId
値を指定するには、getObjectInfo
ワイヤーアダプターを使用して、リアクティブ変数で defaultRecordTypeId
プロパティを設定します。そして、リアクティブ変数を getPicklistValues
ワイヤーアダプターに渡します。
次の例では、取引先の [評価] 項目から選択リスト値の [見込み有り]、[将来見込み有り]、[見込み無し] を返します。
data.values
は、選択リストの表示ラベルと値のリストを返します。「Picklist Value (選択リスト値)」を参照してください。
コンポーネントで選択リスト値を表示するには、for:each
ディレクティブを使用してリストを反復処理します。
lwc-recipes
GitHub リポジトリの wireGetPicklistValues
コンポーネントは、[取引先] 項目の選択リスト値を取得します。
関連トピック