| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
...
Base APIには、Yellowfin APIを独自のウェブページにロードするのに役立つ多くの関数が含まれています。レポートおよびダッシュボードローダーAPIをロードする関数があり、ダッシュボードおよびレポートをロードできます。
セッション管理を支援する関数もあります。
init()
リターン
Promise
説明
Base APIを初期化します。これは、APIがページに含まれている時に呼び出されます。ロードが終了した時点で、APIの使用がこのPromiseが解決するまで待機することを示すPromiseを返します。
例
Yellowfin レポートAPIをページに含め、init() promiseが解決した後でレポートをロードします。
| <script src="https://pathToYourYellowfinServer/JsAPI/v3"></script> <div id="reportDiv"></div> <script> yellowfin.init().then(() => { //The Yellowfin base API has now loaded. Now load a report yellowfin.loadReport({ reportId: 'c83357db-8aef-4ec7-ab72-fce34de9ee77', element: document.querySelector('div#reportDiv'), }); }); </script> |
logoff()
リターン
なし
説明
現在のユーザーセッションを終了します。
loadReport(reportOptions)（レポートのロード）
リターン
Promise
説明
init() promiseがロードするの待ち、渡されたオプションでレポートをロードします。レポートがロードされると、渡されたelement（要素）が追加され、レポートの実行が開始されます。
...
オプションオブジェクトの一部として受け入れられるオプションがいくつかあります。
reportId（レポートID） - 必須
型：String
ロードするレポートのレポートUUIDです。これは、レポートヘッダーテーブルの公開UUIDです。
element（要素） - 必須
型：DOM Element、Selector String
...
幅や高さが渡されない場合、レポートはelementの寸法に合わせて展開されます。
width（幅）
型：Number
レポートをピクセル単位で描画する幅です。
height（高さ）
型：Number
レポートをピクセル単位で描画する高さです。
filterValues（フィルター値）
型：Array[Object]
初期フィルター値を適用するために使用されるオブジェクトの配列です。
...
//Load the report with this option set to false |
例
レポートをロードして、その名前を出力します。
yellowfin.loadReport({ //Some code to execute when the report has loaded console.log(report.name + ‘ has finished loading’); |
インタラクション
インタラクションオブジェクトは、特定のレポートのビジュアライゼーションでどのインタラクションを利用可能にするかを定義します。これにより、Yellowfin レンダラーに対して、そのビジュアライゼーション内でユーザーが使用できる機能を指定できます。
同じレポートを表す複数のelement（要素）があり、インタラクションを無効にしたい場合、表示しているすべてのelement（要素）でこれを無効にする必要があります。例えば、最初のelement（要素）のドリルダウンを無効にしてから、二番目のelement（要素）のドリルダウンを無効にしなかった場合、ユーザーは依然として二番目のelement（要素）のドリルダウンを実行できます。
デフォルトでは、明示的にfalseに設定されていないインタラクションはすべて有効と見なされ、レポートで許可されている場合は表示されます。
drillDown
ドリルダウン機能を無効にできます。
drillAnywhere
ドリルエニウェア機能を無効にできます。
drillThrough
ドリルスルー機能を無効にできます。
unitSelection
単位選択機能を無効にできます。
brushing
ブラッシング機能を無効にできます。
timeSlider
タイムスライダー機能を無効にできます。
drillBreadcrumbs
パンくずリスト機能を無効にできます。
seriesSelection
シリーズ選択機能を無効にできます。
annotations
注釈機能を無効にできます。
例
loadReportの使用時にレポート上のすべてのユーザーインタラクションを無効にするには、以下を参照してください。
yellowfin.loadReport({ reportId: ‘a report id’, interactions: { drillDown: false, drillAnywhere: false, drillThrough: false, unitSelection: false, brushing: false, timeSlider: false, drillBreadcrumbs: false, seriesSelection: false, annotations: false }, element: document.querySelector(‘#reportElement’) }). |
loadDashboard(dashboardOptions)
リターン
Promise
説明
init()promiseがロードされるのを待ち、渡されたオプションでダッシュボードをロードします。ダッシュボードがロードされると、渡されたelement（要素）に追加され、ダッシュボード上のコンテンツの実行が開始されます。
dashboardOptionsオブジェクトには、いくつかのパラメーターを含めることができます。
dashboardUUI（ダッシュボードUUID） - 必須
型：String
ロードするダッシュボードの公開UUIDです。
element（要素） - 必須
型：DOM Element、Selector String
...
幅や高さが渡されない場合、ダッシュボードはelement（要素）の寸法に合わせて表示されます。
filterValues（フィルター値）
型：Array[Object]
ダッシュボードの初期フィルター値を適用するために使用されるオブジェクトの配列です。
...