Page History
...
レポートオブジェクトのどのインスタンスを使用するかを正確に識別するために使用されるレポートの一意の識別子です。多くのイベントは、情報の一部としてこれを含みます。
...
レポートAPI パラメーター
これらのパラメーターは、必要なレポートごとに個別に設定しなくてはいけません。例えば、自動インサイトは通常グラフからトリガーされるため、これらのパラメーターは親レポートのAPIで設定する必要があります。
useDefaultAssistedInsightsPanel(デフォルトの自動インサイトパネルを使用)
デフォルトは、trueになっています。
これは、デフォルトの自動インサイト表示パネルをレンダリングするようにシステムに指定します。displayAssistedInsightsDataがカスタムパネルで上書きされる場合は、falseにする必要があります。
例
コードモードでは、以下のようになります。
let reportElement = this.apis.canvas.select('Performance by Region'); reportElement.onReportLoad.then(() => { let reportAPI = reportElement.reportAPI; reportAPI.useDefaultAssistedInsightsPanel = true; }); |
preventDefaultAssistedInsights(デフォルトの自動インサイトの防止)
デフォルトは、falseになっています。
デフォルトの自動インサイトフローを停止することで、必要に応じて、runAssistedInsightsを呼び出すことができます。
これは特に、自動インサイトプロセスのUI要素(ローダーなど)をカスタマイズしたいが、グラフのツールチップからプロセスをトリガーする必要がある場合に便利です。
例
let reportElement = this.apis.canvas.select('Performance by Region'); reportElement.onReportLoad.then(() => { let reportAPI = reportElement.reportAPI; reportAPI.preventDefaultAssistedInsights = true; }); |
...
関数のリファレンス
getFieldId(fieldName)(フィールドIDの取得)
...
//Add a listener for the reportComplete event report.addListener('reportComplete', () => { //Add a 5000ms delay before triggering runReport again setTimeout(() => { report.runReport(); }, 5000) }); report.runReport(); |
runAssistedInsights(自動インサイトの実行)
リターン
Promise
説明
自動インサイトプロセスを開始します。これにより、一時的な自動インサイトレポートが生成され、レポートデータを使用してPromiseが解決されます。assistedinsigntsCompleted イベントも同じデータでトリガーされます。
新規自動インサイトレポートは、オプションが同じ場合でも、これが呼び出されるたびに生成されます。これを手動で呼び出す場合は、前の呼び出しが返されるまで、重複したリクエストや複数のリクエストを行わないようにすることを推奨します。
この関数に必要な形式でデータを生成する最も簡単な方法は、既存のグラフで自動インサイトプロセスをトリガーし、assistedInsigntsRequestedByChart イベントからeventDataを使用することです。
パラメーター
Options{object}
- loader{DOM 要素}(オプション設定)。自動インサイトプロセスの進行中にレンダリングするカスタムローダーです。これは、必要に応じて自動的にページに追加され、自動インサイトデータが返されると削除されます。これが提供されない場合は、デフォルトローダーがレンダリングされます。
- reportTitle{String}(オプション設定)。一時的な自動インサイトレポートのレポート名です。これが提供されない場合は、デフォルトのレポート名が生成されます。
options objectには、自動インサイトプロセスに次のデータを必要とします。必要なデータ以外にも、グラフや分析のタイプに応じて変数が変化します。
必要なデータ:
- type{String} - 自動インサイトの分析タイプを指定します。「compare」、または「explain」のいずれかになります(下記参照)
- metricField
- metricDescription
- categoryField
- value1{String またはNumber}: 実際に分析で使用される値です。
「explain」String タイプ
オプション設定:
- dateValue
- timeSeries
- discreteTimeSeries
- granularity
「compare」String タイプ
追加で必要な値:
- categoryFieldId
- categoryKey
- value2{String またはNumber}: 自動インサイトの比較分析で使用される二番目の値です。
- valueOneFormatted(デフォルトローダーを使用している場合のみ):ユーザーに表示されるvalue oneの説明です(例:Australia)。
- valueTwoFormatted(デフォルトローダーを使用している場合のみ必要):ユーザーに表示されるvalue twoの説明です。
オプション設定:
- timeSeries
- discreteTimeSeries
- timeGranularity
例
グラフのデータを使用してrunAssistedInsightsを呼び出す方法については、assistedInsightsRequestedByChart イベントリファレンスを参照してください。
手動での呼び出し:
let assistedInsightsData = { categoryField: 60629, categoryFieldId: 1, categoryKey: "61039", dashboardName: "Sales Performance", dashboardUUID: "e7409ff2-f846-44e1-a603-b78ec51b20b9", metricDescription: "KPI", metricField: 60686, reportTitle: "Comparing KPI for Europe to Asia", parentReportId: 61035, sourceId: 54700, type: "compare", value1: "Europe", value2: "Asia", valueOneFormatted: "Europe", valueTwoFormatted: "Asia", viewId: 60543 }; reportAPI.runAssistedInsights(assistedInsightsData); |
openComaprePanel(value, comparableValues, metricDescription)(比較パネルのオープン)
リターン
なし
説明
自動インサイトの比較分析で使用する二番目の値を選択するためのパネルをレンダリングします。
この関数を上書きすることで、ユーザーは独自の比較パネルを実装することができます。上書きしない場合は、デフォルトのパネルがレンダリングされます。どちらの場合でも、二番目の値が選択されることで、compareValuesSelected イベントがトリガーされます。このイベントとともに渡されるデータについては、compareValuesSelected イベントリファレンスを参照してください。
グラフのツールチップから比較がトリガーされたときに、ひとつの値のみが選択されている場合、openComaprePanelの呼び出しは、デフォルトの自動インサイトフローにより自動的に制御されます。preventDefaultAssistedInsightsがtrueに設定され、runAssistedInsightsを呼び出している場合、openComaprePanelも手動で呼び出す必要があります。
パラメーター
- value{Object}: 比較分析の最初の値を含むvalueObjectです。
- これらは、次のいずれかの形式になります。value/rawValueは分析で使用される値を示し、description/formattedValueはユーザーに表示される値の説明を示します。
{ value: “EU”, description: “Europe” } |
{ rawValue: "EU", formattedValue: "Europe" } |
Info |
---|
assistedInsightsRequestedByChart イベントから自動インサイトデータを抽出している場合、valueはeventDataのvalue 1に対応し、comparableValuesはpossibleValuesに対応します。 |
- comparableValues{Array}: 比較分析の二番目の値として使用される可能性のある値を含むvalueObjectsの配列です。
- 次の形式である必要があります。
[{ value: “AUS”, description: “Australia” }, { value: “NA”, description: “North America” }] |
- metricDescription{String}(オプション設定):使用されるメトリック(数値)(例:KPI)の説明です。これはUI目的で、デフォルトの比較パネルに情報を追加するためだけに使用されます。
例
reportAPI.addListener('assistedInsightsRequestedByChart', event => { let runAssistedInsightsData = event.eventData; if (runAssistedInsightsData.type === 'compare' && runAssistedInsightsData.value2 == null) { reportAPI.openComparePanel(runAssistedInsightsData.value1, runAssistedInsightsData.possibleValues, runAssistedInsightsData.metricDescription); } }); |
displayAssistedInsightsData(assistedInsightsData)(自動インサイトデータの表示)
リターン
なし
説明
ページ上に自動インサイトデータをレンダリングします。
この関数を上書きすることで、データがレンダリングされる方法をカスタマイズできます。そのためには、レポートAPIでuseDefaultAssistedInsightsPanelをfalseに設定します。
独自の表示パネルをレンダリングする場合は、データが不要になったら(通常は表示パネルが閉じられたら)、deleteTemporaryAssistedInsightsReportを呼び出すことを推奨します。これは、一時的な自動インサイトレポートに関連するすべてのデータを削除します。デフォルトの表示パネルは、自動的にこれを制御します。
例
let runAssistedInsightsPromise = reportAPI.runAssistedInsights(data); runAssistedInsightsPromise.then(assistedInsightsData => { // Display the report results reportAPI.displayAssistedInsightsData(assistedInsightsData); }); |
cancelAssistedInsights(assistedInsightsUUID)(自動インサイトのキャンセル)
リターン
なし
説明
自動インサイトプロセスが完了し、データが返される前に、そのプロセスをキャンセルします。
これはカスタムローダーをレンダリングする際に、時間がかかりすぎる場合、ユーザーがプロセスをキャンセルできるため便利です。
これには、自動インサイトジョブのUUIDが必要です。これは、assistedInsightsProgress イベントがトリガーされたときに、eventDataとして渡されます。
例
reportAPI.addListener(‘assistedInsightsInProgress’, event => { let assistedInsightsTaskUUID = event.eventData; reportAPI.cancelAssistedInsights(assistedInsightsTaskUUID); }); |
deleteTemporaryAssistedInsightsReport(assistedInsightsReportId)(一時的な自動インサイトレポートの削除)
リターン
なし
説明
自動インサイトに対して生成された一時レポートを削除します。これは、デフォルトのYellowfin表示パネルが閉じられると自動的に呼び出されますが、カスタム表示パネルをレンダリングしている場合は、データが不要になった際にこれを呼び出すことを推奨します。
パラメーター
- assistedInsightsReportId{Number}: 一時的な自動インサイトレポートのIDです。runAssistedInsights promiseが解決されたとき、またはassistedInsightsCompleted イベントがトリガーされたときに渡されるデータに返されます。
例
let runAssistedInsightsPromise = reportAPI.runAssistedInsights(data); runAssistedInsightsPromise.then(assistedInsightsData => { let reportId = assistedInsightsData.assistedInsightsReportId; reportAPI.deleteTemporaryAssistedInsightsReport(reportId); }); |
registerOutputType(outputOptions, callback)(出力タイプの登録)
...
{ //Example Empty Dataset 8399975157147: [//A random ID for the output type [] //Report Dataset data ] } |
assistedInsightsRequestedByChart(グラフからの自動インサイトリクエスト)
説明
グラフのツールチップから自動インサイトを要求したときにトリガーされます。
特定の自動インサイトレポートを生成するために使用されるデータを抽出したい場合や、useDefaultAssistedInsightsPanelがfalseに設定され、runAssistedInsightsを呼び出している場合に便利です。
パラメーター
eventDataオブジェクトには、自動インサイトの実行に必要なすべての情報が含まれており、手動で呼び出している場合は、runAssistedInsightsに直接渡すことができます。このコンテンツは、自動インサイトのタイプやグラフに応じて異なります。
eventData
- categoryField
- categoryFieldId(オプション設定)
- categoryKey(オプション設定)
- dashboardName: ダッシュボードの名前です。
- dashboardUUID: ダッシュボードのUUIDです。
- metricDescription
- metricField
- parentReportId: グラフが属するレポートのIDです。
- possibleValues(オプション設定):value 1との比較分析で使用できる値を表すオブジェクトの一覧です。
- reportKey:グラフが属するレポートのキーです。
- sourceId:parentReportに使用されるデータソースのIDです。
- type:自動インサイト分析のタイプです(「explain」、または「compare」のいずれかです)
- value1:分析に使用される値です。
- value2(オプション設定):比較分析に使用される二番目の値です。
- viewId:parentReportに使用されるビューのIDです。
例
reportAPI.addListener('assistedInsightsRequestedByChart', chartData => { // This already contains all of the data we need to run Assisted Insights so we don’t need to make any additional changes to it let newData = Object.assign({}, chartData.eventData); let promise = this.reportAPI.runAssistedInsights(newData); }); |
assistedInsightsStarted(自動インサイトの開始)
説明
runAssistedInsightsが呼び出された際にトリガーされます。
パラメーター
なし
例
reportAPI.addListener(assistedInsightsStarted, () => { console.log(“Assisted Insights has started”); }; |
compareValuesSelected(選択された値の比較)
説明
比較分析に二番目の値が選択されたときにトリガーされます。
パラメーター
eventData
- value1{String、またはNumber}: 「実際の」value oneです。これが分析に使用されます。openComparePanelに渡されるvalue/rawValueに相当します。
- valueOneFormatted{String、またはNumber}: ユーザーに表示されるvalue oneの説明です。openComparePanelに渡されるdescription/formattedValueに相当します。
- value2{String、またはNumber}: 「実際の」value twoです。これが分析nに使用されます。openComparePanelに渡されるvalue/rawValueに相当します。
- valueTwoFormatted{String、またはNumber}: ユーザーに表示されるvalue twoの説明です。openComparePanelに渡されるdescription/formattedValueに相当します。
例
this.reportAPI.addListener('compareValuesSelected', event => { let comparisonValues = event.eventData; // Combine them with the existing Assisted Insights data let allData = Object.assign({}, assistedInsightsData, comparisonValues); // Generate the assisted insights report reportAPI.runAssistedInsights(allData); }); |
assistedInsightsInProgress(進行中の自動インサイト)
説明
自動インサイトバックグラウンドタスクが最初に開始されたときにトリガーされます。
パラメーター
eventData
- 自動インサイトバックグラウンドタスクのUUIDです。これは、完了前にタスクをキャンセルするときに、cancelAssistedInsightsに渡すことができます。
注意:タスクUUIDは、バックグラウンドタスクのUUIDを参照します。これは、runAssistedInsights promiseが解決されたとき、またはassistedInsightsCompleted イベントがトリガーされたときに返される自動インサイトレポートIDとは異なります。
例
reportAPI.addListener(‘assistedInsightsInProgress’, event => { let assistedInsightsTaskUUID = event.eventData; reportAPI.cancelAssistedInsights(assistedInsightsTaskUUID); }); |
assistedInsightsUpdate(自動インサイトの更新)
説明
自動インサイトタスクの進行中にトリガーされます。タスクの現在の状態を更新します。
パラメーター
eventData
- progressText{String}: 自動インサイトタスクの現在の進捗に関する更新を翻訳した文字列です。カスタムローダーでユーザーに更新をレンダリングする場合に便利です。
- state{String}: バックグラウンドタスクの現在の状態です。待機、実行中、完了のいずれかになります。
例
reportAPI.addListener(‘assistedInsightUpdate’, event => { let progressData = event.eventData; let customLoader = document.getElementById("myCustomLoader"). customLoader.innerHTML(progressData.progressText); }); |
assistedInsightsCompleted(自動インサイトの完了)
説明
runAssistedInsightsprocess全体が終了した場合にトリガーされます。
注意:これは、runAssistedInsights promiseが解決されることで追加されます。どちらも同じデータを返します。
パラメーター
eventData
- assistedInsightsReportId{Number}: 一時的な自動インサイトレポートのIDです。これは、deleteTemporaryAssistedInsightsReportの呼び出しに必要です。
- chartData{Object}: 表示パネルにレンダリングされる自動インサイトデータオブジェクトを含むオブジェクトです。
- assistedInsightsImage{base64 String}: 自動インサイトグラフのイメージです。
- assistedInsightsZoomedImage{base64 String}: 自動インサイトグラフの拡大イメージです。
- chartId{Number}: グラフのIDです。
- narratives{Array}: 自動インサイトの結果の概要を示す書式設定されたテキストです。
例
reportAPI.addListener('assistedInsightsCompleted', data => { // Display the report results reportAPI.displayAssistedInsightsData(data.eventData); }); |
assistedInsightsCancelled(自動インサイトのキャンセル)
説明
cancelAssistedInsightsがキャンセルされた場合にトリガーされます。
パラメーター
eventData
キャンセルされたタスクのUUIDです。
例
reportAPI.addListener(‘assistedInsightsCancelled’, event => { console.log(“Task ” + event.eventData + “ has been cancelled”); }); |
assistedInsightsError(自動インサイトのエラー)
説明
自動インサイトプロセスの完了を何かが妨げている場合にトリガーされます。
パラメーター
eventData
- getMessageText{function}: エラーが発生したことを示す一般的なエラーメッセージです。
例
reportAPI.addListener(‘assistedInsightsError’, event => { console.log(event.eventData.getMessageText()); }); |
assistedInsightsExceptionError(自動インサイトの例外エラー)
説明
自動インサイトの処理中に例外が発生した場合にトリガーされます。
パラメーター
eventData
- errorMessage: 分析が完了できなかったことを示す一般的なエラーメッセージです。
例
reportAPI.addListener(‘assistedInsightsExceptionError’, event => { console.log(event.eventData.errorMessage); }); |
drilldown(ドリルダウン)
説明
レポート上の任意のフィールドにドリルダウンが適用されるたびにトリガーされます。
...