Sdílet prostřednictvím

Create class

  • Reference
Balíček:
powerbi-client

Komponenta tvůrce sestav Power BI

Extends

Embed

Konstruktory

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

Metody

getId()

Získá ID datové sady z prvního dostupného umístění: createConfig nebo embed url.
isSaved()

zkontroluje, jestli je sestava uložená.

report.isSaved()
validate(IEmbedConfigurationBase)

Ověřte konfiguraci vytvoření sestavy.

Zděděné metody

exitFullscreen()

Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce.
fullscreen()

Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu celé obrazovky.
getCorrelationId()

Získejte ID korelace pro aktuální relaci vložení.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
off<T>(string, IEventHandler<T>)

Odebere jeden nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud není zadaná obslužná rutina, odeberte všechny obslužné rutiny pro zadaný název události.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)

Přidá obslužnou rutinu události pro konkrétní událost.

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

Znovu načte vložení pomocí existující konfigurace. Například u sestav to efektivně vymaže všechny filtry a aktivuje první stránku, která simuluje resetování sestavy zpět do načteného stavu.

report.reload();
removeComponentTabIndex(number)

Odebere atribut tabindex elementu.
save()

Uloží sestavu.
saveAs(ISaveAsParameters)

Sestava SaveAs
setAccessToken(string)

Nastavte accessToken.
setComponentTabIndex(number)

Nastaví atribut tabindex elementu.
setComponentTitle(string)

Nastavte název komponenty pro usnadnění přístupu. V případě elementů iframe tato metoda změní název prvku iframe.

Podrobnosti konstruktoru

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean) 

new Create(service: Service, element: HTMLElement, config: IEmbedConfiguration | IReportCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

Parametry

service
Service
element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

Podrobnosti metody

getId()

Získá ID datové sady z prvního dostupného umístění: createConfig nebo embed url.

function getId(): string

Návraty

string

isSaved()

zkontroluje, jestli je sestava uložená.

report.isSaved()

function isSaved(): Promise<boolean>

Návraty

Promise<boolean>

validate(IEmbedConfigurationBase)

Ověřte konfiguraci vytvoření sestavy.

function validate(config: IEmbedConfigurationBase): IError[]

Parametry

config
IEmbedConfigurationBase

Návraty

IError[]

Podrobnosti zděděných metod

exitFullscreen()

Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce.

function exitFullscreen()

zděděný z obrazovky Embed.exitFullscreen

fullscreen()

Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu celé obrazovky.

function fullscreen()

zděděno z obrazovky Embed.fullscreen

getCorrelationId()

Získejte ID korelace pro aktuální relaci vložení.

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

function getCorrelationId(): Promise<string>

Návraty

Promise<string>

zděděno z Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

Odebere jeden nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud není zadaná obslužná rutina, odeberte všechny obslužné rutiny pro zadaný název události.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametry

eventName

string

handler

IEventHandler<T>

zděděno z Embed.off

on<T>(string, IEventHandler<T>)

Přidá obslužnou rutinu události pro konkrétní událost.

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

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

Parametry

eventName

string

handler

IEventHandler<T>

zděděno z Embed.on

reload()

Znovu načte vložení pomocí existující konfigurace. Například u sestav to efektivně vymaže všechny filtry a aktivuje první stránku, která simuluje resetování sestavy zpět do načteného stavu.

report.reload();

function reload(): Promise<void>

Návraty

Promise<void>

zděděno ze souboru Embed.reload

removeComponentTabIndex(number)

Odebere atribut tabindex elementu.

function removeComponentTabIndex(_tabIndex?: number)

Parametry

_tabIndex

number

zděděno z Embed.removeComponentTabIndex

save()

Uloží sestavu.

function save(): Promise<void>

Návraty

Promise<void>

zděděno z Embed.save

saveAs(ISaveAsParameters)

Sestava SaveAs

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

Parametry

saveAsParameters
ISaveAsParameters

Návraty

Promise<void>

zděděno z Embed.saveAs

setAccessToken(string)

Nastavte accessToken.

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

Parametry

accessToken

string

Návraty

Promise<void>

zděděno z Embed.setAccessToken

setComponentTabIndex(number)

Nastaví atribut tabindex elementu.

function setComponentTabIndex(tabIndex?: number)

Parametry

tabIndex

number

zděděno z Embed.setComponentTabIndex

setComponentTitle(string)

Nastavte název komponenty pro usnadnění přístupu. V případě elementů iframe tato metoda změní název prvku iframe.

function setComponentTitle(title: string)

Parametry

title

string

zděděno z Embed.setComponentTitle