Class NavigationService

Centralized navigation service that handles all navigation operations with automatic shift-key detection for power user workflows

Implements

OnDestroy

Constructors

constructor

new NavigationService(workspaceManager, appManager): NavigationService
Parameters
- workspaceManager: WorkspaceStateManager
- appManager: ApplicationManager
Returns NavigationService
- Defined in Explorer/shared/src/lib/navigation.service.ts:25

Properties

`Private` appManager

appManager: ApplicationManager

`Private` shiftKeyPressed

shiftKeyPressed: boolean = false

`Private` subscriptions

subscriptions: Subscription[] = []

`Private` workspaceManager

workspaceManager: WorkspaceStateManager

Accessors

ExplorerAppColor

get ExplorerAppColor(): string
Get the neutral color used for system-wide resources (entities, views, dashboards) Returns a light neutral gray

Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:36

Methods

OpenArtifact

OpenArtifact(artifactId, artifactName?, options?): string
Open an artifact (system-wide resource) Artifacts are versioned content containers (reports, dashboards, UI components, etc.)
Parameters
- artifactId: string
- Optional artifactName: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:333

OpenDashboard

OpenDashboard(dashboardId, dashboardName, options?): string
Open a dashboard (system-wide resource)
Parameters
- dashboardId: string
- dashboardName: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:268

OpenDynamicView

OpenDynamicView(entityName, extraFilter?, options?): string
Open a dynamic view (system-wide resource) Dynamic views are entity-based views with custom filters, not saved views
Parameters
- entityName: string
- Optional extraFilter: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:366

OpenEntityRecord

OpenEntityRecord(entityName, recordPkey, options?): string
Open an entity record view System-wide resource using __explorer app ID and neutral color
Parameters
- entityName: string
- recordPkey: CompositeKey
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:189

OpenNavItem

OpenNavItem(appId, navItem, appColor, options?): string
Open a navigation item within an app
Parameters
- appId: string
- navItem: NavItem
- appColor: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:147

OpenNavItemByName

OpenNavItemByName(navItemName, configuration?, appId?, options?): null | string
Navigate to a nav item by name within the current or specified application. Allows passing additional configuration parameters to merge with the nav item's config. This is useful for cross-resource navigation where a component needs to navigate to another nav item with specific parameters (e.g., navigate to Conversations with a specific conversationId).
Parameters
- navItemName: string
  The label/name of the nav item to navigate to
- Optional configuration: Record<string, unknown>
  Additional configuration to merge (e.g., conversationId, artifactId)
- Optional appId: string
  Optional app ID (defaults to current active app)
- Optional options: NavigationOptions
  Navigation options
Returns null | string
The tab ID if successful, null if nav item not found
- Defined in Explorer/shared/src/lib/navigation.service.ts:491

OpenNewEntityRecord

OpenNewEntityRecord(entityName, options?): string
Open a new entity record creation form System-wide resource using __explorer app ID and neutral color
Parameters
- entityName: string
  The name of the entity to create a new record for
- Optional options: NavigationOptions
  Navigation options including optional newRecordValues for pre-populating fields
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:436

OpenQuery

OpenQuery(queryId, queryName, options?): string
Open a query (system-wide resource)
Parameters
- queryId: string
- queryName: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:401

OpenReport

OpenReport(reportId, reportName, options?): string
Open a report (system-wide resource)
Parameters
- reportId: string
- reportName: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:300

OpenView

OpenView(viewId, viewName, options?): string
Open a view (system-wide resource)
Parameters
- viewId: string
- viewName: string
- Optional options: NavigationOptions
Returns string
- Defined in Explorer/shared/src/lib/navigation.service.ts:236

SwitchToApp

SwitchToApp(appId, navItemName?): Promise<void>
Switch to an application by ID. This sets the app as active and either opens a specific nav item or creates a default tab. If the requested nav item already has an open tab, switches to that tab instead of creating a new one.
Parameters
- appId: string
  The application ID to switch to
- Optional navItemName: string
  Optional name of a nav item to open within the app. If provided, opens that nav item.
Returns Promise<void>
- Defined in Explorer/shared/src/lib/navigation.service.ts:535

`Private` handleSingleResourceModeTransition

handleSingleResourceModeTransition(forceNew, newRequest): void
Handle temporary tab preservation when forcing new tabs Rule: Only ONE tab should be temporary at a time When shift+clicking to force a new tab, pin the current active tab if it's temporary
Parameters
- forceNew: boolean
- newRequest: TabRequest
Returns void
- Defined in Explorer/shared/src/lib/navigation.service.ts:93

`Private` isSameResource

isSameResource(tab, request): boolean
Check if a tab request matches an existing tab's resource
Parameters
- tab: any
- request: TabRequest
Returns boolean
- Defined in Explorer/shared/src/lib/navigation.service.ts:120

`Private` isShiftPressed

isShiftPressed(): boolean
Get current shift key state

Returns boolean
- Defined in Explorer/shared/src/lib/navigation.service.ts:71

ngOnDestroy

ngOnDestroy(): void
Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in Explorer/shared/src/lib/navigation.service.ts:40

`Private` setupGlobalShiftKeyDetection

setupGlobalShiftKeyDetection(): void
Set up global keyboard event listeners to track shift key state

Returns void
- Defined in Explorer/shared/src/lib/navigation.service.ts:47

`Private` shouldForceNewTab

shouldForceNewTab(options?): boolean
Determine if a new tab should be forced based on options and shift key state
Parameters
- Optional options: NavigationOptions
Returns boolean
- Defined in Explorer/shared/src/lib/navigation.service.ts:78

Class NavigationService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NavigationService

Properties

Private appManager

Private shiftKeyPressed

Private subscriptions

Private workspaceManager

Accessors

ExplorerAppColor

Returns string

Methods

OpenArtifact

Parameters

Returns string

OpenDashboard

Parameters

Returns string

OpenDynamicView

Parameters

Returns string

OpenEntityRecord

Parameters

Returns string

OpenNavItem

Parameters

Returns string

OpenNavItemByName

Parameters

Returns null | string

OpenNewEntityRecord

Parameters

Returns string

OpenQuery

Parameters

Returns string

OpenReport

Parameters

Returns string

OpenView

Parameters

Returns string

SwitchToApp

Parameters

Returns Promise<void>

Private handleSingleResourceModeTransition

Parameters

Returns void

Private isSameResource

Parameters

Returns boolean

Private isShiftPressed

Returns boolean

ngOnDestroy

Returns void

Private setupGlobalShiftKeyDetection

Returns void

Private shouldForceNewTab

Parameters

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Private` appManager

`Private` shiftKeyPressed

`Private` subscriptions

`Private` workspaceManager

`Private` handleSingleResourceModeTransition

`Private` isSameResource

`Private` isShiftPressed

`Private` setupGlobalShiftKeyDetection

`Private` shouldForceNewTab