Published — v. 6
/
サブタブ API

サブタブ API

Owned by YUKA SAITO
Last updated: Apr 16, 2021Version comment

サブタブ

サブタブはダッシュボードの小要素であり、ダッシュボード上のコンテンツのコンテナーとして使用されます。サブタブオブジェクトには、サブタブの名前とuuid、そのサブタブに配置されているレポートの情報が含まれています。


プロパティのリファレンス

name（名前）

リターン

String

説明

Yellowfin UIに表示されるサブタブの表示名を返します。


uuid

リターン

String

説明

サブタブのUUIDを返します。



関数のリファレンス

isCanvas()

リターン

Boolean

説明

サブタブがキャンバスタブの場合trueを返します。


getReports()

リターン

Array[Object]

説明

サブタブに存在するすべてのレポートのレポートUUIDおよびエンティティUUIDを返します。

サブタブにレポートが無い場合は、空の配列が返されます。

例

この関数を使用することで、ダッシュボード上にある特定のレポートのすべてのインスタンスを検索できます。

let reportToFind = 'af67e527-81d3-47fc-81ce-dfc506a61dd2';
let dashboardReports = dashboard.getAllReports();
let dashboardReport= dashboardReports.find(reportInfo => {
          return reportInfo.reportUUID ===  reportToFind;
});

if(dashboardReport) {
         //We found that report now we can load the report object. If the report has already been loaded by the dashboard this will just give us that version of the report
         dashboard.loadReport({
                  reportId: reportInfo.reportUUID,
                  entityUUID: reportInfo.entityUUID
         }).then(report => {
                  //Now we've fetched the report.
         });
}



イベントのリファンレンス

サブタブがトリガーになるイベントはありません。