次の方法で共有

Page class

  • リファレンス
パッケージ:
powerbi-client

Power BI レポート ページ

プロパティ

background

ページの背景色。
defaultDisplayOption

レポートに保存されているページ表示オプション。
defaultSize

レポートに保存されているページ サイズ。
displayName

レポート ページのユーザー定義の表示名。ページが手動で作成された場合は未定義です。
isActive

このページはアクティブなページか
mobileSize

レポートに保存されているモバイル ビューのページ サイズ (定義されている場合)。
name

レポート ページ名
report

このページがメンバーになっている親 Power BI レポート
visibility

ページの可視性。 0 - 常に表示 1 - 表示モードで非表示
wallpaper

ページの壁紙の色。

メソッド

delete()

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

// Delete the page from the report
page.delete();
getFilters()

レポート内のすべてのページ レベル フィルターを取得します。

page.getFilters()
 .then(filters => { ... });
getSlicers()

ページ上のスライサー ビジュアルの一覧を取得します。

page.getSlicers()
 .then(slicers => {
     ...
 });
getSmartNarrativeInsights()

レポート ページの分析情報を取得する

page.getSmartNarrativeInsights();
getVisualByName(string)

ページ上の名前でビジュアルを取得します。

page.getVisualByName(visualName: string)
 .then(visual => {
     ...
 });
getVisuals()

ページ上のすべてのビジュアルを取得します。

page.getVisuals()
  .then(visuals => { ... });
hasLayout(LayoutType)

ページにレイアウトがあるかどうかを確認します。

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)

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

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

レポートのこのページからすべてのフィルターを削除します。

page.removeFilters();
resizePage(PageSizeType, number, number)

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

page.resizePage(pageSizeType, width, height)
  .catch(error => { ... });
resizeVisual(string, number, number)

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

page.resizeVisual(visualName, width, height)
  .catch(error => { ... });
setActive()

現在のページをレポートのアクティブ ページにします。

page.setActive();
setDisplayName(string)

displayName を現在のページに設定します。

page.setName(displayName);
setFilters(IFilter[])

現在のページのすべてのフィルターを設定します。

page.setFilters(filters)
  .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)

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

page.setVisualDisplayState(visualName, displayState)
  .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])

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

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

プロパティの詳細

background

ページの背景色。

background: IPageBackground

プロパティ値

IPageBackground

defaultDisplayOption

レポートに保存されているページ表示オプション。

defaultDisplayOption: DisplayOption

プロパティ値

DisplayOption

defaultSize

レポートに保存されているページ サイズ。

defaultSize: ICustomPageSize

プロパティ値

ICustomPageSize

displayName

レポート ページのユーザー定義の表示名。ページが手動で作成された場合は未定義です。

displayName: string

プロパティ値

string

isActive

このページはアクティブなページか

isActive: boolean

プロパティ値

boolean

mobileSize

レポートに保存されているモバイル ビューのページ サイズ (定義されている場合)。

mobileSize: ICustomPageSize

プロパティ値

ICustomPageSize

name

レポート ページ名

name: string

プロパティ値

string

report

このページがメンバーになっている親 Power BI レポート

report: IReportNode

プロパティ値

IReportNode

visibility

ページの可視性。 0 - 常に表示 1 - 表示モードで非表示

visibility: SectionVisibility

プロパティ値

SectionVisibility

wallpaper

ページの壁紙の色。

wallpaper: IPageWallpaper

プロパティ値

IPageWallpaper

メソッドの詳細

delete()

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

// Delete the page from the report
page.delete();

function delete(): Promise<void>

戻り値

Promise<void>

getFilters()

レポート内のすべてのページ レベル フィルターを取得します。

page.getFilters()
 .then(filters => { ... });

function getFilters(): Promise<IFilter[]>

戻り値

Promise<IFilter[]>

getSlicers()

ページ上のスライサー ビジュアルの一覧を取得します。

page.getSlicers()
 .then(slicers => {
     ...
 });

function getSlicers(): Promise<IVisual[]>

戻り値

Promise<IVisual[]>

getSmartNarrativeInsights()

レポート ページの分析情報を取得する

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

戻り値

Promise<ISmartNarratives>

getVisualByName(string)

ページ上の名前でビジュアルを取得します。

page.getVisualByName(visualName: string)
 .then(visual => {
     ...
 });

function getVisualByName(visualName: string): Promise<VisualDescriptor>

パラメーター

visualName

string

戻り値

Promise<VisualDescriptor>

getVisuals()

ページ上のすべてのビジュアルを取得します。

page.getVisuals()
  .then(visuals => { ... });

function getVisuals(): Promise<VisualDescriptor[]>

戻り値

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

ページにレイアウトがあるかどうかを確認します。

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });

function hasLayout(layoutType: LayoutType): Promise<boolean>

パラメーター

layoutType
LayoutType

戻り値

Promise<boolean>

moveVisual(string, number, number, number)

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

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

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

パラメーター

visualName

string

x

number

y

number

z

number

戻り値

Promise<IHttpPostMessageResponse<void>>

removeFilters()

レポートのこのページからすべてのフィルターを削除します。

page.removeFilters();

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

戻り値

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

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

page.resizePage(pageSizeType, width, height)
  .catch(error => { ... });

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

パラメーター

pageSizeType
PageSizeType
width

number

height

number

戻り値

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

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

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

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

パラメーター

visualName

string

width

number

height

number

戻り値

Promise<IHttpPostMessageResponse<void>>

setActive()

現在のページをレポートのアクティブ ページにします。

page.setActive();

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

戻り値

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

displayName を現在のページに設定します。

page.setName(displayName);

function setDisplayName(displayName: string): Promise<IHttpPostMessageResponse<void>>

パラメーター

displayName

string

戻り値

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

現在のページのすべてのフィルターを設定します。

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

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

パラメーター

filters

IFilter[]

戻り値

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

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

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

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

パラメーター

visualName

string

displayState
VisualContainerDisplayMode

戻り値

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

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

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

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

パラメーター

operation
FiltersOperations
filters

IFilter[]

戻り値

Promise<IHttpPostMessageResponse<void>>