Dashboard class

使用可能な最初の場所 (オプション、属性、埋め込み URL) からダッシュボード ID を取得します。

function getId(): string

戻り値

全画面表示モードを終了するようにブラウザーに要求します。

function exitFullscreen()

Embed.exitFullscreen から継承された

コンポーネントの iframe を全画面表示モードでレンダリングするようにブラウザーに要求します。

function fullscreen()

Embed.fullscreen から継承された

現在の埋め込みセッションの correlationId を取得します。

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

戻り値

Embed.getCorrelationId から継承された

ハンドラーの一覧から 1 つ以上のイベント ハンドラーを削除します。 既存のハンドル関数への参照が指定されている場合は、特定のハンドラーを削除します。 ハンドラーが指定されていない場合は、指定されたイベント名のすべてのハンドラーを削除します。

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

パラメーター

Embed.off から継承された

特定のイベントのイベント ハンドラーを追加します。

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

パラメーター

Embed.on から継承された

既存の構成を使用して埋め込みを再読み込みします。 たとえば、レポートの場合、これは効果的にすべてのフィルターをクリアし、レポートを読み込まれた状態にリセットすることをシミュレートする最初のページをアクティブにします。

report.reload();

function reload(): Promise<void>

戻り値

Embed.reload から継承された

要素の tabindex 属性を削除します。

function removeComponentTabIndex(_tabIndex?: number)

パラメーター

Embed.removeComponentTabIndex から継承された

レポートを保存します。

function save(): Promise<void>

戻り値

Embed.save から継承された

SaveAs レポート。

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

パラメーター

戻り値

Embed.saveAs から継承された

accessToken を設定します。

function setAccessToken(accessToken: string): Promise<void>

パラメーター

戻り値

Embed.setAccessToken から継承された

要素の tabindex 属性を設定します。

function setComponentTabIndex(tabIndex?: number)

パラメーター

Embed.setComponentTabIndex から継承された

アクセシビリティのコンポーネント タイトルを設定します。 iframe の場合、このメソッドは iframe タイトルを変更します。

function setComponentTitle(title: string)

パラメーター

Embed.setComponentTitle から継承された