getPicklistValuesByRecordType

指定したレコードタイプのすべての選択リストの値を取得するには、このワイヤアダプタを使用します。

構文

1import { LightningElement, wire } from "lwc";
2import { getPicklistValuesByRecordType } from "lightning/uiObjectInfoApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4
5export default class Example extends LightningElement {
6  @wire(getPicklistValuesByRecordType, {
7    objectApiName: ACCOUNT_OBJECT,
8    recordTypeId: "012000000000000AAA",
9  })
10  propertyOrFunction;
11}

ユーザインターフェース API リソース

1GET /ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}

getPicklistValuesByRecordType は、このユーザインターフェース API リソースを使用します。

パラメータ

objectApiName — (必須) サポートされているオブジェクトの API 名。
recordTypeId — (必須) レコードタイプの ID。getObjectInfo から返されるオブジェクト情報 defaultRecordTypeId プロパティを使用します。
propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

戻り値

data — 選択リストの値のコレクション
error — FetchResponse

使用方法

選択リストの値は、レコードタイプを範囲とします。getPicklistValuesByRecordType は、指定されたレコードタイプのすべての選択リストの値のコレクションを返します。詳細は、「選択リストの UI の構築」を参照してください。

特定の項目の選択リストを取得するには、代わりに getPicklistValues を使用します。

例

lwc-recipes GitHub リポジトリの wireGetPicklistValuesByRecordType コンポーネントを参照してください。

関連トピック

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。