Member Junction
    Preparing search index...

    Class HomeDashboardComponent

    Home Dashboard - Personalized home screen showing all available applications with quick access navigation and configuration options.

    Uses OnPush change detection and cached computed values for optimal performance. Registered as a BaseResourceComponent so it can be used as a Custom resource type in nav items, allowing users to return to the Home dashboard after viewing orphan resources.

    Hierarchy (View Summary)

    Implements

    • AfterViewInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    ActionConfigActionDescription ActionConfigActionId ActionConfigActionName ActionConfigDialogVisible ActionRunnerDialogVisible ActionRunnerPin AddPanelLoading AddPanelNewGroupName AddPanelOpen AddPanelSearchQuery AddPanelSelectedGroup appConfigDialog apps appsDisplayData AvailableActions AvailableApps AvailableDashboards AvailableQueries AvailableViews currentUser destroy$ DraggingPinId DragOverPinId EditingGroupName EditingPinId EditMode favoriteDisplayNames favorites favoritesLoading HasDataExplorerApp HidePinEmptyState isLoading navigationService notificationsLoading PanelSectionCollapsed ParentTabId PinGroups PinMenuPin PinMenuVisible PinMenuX PinMenuY PinnedItems Provider recentItems recentsLoading showConfigDialog sidebarOpen UngroupedPins unreadNotifications ɵdir ɵfac

    Accessors

    Data DisplayNameChangedEvent formattedDate greeting hasSidebarContent LoadComplete LoadCompleteEvent LoadStarted LoadStartedEvent ProviderToUse ResourceCloseRequestedEvent ResourceRecordSavedEvent RunQueryToUse RunReportToUse RunViewToUse

    Methods

    CloseAddPinPanel DismissPinEmptyState FilterApps FilterPanelItems formatDate getEntityIconByName getFavoriteDisplayName GetInputValue GetPinAccentColor GetPinIcon GetPinsInGroup GetQueryParams GetResourceDisplayName GetResourceIconClass GetResourceTypeLabel getTabId HidePinMenu ngAfterViewInit ngOnDestroy ngOnInit NotifyCloseRequested NotifyDisplayNameChanged NotifyLoadComplete NotifyLoadStarted OnActionConfigResult OnActionRunnerResult onAppClick onConfigSaved OnDragEnd OnDragLeave OnDragOver OnDragStart OnDrop onFavoriteClick onNotificationClick OnPanelSectionExpandedChange OnPinClick OnPinMenuEdit OnPinMenuMoveToGroup OnPinMenuUnpin OnQueryParamsChanged onRecentClick OpenActionPinConfig OpenAddPinPanel openConfigDialog PinAppNavItem PinFromPanel RefreshView RemoveGroup RemovePin ResourceRecordSaved SaveGroupName SavePinName ShowPinMenu StartEditingGroup StartEditingPin ToggleEditMode toggleSidebar trackByApp trackByFavorite trackByGroup trackByNavItem trackByNotification trackByPin trackByRecent UpdateQueryParams

    Constructors

    Properties

    ActionConfigActionDescription: string | null = null
    ActionConfigActionId: string | null = null
    ActionConfigActionName: string | null = null
    ActionConfigDialogVisible: boolean = false
    ActionRunnerDialogVisible: boolean = false
    ActionRunnerPin: HomeAppPinnedItem | null = null
    AddPanelLoading: boolean = false
    AddPanelNewGroupName: string = ''
    AddPanelOpen: boolean = false
    AddPanelSearchQuery: string = ''
    AddPanelSelectedGroup: string = ''
    appConfigDialog: UserAppConfigComponent
    apps: BaseApplication[] = []
    appsDisplayData: AppDisplayData[] = []
    AvailableActions: {
        description: string;
        id: string;
        name: string;
        pinned: boolean;
    }[] = []
    AvailableApps: {
        appId: string;
        appName: string;
        color: string;
        icon: string;
        navItems: { icon: string; label: string; pinned: boolean }[];
    }[] = []
    AvailableDashboards: { id: string; name: string; pinned: boolean }[] = []
    AvailableQueries: { id: string; name: string; pinned: boolean }[] = []
    AvailableViews: {
        entityName: string;
        id: string;
        name: string;
        pinned: boolean;
    }[] = []
    currentUser: { Email: string; Name: string } | null = null
    destroy$: Subject<void> = ...
    DraggingPinId: string | null = null
    DragOverPinId: string | null = null
    EditingGroupName: string | null = null
    EditingPinId: string | null = null
    EditMode: boolean = false
    favoriteDisplayNames: Map<string, string> = ...
    favorites: MJUserFavoriteEntity[] = []
    favoritesLoading: boolean = true
    HasDataExplorerApp: boolean = false
    HidePinEmptyState: boolean = false
    isLoading: boolean = true
    navigationService: NavigationService
    notificationsLoading: boolean = true
    PanelSectionCollapsed: Record<string, boolean> = {}
    ParentTabId: string | null

    Tab ID for query param notification scoping. Set by resource wrappers that render child dashboards, so the child knows which tab it belongs to. If not set, falls back to Data.Configuration.tabId.

    PinGroups: string[] = []
    PinMenuPin: HomeAppPinnedItem | null = null
    PinMenuVisible: boolean = false
    PinMenuX: number = 0
    PinMenuY: number = 0
    PinnedItems: HomeAppPinnedItem[] = []
    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.

    recentItems: RecentAccessItem[] = []
    recentsLoading: boolean = true
    showConfigDialog: boolean = false
    sidebarOpen: boolean = false
    UngroupedPins: HomeAppPinnedItem[] = []
    unreadNotifications: MJUserNotificationEntity[] = []
    "ɵdir": unknown
    "ɵfac": unknown

    Accessors

    • get DisplayNameChangedEvent(): ((newName: string) => void) | null

      Returns ((newName: string) => void) | null

    • set DisplayNameChangedEvent(value: ((newName: string) => void) | null): void

      Parameters

      • value: ((newName: string) => void) | null

      Returns void

    • get LoadComplete(): boolean

      Returns boolean

    • get LoadStarted(): boolean

      Returns boolean

    • get LoadStartedEvent(): any

      Returns any

    • set LoadStartedEvent(value: any): void

      Parameters

      • value: any

      Returns void

    • get ProviderToUse(): IMetadataProvider

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

      Returns IMetadataProvider

    • get ResourceCloseRequestedEvent(): (() => void) | null

      Returns (() => void) | null

    • set ResourceCloseRequestedEvent(value: (() => void) | null): void

      Parameters

      • value: (() => void) | null

      Returns void

    • get ResourceRecordSavedEvent(): any

      Returns any

    • set ResourceRecordSavedEvent(value: any): void

      Parameters

      • value: any

      Returns void

    • get RunQueryToUse(): IRunQueryProvider

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

      Returns IRunQueryProvider

    • get RunReportToUse(): IRunReportProvider

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

      Returns IRunReportProvider

    • get RunViewToUse(): IRunViewProvider

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

      Returns IRunViewProvider

    Methods

    • Filter apps by search query (matches app name or nav item labels)

      Returns {
          appId: string;
          appName: string;
          color: string;
          icon: string;
          navItems: { icon: string; label: string; pinned: boolean }[];
      }[]

    • Read current query params from tab configuration. Use in initDashboard() / ngOnInit() to get initial URL state.

      Returns Record<string, string>

    • Get this component's tab ID. Checks ParentTabId input first (set by resource wrappers for child dashboards), then falls back to Data.Configuration.tabId.

      Returns string

    • A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

      Returns Promise<void>

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    • Ask the host shell to close/dismiss this resource (typically: close the tab). Called by subclasses that hosted a form that emitted a 'dismiss' navigation event — most often, a brand-new record where the user clicked Discard. The record was never saved, the form is empty, and leaving it open serves no purpose. The tab-container listens for this and closes the workspace tab.

      Returns void

    • Call this to notify the tab system that the resource's display name has changed. The tab container will update the tab title and browser title accordingly.

      Parameters

      • newName: string

      Returns void

    • Set a section's collapsed state in the Add Pin panel from the accordion panel's (ExpandedChange) output. The accordion reports the EXPANDED state, which is the inverse of our stored COLLAPSED flag. OnPush component, so mark for check after mutating the map.

      Parameters

      • section: string
      • expanded: boolean

      Returns void

    • Called by the framework when query params change from an external source (browser back/forward, deep link navigation). Override in subclasses to react to query param changes.

      Parameters

      • params: Record<string, string>

        The new query params from the URL

      • source: "popstate" | "deeplink"

        'popstate' for back/forward, 'deeplink' for external URL entry

      Returns void

    • Open the Configure Action Pin dialog — triggered when the user clicks an Action in the Add Pin panel. Actions need extra configuration (preset params, runtime params, title, theming) before they can be pinned.

      Parameters

      • actionId: string
      • actionName: string
      • description: string

      Returns void

    • Pin an app nav item from the Add Panel

      Parameters

      • appName: string
      • _appIcon: string
      • appColor: string
      • navItemLabel: string
      • navItemIcon: string

      Returns void

    • Marks this component's view (and its ancestors) as needing change detection and schedules a tick — the reliable way for a resource component to re-render after updating state from async work (RunView/RunQuery continuations, timers, websocket pushes, RxJS subscriptions).

      WHY THIS EXISTS: the Explorer shell hosts resource components dynamically — createComponent()

      • ApplicationRef.attachView() — because tab content mounts into Golden Layout / cached DOM containers, not into an Angular template. Since Angular 18's change-detection scheduler rework (Explorer is on Angular 21), ApplicationRef.tick() only refreshes attached views that are FLAGGED dirty; a root-level attached view whose component mutates plain fields from an async continuation is never flagged, so the view silently never re-renders — even though the component uses default (non-OnPush) change detection (issue #3106).

      The framework calls this automatically from NotifyLoadStarted() / NotifyLoadComplete(), so the standard load lifecycle re-renders without any subclass action. Call it yourself after any LATER async state change that must reach the DOM outside those signals.

      Returns void

    • Push query param changes to the URL. Creates a browser history entry. Safe to call during OnQueryParamsChanged — auto-suppressed to prevent loops.

      Parameters

      • params: Record<string, string | null>

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    CloseAddPinPanelDismissPinEmptyStateFilterAppsFilterPanelItemsformatDategetEntityIconByNamegetFavoriteDisplayNameGetInputValueGetPinAccentColorGetPinIconGetPinsInGroupGetQueryParamsGetResourceDisplayNameGetResourceIconClassGetResourceTypeLabelgetTabIdHidePinMenungAfterViewInitngOnDestroyngOnInitNotifyCloseRequestedNotifyDisplayNameChangedNotifyLoadCompleteNotifyLoadStartedOnActionConfigResultOnActionRunnerResultonAppClickonConfigSavedOnDragEndOnDragLeaveOnDragOverOnDragStartOnDroponFavoriteClickonNotificationClickOnPanelSectionExpandedChangeOnPinClickOnPinMenuEditOnPinMenuMoveToGroupOnPinMenuUnpinOnQueryParamsChangedonRecentClickOpenActionPinConfigOpenAddPinPanelopenConfigDialogPinAppNavItemPinFromPanelRefreshViewRemoveGroupRemovePinResourceRecordSavedSaveGroupNameSavePinNameShowPinMenuStartEditingGroupStartEditingPinToggleEditModetoggleSidebartrackByApptrackByFavoritetrackByGrouptrackByNavItemtrackByNotificationtrackByPintrackByRecentUpdateQueryParams