Visual class

bookmarksManager: BookmarksManager

プロパティ値

Report.bookmarksManager から継承

フィルター レベルに適用されるフィルターを取得します。 既定のフィルター レベルはビジュアル レベルです。

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });

function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

パラメーター

戻り値

レポート内のページの一覧を取得します。ビジュアルではサポートされていません

function getPages(): Promise<Page[]>

戻り値

ビジュアル名、型などを含む埋め込みビジュアル記述子オブジェクトを取得します。

visual.getVisualDescriptor()
  .then(visualDetails => { ... });

function getVisualDescriptor(): Promise<VisualDescriptor>

戻り値

現在のフィルター レベルからすべてのフィルターを削除します。 既定のフィルター レベルはビジュアル レベルです。

visual.removeFilters(filtersLevel);

function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

フィルター レベルでフィルターを設定します。 既定のフィルター レベルはビジュアル レベルです。

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

レポートのアクティブなページを設定します。ビジュアルではサポートされていません

function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

フィルター レベルでフィルターを更新します。 既定のフィルター レベルはビジュアル レベルです。

const filters: [
   ...
];

visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
 .catch(errors => {
   ...
 });

function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

コンテキスト メニュー拡張機能コマンドを追加します。

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });

function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.addContextMenuCommand から継承されます

オプション メニュー拡張機能コマンドを追加します。

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });

function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.addOptionsMenuCommand から継承された

空のページをレポートに追加する

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");

function addPage(displayName?: string): Promise<Page>

パラメーター

戻り値

Report.addPage から継承された

レポートにテーマを適用する

report.applyTheme(theme);

function applyTheme(theme: IReportTheme): Promise<void>

パラメーター

戻り値

Report.applyTheme から継承された

レポートにユーザーのフィルター、スライサー、またはその他のデータ ビューの変更が適用されている場合に返します。 永続的なフィルターが無効な場合は、false を返します。

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

戻り値

Report.arePersistentFiltersApplied から継承された

選択したビジュアルがポップアウトされていない場合はクリアします。フラグが渡されると、すべてのビジュアルの選択がクリアされます。

report.clearSelectedVisuals()
 .then(() => {
     ...
 });

function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

パラメーター

戻り値

Report.clearSelectedVisuals から継承された

開いているすべてのコンテキスト メニューとツールヒントを閉じます。

report.closeAllOverlays()
 .then(() => {
     ...
 });

function closeAllOverlays(): Promise<void>

戻り値

Report.closeAllOverlays から継承されます

構成の変更を処理します。

function configChanged(isBootstrap: boolean)

パラメーター

Report.configChanged から継承された

レポートからページを削除する

// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");

function deletePage(pageName: string): Promise<void>

パラメーター

戻り値

Report.deletePage から継承された

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

function exitFullscreen()

から継承Report.exitFullscreen

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

function fullscreen()

Report.fullscreen から継承された

アクティブなレポート ページを取得します。

report.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

戻り値

Report.getActivePage から継承された

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

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

function getCorrelationId(): Promise<string>

戻り値

Report.getCorrelationId から継承された

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

function getId(): string

戻り値

Report.getId から継承された

レポート ページを名前で取得します。

report.getPageByName(pageName)
 .then(page => {
     ...
 });

function getPageByName(pageName: string): Promise<Page>

パラメーター

戻り値

Report.getPageByName から継承された

レポートのテーマを取得する

report.getTheme();

function getTheme(): Promise<IReportTheme>

戻り値

Report.getTheme から継承された

レポートの現在のズーム レベルを返します。

function getZoom(): Promise<number>

戻り値

Report.getZoom から継承された

は、レポートが保存されているかどうかを確認します。

report.isSaved()

function isSaved(): Promise<boolean>

戻り値

Report.isSaved から継承された

ページ内のビジュアルの位置を更新します。

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });

function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.moveVisual から継承された

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

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

パラメーター

Report.off から継承された

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

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

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

パラメーター

レポートから継承された .on

埋め込み iframe コンポーネントで window.print() を呼び出して、レポートのアクティブなページを出力します。

function print(): Promise<void>

戻り値

Report.print から継承された

レポートのデータ ソースを更新します。

report.refresh();

function refresh(): Promise<void>

戻り値

Report.refresh から継承

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

report.reload();

function reload(): Promise<void>

戻り値

Report.reload から継承された

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

function removeComponentTabIndex(_tabIndex?: number)

パラメーター

Report.removeComponentTabIndex から継承された

コンテキスト メニュー拡張機能コマンドを削除します。

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });

function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

report.removeContextMenuCommand から継承

オプション メニュー拡張機能コマンドを削除します。

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });

function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.removeOptionsMenuCommand から継承されます

レポートからページの名前を変更する

// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");

function renamePage(pageName: string, displayName: string): Promise<void>

パラメーター

戻り値

Report.renamePage から継承された

ユーザーのフィルター、スライサー、およびその他のデータ ビューの変更をレポートの既定の状態にリセットする

report.resetPersistentFilters();

function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>

戻り値

Report.resetPersistentFilters から継承された

レポートの既定のテーマをリセットして適用する

report.resetTheme();

function resetTheme(): Promise<void>

戻り値

Report.resetTheme から継承

レポート内のアクティブなページのサイズを更新します。

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });

function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.resizeActivePage から継承された

ページ内のビジュアルのサイズを変更します。

report.resizeVisual(pageName, visualName, width, height)
  .catch(error => { ... });

function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.resizeVisual から継承された

レポートを保存します。

function save(): Promise<void>

戻り値

Report.save から継承された

SaveAs レポート。

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

パラメーター

戻り値

Report.saveAs から継承された

レポートのユーザーのフィルター、スライサー、およびその他のデータ ビューの変更を保存する

report.savePersistentFilters();

function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>

戻り値

Report.savePersistentFilters から継承された

accessToken を設定します。

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

パラメーター

戻り値

Report.setAccessToken から継承された

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

function setComponentTabIndex(tabIndex?: number)

パラメーター

Report.setComponentTabIndex から継承

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

function setComponentTitle(title: string)

パラメーター

Report.setComponentTitle から継承された

ページ内のビジュアルの表示状態を更新します。

report.setVisualDisplayState(pageName, visualName, displayState)
  .catch(error => { ... });

function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.setVisualDisplayState から継承

レポートのズーム レベルを設定します。

function setZoom(zoomLevel: number): Promise<void>

パラメーター

戻り値

Report.setZoom から継承された

レポート レイアウトを更新します

report.switchLayout(layoutType);

function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.switchLayout から継承された

レポート ビュー モードを切り替えます。

function switchMode(viewMode: string | ViewMode): Promise<void>

パラメーター

戻り値

report.switchMode から継承

フィルター ウィンドウとページ ナビゲーション ウィンドウの表示設定を更新します。

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

Report.updateSettings から継承された