Report class

Paquete:

powerbi-client

Componente de inserción de informes de Power BI

Extends

Embed

Propiedades

bookmarksManager

Métodos

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)	Agregue el comando de extensión del menú contextual. report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName) .catch(error => { ... });
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)	Comando agregar opciones de extensión de menú. report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon) .catch(error => { ... });
addPage(string)	Agregar una página vacía al informe // Add a page to the report with "Sales" as the page display name report.addPage("Sales");
applyTheme(IReportTheme)	Aplicar un tema al informe report.applyTheme(theme);
arePersistentFiltersApplied()	Devuelve si hay filtros, segmentaciones de datos u otros cambios de vista de datos aplicados en el informe. Si los filtros persistentes están deshabilitados, devuelve false. report.arePersistentFiltersApplied();
clearSelectedVisuals(boolean)	Borra los objetos visuales seleccionados no extraídos, si se pasa la marca, se borrarán todas las selecciones de objetos visuales. report.clearSelectedVisuals() .then(() => { ... });
closeAllOverlays()	Cierra todos los menús contextuales abiertos y la información sobre herramientas. report.closeAllOverlays() .then(() => { ... });
configChanged(boolean)	Controle los cambios de configuración.
deletePage(string)	Eliminar una página de un informe // Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API) report.deletePage("ReportSection145");
getActivePage()	Obtiene la página del informe activo. report.getActivePage() .then(activePage => { ... });
getFilters()	Obtiene filtros que se aplican en el nivel de informe. // Get filters applied at report level report.getFilters() .then(filters => { ... });
getId()	Obtiene el identificador de informe de la primera ubicación disponible: opciones, atributo, dirección URL de inserción.
getPageByName(string)	Obtiene una página de informe por su nombre. report.getPageByName(pageName) .then(page => { ... });
getPages()	Obtiene la lista de páginas del informe. report.getPages() .then(pages => { ... });
getTheme()	obtener el tema del informe report.getTheme();
getZoom()	Devuelve el nivel de zoom actual del informe.
isSaved()	comprueba si el informe se guarda. report.isSaved()
moveVisual(string, string, number, number, number)	Actualiza la posición de un objeto visual en una página. report.moveVisual(pageName, visualName, x, y, z) .catch(error => { ... });
print()	Imprime la página activa del informe invocando window.print() en el componente insertar iframe.
refresh()	Actualiza los orígenes de datos del informe. report.refresh();
removeContextMenuCommand(string, string)	Quite el comando de extensión del menú contextual. report.removeContextMenuCommand(commandName, contextMenuTitle) .catch(error => { ... });
removeFilters()	Quita todos los filtros en el nivel de informe. report.removeFilters();
removeOptionsMenuCommand(string, string)	Comando de extensión de menú Quitar opciones. report.removeOptionsMenuCommand(commandName, optionsMenuTitle) .then({ ... });
renamePage(string, string)	Cambiar el nombre de una página de un informe // Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API) report.renamePage("ReportSection145", "Sales");
render(IReportEmbedConfiguration | IReportLoadConfiguration)	Representación de un informe precargado mediante la API de inserción por fases // Load report var report = powerbi.load(element, config); ... // Render report report.render()
resetPersistentFilters()	Restablecer los filtros, segmentaciones de datos y otros cambios de vista de datos del usuario en el estado predeterminado del informe report.resetPersistentFilters();
resetTheme()	Restablecer y aplicar el tema predeterminado del informe report.resetTheme();
resizeActivePage(PageSizeType, number, number)	Actualiza el tamaño de la página activa en el informe. report.resizeActivePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, string, number, number)	Cambiar el tamaño de un objeto visual en una página. report.resizeVisual(pageName, visualName, width, height) .catch(error => { ... });
savePersistentFilters()	Guardar los filtros, segmentaciones de datos y otros cambios en la vista de datos del informe report.savePersistentFilters();
setFilters(IFilter[])	Establece filtros en el nivel de informe. const filters: [ ... ]; report.setFilters(filters) .catch(errors => { ... });
setPage(string)	Establece la página activa del informe. report.setPage("page2") .catch(error => { ... });
setVisualDisplayState(string, string, VisualContainerDisplayMode)	Actualiza el estado de visualización de un objeto visual en una página. report.setVisualDisplayState(pageName, visualName, displayState) .catch(error => { ... });
setZoom(number)	Establece el nivel de zoom del informe.
switchLayout(LayoutType)	Actualiza el diseño del informe report.switchLayout(layoutType);
switchMode(string | ViewMode)	Cambie el modo de vista Informe.
updateFilters(FiltersOperations, IFilter[])	Actualice los filtros en el nivel de informe según la operación: agregue, reemplace todo, reemplace por destino o quite. report.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });
updateSettings(ISettings)	Actualiza la configuración de visibilidad para el panel de filtro y el panel de navegación de páginas. const newSettings = { panes: { filters: { visible: false } } }; report.updateSettings(newSettings) .catch(error => { ... });

