Udostępnij za pośrednictwem

Create class

  • Odwołanie
Pakiet:
powerbi-client

Składnik twórcy raportów usługi Power BI

Rozszerzenie

Embed

Konstruktory

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

Metody

getId()

Pobiera identyfikator zestawu danych z pierwszej dostępnej lokalizacji: createConfig lub adres URL osadzania.
isSaved()

sprawdza, czy raport jest zapisany.

report.isSaved()
validate(IEmbedConfigurationBase)

Zweryfikuj konfigurację tworzenia raportu.

Metody dziedziczone

exitFullscreen()

Żąda, aby przeglądarka zakończyła tryb pełnoekranowy.
fullscreen()

Żąda przeglądarki renderowania elementu iframe składnika w trybie pełnoekranowym.
getCorrelationId()

Pobierz identyfikator correlationId dla bieżącej sesji osadzania.

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

Usuwa co najmniej jeden program obsługi zdarzeń z listy procedur obsługi. Jeśli określono odwołanie do istniejącej funkcji dojścia, usuń określoną procedurę obsługi. Jeśli program obsługi nie zostanie określony, usuń wszystkie programy obsługi dla określonej nazwy zdarzenia.

report.off('pageChanged')

or

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

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

Dodaje procedurę obsługi zdarzeń dla określonego zdarzenia.

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

Ponownie ładuje osadzanie przy użyciu istniejącej konfiguracji. Na przykład w przypadku raportów skutecznie usuwa wszystkie filtry i uaktywnia pierwszą stronę, która symuluje zresetowanie raportu z powrotem do stanu załadowanego.

report.reload();
removeComponentTabIndex(number)

Usuwa atrybut tabindex elementu
save()

Zapisuje raport.
saveAs(ISaveAsParameters)

ZapiszAs raport.
setAccessToken(string)

Ustaw wartość accessToken.
setComponentTabIndex(number)

Ustawia atrybut tabindex elementu
setComponentTitle(string)

Ustaw tytuł składnika pod kątem ułatwień dostępu. W przypadku elementów iframe ta metoda zmieni tytuł elementu iframe.

Szczegóły konstruktora

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

Szczegóły metody

getId()

Pobiera identyfikator zestawu danych z pierwszej dostępnej lokalizacji: createConfig lub adres URL osadzania.

function getId(): string

Zwraca

string

isSaved()

sprawdza, czy raport jest zapisany.

report.isSaved()

function isSaved(): Promise<boolean>

Zwraca

Promise<boolean>

validate(IEmbedConfigurationBase)

Zweryfikuj konfigurację tworzenia raportu.

function validate(config: IEmbedConfigurationBase): IError[]

Parametry

config
IEmbedConfigurationBase

Zwraca

IError[]

Szczegóły metody dziedziczonej

exitFullscreen()

Żąda, aby przeglądarka zakończyła tryb pełnoekranowy.

function exitFullscreen()

dziedziczone z Embed.exitFullscreen

fullscreen()

Żąda przeglądarki renderowania elementu iframe składnika w trybie pełnoekranowym.

function fullscreen()

dziedziczone z Embed.fullscreen

getCorrelationId()

Pobierz identyfikator correlationId dla bieżącej sesji osadzania.

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

function getCorrelationId(): Promise<string>

Zwraca

Promise<string>

dziedziczone z Embed.getCorrelationId

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

Usuwa co najmniej jeden program obsługi zdarzeń z listy procedur obsługi. Jeśli określono odwołanie do istniejącej funkcji dojścia, usuń określoną procedurę obsługi. Jeśli program obsługi nie zostanie określony, usuń wszystkie programy obsługi dla określonej nazwy zdarzenia.

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>

dziedziczone z Embed.off

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

Dodaje procedurę obsługi zdarzeń dla określonego zdarzenia.

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

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

Parametry

eventName

string

handler

IEventHandler<T>

dziedziczone z Embed.on

reload()

Ponownie ładuje osadzanie przy użyciu istniejącej konfiguracji. Na przykład w przypadku raportów skutecznie usuwa wszystkie filtry i uaktywnia pierwszą stronę, która symuluje zresetowanie raportu z powrotem do stanu załadowanego.

report.reload();

function reload(): Promise<void>

Zwraca

Promise<void>

dziedziczone z Embed.reload

removeComponentTabIndex(number)

Usuwa atrybut tabindex elementu

function removeComponentTabIndex(_tabIndex?: number)

Parametry

_tabIndex

number

dziedziczone z Embed.removeComponentTabIndex

save()

Zapisuje raport.

function save(): Promise<void>

Zwraca

Promise<void>

dziedziczone z Embed.save

saveAs(ISaveAsParameters)

ZapiszAs raport.

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

Parametry

saveAsParameters
ISaveAsParameters

Zwraca

Promise<void>

dziedziczone z Embed.saveAs

setAccessToken(string)

Ustaw wartość accessToken.

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

Parametry

accessToken

string

Zwraca

Promise<void>

dziedziczone z Embed.setAccessToken

setComponentTabIndex(number)

Ustawia atrybut tabindex elementu

function setComponentTabIndex(tabIndex?: number)

Parametry

tabIndex

number

dziedziczone z Embed.setComponentTabIndex

setComponentTitle(string)

Ustaw tytuł składnika pod kątem ułatwień dostępu. W przypadku elementów iframe ta metoda zmieni tytuł elementu iframe.

function setComponentTitle(title: string)

Parametry

title

string

dziedziczone z Embed.setComponentTitle