...
| Note |
|---|
このAPIは、ダッシュボードコードモードでは使用できません。 |
Base APIには、Yellowfin APIを独自のウェブページにロードするのに役立つ多くの関数が含まれています。レポートおよびダッシュボードローダーAPIをロードする関数があり、ダッシュボードおよびレポートをロードできます。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がロードするの待ち、渡されたオプションでレポートをロードします。レポートがロードされると、渡された要素が追加され、レポートの実行が開始されます。promiseがロードするの待ち、渡されたオプションでレポートをロードします。レポートがロードされると、渡されたelement（要素）が追加され、レポートの実行が開始されます。
promiseが解決されると、レポートオブジェクトはpromiseが解決されると、レポートオブジェクトは.then()関数に渡されます。promiseは、レポートの実行が開始される直前に解決されます。
...
オプションオブジェクトの一部として受け入れられるオプションがいくつかあります。
reportId（レポートID） - 必須
型：String
ロードするレポートのレポートUUIDです。これは、レポートヘッダーテーブルの公開UUIDです。
element（要素） - 必須
型：DOM要素、セレクターString
レポートに描画する要素です。DOM要素、またはページから要素を選択するために使用されるセレクターのどちらかになります。
幅や高さが渡されない場合、レポートは要素の寸法に合わせて展開されます。DOM Element、Selector String
レポートに描画するelement（要素）です。DOM element、またはページからelementを選択するために使用されるselectorのどちらかになります。
幅や高さが渡されない場合、レポートはelementの寸法に合わせて展開されます。
width（幅）
型：Number
レポートをピクセル単位で描画する幅です。
height（高さ）
型：Number
レポートをピクセル単位で描画する高さです。
filterValues（フィルター値）
型：配列Array[オブジェクトObject]
初期フィルター値を適用するために使用されるオブジェクトの配列です。フィルター値についての詳細は、フィルター APIを参照してください。
フィルター値についての詳細は、フィルター APIを参照してください。
オブジェクトには、次の情報が含まれます。
- filterId - 設定するフィルターのUUID、または名前です。
- valueOne - フィルターの最初の値です。
- valueTwo - フィルターの二番目の値です。「〜の間」、または「〜の間ではない」フィルタータイプにのみ影響します。フィルターの二番目の値です。Between（の間）、またはNot Between（の間ではない）フィルタータイプにのみ影響します。
- valueList - フィルター一覧に適用する値の配列です。
...
//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’); |
...
loadDashboard(dashboardOptions)
リターン
Promise
説明
init()promiseがロードされるのを待ち、渡されたオプションでダッシュボードをロードします。ダッシュボードがロードされると、渡された要素に追加され、ダッシュボード上のコンテンツの実行が開始されます。promiseがロードされるのを待ち、渡されたオプションでダッシュボードをロードします。ダッシュボードがロードされると、渡されたelement（要素）に追加され、ダッシュボード上のコンテンツの実行が開始されます。
dashboardOptionsオブジェクトには、いくつかのパラメーターを含めることができます。
dashboardUUI（ダッシュボードUUID） - 必須
型：String
ロードするダッシュボードの公開UUIDです。
element（要素） - 必須
型：DOM要素、セレクターString
ダッシュボードに描画する要素です。DOM要素、またはページからセレクターの最初のインスタンスを選択するために使用されるセレクターのどちらかになります。
幅や高さが渡されない場合、ダッシュボードは要素の寸法に合わせて表示されます。DOM Element、Selector String
ダッシュボードに描画するelement（要素）です。DOM element、またはページからselectorの最初のインスタンスを選択するために使用されるselectorのどちらかになります。
幅や高さが渡されない場合、ダッシュボードはelement（要素）の寸法に合わせて表示されます。
filterValues（フィルター値）
型：配列Array[オブジェクトObject]
ダッシュボードの初期フィルター値を適用するために使用されるオブジェクトの配列です。フィルター値についての詳細は、フィルター APIを参照してください。
フィルター値についての詳細は、フィルター APIを参照してください。
オブジェクトには、次の情報が含まれます。
- filterId - 設定するフィルターのUUID、または名前です。
- valueOne - フィルターの最初の値です。
- valueTwo - フィルターの二番目の値です。「〜の間」、または「〜の間ではない」フィルタータイプにのみ影響します。フィルターの二番目の値です。Between（の間）、またはNot Between（の間ではない）フィルタータイプにのみ影響します。
- valueList - フィルター一覧に適用する値の配列です。
...