Métodos heredados

exitFullscreen()	Solicita al explorador que salga del modo de pantalla completa.
fullscreen()	Solicita al explorador que represente el iframe del componente en modo de pantalla completa.
getCorrelationId()	Obtenga el correlationId para la sesión de inserción actual. // Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });
off<T>(string, IEventHandler<T>)	Quita uno o varios controladores de eventos de la lista de controladores. Si se especifica una referencia a la función de controlador existente, quite el controlador específico. Si no se especifica el controlador, quite todos los controladores para el nombre de evento especificado. report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)	Agrega un controlador de eventos para un evento específico. report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });
reload()	Vuelve a cargar la inserción mediante la configuración existente. Por ejemplo, para los informes, esto borra eficazmente todos los filtros y hace que la primera página esté activa que simula restablecer un informe de nuevo al estado cargado. report.reload();
removeComponentTabIndex(number)	Quita el atributo tabindex del elemento.
save()	Guarda informe.
saveAs(ISaveAsParameters)	SaveAs Report.
setAccessToken(string)	Establezca accessToken.
setComponentTabIndex(number)	Establece el atributo tabindex del elemento
setComponentTitle(string)	Establezca el título del componente para accesibilidad. En el caso de iframes, este método cambiará el título del iframe.

Detalles de las propiedades

bookmarksManager

bookmarksManager: BookmarksManager

Valor de propiedad

BookmarksManager

Detalles del método

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

Agregue el comando de extensión del menú contextual.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });

function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>

Parámetros

commandName

string

commandTitle

string

contextMenuTitle

string

menuLocation

MenuLocation

visualName

string

visualType

string

groupName

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Comando agregar opciones de extensión de menú.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });

function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>

Parámetros

commandName

string

commandTitle

string

optionsMenuTitle

string

menuLocation

MenuLocation

visualName

string

visualType

string

groupName

string

commandIcon

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

addPage(string)

Agregar una página vacía al informe

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");

function addPage(displayName?: string): Promise<Page>

Parámetros

displayName

string

Devoluciones

Promise<Page>

applyTheme(IReportTheme)

Aplicar un tema al informe

report.applyTheme(theme);

function applyTheme(theme: IReportTheme): Promise<void>

Parámetros

theme

IReportTheme

Devoluciones

Promise<void>

arePersistentFiltersApplied()

Devuelve si hay filtros, segmentaciones de datos u otros cambios de vista de datos aplicados en el informe. Si los filtros persistentes están deshabilitados, devuelve false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Devoluciones

Promise<boolean>

clearSelectedVisuals(boolean)

Borra los objetos visuales seleccionados no extraídos, si se pasa la marca, se borrarán todas las selecciones de objetos visuales.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });

function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Parámetros

clearPopOutState

boolean

Si la selección de objetos visuales false/no definidos no se borrará si uno de los objetos visuales está en estado emergente (en el foco, mostrar como tabla, contenido destacado...)

Devoluciones

Promise<void>

closeAllOverlays()

