cx-pickerフラグメントのパラメータ
このトピックでは、cx-pickerフラグメントに設定できるパラメータを示します。 このフラグメントのパラメータを設定する方法を学習するには、「ピッカーの構成」を参照してください。
パラメータ |
サンプル値 |
説明 |
---|---|---|
dynamicLayoutContext |
|
このパラメータはデフォルトで設定されており、作成または編集ページにフィールドが表示されている場合は変更する必要はありません。 このフィールドが、作成/編集ページに表示されず、マス・アップデート・ページなどに表示されない場合は、このパラメータでデフォルト値を削除できます。 |
pickerLayoutId |
|
このパラメータは、実行時にピッカーがどのように見えるかを制御するレイアウトを持つルール・セットを示します。 変更する必要のないデフォルト値は、 カスタム・ルール・セットを作成する必要がある場合は、動的表としてルール・セットを作成し、「ラベル」フィールドと「ID」フィールドの値が同一であることを確認します。 次に、ルール・セットのIDをこのパラメータに追加します。 |
リソース |
|
このパラメータを使用して、ターゲット・オブジェクト名とエンドポイントを渡します:
オプションで、次の追加属性を渡します:
ユース・ケースに適した値で「リソース」パラメータを必ず更新してください。 たとえば、 |
パラメータ |
サンプル値 |
説明 |
---|---|---|
context |
1つのフィールドと別のフィールドを表示するには、「コンテキスト」パラメータを 次に例を示します: ユーザーがこのフィールドにテキスト値を入力できるようにするには、このプロパティをコンテキストパラメータに追加: |
コンテキスト・パラメータを使用して、ピッカーの動作を制御できます。 たとえば:
|
createConfig |
|
ユーザーがピッカーから直接レコードを作成できるかどうかを示します。 値が設定されていない場合は、デフォルトで「レコードの作成」オプションがピッカーに自動的に表示されます。 |
isDefaultSavedSearchEnabled |
このパラメータはチェック・ボックスです。 |
このパラメータを使用して、ピッカー・フィールドの値リストに自動的に適用されるデフォルトの保存済検索を指定します。 デフォルトでは、このチェック・ボックスは選択されていません。
ノート: このパラメータは、適応型検索でサポートされているオブジェクトにのみ適用されます。
|
label |
|
このパラメータを使用して、UIのフィールド名を上書きします。 このパラメータは、アプリケーション・コンポーザの動的選択リスト・フィールドにフィルタが定義されている場合、または「問合せ」パラメータ(後述)を使用してフィルタ基準を渡す場合に特に役立ちます。 たとえば、動的選択リスト・フィールドに単純なフィルタを追加して、米国のアカウントのみを表示する場合は、「ラベル」パラメータを使用してフィールド名を変更できます。 この例では、Accountフィールド名を新しいフィールド名 |
pickerNameField |
|
このパラメータを「コンテキスト」パラメータとともに使用して、ピッカー・フィールドにユーザーが入力したテキストをサポートします。 このパラメータを、作成する仮想フィールドにバインドします( このフィールドに単純なフィルタ(アプリケーション・コンポーザから)または「問合せ」パラメータの値がある場合、pickerNameFieldパラメータの値は無視されます。 |
問合せ |
|
このパラメータを使用して、実行時にピッカーで使用可能なレコードをフィルタします。 たとえば、レコードをフィルタして、名前に特定のキーワードがあるアカウント( このパラメータの値はarray[object]である必要があります。 動的選択リスト・フィールド(アプリケーション・コンポーザから)に単純なフィルタと、このパラメータの問合せの両方がある場合、このパラメータが優先されます。 このパラメータで値を渡すと、実行時に保存済検索のリストがピッカーに表示されなくなります。 |
readonly |
このパラメータはチェック・ボックスです。 |
このパラメータを使用して、フィールドを読取り専用にします。 たとえば、ユーザーが最初にレコードを作成したときにのみ、フィールドを編集可能にできます。 ただし、編集中は、このフィールドを読取り専用にできます。 |
required |
このパラメータはチェック・ボックスです。 |
このパラメータは、dynamicLayoutContextパラメータに値がない場合にのみ適用されます。 このパラメータを使用して、ピッカー・フィールドを必須にします。 ただし、dynamicLayoutContextパラメータに値が含まれている場合は、「フィールド」タブで「必須」チェック・ボックスを選択すると、ピッカー・フィールドを必須にできます。 次に例を示します: . |
selectedRow |
|
このパラメータを「値」パラメータとともに使用して、ピッカーで選択した行の他のフィールド値を使用します。 たとえば、ユーザーが担当者を選択すると、contactIdはピッカーにバインドされている「値」パラメータに格納されます。 ただし、このパラメータを使用して担当者のEメール・アドレスを取得することもできます。
|
sortCriteria |
例: |
このパラメータを使用して、ピッカー・レイアウトのデフォルトのソート基準を上書きします。 ユーザーが保存済検索を選択した場合、ソート基準はこのパラメータから取得されます(指定されている場合)。 指定しない場合、ピッカーは保存済検索で定義されたソート基準に従います。 定義されていない場合、ピッカーはピッカー・レイアウトの最初の列に基づいて値をソートします。 フィールドに単純なフィルタがある場合、または「問合せ」パラメータにフィルタが定義されている場合、またはユーザーが「関連レコード」を選択した場合、ソート基準はこのパラメータから取得されます(指定されている場合)。 指定しない場合、ピッカーはピッカー・レイアウトの最初の列に基づいて値をソートします。 |
value |
|
このパラメータを使用して、dynamicLayoutContextパラメータに値がない場合、ピッカー・フィールドで選択した値を格納します。 たとえば、担当者ピッカーがページにあり、動的レイアウトがないとします。 ユーザーが担当者を選択すると、contactIdは、ピッカーにバインドされている「値」パラメータに格納されます。 |