Member Junction
    Preparing search index...

    A Config dashboard with its header: view mode (title, description, favorite, host actions, Edit) and edit mode (Editing badge, name and description fields, Add part, Save, Cancel), the part dialog and the dashboard viewer. Made for the dashboard tab and Home's dashboard view, so both edit a dashboard the same way; Save asks before it replaces a save made elsewhere during the edit. It never navigates: hosts handle its events.

    Hosts project their own header buttons: [headerTools] shows in both modes, [viewActions] in view mode after the star.

    Hierarchy (View Summary)

    Implements

    • AfterViewInit
    • OnDestroy
    Index

    Constructors

    Properties

    BodyStyle: DashboardEditorBodyStyle = 'fill'

    'fill': the dashboard fills the editor. 'card': a padded card body.

    ConfigChanged: EventEmitter<void> = ...

    The viewer's configuration changed (parts, layout).

    EditingChange: EventEmitter<boolean> = ...

    The editor entered (true) or left (false) edit mode. Not emitted when the editor is destroyed.

    EditingDescription: string = ''

    The description field.

    EditingName: string = ''

    The name field.

    EditPartPanel: DashboardPanel | null = null

    The part the part dialog edits in edit mode.

    FavoriteChange: EventEmitter<boolean> = ...

    The user starred (true) or unstarred (false) the dashboard.

    IsEditing: boolean = false

    True while the editor is in edit mode.

    IsSaving: boolean = false

    True while a Save of the shown dashboard runs (the question about a save made elsewhere, the screenshot, then the save). Meanwhile Edit, Save, Cancel, Add part and part edits do nothing, and the header shows it.

    Loaded: EventEmitter<MJDashboardEntity> = ...

    The dashboard's layout is ready. Once for each DashboardId.

    LoadFailed: EventEmitter<DashboardEditorLoadError> = ...

    The dashboard could not be shown: DashboardEngine does not hold it, it is a Code dashboard, or its layout failed. The editor then shows no dashboard.

    NameChanged: EventEmitter<string> = ...

    The shown dashboard's saved name changed: this editor's Save, or a save elsewhere. Never empty.

    NavigationRequested: EventEmitter<DashboardNavRequestEvent> = ...

    A part asked to open something: a record, another dashboard, a query.

    OpenInDashboardsRequested: EventEmitter<MJDashboardEntity> = ...

    The user clicked "Open in Dashboards".

    PartDialogMode: DashboardPartDialogMode | null = null

    Whether the part dialog is open to add a part or to edit one. Null while it is closed.

    Permissions: DashboardUserPermissions = NO_PERMISSIONS

    The user's permissions for the shown dashboard. Nothing is allowed before a dashboard loads.

    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.

    ReloadedFromSaved: EventEmitter<void> = ...

    The editor rebuilt the saved layout because the dashboard was saved elsewhere.

    Saved: EventEmitter<MJDashboardEntity> = ...

    The viewer saved the dashboard (before the editor leaves edit mode).

    ShowFavorite: boolean = true

    Shows the favorite star in view mode.

    ShowOpenInDashboards: boolean = false

    Shows "Open in Dashboards" in view mode.

    StartInEditMode: boolean = false

    Enter edit mode when the dashboard finishes loading. Read once per load, then reset (StartInEditModeChange).

    StartInEditModeChange: EventEmitter<boolean> = ...

    Emits false when the editor has read StartInEditMode, for a two-way binding.

    TitleTemplate: TemplateRef<DashboardEditorTitleContext> | null = null

    Replaces the view-mode title, for example with Home's breadcrumb and dashboard switcher.

    "ɵ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