Cierra todos los menús contextuales abiertos y la información sobre herramientas.

report.closeAllOverlays()
 .then(() => {
     ...
 });

function closeAllOverlays(): Promise<void>

Devoluciones

Promise<void>

configChanged(boolean)

Controle los cambios de configuración.

function configChanged(isBootstrap: boolean)

Parámetros

isBootstrap

boolean

deletePage(string)

Eliminar una página de un informe

// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");

function deletePage(pageName: string): Promise<void>

Parámetros

pageName

string

Devoluciones

Promise<void>

getActivePage()

Obtiene la página del informe activo.

report.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

Devoluciones

Promise<Page>

getFilters()

Obtiene filtros que se aplican en el nivel de informe.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

Devoluciones

Promise<IFilter[]>

getId()

Obtiene el identificador de informe de la primera ubicación disponible: opciones, atributo, dirección URL de inserción.

function getId(): string

Devoluciones

string

getPageByName(string)

Obtiene una página de informe por su nombre.

report.getPageByName(pageName)
 .then(page => {
     ...
 });

function getPageByName(pageName: string): Promise<Page>

Parámetros

pageName

string

Devoluciones

Promise<Page>

getPages()

Obtiene la lista de páginas del informe.

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

Devoluciones

Promise<Page[]>

getTheme()

obtener el tema del informe

report.getTheme();

function getTheme(): Promise<IReportTheme>

Devoluciones

Promise<IReportTheme>

getZoom()

Devuelve el nivel de zoom actual del informe.

function getZoom(): Promise<number>

Devoluciones

Promise<number>

isSaved()

comprueba si el informe se guarda.

report.isSaved()

function isSaved(): Promise<boolean>

Devoluciones

Promise<boolean>

moveVisual(string, string, number, number, number)

Actualiza la posición de un objeto visual en una página.

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

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

Parámetros

pageName

string

visualName

string

x

number

y

number

z

number

Devoluciones

Promise<IHttpPostMessageResponse<void>>

print()

Imprime la página activa del informe invocando window.print() en el componente insertar iframe.

function print(): Promise<void>

Devoluciones

Promise<void>

refresh()

Actualiza los orígenes de datos del informe.

report.refresh();

function refresh(): Promise<void>

Devoluciones

Promise<void>

removeContextMenuCommand(string, string)

Quite el comando de extensión del menú contextual.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });

function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parámetros

commandName

string

contextMenuTitle

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Quita todos los filtros en el nivel de informe.

report.removeFilters();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Comando de extensión de menú Quitar opciones.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });

function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parámetros

commandName

string

optionsMenuTitle

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

renamePage(string, string)

Cambiar el nombre de una página de un informe

// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");

function renamePage(pageName: string, displayName: string): Promise<void>

Parámetros

pageName

string

displayName

string

Devoluciones

Promise<void>

render(IReportEmbedConfiguration | IReportLoadConfiguration)

Representación de un informe precargado mediante la API de inserción por fases

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

Parámetros

config

IReportEmbedConfiguration | IReportLoadConfiguration

Devoluciones

Promise<void>

resetPersistentFilters()

Restablecer los filtros, segmentaciones de datos y otros cambios de vista de datos del usuario en el estado predeterminado del informe

report.resetPersistentFilters();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

resetTheme()

Restablecer y aplicar el tema predeterminado del informe

report.resetTheme();

function resetTheme(): Promise<void>

Devoluciones

Promise<void>

resizeActivePage(PageSizeType, number, number)

Actualiza el tamaño de la página activa en el informe.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });

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

Parámetros

pageSizeType

PageSizeType

width

number

height

number

Devoluciones

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, string, number, number)

Cambiar el tamaño de un objeto visual en una página.

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

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

Parámetros

pageName

string

visualName

string

width

number

height

number

Devoluciones

Promise<IHttpPostMessageResponse<void>>

savePersistentFilters()

Guardar los filtros, segmentaciones de datos y otros cambios en la vista de datos del informe

