powerbi-client-angular-next/dist/powerbi-client-angular/index.d.ts

Angular wrapper for powerbi-client library

import * as i0 from '@angular/core';
import { OnInit, OnChanges, AfterViewInit, SimpleChanges } from '@angular/core';
import { service, Embed, IReportEmbedConfiguration, Report, IDashboardEmbedConfiguration, Dashboard, ITileEmbedConfiguration, Tile, IVisualEmbedConfiguration, Visual, IQnaEmbedConfiguration, Qna, Create } from 'powerbi-client';
import { IPaginatedReportLoadConfiguration, IReportCreateConfiguration } from 'powerbi-models';

/**
 * Type for event handler function of embedded entity
 */
type EventHandler = (event?: service.ICustomEvent<any>, embeddedEntity?: Embed) => void | null;
/**
 * Base component to hold common properties for all the Power BI entities
 */
declare class PowerBIEmbedComponent implements OnInit {
    private static _powerbi;
    readonly cssClassName: i0.InputSignal<string | undefined>;
    readonly service: i0.InputSignal<service.Service | undefined>;
    powerbi: service.Service;
    private prevEventHandlerMapString;
    private destroyRef;
    ngOnInit(): void;
    /**
     * Sets all event handlers from the input on the embedded entity
     *
     * @param embed Embedded object
     * @param eventHandlerMap Array of event handlers to be set on embedded entity
     * @returns void
     */
    protected setEventHandlers(embed: Embed, eventHandlerMap: Map<string, EventHandler | null>): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIEmbedComponent, "powerbi-embed", never, { "cssClassName": { "alias": "cssClassName"; "required": false; "isSignal": true; }; "service": { "alias": "service"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}

/**
 * Report component to embed the report, extends the Base Component
 */
declare class PowerBIReportEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IReportEmbedConfiguration;
    phasedEmbedding?: boolean;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getReport(): Report;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed or load the PowerBI Report based on phasedEmbedding flag
     *
     * @returns void
     */
    private embedReport;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIReportEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIReportEmbedComponent, "powerbi-report[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "phasedEmbedding": { "alias": "phasedEmbedding"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Dashboard component to embed the dashboard, extends the Base component
 */
declare class PowerBIDashboardEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IDashboardEmbedConfiguration;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getDashboard(): Dashboard;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI Dashboard
     *
     * @returns void
     */
    private embedDashboard;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIDashboardEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIDashboardEmbedComponent, "powerbi-dashboard[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Tile component to embed the tile, extends Base component
 */
declare class PowerBITileEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: ITileEmbedConfiguration;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getTile(): Tile;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI Tile
     *
     * @returns void
     */
    private embedTile;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBITileEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBITileEmbedComponent, "powerbi-tile[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Paginated report component to embed the entity, extends the Base component
 */
declare class PowerBIPaginatedReportEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IPaginatedReportLoadConfiguration;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI Paginated report
     *
     * @returns void
     */
    private embedPaginatedReport;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIPaginatedReportEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIPaginatedReportEmbedComponent, "powerbi-paginated-report[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Visual component to embed the visual, extends Base component
 */
declare class PowerBIVisualEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IVisualEmbedConfiguration;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getVisual(): Visual;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI Visual
     *
     * @returns void
     */
    private embedVisual;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIVisualEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIVisualEmbedComponent, "powerbi-visual[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Qna component to embed the Qna visual, extends Base component
 */
declare class PowerBIQnaEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IQnaEmbedConfiguration;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getQna(): Qna;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI QnA Visual
     *
     * @returns void
     */
    private embedQnaVisual;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIQnaEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBIQnaEmbedComponent, "powerbi-qna[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

/**
 * Create report component to embed the entity, extends the Base component
 */
declare class PowerBICreateReportEmbedComponent extends PowerBIEmbedComponent implements OnInit, OnChanges, AfterViewInit {
    embedConfig: IReportCreateConfiguration;
    eventHandlers?: Map<string, EventHandler | null>;
    private containerRef;
    private _embed?;
    private get embed();
    private set embed(value);
    constructor();
    getCreateObject(): Create;
    ngOnInit(): void;
    ngOnChanges(changes: SimpleChanges): void;
    ngAfterViewInit(): void;
    /**
     * Embed the PowerBI Create report
     *
     * @returns void
     */
    private embedCreateReport;
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBICreateReportEmbedComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<PowerBICreateReportEmbedComponent, "powerbi-create-report[embedConfig]", never, { "embedConfig": { "alias": "embedConfig"; "required": false; }; "eventHandlers": { "alias": "eventHandlers"; "required": false; }; }, {}, never, never, true, never>;
}

declare class PowerBIEmbedModule {
    static ɵfac: i0.ɵɵFactoryDeclaration<PowerBIEmbedModule, never>;
    static ɵmod: i0.ɵɵNgModuleDeclaration<PowerBIEmbedModule, never, [typeof PowerBIEmbedComponent, typeof PowerBIDashboardEmbedComponent, typeof PowerBIPaginatedReportEmbedComponent, typeof PowerBIQnaEmbedComponent, typeof PowerBIReportEmbedComponent, typeof PowerBITileEmbedComponent, typeof PowerBIVisualEmbedComponent, typeof PowerBICreateReportEmbedComponent], [typeof PowerBIDashboardEmbedComponent, typeof PowerBIPaginatedReportEmbedComponent, typeof PowerBIQnaEmbedComponent, typeof PowerBIReportEmbedComponent, typeof PowerBITileEmbedComponent, typeof PowerBIVisualEmbedComponent, typeof PowerBICreateReportEmbedComponent]>;
    static ɵinj: i0.ɵɵInjectorDeclaration<PowerBIEmbedModule>;
}

export { PowerBICreateReportEmbedComponent, PowerBIDashboardEmbedComponent, PowerBIEmbedModule, PowerBIPaginatedReportEmbedComponent, PowerBIQnaEmbedComponent, PowerBIReportEmbedComponent, PowerBITileEmbedComponent, PowerBIVisualEmbedComponent };