Member Junction
    Preparing search index...

    Main dashboard viewer component. Renders a configurable dashboard with draggable/resizable panels using Golden Layout.

    This component is GENERIC and has no routing dependencies. Navigation events are bubbled up for the parent component to handle.

    Hierarchy (View Summary)

    Implements

    • OnDestroy
    Index

    Constructors

    Properties

    breadcrumbNavigate: EventEmitter<BreadcrumbNavigateEvent> = ...

    Use BreadcrumbNavigate.

    The same emitter under the old binding name, so a template still binding (breadcrumbNavigate) keeps working. Must stay AFTER BreadcrumbNavigate: class fields initialise in order, and the other way round this captures undefined.

    BreadcrumbNavigate: EventEmitter<BreadcrumbNavigateEvent> = ...

    Emitted when user navigates via breadcrumb

    CanEdit: boolean = false

    Whether the user may edit this dashboard. An empty dashboard then offers Add part in view mode too; the host decides how to get into edit mode.

    Categories: MJDashboardCategoryEntity[] = []

    All categories for breadcrumb path resolution

    config: DashboardConfig | null = null
    configChanged: EventEmitter<DashboardConfigChangedEvent> = ...

    Emitted when dashboard configuration changes

    dashboardSaved: EventEmitter<MJDashboardEntity> = ...

    Use DashboardSaved.

    The same emitter under the old binding name, so a template still binding (dashboardSaved) keeps working. Must stay AFTER DashboardSaved: class fields initialise in order, and the other way round this captures undefined.

    DashboardSaved: EventEmitter<MJDashboardEntity> = ...

    Emitted when the dashboard is saved

    editModeChanged: EventEmitter<boolean> = ...

    Use EditModeChanged.

    The same emitter under the old binding name, so a template still binding (editModeChanged) keeps working. Must stay AFTER EditModeChanged: class fields initialise in order, and the other way round this captures undefined.

    EditModeChanged: EventEmitter<boolean> = ...

    Emitted when edit mode changes

    error: EventEmitter<{ error?: Error; message: string }> = ...

    Emitted when an error occurs

    HasUnsavedChanges: boolean = false
    isLoading: boolean = false
    LayoutContainer: ElementRef<HTMLElement>
    layoutDeferred: EventEmitter<{ reason: string }> = ...

    Use LayoutDeferred.

    The same emitter under the old binding name, so a template still binding (layoutDeferred) keeps working. Must stay AFTER LayoutDeferred: class fields initialise in order, and the other way round this captures undefined.

    LayoutDeferred: EventEmitter<{ reason: string }> = ...

    Emitted when layout initialization is deferred because the container cannot be initialized yet.

    layoutLifecycle: EventEmitter<DashboardLayoutLifecycleEvent> = ...

    Use LayoutLifecycle.

    The same emitter under the old binding name, so a template still binding (layoutLifecycle) keeps working. Must stay AFTER LayoutLifecycle: class fields initialise in order, and the other way round this captures undefined.

    LayoutLifecycle: EventEmitter<DashboardLayoutLifecycleEvent> = ...

    Emitted as the Golden Layout viewer moves through dashboard/layout readiness states.

    layoutReady: EventEmitter<void> = ...

    Use LayoutReady.

    The same emitter under the old binding name, so a template still binding (layoutReady) keeps working. Must stay AFTER LayoutReady: class fields initialise in order, and the other way round this captures undefined.

    LayoutReady: EventEmitter<void> = ...

    Emitted once Golden Layout has initialized with a non-zero container and updated its size.

    navigationRequested: EventEmitter<DashboardNavRequestEvent> = ...

    Use NavigationRequested.

    The same emitter under the old binding name, so a template still binding (navigationRequested) keeps working. Must stay AFTER NavigationRequested: class fields initialise in order, and the other way round this captures undefined.

    NavigationRequested: EventEmitter<DashboardNavRequestEvent> = ...

    Emitted when a panel requests navigation to another resource

    openInTab: EventEmitter<{ dashboardId: string; dashboardName: string }> = ...

    Use OpenInTab.

    The same emitter under the old binding name, so a template still binding (openInTab) keeps working. Must stay AFTER OpenInTab: class fields initialise in order, and the other way round this captures undefined.

    OpenInTab: EventEmitter<{ dashboardId: string; dashboardName: string }> = ...

    Emitted when user clicks "Open in Tab" button

    panelInteraction: EventEmitter<PanelInteractionEvent> = ...

    Use PanelInteraction.

    The same emitter under the old binding name, so a template still binding (panelInteraction) keeps working. Must stay AFTER PanelInteraction: class fields initialise in order, and the other way round this captures undefined.

    PanelInteraction: EventEmitter<PanelInteractionEvent> = ...

    Emitted when a panel interaction occurs

    PartTypes: MJDashboardPartTypeEntity[] = []
    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    ShowBreadcrumb: boolean = true

    Whether to show the breadcrumb navigation

    ShowEditButton: boolean = true

    Whether to show the Edit button

    ShowOpenInTabButton: boolean = false

    Whether to show the "Open in Tab" button (for embedded dashboards)

    "ɵdir": unknown
    "ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

    Accessors

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    • Adds a panel and returns its id, or null when nothing was added (no layout yet, or an unknown part type). With a location, the layout editor places the panel there and the layout is rebuilt; without one, Golden Layout adds the panel to its first stack.

      Parameters

      Returns Promise<string | null>

      LayoutEditError when the location is not valid or names a panel that is not in the layout.

    • Update a panel's configuration. Since panels live in componentState within the layout, we need to update the layout tree directly or reinitialize with updated data. Resolves once the layout is rebuilt with the updated panel; rejects when the rebuild fails.

      Parameters

      • panelId: string
      • newConfig: PanelConfig
      • Optionaltitle: string
      • Optionalicon: string

      Returns Promise<void>