report.savePersistentFilters();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Establece filtros en el nivel de informe.

const filters: [
   ...
];

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

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

Parámetros

filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setPage(string)

Establece la página activa del informe.

report.setPage("page2")
 .catch(error => { ... });

function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>

Parámetros

pageName

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, string, VisualContainerDisplayMode)

Actualiza el estado de visualización de un objeto visual en una página.

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

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

Parámetros

pageName

string

visualName

string

displayState

VisualContainerDisplayMode

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Establece el nivel de zoom del informe.

function setZoom(zoomLevel: number): Promise<void>

Parámetros

zoomLevel

number

nivel de zoom que se va a establecer

Devoluciones

Promise<void>

switchLayout(LayoutType)

Actualiza el diseño del informe

report.switchLayout(layoutType);

function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

Parámetros

layoutType

LayoutType

Devoluciones

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Cambie el modo de vista Informe.

function switchMode(viewMode: string | ViewMode): Promise<void>

Parámetros

viewMode

string | ViewMode

Devoluciones

Promise<void>

updateFilters(FiltersOperations, IFilter[])

Actualice los filtros en el nivel de informe según la operación: agregue, reemplace todo, reemplace por destino o quite.

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

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

Parámetros

operation

FiltersOperations

filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>

updateSettings(ISettings)

Actualiza la configuración de visibilidad para el panel de filtro y el panel de navegación de páginas.

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

Parámetros

settings

ISettings

Devoluciones

Promise<IHttpPostMessageResponse<void>>

Detalles de los métodos heredados

exitFullscreen()

Solicita al explorador que salga del modo de pantalla completa.

function exitFullscreen()

Inherited From Embed.exitFullscreen

fullscreen()

Solicita al explorador que represente el iframe del componente en modo de pantalla completa.

function fullscreen()

se hereda de embed.fullscreen

getCorrelationId()

Obtenga el correlationId para la sesión de inserción actual.

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

function getCorrelationId(): Promise<string>

Devoluciones

Promise<string>

Heredar de Embed.getCorrelationId

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

Quita uno o varios controladores de eventos de la lista de controladores. Si se especifica una referencia a la función de controlador existente, quite el controlador específico. Si no se especifica el controlador, quite todos los controladores para el nombre de evento especificado.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parámetros

eventName

string

handler

IEventHandler<T>

Heredado de Insertar.off

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

Agrega un controlador de eventos para un evento específico.

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

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

Parámetros

eventName

string

handler

IEventHandler<T>

Heredado de Insertar.on

reload()

Vuelve a cargar la inserción mediante la configuración existente. Por ejemplo, para los informes, esto borra eficazmente todos los filtros y hace que la primera página esté activa que simula restablecer un informe de nuevo al estado cargado.

report.reload();

function reload(): Promise<void>

Devoluciones

Promise<void>

Heredado de Insertar.reload

removeComponentTabIndex(number)

Quita el atributo tabindex del elemento.

function removeComponentTabIndex(_tabIndex?: number)

Parámetros

_tabIndex

number

Inherited From Embed.removeComponentTabIndex

save()

Guarda informe.

function save(): Promise<void>

Devoluciones

Promise<void>

Heredado de Insertar.save

saveAs(ISaveAsParameters)

SaveAs Report.

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

Parámetros

saveAsParameters

ISaveAsParameters

Devoluciones

Promise<void>

Heredado de Embed.saveAs

setAccessToken(string)

Establezca accessToken.

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

Parámetros

accessToken

string

Devoluciones

Promise<void>

Heredado de Embed.setAccessToken

setComponentTabIndex(number)

Establece el atributo tabindex del elemento

function setComponentTabIndex(tabIndex?: number)

Parámetros

tabIndex

number

Heredado de Embed.setComponentTabIndex

setComponentTitle(string)

Establezca el título del componente para accesibilidad. En el caso de iframes, este método cambiará el título del iframe.

function setComponentTitle(title: string)

Parámetros

title

string

Heredado de Embed.setComponentTitle