Visual class

bookmarksManager: BookmarksManager

Valor de propiedad

heredado de Report.bookmarksManager

Obtiene filtros que se aplican al nivel de filtro. El nivel de filtro predeterminado es el nivel visual.

visual.getFilters(filtersLevel)
  .then(filters => {
    ...
  });

function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>

Parámetros

Devoluciones

Obtiene la lista de páginas del informe: no se admite en el objeto visual.

function getPages(): Promise<Page[]>

Devoluciones

Obtiene el objeto descriptor visual incrustado que contiene el nombre visual, el tipo, etc.

visual.getVisualDescriptor()
  .then(visualDetails => { ... });

function getVisualDescriptor(): Promise<VisualDescriptor>

Devoluciones

Quita todos los filtros del nivel de filtro actual. El nivel de filtro predeterminado es el nivel visual.

visual.removeFilters(filtersLevel);

function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parámetros

Devoluciones

Establece filtros en el nivel de filtro. El nivel de filtro predeterminado es el nivel visual.

const filters: [
   ...
];

visual.setFilters(filters, filtersLevel)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>

Parámetros

Devoluciones

Establece la página activa del informe; no se admite en el objeto visual.

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

Parámetros

Devoluciones

Actualiza los filtros en el nivel de filtro. El nivel de filtro predeterminado es el nivel visual.

const filters: [
   ...
];

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

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

Parámetros

Devoluciones

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

Devoluciones

Se hereda dereport.addContextMenuCommand

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

Devoluciones

heredado deReport.addOptionsMenuCommand

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

Devoluciones

heredado de Report.addPage

Aplicar un tema al informe

report.applyTheme(theme);

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

Parámetros

Devoluciones

heredado dereport.applyTheme

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

Heredado deReport.arePersistentFiltersApplied

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

Devoluciones

Heredado deReport.clearSelectedVisuals

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

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

function closeAllOverlays(): Promise<void>

Devoluciones

heredado deReport.closeAllOverlays

Controle los cambios de configuración.

function configChanged(isBootstrap: boolean)

Parámetros

heredado de Report.configChanged

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

Devoluciones

heredado de Report.deletePage

Solicita al explorador que salga del modo de pantalla completa.

function exitFullscreen()

heredado dereport.exitFullscreen

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

function fullscreen()

heredado de report.fullscreen

Obtiene la página del informe activo.

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

function getActivePage(): Promise<Page>

Devoluciones

heredado dereport.getActivePage

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

heredado deReport.getCorrelationId

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

function getId(): string

Devoluciones

heredado de Report.getId

Obtiene una página de informe por su nombre.

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

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

Parámetros

Devoluciones

Heredado deReport.getPageByName

obtener el tema del informe

report.getTheme();

function getTheme(): Promise<IReportTheme>

Devoluciones

Heredado deReport.getTheme

Devuelve el nivel de zoom actual del informe.

function getZoom(): Promise<number>

Devoluciones

Heredado deReport.getZoom

comprueba si el informe se guarda.

report.isSaved()

function isSaved(): Promise<boolean>

Devoluciones

Heredado deReport.isSaved

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

Devoluciones

heredado deReport.moveVisual

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

heredado deReport.off

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

heredado deReport.on

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

function print(): Promise<void>

Devoluciones

heredado de Report.print

Actualiza los orígenes de datos del informe.

report.refresh();

function refresh(): Promise<void>

Devoluciones

heredado de Report.refresh

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

heredado de Report.reload

Quita el atributo tabindex del elemento.

function removeComponentTabIndex(_tabIndex?: number)

Parámetros

heredado dereport.removeComponentTabIndex

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

Devoluciones

Se hereda dereport.removeContextMenuCommand

Comando de extensión de menú Quitar opciones.

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

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

Parámetros

Devoluciones

Heredado deReport.removeOptionsMenuCommand

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

Devoluciones

Heredar dereport.renamePage

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

Heredado deReport.resetPersistentFilters

Restablecer y aplicar el tema predeterminado del informe

report.resetTheme();

function resetTheme(): Promise<void>

Devoluciones

heredado dereport.resetTheme

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

Devoluciones

heredado dereport.resizeActivePage

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

Devoluciones

Heredado deReport.resizeVisual

Guarda informe.

function save(): Promise<void>

Devoluciones

heredar de Report.save

SaveAs Report.

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

Parámetros

Devoluciones

heredado dereport.saveAs

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

report.savePersistentFilters();

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

Devoluciones

Heredado deReport.savePersistentFilters

Establezca accessToken.

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

Parámetros

Devoluciones

heredado dereport.setAccessToken

Establece el atributo tabindex del elemento

function setComponentTabIndex(tabIndex?: number)

Parámetros

se hereda de Report.setComponentTabIndex

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

heredado dereport.setComponentTitle

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

Devoluciones

Heredado deReport.setVisualDisplayState

Establece el nivel de zoom del informe.

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

Parámetros

Devoluciones

Heredado de Report.setZoom

Actualiza el diseño del informe

report.switchLayout(layoutType);

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

Parámetros

Devoluciones

heredado dereport.switchLayout

Cambie el modo de vista Informe.

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

Parámetros

Devoluciones

Heredado de Report.switchMode

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

Devoluciones

heredado de Report.updateSettings