ドキュメントAEM as a Cloud Serviceユーザーガイド

アセットセレクターのプロパティ asset-selector-properties

Last update: Tue Oct 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 管理者
  • ユーザー
検索のベストプラクティス
メタデータのベストプラクティス
コンテンツハブ
OpenAPI 機能を備えたDynamic Media
AEM Assets開発者向けドキュメント

アセットセレクターのプロパティを使用して、アセットセレクターのレンダリング方法をカスタマイズできます。次の表に、アセットセレクターをカスタマイズして使用するために利用できるプロパティを示します。

Property
タイプ
必須
デフォルト
説明
rail
ブール値
いいえ
False
true とマークされている場合、アセットセレクターは左側のパネルビューにレンダリングされます。false とマークされている場合、アセットセレクターはモーダルビューにレンダリングされます。
imsOrg
文字列
はい
Adobe Experience Manager as a Cloud Service を組織にプロビジョニングする場合に割り当てられる Adobe Identity Management System（IMS）の ID です。imsOrg キーは、アクセスしようとしている組織が Adobe IMS 内にあるかどうかを認証するために必要です。
imsToken
文字列
いいえ
認証に使用される IMS ベアラートークンです。統合に Adobe アプリケーションを使用している場合、imsToken は必須です。
apiKey
文字列
いいえ
AEM Discovery サービスへのアクセスに使用する API キーです。Adobe アプリケーション統合を使用している場合、apiKey は必須です。
filterSchema
配列
いいえ
フィルタープロパティの設定に使用するモデルです。これは、アセットセレクターで特定のフィルターオプションを制限する場合に便利です。
filterFormProps
オブジェクト
いいえ
検索を絞り込むために使用する必要があるフィルタープロパティを指定します。（例：MIME タイプの JPG、PNG、GIF）
selectedAssets
配列 <Object>
いいえ
アセットセレクターがレンダリングされる際に、選択したアセットを指定します。アセットの ID プロパティを含むオブジェクトの配列が必要です。（例：[{id: 'urn:234}, {id: 'urn:555'}]）アセットは、現在のディレクトリで使用できる必要があります。別のディレクトリを使用する必要がある場合は、path プロパティの値も指定します。
acvConfig
オブジェクト
いいえ
デフォルトを上書きするカスタム設定が含まれているオブジェクトを含む、アセットコレクション表示プロパティです。また、このプロパティは、アセットビューアのパネルビューを有効にするために rail プロパティと共にに使用されます。
i18nSymbols
Object<{ id?: string, defaultMessage?: string, description?: string}>
いいえ
OOTB 翻訳がアプリケーションのニーズを満たさない場合は、独自のローカライズされたカスタム値を i18nSymbols プロップ経由で渡すことができるインターフェイスを表示できます。このインターフェイスを介して値を渡すと、提供されたデフォルトの翻訳が上書きされ、代わりに独自の翻訳が使用されます。上書きを実行するには、上書きしたい i18nSymbols のキーに有効なメッセージ記述子オブジェクトを渡す必要があります。
intl
オブジェクト
いいえ
アセットセレクターはデフォルトの OOTB 翻訳を提供します。intl.locale プロップを介して有効なロケール文字列を指定することで、翻訳言語を選択できます。（例：intl={{ locale: "es-es" }}

）サポートされているロケール文字列は、言語名の標準規格を表す ISO 639 - コードに従います。

サポートされているロケールの一覧：英語 - 'en-us'（デフォルト）スペイン語 - 'es-es' ドイツ語 - 'de-de' フランス語 - 'fr-fr' イタリア語 - 'it-it' 日本語 - 'ja-jp' 韓国語 - 'ko-kr' ポルトガル語 - 'pt-br' 中国語（簡体字） - 'zh-cn' 中国語（繁体字） - 'zh-tw'
repositoryId
文字列
いいえ
''
アセットセレクターがコンテンツを読み込む元のリポジトリです。
additionalAemSolutions
Array<string>
いいえ
[ ]
追加の AEM リポジトリのリストを追加できます。このプロパティで情報が指定されない場合、メディアライブラリまたは AEM Assets リポジトリのみが考慮されます。
hideTreeNav
ブール値
いいえ
アセットツリーのナビゲーションサイドバーを表示するか非表示にするかを指定します。このプロパティはモーダルビューでのみ使用されるので、パネルビューではこのプロパティの影響はありません。
onDrop
関数
いいえ
このプロパティで、アセットのドロップ機能を許可することができます。
dropOptions
{allowList?: Object}
いいえ
「allowList」を使用してドロップオプションを設定します。
colorScheme
文字列
いいえ
アセットセレクターのテーマ（light または dark）を設定します。
テーマ
文字列
いいえ
デフォルト
default と express の間のアセットセレクターアプリケーションにテーマを適用します。 @react-spectrum/theme-express もサポートしています。
handleSelection
関数
いいえ

アセットが選択され、モーダルの Select ボタンがクリックされた場合に、アセットの項目の配列と一緒に呼び出されます。この関数は、モーダルビューでのみ呼び出されます。パネルビューの場合は、handleAssetSelection 関数または onDrop 関数を使用します。例：

handleSelection=(assets: Asset[])=> {…}

詳しくは アセットの選択を参照してください。

handleAssetSelection
関数
いいえ

アセットが選択または選択解除されたときに、項目の配列と一緒に呼び出されます。これは、ユーザーがアセットの選択時にアセットをリッスンする場合に役立ちます。例：

handleSelection=(assets: Asset[])=> {…}

詳しくは アセットの選択を参照してください。

onClose
関数
いいえ
モーダルビューで Close ボタンが押された際に呼び出されます。これは、modal ビューでのみ呼び出され、rail ビューでは無視されます。
onFilterSubmit
関数
いいえ
ユーザーが別のフィルター条件を変更したときに、フィルター項目と一緒に呼び出されます。
selectionType
文字列
いいえ
シングル
一度にアセットを single 選択または multiple 選択するための設定です。
dragOptions.allowList
ブール値
いいえ
プロパティは、選択できないアセットのドラッグを許可または拒否するために使用されます。
aemTierType
文字列
いいえ
配信層、オーサー層またはその両方のアセットを表示するかを選択できます。

構文：aemTierType:[0]: "author" 1: "delivery"

例えば、["author","delivery"] の両方を使用する場合、リポジトリスイッチャーにはオーサーと配信の両方のオプションが表示されます。
handleNavigateToAsset
関数
いいえ
アセットの選択を処理するコールバック関数です。
noWrap
ブール値
いいえ
noWrap プロパティは、サイドパネルでのアセットセレクターのレンダリングに役立ちます。このプロパティを指定しない場合、デフォルトで​ ダイアログビュー ​がレンダリングされます。
dialogSize
小、中、大、フルスクリーン、またはフルスクリーンのテイクオーバー
文字列
オプション
指定されたオプションを使用してサイズを指定することで、レイアウトを制御できます。
colorScheme
ライトまたはダーク
いいえ
このプロパティは、アセットセレクターアプリケーションのテーマを設定するために使用されます。テーマは、ライトテーマとダークテーマから選択できます。
filterRepoList
関数
いいえ
Experience Manager リポジトリを呼び出し、フィルタリングされたリポジトリのリストを返す filterRepoList コールバック関数を使用できます。
expiryOptions
関数
次の 2 つのプロパティ間で使用できます。getExpiryStatus では、有効期限切れのアセットのステータスが表示されます。関数は、指定したアセットの有効期限に基づいて、EXPIRED、EXPIRING_SOON または NOT_EXPIRED を返します。有効期限切れのアセットのカスタマイズを参照してください。さらに、allowSelectionAndDrag を使用できます。この場合、関数の値は true または false のいずれかになります。値が false に設定されている場合、有効期限切れのアセットはキャンバス上で選択またはドラッグできません。
showToast
いいえ
これにより、アセットセレクターで、有効期限切れのアセットに対してカスタマイズされたトーストメッセージを表示できます。
metadataSchema
配列
不可
ユーザーからメタデータを収集するために指定するフィールドの配列を追加します。 このプロパティを使用すると、非表示のメタデータも使用できます。このメタデータは、アセットに自動的に割り当てられますが、ユーザーには表示されません。
onMetadataFormChange
コールバック関数
不可
それは property と value で構成されています。 Property は、値が更新中の metadataSchema から渡されたフィールドの mapToProperty と等しくなります。 一方、value は新しい値と等しく、入力として提供されます。
targetUploadPath
文字列
"/content/dam"
ファイルのターゲットアップロードパス。デフォルトは、アセットリポジトリのルートです。
hideUploadButton
ブール演算式
False
内部のアップロードボタンを非表示にするかどうかを確認します。
onUploadStart
関数
いいえ
これは、Dropbox、OneDrive、ローカル間でアップロードソースを渡すために使用されるコールバック関数です。 構文は (uploadInfo: UploadInfo) => void です
importSettings
関数
これにより、サードパーティのソースからアセットを読み込むサポートが可能になります。 sourceTypes では、有効にする読み込みソースの配列を使用します。 サポートされているソースは Onedrive とDropboxです。 構文は { sourceTypes?: ImportSourceType[]; apiKey?: string; } です
onUploadComplete
関数
いいえ
これは、成功、失敗または重複の中からファイルのアップロードステータスを渡すために使用されるコールバック関数です。 構文は (uploadStats: UploadStats) => void です
onFilesChange
関数
いいえ
これは、ファイルが変更されたときのアップロードの動作を表示するために使用されるコールバック関数です。 アップロード待ちの新しいファイル配列と、アップロードのソースタイプが渡されます。 エラーが発生した場合、Sourceのタイプは null にできます。 構文は (newFiles: File[], uploadType: UploadType) => void です
uploadingPlaceholder
文字列
これは、アセットのアップロードが開始されたときに、メタデータフォームに置き換わるプレースホルダー画像です。 構文は { href: string; alt: string; } です
uploadConfig
オブジェクト
これは、アップロード用にカスタマイズされた設定を含むオブジェクトです。
featureSet
配列
文字列
featureSet:[ ] プロパティは、アセットセレクターアプリケーションで特定の機能を有効または無効にするために使用されます。 コンポーネントまたは機能を有効にするには、配列に文字列値を渡すか、配列を空のままにして、そのコンポーネントを無効にします。 例えば、アセットセレクターでアップロード機能を有効にするには、構文 featureSet:[0:"upload"] を使用します。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab