Report class

bookmarksManager: BookmarksManager

プロパティ値

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

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.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>>

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

report.applyTheme(theme);

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

パラメーター

戻り値

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

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

戻り値

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

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

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

パラメーター

戻り値

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

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

function closeAllOverlays(): Promise<void>

戻り値

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

function configChanged(isBootstrap: boolean)

パラメーター

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

// 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.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

戻り値

レポート レベルで適用されるフィルターを取得します。

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

戻り値

使用可能な最初の場所 (options、attribute、embed url) からレポート ID を取得します。

function getId(): string

戻り値

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

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

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

パラメーター

戻り値

レポート内のページの一覧を取得します。

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

戻り値

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

report.getTheme();

function getTheme(): Promise<IReportTheme>

戻り値

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

function getZoom(): Promise<number>

戻り値

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

report.isSaved()

function isSaved(): Promise<boolean>

戻り値

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

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

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

パラメーター

戻り値

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

function print(): Promise<void>

戻り値

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

report.refresh();

function refresh(): Promise<void>

戻り値

コンテキスト メニュー拡張機能の削除コマンド。

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

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

パラメーター

戻り値

レポート レベルのすべてのフィルターを削除します。

report.removeFilters();

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

戻り値

[オプションの削除] メニュー拡張機能コマンド。

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

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

パラメーター

戻り値

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

// 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>

パラメーター

戻り値

フェーズ埋め込み API を使用して事前に読み込まれたレポートをレンダリングする

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

パラメーター

戻り値

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

report.resetPersistentFilters();

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

戻り値

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

report.resetTheme();

function resetTheme(): Promise<void>

戻り値

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

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

report.savePersistentFilters();

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

戻り値

レポート レベルでフィルターを設定します。

const filters: [
   ...
];

report.setFilters(filters)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

パラメーター

戻り値

レポートのアクティブなページを設定します。

report.setPage("page2")
 .catch(error => { ... });

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

レポート レイアウトを更新する

report.switchLayout(layoutType);

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

パラメーター

戻り値

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

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

パラメーター

戻り値

操作に従ってレポート レベルでフィルターを更新します。追加、すべて置換、ターゲットで置き換えるか、削除します。

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

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

パラメーター

戻り値

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

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

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

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

パラメーター

戻り値

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

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 Report。

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