Member Junction
    Preparing search index...

    Interface DashboardNavigationOptions

    Options for NavigationService.OpenDashboard

    interface DashboardNavigationOptions {
        alternateBaseView?: string;
        applicationId?: string;
        focusTab?: boolean;
        forceNewTab?: boolean;
        formMode?: "standard";
        newRecordValues?: string | Record<string, unknown>;
        openInEditMode?: boolean;
        pinTab?: boolean;
        queryParams?: Record<string, string | null>;
        recordSource?: RecordSourceContext | "none";
        replaceActive?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alternateBaseView? applicationId? focusTab? forceNewTab? formMode? newRecordValues? openInEditMode? pinTab? queryParams? recordSource? replaceActive?

    Properties

    alternateBaseView?: string

    Optional semantic name (EntityAlternateBaseView.Name) of an alternate base view to use when opening a dynamic view via OpenDynamicView.

    applicationId?: string

    The application the dashboard's tab belongs to. When omitted, or when that application is not loaded, the tab belongs to the default application (the Home app when it exists).

    focusTab?: boolean

    Focus the tab after creation (default: true)

    forceNewTab?: boolean

    Force creation of a new tab instead of replacing temporary tabs If not specified, the NavigationService will use global shift-key detection

    formMode?: "standard"

    Open the record in the CodeGen standard form even when a custom form is registered (MJ#4755). Applied as the tab's form=standard query param — on a new tab or on the existing tab the open focused — which the record resource hands to the form host. Omit to leave the tab's mode unchanged.

    newRecordValues?: string | Record<string, unknown>

    Initial values to populate when creating a new record. Should be a plain object with field names as keys.

    openInEditMode?: boolean

    Open the dashboard in edit mode, if the user can edit it. The open takes the usual tab path: a tab already open for the dashboard in that application is focused and enters edit mode, and otherwise the dashboard starts in edit mode in the tab it opens in (the replaced preview tab, or a separate tab for a Shift-click).

    pinTab?: boolean

    Create the tab as a pinned (permanent) tab

    queryParams?: Record<string, string | null>

    URL query parameters to set on the tab after navigation. Use null values to remove a query param.

    recordSource?: RecordSourceContext | "none"

    Origin override for record opens (records-style origin crumb).

    • omitted: NavigationService snapshots the active app/tab — correct for in-tab surfaces, WRONG for overlays/dialogs (it blames the page behind them).
    • a RecordSourceContext: used verbatim. Overlay surfaces set at least sourceLabel ('Conversation', 'Search', ...), plus app/nav-label when there is a real place to return to.
    • 'none': the open has no meaningful origin (e.g. recreating a closed tab from browser history) — no crumb is rendered.
    replaceActive?: boolean

    Replace the currently active tab instead of creating a new one

    Settings

    Member Visibility

    On This Page

    Properties