Visual class
Het insluitonderdeel power BI-visual
- Uitbreiding
Overgenomen eigenschappen
| bookmarks |
Methoden
| get |
Hiermee haalt u filters op die worden toegepast op het filterniveau. Standaardfilterniveau is visueel niveau.
|
| get |
Hiermee haalt u de lijst met pagina's in het rapport op, niet ondersteund in visuals |
| get |
Hiermee haalt u het ingesloten visualdescriptorobject op dat de naam van de visual, het type, enzovoort bevat.
|
| remove |
Hiermee verwijdert u alle filters van het huidige filterniveau. Standaardfilterniveau is visueel niveau.
|
| set |
Hiermee stelt u filters in op filterniveau. Standaardfilterniveau is visueel niveau.
|
| set |
Hiermee stelt u de actieve pagina van het rapport in, niet ondersteund in de visual |
| update |
Hiermee worden filters bijgewerkt op filterniveau. Standaardfilterniveau is visueel niveau.
|
Overgenomen methoden
| add |
Opdracht Contextmenu-extensie toevoegen.
|
| add |
Opdracht Voor menuuitbreiding opties toevoegen.
|
| add |
Een lege pagina toevoegen aan het rapport
|
| apply |
Een thema toepassen op het rapport
|
| are |
Retourneert als er filters, slicers of andere wijzigingen in de gegevensweergave van gebruikers zijn toegepast op het rapport. Als permanente filters zijn uitgeschakeld, wordt onwaar geretourneerd.
|
| clear |
Hiermee worden geselecteerde niet-pop-outvisuals gewist, als de vlag wordt doorgegeven, worden alle selecties van visuals gewist.
|
| close |
Hiermee sluit u alle geopende contextmenu's en knopinfo.
|
| config |
Configuratiewijzigingen verwerken. |
| delete |
Een pagina uit een rapport verwijderen
|
| exit |
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. |
| get |
Hiermee haalt u de actieve rapportpagina op.
|
| get |
Haal de correlationId op voor de huidige insluitingssessie.
|
| get |
Haalt de rapport-id op van de eerste beschikbare locatie: opties, kenmerk, insluit-URL. |
| get |
Hiermee haalt u een rapportpagina op met de naam.
|
| get |
het thema van het rapport ophalen
|
| get |
Hiermee wordt het huidige zoomniveau van het rapport geretourneerd. |
| is |
controleert of het rapport is opgeslagen.
|
| move |
Hiermee wordt de positie van een visual op een pagina bijgewerkt.
|
| off<T>(string, IEvent |
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.
|
| on<T>(string, IEvent |
Hiermee voegt u een gebeurtenis-handler toe voor een specifieke gebeurtenis.
|
| print() | Hiermee drukt u de actieve pagina van het rapport af door |
| refresh() | Hiermee worden gegevensbronnen voor het rapport vernieuwd.
|
| 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.
|
| remove |
Het tabbladindexkenmerk van het element verwijderen |
| remove |
Opdracht contextmenu-extensie verwijderen.
|
| remove |
Opdracht Menu-extensie opties verwijderen.
|
| rename |
De naam van een pagina wijzigen vanuit een rapport
|
| reset |
De filters, slicers en andere gegevensweergaven van gebruikers opnieuw instellen op de standaardstatus van het rapport
|
| reset |
Het standaardthema van het rapport opnieuw instellen en toepassen
|
| resize |
Hiermee wordt de grootte van de actieve pagina in het rapport bijgewerkt.
|
| resize |
Het formaat van een visual op een pagina wijzigen.
|
| save() | Slaat het rapport op. |
| save |
SaveAs-rapport. |
| save |
Wijzigingen in de rapportweergave van filters, slicers en andere gegevensweergaven van gebruikers opslaan
|
| set |
Stel accessToken in. |
| set |
Het kenmerk TabIndex van het element instellen |
| set |
Stel de onderdeeltitel in voor toegankelijkheid. In het geval van iframes wordt met deze methode de titel van het iframe gewijzigd. |
| set |
Hiermee wordt de weergavestatus van een visual op een pagina bijgewerkt.
|
| set |
Hiermee stelt u het zoomniveau van het rapport in. |
| switch |
De rapportindeling bijwerken
|
| switch |
Schakelen tussen de rapportweergavemodus. |
| update |
Hiermee worden de zichtbaarheidsinstellingen voor het filterdeelvenster en het paginanavigatiedeelvenster bijgewerkt.
|
Details van overgenomen eigenschap
bookmarksManager
Methodedetails
getFilters(FiltersLevel)
Hiermee haalt u filters op die worden toegepast op het filterniveau. Standaardfilterniveau is visueel niveau.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Parameters
- filtersLevel
- FiltersLevel
Retouren
Promise<IFilter[]>
getPages()
Hiermee haalt u de lijst met pagina's in het rapport op, niet ondersteund in visuals
function getPages(): Promise<Page[]>
Retouren
Promise<Page[]>
getVisualDescriptor()
Hiermee haalt u het ingesloten visualdescriptorobject op dat de naam van de visual, het type, enzovoort bevat.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Retouren
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Hiermee verwijdert u alle filters van het huidige filterniveau. Standaardfilterniveau is visueel niveau.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameters
- filtersLevel
- FiltersLevel
Retouren
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Hiermee stelt u filters in op filterniveau. Standaardfilterniveau is visueel niveau.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameters
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Retouren
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Hiermee stelt u de actieve pagina van het rapport in, niet ondersteund in de visual
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Parameters
- _pageName
-
string
Retouren
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Hiermee worden filters bijgewerkt op filterniveau. Standaardfilterniveau is visueel niveau.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameters
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Retouren
Promise<IHttpPostMessageResponse<void>>
Details overgenomen methode
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
Opdracht Contextmenu-extensie toevoegen.
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>>
Parameters
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.addContextMenuCommand-
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
Opdracht Voor menuuitbreiding opties toevoegen.
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>>
Parameters
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.addOptionsMenuCommand-
addPage(string)
Een lege pagina toevoegen aan het rapport
// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");
function addPage(displayName?: string): Promise<Page>
Parameters
- displayName
-
string
Retouren
Promise<Page>
overgenomen vanReport.addPage-
applyTheme(IReportTheme)
Een thema toepassen op het rapport
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Parameters
- theme
- IReportTheme
Retouren
Promise<void>
overgenomen vanReport.applyTheme-
arePersistentFiltersApplied()
Retourneert als er filters, slicers of andere wijzigingen in de gegevensweergave van gebruikers zijn toegepast op het rapport. Als permanente filters zijn uitgeschakeld, wordt onwaar geretourneerd.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
Retouren
Promise<boolean>
overgenomen vanReport.arePersistentFiltersApplied
clearSelectedVisuals(boolean)
Hiermee worden geselecteerde niet-pop-outvisuals gewist, als de vlag wordt doorgegeven, worden alle selecties van visuals gewist.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Parameters
- clearPopOutState
-
boolean
Als de selectie van onwaar/niet-gedefinieerde visuals niet wordt gewist als een van de visuals de status Pop-out heeft (in focus, weergeven als tabel, spotlight...)
Retouren
Promise<void>
overgenomen vanReport.clearSelectedVisuals
closeAllOverlays()
Hiermee sluit u alle geopende contextmenu's en knopinfo.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Retouren
Promise<void>
overgenomen vanReport.closeAllOverlays
configChanged(boolean)
Configuratiewijzigingen verwerken.
function configChanged(isBootstrap: boolean)
Parameters
- isBootstrap
-
boolean
overgenomen vanReport.configChanged-
deletePage(string)
Een pagina uit een rapport verwijderen
// 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>
Parameters
- pageName
-
string
Retouren
Promise<void>
overgenomen vanReport.deletePage
exitFullscreen()
Vraagt de browser om de modus Volledig scherm af te sluiten.
function exitFullscreen()
overgenomen vanReport.exitFullscreen-
fullscreen()
Vraagt de browser om het iframe van het onderdeel weer te geven in de modus Volledig scherm.
function fullscreen()
overgenomen vanReport.fullscreen
getActivePage()
Hiermee haalt u de actieve rapportpagina op.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Retouren
Promise<Page>
overgenomen vanReport.getActivePage-
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 vanReport.getCorrelationId
getId()
Haalt de rapport-id op van de eerste beschikbare locatie: opties, kenmerk, insluit-URL.
function getId(): string
Retouren
string
overgenomen vanReport.getId-
getPageByName(string)
Hiermee haalt u een rapportpagina op met de naam.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parameters
- pageName
-
string
Retouren
Promise<Page>
overgenomen vanReport.getPageByName-
getTheme()
het thema van het rapport ophalen
report.getTheme();
function getTheme(): Promise<IReportTheme>
Retouren
Promise<IReportTheme>
overgenomen vanReport.getTheme-
getZoom()
Hiermee wordt het huidige zoomniveau van het rapport geretourneerd.
function getZoom(): Promise<number>
Retouren
Promise<number>
overgenomen vanReport.getZoom-
isSaved()
controleert of het rapport is opgeslagen.
report.isSaved()
function isSaved(): Promise<boolean>
Retouren
Promise<boolean>
overgenomen vanreport.isSaved
moveVisual(string, string, number, number, number)
Hiermee wordt de positie van een visual op een pagina bijgewerkt.
report.moveVisual(pageName, visualName, x, y, z)
.catch(error => { ... });
function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>
Parameters
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.moveVisual-
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 vanReport.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 uitrapport.on
print()
Hiermee drukt u de actieve pagina van het rapport af door window.print() aan te roepen op het ingesloten iframe-onderdeel.
function print(): Promise<void>
Retouren
Promise<void>
overgenomen vanReport.print
refresh()
Hiermee worden gegevensbronnen voor het rapport vernieuwd.
report.refresh();
function refresh(): Promise<void>
Retouren
Promise<void>
overgenomen vanReport.refresh
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 vanReport.reload
removeComponentTabIndex(number)
Het tabbladindexkenmerk van het element verwijderen
function removeComponentTabIndex(_tabIndex?: number)
Parameters
- _tabIndex
-
number
overgenomen vanReport.removeComponentTabIndex
removeContextMenuCommand(string, string)
Opdracht contextmenu-extensie verwijderen.
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameters
- commandName
-
string
- contextMenuTitle
-
string
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.removeContextMenuCommand-
removeOptionsMenuCommand(string, string)
Opdracht Menu-extensie opties verwijderen.
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameters
- commandName
-
string
- optionsMenuTitle
-
string
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.removeOptionsMenuCommand-
renamePage(string, string)
De naam van een pagina wijzigen vanuit een rapport
// 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>
Parameters
- pageName
-
string
- displayName
-
string
Retouren
Promise<void>
overgenomen vanReport.renamePage-
resetPersistentFilters()
De filters, slicers en andere gegevensweergaven van gebruikers opnieuw instellen op de standaardstatus van het rapport
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.resetPersistentFilters
resetTheme()
Het standaardthema van het rapport opnieuw instellen en toepassen
report.resetTheme();
function resetTheme(): Promise<void>
Retouren
Promise<void>
overgenomen vanReport.resetTheme-
resizeActivePage(PageSizeType, number, number)
Hiermee wordt de grootte van de actieve pagina in het rapport bijgewerkt.
report.resizeActivePage(pageSizeType, width, height)
.catch(error => { ... });
function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>
Parameters
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.resizeActivePage
resizeVisual(string, string, number, number)
Het formaat van een visual op een pagina wijzigen.
report.resizeVisual(pageName, visualName, width, height)
.catch(error => { ... });
function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>
Parameters
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.resizeVisual-
save()
Slaat het rapport op.
function save(): Promise<void>
Retouren
Promise<void>
overgenomen vanReport.save
saveAs(ISaveAsParameters)
SaveAs-rapport.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parameters
- saveAsParameters
- ISaveAsParameters
Retouren
Promise<void>
overgenomen vanReport.saveAs
savePersistentFilters()
Wijzigingen in de rapportweergave van filters, slicers en andere gegevensweergaven van gebruikers opslaan
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.savePersistentFilters
setAccessToken(string)
Stel accessToken in.
function setAccessToken(accessToken: string): Promise<void>
Parameters
- accessToken
-
string
Retouren
Promise<void>
overgenomen vanReport.setAccessToken
setComponentTabIndex(number)
Het kenmerk TabIndex van het element instellen
function setComponentTabIndex(tabIndex?: number)
Parameters
- tabIndex
-
number
overgenomen vanReport.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 vanReport.setComponentTitle-
setVisualDisplayState(string, string, VisualContainerDisplayMode)
Hiermee wordt de weergavestatus van een visual op een pagina bijgewerkt.
report.setVisualDisplayState(pageName, visualName, displayState)
.catch(error => { ... });
function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>
Parameters
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.setVisualDisplayState
setZoom(number)
Hiermee stelt u het zoomniveau van het rapport in.
function setZoom(zoomLevel: number): Promise<void>
Parameters
- zoomLevel
-
number
zoomniveau om in te stellen
Retouren
Promise<void>
overgenomen vanReport.setZoom-
switchLayout(LayoutType)
De rapportindeling bijwerken
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parameters
- layoutType
- LayoutType
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.switchLayout-
switchMode(string | ViewMode)
Schakelen tussen de rapportweergavemodus.
function switchMode(viewMode: string | ViewMode): Promise<void>
Parameters
- viewMode
-
string | ViewMode
Retouren
Promise<void>
overgenomen vanReport.switchMode-
updateSettings(ISettings)
Hiermee worden de zichtbaarheidsinstellingen voor het filterdeelvenster en het paginanavigatiedeelvenster bijgewerkt.
const newSettings = {
panes: {
filters: {
visible: false
}
}
};
report.updateSettings(newSettings)
.catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
Parameters
- settings
- ISettings
Retouren
Promise<IHttpPostMessageResponse<void>>
overgenomen vanReport.updateSettings