Interface ReportSetup

Top-level object resolved by lx.init(). Contains everything the report needs to configure itself before calling lx.ready().

  • reportId — unique identifier of this report in the workspace
  • bookmarkName — display name of the currently active saved configuration (bookmark)
  • config — arbitrary config passed by the container when opening the report; factSheetType is a common key; other keys are report-specific
  • settings — full workspace context (data model, view model, translations, user, etc.)
  • savedState — state previously persisted via lx.publishState(), or undefined on first load; use to restore the report to a previously saved configuration
interface ReportSetup {
    bookmarkName: string;
    config: ReportSetupConfig;
    reportId: string;
    savedState?: ReportingBookmarkState<any>;
    settings: ReportSetupSettings;
}

Properties

bookmarkName: string
reportId: string
savedState?: ReportingBookmarkState<any>

Generated using TypeDoc