Member Junction
    Preparing search index...

    The dialog that adds a part to a dashboard or edits one, on mj-dialog.

    It shows the part type tiles, the part type's settings panel as the Source section, the title and, for a query, the parameter-controls and auto refresh options. The settings panel is the BaseConfigPanel that ClassFactory registers under the part type's ConfigDialogClass; the dialog passes it Provider and hides the panel's own copies of the fields it shows itself. In edit mode the part's type cannot change, so the other tiles are disabled.

    The host opens and closes it, for example with @if around [Visible]="true".

    Hierarchy (View Summary)

    Implements

    • OnDestroy
    Index

    Constructors

    Properties

    AutoRefreshEnabled: boolean = false

    Query option: refresh the part on a timer.

    AutoRefreshSeconds: number = DEFAULT_QUERY_REFRESH_SECONDS

    Query option: the refresh interval, in seconds.

    Cancelled: EventEmitter<void> = ...

    Emitted on Cancel, and when the user closes the dialog with Escape, the backdrop or the close button.

    Errors: string[] = []

    The settings panel's validation errors from the last Add part or Apply.

    IsLoadingPanel: boolean = false

    True while the settings panel of the chosen part type loads.

    LoadError: string | null = null

    Why the settings panel could not load, when it could not.

    Whether the dialog adds a new part or edits Panel.

    Panel: DashboardPanel | null = null

    The part to edit in edit mode. Its part type is the one in PartTypes with its partTypeId.

    PartTypes: MJDashboardPartTypeEntity[] = []

    The part types to offer. The tiles show the active ones, and the edited part's type, by SortOrder.

    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.

    Saved: EventEmitter<DashboardPartDialogResult> = ...

    Emitted on Add part or Apply with the part type, config, title and icon of the part.

    SelectedPartType: MJDashboardPartTypeEntity | null = null

    The chosen part type.

    ShowParameterControls: boolean = true

    Query option: show the query's parameter controls on the part.

    SourceName: string = ''

    The name of the chosen source, from the settings panel. A part type without one shows its tile label.

    Title: string = ''

    The part's title: empty for a new part, the part's title in edit mode. An empty title means the source name.

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