Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Create

A Power BI Report creator component

export
class

Create

extends

{Embed}

Hierarchy

  • Embed
    • Create

Index

Constructors

constructor

Methods

exitFullscreen

  • exitFullscreen(): void
  • Requests the browser to exit fullscreen mode.

    Returns void

fullscreen

  • fullscreen(): void
  • Requests the browser to render the component's iframe in fullscreen mode.

    Returns void

getCorrelationId

  • getCorrelationId(): Promise<string>
  • Get the correlationId for the current embed session.

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

    Returns Promise<string>

getId

  • getId(): string
  • Gets the dataset ID from the first available location: createConfig or embed url.

    Returns string

isSaved

  • isSaved(): Promise<boolean>
  • checks if the report is saved.

    report.isSaved()

    Returns Promise<boolean>

off

  • off<T>(eventName: string, handler?: IEventHandler<T>): void
  • Removes one or more event handlers from the list of handlers. If a reference to the existing handle function is specified, remove the specific handler. If the handler is not specified, remove all handlers for the event name specified.

    report.off('pageChanged')
    
    or
    
    const logHandler = function (event) {
       console.log(event);
    };
    
    report.off('pageChanged', logHandler);
    template

    T

    Type parameters

    • T

    Parameters

    • eventName: string
    • Optional handler: IEventHandler<T>

    Returns void

on

  • on<T>(eventName: string, handler: IEventHandler<T>): void
  • Adds an event handler for a specific event.

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

    T

    Type parameters

    • T

    Parameters

    • eventName: string
    • handler: IEventHandler<T>

    Returns void

reload

  • reload(): Promise<void>
  • Reloads embed using existing configuration. E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.

    report.reload();

    Returns Promise<void>

removeComponentTabIndex

  • removeComponentTabIndex(_tabIndex?: number): void
  • Removes element's tabindex attribute

    Parameters

    • Optional _tabIndex: number

    Returns void

save

  • save(): Promise<void>
  • Saves Report.

    Returns Promise<void>

saveAs

  • saveAs(saveAsParameters: models.ISaveAsParameters): Promise<void>
  • SaveAs Report.

    Parameters

    • saveAsParameters: models.ISaveAsParameters

    Returns Promise<void>

setAccessToken

  • setAccessToken(accessToken: string): Promise<void>
  • Set accessToken.

    Parameters

    • accessToken: string

    Returns Promise<void>

setComponentTabIndex

  • setComponentTabIndex(tabIndex?: number): void
  • Sets element's tabindex attribute

    Parameters

    • Optional tabIndex: number

    Returns void

setComponentTitle

  • setComponentTitle(title: string): void
  • Set the component title for accessibility. In case of iframes, this method will change the iframe title.

    Parameters

    • title: string

    Returns void

validate

Generated using TypeDoc