lightning:utilityBarAPI

このコンポーネントでは、Lightning アプリケーションのユーティリティバー内のユーティリティをプログラムで制御するメソッドにアクセスできます。ユーティリティバーは、ユーザが頻繁に使用するツールやコンポーネントにすばやくアクセスできるようにするためのフッターです。各ユーティリティは、標準またはカスタム Lightning コンポーネントが含まれる 1 列の Lightning ページです。

メソッドにアクセスするには、ユーティリティ内の lightning:utilityBarAPI コンポーネントのインスタンスを作成し、aura:id 属性を割り当てます。

1<lightning:utilityBarAPI aura:id="utilitybar"/>

次の例では、ボタンをクリックすると、ユーティリティのアイコンが SLDS の「insert tag field (タグ項目を挿入)」アイコンに設定されます。

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:utilityBarAPI aura:id="utilitybar" />
3    <lightning:button label="Set Utility Icon" onclick="{! c.setUtilityIcon }" />
4</aura:component>

コンポーネントのボタンにより、次のクライアント側コントローラがコールされます。

1({
2    setUtilityIcon : function(component, event, helper) {
3        var utilityAPI = component.find("utilitybar");
4        utilityAPI.setUtilityIcon({icon: 'insert_tag_field'});
5    }
6})

このコンポーネントは、次のメソッドをサポートします。大部分のメソッドは 1 つの引数 (パラメータの JSON 配列) のみを取ります。utilityId パラメータは、ユーティリティ自体内の場合にのみ省略可能です。これらのメソッドについての詳細は、『コンソール開発者ガイド』を参照してください。

getEnclosingUtilityId()

プロミスを返します。成功すると、囲んでいる utilityId に解決します。ユーティリティ内ではない場合は false になります。エラー時にはプロミスは却下されます。

getUtilityInfo({utilityId})

• utilityId (string): 省略可能。情報を取得するユーティリティの ID。

プロミスを返します。成功すると、utilityInfo オブジェクトに解決します。エラー時にはプロミスは却下されます。

getAllUtilityInfo()

プロミスを返します。成功すると、utilityInfo オブジェクトの配列に解決します。エラー時にはプロミスは却下されます。

minimizeUtility({utilityId})

• utilityId (string): 省略可能。最小化するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

openUtility({utilityId})

• utilityId (string): 省略可能。開くユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setPanelHeaderIcon({icon, utilityId})

• icon (string): SLDS ユーティリティアイコンキー。ユーティリティパネルに表示されます。SLDS リファレンスサイトでユーティリティアイコンキーの完全なリストを確認してください。
• utilityId (string): 省略可能。パネルヘッダーアイコンを設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setPanelHeaderLabel({label, utilityId})

• label (string): パネルヘッダーに表示されるユーティリティの表示ラベル。
• utilityId (string): 省略可能。パネルヘッダー表示ラベルを設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setPanelHeight({heightPX, utilityId})

• heightPX (integer): ユーティリティパネルの高さ (ピクセル単位)。
• utilityId (string): 省略可能。パネルの高さを設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setPanelWidth({widthPX, utilityId})

• widthPX (integer): ユーティリティパネルの幅 (ピクセル単位)。
• utilityId (string): 省略可能。パネルの幅を設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setUtilityHighlighted({highlighted, utilityId})

• highlighted (boolean): ユーティリティを強調表示するかどうか。異なる背景色を設定してユーティリティを強調表示します。
• utilityId (string): 省略可能。強調表示するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setUtilityIcon({icon, utilityId})

• icon (string): SLDS ユーティリティアイコンキー。ユーティリティバーに表示されます。SLDS リファレンスサイトでユーティリティアイコンキーの完全なリストを確認してください。
• utilityId (string): 省略可能。アイコンを設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

setUtilityLabel({label, utilityId})

• label (string): ユーティリティの表示ラベル。ユーティリティバーに表示されます。
• utilityId (string): 省略可能。表示ラベルを設定するユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

toggleModalMode({enableModalMode, utilityId})

• enableModalMode (boolean): ユーティリティのモーダルモードを有効にするかどうか。モーダルモードの場合、オーバーレイがアプリケーション全体に表示されて、ユーティリティパネルが表示されていても使用できなくなります。
• utilityId (string): 省略可能。モーダルモードを切り替えるユーティリティの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。