Lightning Experience の getUtilityInfo()
現在のユーティリティの状態を utilityInfo オブジェクトとして返します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | 状態を取得するユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、囲んでいるユーティリティの情報が取得され、現在表示されていない場合は開き、表示されている場合は閉じます。
コンポーネントコード:
コントローラコード:
応答
このメソッドは、成功時に囲んでいるユーティリティを表し、次の項目が含まれる utilityInfo オブジェクトに解決される Promise を返します。
| 名前 | 型 | 説明 |
|---|---|---|
| id | string | ユーティリティの ID。 |
| isLoaded | boolean | ユーティリティが読み込まれるかどうか。 |
| utilityLabel | string | ユーティリティの表示ラベル。 |
| utilityIcon | string | ユーティリティのアイコンの SLDS アイコン ID。 |
| utilityHighlighted | boolean | ユーティリティが強調表示されるかどうか。 |
| utilityVisible | boolean | ユーティリティ項目パネルが表示されるかどうか。 |
| panelHeaderLabel | string | ユーティリティパネルの表示ラベル。 |
| panelHeaderIcon | string | ユーティリティパネルのアイコンの SLDS アイコン ID。 |
| panelHeight | integer | ユーティリティパネルの高さ (ピクセル単位)。 |
| panelWidth | integer | ユーティリティパネルの幅 (ピクセル単位)。 |