Lightning コンソール JavaScript API の構文

Lightning コンソール JavaScript API を使用するには、lightning:navigationItemAPI、lightning:workspaceAPI、lightning:utilityBarAPI を Aura コンポーネントに含めます。

lightning:navigationItemAPI、lightning:workspaceAPI、lightning:utilityBarAPI コンポーネントを使用すると、これらの調整 API にアクセスできます。各コンポーネントに aura:id を付与して、コンポーネントのコントローラから参照できるようにします。

次の例では、API ライブラリを使用する簡単な Aura コンポーネントを示します。

このコンポーネントは flexipage:availableForAllPageTypes を実装しているため、Lightning アプリケーションビルダーでアクセスできます。

コンポーネントの JavaScript コントローラを次に示します。

コントローラには、API メソッドを使用する 3 つの関数があります。コントローラでメソッドを使用するには、lightning:navigationItemAPI、lightning:workspaceAPI、lightning:utilityBarAPI に付与した aura:id と共に component.find を使用します。

ワークスペース API とユーティリティバー API のメソッドは、引数として JSON オブジェクトを取ります。オブジェクトに含まれる値は、メソッドによって異なります。たとえば、openTab は、url と focus (新しいタブにフォーカスするかどうか) が含まれるオブジェクトを取ります。メソッドを使用する前にこのガイドの「参照」セクションを参照して、メソッドに渡す引数を確認してください。