pCon.basket - Plugin Development
    Preparing search index...

    Interface ProjectReportPlugin

    Plugin that creates the ProjectReport component and adds reporting functionality to the basket.

    • Plugin category = ProjectReport
    interface ProjectReportPlugin {
        eventAfterGenerateReport: AsyncListenableEvent<
            AfterGenerateReportEventData,
            ProjectReportPlugin,
        >;
        eventBeforeGenerateReport: AsyncListenableEvent<
            BeforeGenerateReportEventData,
            ProjectReportPlugin,
        >;
        isAvailable?: boolean;
        name: string;
        createComponent(
            pEditor: ProjectEditor,
            pContainer: HTMLElement,
        ): Promise<ProjectReport>;
        getTemplates(
            pContext: EaiwsContext,
            pOptions?: GetTemplatesOptions,
        ): Promise<Template[]>;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    eventAfterGenerateReport: AsyncListenableEvent<
        AfterGenerateReportEventData,
        ProjectReportPlugin,
    >

    Event which will be called after a report was generated.

    eventBeforeGenerateReport: AsyncListenableEvent<
        BeforeGenerateReportEventData,
        ProjectReportPlugin,
    >

    Event which will be called before a report is generated.

    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • Will be called once after the plugin was loaded.

      Parameters

      • pDescriptor: PluginDescriptor

        Plugin descriptor for this plugin.

      • pSettings: unknown

        Optional plugin specific settings which may be defined as part of the application settings.

      Returns Promise<void>