Delen via

Create class

Pakket:
powerbi-client

Een Power BI Report Creator-onderdeel

Uitbreiding

Embed

Constructors

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

Methoden

getId()

Haalt de gegevensset-id op van de eerste beschikbare locatie: createConfig of embed URL.
isSaved()

controleert of het rapport is opgeslagen.

report.isSaved()
validate(IEmbedConfigurationBase)

Valideer de rapportconfiguratie maken.

Overgenomen methoden

exitFullscreen()

Vraagt de browser om de modus Volledig scherm af te sluiten.
fullscreen()

Vraagt de browser om het iframe van het onderdeel weer te geven in de modus Volledig scherm.
getCorrelationId()

Haal de correlationId op voor de huidige insluitingssessie.

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

Hiermee verwijdert u een of meer gebeurtenis-handlers uit de lijst met handlers. Als er een verwijzing naar de bestaande handle-functie is opgegeven, verwijdert u de specifieke handler. Als de handler niet is opgegeven, verwijdert u alle handlers voor de opgegeven gebeurtenisnaam.

report.off('pageChanged')

or

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

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

Hiermee voegt u een gebeurtenis-handler toe voor een specifieke gebeurtenis.

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

Hiermee wordt het insluiten opnieuw geladen met behulp van een bestaande configuratie. Voor rapporten worden bijvoorbeeld alle filters gewist en wordt de eerste pagina actief, waardoor het opnieuw instellen van een rapport wordt gesimuleerd naar de geladen status.

report.reload();
removeComponentTabIndex(number)

Het tabbladindexkenmerk van het element verwijderen
save()

Slaat het rapport op.
saveAs(ISaveAsParameters)

SaveAs-rapport.
setAccessToken(string)

Stel accessToken in.
setComponentTabIndex(number)

Het kenmerk TabIndex van het element instellen
setComponentTitle(string)

Stel de onderdeeltitel in voor toegankelijkheid. In het geval van iframes wordt met deze methode de titel van het iframe gewijzigd.

Constructordetails

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

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

Parameters

service
Service
element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

Methodedetails

getId()

Haalt de gegevensset-id op van de eerste beschikbare locatie: createConfig of embed URL.

function getId(): string

Retouren

string

isSaved()

controleert of het rapport is opgeslagen.

report.isSaved()

function isSaved(): Promise<boolean>

Retouren

Promise<boolean>

validate(IEmbedConfigurationBase)

Valideer de rapportconfiguratie maken.

function validate(config: IEmbedConfigurationBase): IError[]

Parameters

config
IEmbedConfigurationBase

Retouren

IError[]

Details overgenomen methode

exitFullscreen()

Vraagt de browser om de modus Volledig scherm af te sluiten.

function exitFullscreen()

overgenomen van Embed.exitFullscreen

fullscreen()

Vraagt de browser om het iframe van het onderdeel weer te geven in de modus Volledig scherm.

function fullscreen()

overgenomen van Embed.fullscreen

getCorrelationId()

Haal de correlationId op voor de huidige insluitingssessie.

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

function getCorrelationId(): Promise<string>

Retouren

Promise<string>

overgenomen van Embed.getCorrelationId

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

Hiermee verwijdert u een of meer gebeurtenis-handlers uit de lijst met handlers. Als er een verwijzing naar de bestaande handle-functie is opgegeven, verwijdert u de specifieke handler. Als de handler niet is opgegeven, verwijdert u alle handlers voor de opgegeven gebeurtenisnaam.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parameters

eventName

string

handler

IEventHandler<T>

overgenomen van Embed.off

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

Hiermee voegt u een gebeurtenis-handler toe voor een specifieke gebeurtenis.

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

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

Parameters

eventName

string

handler

IEventHandler<T>

overgenomen van Embed.on

reload()

Hiermee wordt het insluiten opnieuw geladen met behulp van een bestaande configuratie. Voor rapporten worden bijvoorbeeld alle filters gewist en wordt de eerste pagina actief, waardoor het opnieuw instellen van een rapport wordt gesimuleerd naar de geladen status.

report.reload();

function reload(): Promise<void>

Retouren

Promise<void>

overgenomen van Embed.reload

removeComponentTabIndex(number)

Het tabbladindexkenmerk van het element verwijderen

function removeComponentTabIndex(_tabIndex?: number)

Parameters

_tabIndex

number

overgenomen van Embed.removeComponentTabIndex

save()

Slaat het rapport op.

function save(): Promise<void>

Retouren

Promise<void>

overgenomen van Embed.save

saveAs(ISaveAsParameters)

SaveAs-rapport.

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

Parameters

saveAsParameters
ISaveAsParameters

Retouren

Promise<void>

overgenomen van Embed.saveAs

setAccessToken(string)

Stel accessToken in.

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

Parameters

accessToken

string

Retouren

Promise<void>

overgenomen van Embed.setAccessToken

setComponentTabIndex(number)

Het kenmerk TabIndex van het element instellen

function setComponentTabIndex(tabIndex?: number)

Parameters

tabIndex

number

overgenomen van Embed.setComponentTabIndex

setComponentTitle(string)

Stel de onderdeeltitel in voor toegankelijkheid. In het geval van iframes wordt met deze methode de titel van het iframe gewijzigd.

function setComponentTitle(title: string)

Parameters

title

string

Overgenomen van Embed.setComponentTitle