QuickCreate class
Power BI クイック作成コンポーネント
- Extends
-
Embed
コンストラクター
Quick |
メソッド
get |
GetId 抽象関数をオーバーライドする QuickCreate には ID は必要ありません |
validate(IEmbed |
レポートの作成構成を検証します。 |
継承されたメソッド
exit |
全画面表示モードを終了するようにブラウザーに要求します。 |
fullscreen() | コンポーネントの iframe を全画面表示モードでレンダリングするようにブラウザーに要求します。 |
get |
現在の埋め込みセッションの correlationId を取得します。
|
off<T>(string, IEvent |
ハンドラーの一覧から 1 つ以上のイベント ハンドラーを削除します。 既存のハンドル関数への参照が指定されている場合は、特定のハンドラーを削除します。 ハンドラーが指定されていない場合は、指定されたイベント名のすべてのハンドラーを削除します。
|
on<T>(string, IEvent |
特定のイベントのイベント ハンドラーを追加します。
|
reload() | 既存の構成を使用して埋め込みを再読み込みします。 たとえば、レポートの場合、これは効果的にすべてのフィルターをクリアし、レポートを読み込まれた状態にリセットすることをシミュレートする最初のページをアクティブにします。
|
remove |
要素の tabindex 属性を削除します。 |
save() | レポートを保存します。 |
save |
SaveAs レポート。 |
set |
accessToken を設定します。 |
set |
要素の tabindex 属性を設定します。 |
set |
アクセシビリティのコンポーネント タイトルを設定します。 iframe の場合、このメソッドは iframe タイトルを変更します。 |
コンストラクターの詳細
QuickCreate(Service, HTMLElement, IQuickCreateConfiguration, boolean, boolean)
new QuickCreate(service: Service, element: HTMLElement, config: IQuickCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)
パラメーター
- service
- Service
- element
-
HTMLElement
- config
- IQuickCreateConfiguration
- phasedRender
-
boolean
- isBootstrap
-
boolean
メソッドの詳細
getId()
GetId 抽象関数をオーバーライドする QuickCreate には ID は必要ありません
function getId(): string
戻り値
string
validate(IEmbedConfigurationBase)
レポートの作成構成を検証します。
function validate(config: IEmbedConfigurationBase): IError[]
パラメーター
- config
- IEmbedConfigurationBase
戻り値
IError[]
継承済みメソッドの詳細
exitFullscreen()
全画面表示モードを終了するようにブラウザーに要求します。
function exitFullscreen()
Embed.exitFullscreen から継承された
fullscreen()
コンポーネントの iframe を全画面表示モードでレンダリングするようにブラウザーに要求します。
function fullscreen()
Embed.fullscreen から継承された
getCorrelationId()
現在の埋め込みセッションの correlationId を取得します。
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
戻り値
Promise<string>
Embed.getCorrelationId から継承された
off<T>(string, IEventHandler<T>)
ハンドラーの一覧から 1 つ以上のイベント ハンドラーを削除します。 既存のハンドル関数への参照が指定されている場合は、特定のハンドラーを削除します。 ハンドラーが指定されていない場合は、指定されたイベント名のすべてのハンドラーを削除します。
report.off('pageChanged')
or
const logHandler = function (event) {
console.log(event);
};
report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)
パラメーター
- eventName
-
string
- handler
-
IEventHandler<T>
Embed.off から継承された
on<T>(string, IEventHandler<T>)
特定のイベントのイベント ハンドラーを追加します。
report.on('pageChanged', (event) => {
console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)
パラメーター
- eventName
-
string
- handler
-
IEventHandler<T>
Embed.on から継承された
reload()
既存の構成を使用して埋め込みを再読み込みします。 たとえば、レポートの場合、これは効果的にすべてのフィルターをクリアし、レポートを読み込まれた状態にリセットすることをシミュレートする最初のページをアクティブにします。
report.reload();
function reload(): Promise<void>
戻り値
Promise<void>
Embed.reload から継承された
removeComponentTabIndex(number)
要素の tabindex 属性を削除します。
function removeComponentTabIndex(_tabIndex?: number)
パラメーター
- _tabIndex
-
number
Embed.removeComponentTabIndex から継承された
save()
レポートを保存します。
function save(): Promise<void>
戻り値
Promise<void>
Embed.save から継承された
saveAs(ISaveAsParameters)
SaveAs レポート。
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
パラメーター
- saveAsParameters
- ISaveAsParameters
戻り値
Promise<void>
Embed.saveAs から継承された
setAccessToken(string)
accessToken を設定します。
function setAccessToken(accessToken: string): Promise<void>
パラメーター
- accessToken
-
string
戻り値
Promise<void>
Embed.setAccessToken から継承された
setComponentTabIndex(number)
要素の tabindex 属性を設定します。
function setComponentTabIndex(tabIndex?: number)
パラメーター
- tabIndex
-
number
Embed.setComponentTabIndex から継承された
setComponentTitle(string)
アクセシビリティのコンポーネント タイトルを設定します。 iframe の場合、このメソッドは iframe タイトルを変更します。
function setComponentTitle(title: string)
パラメーター
- title
-
string
Embed.setComponentTitle から継承された