Class BaseConfigPanel`Abstract`

Base class for config panels. Config panels contain ONLY the form content - no dialog chrome (header, footer, buttons). They communicate with their container via the configChanged output.

This allows the same panel to be used:

Embedded in the add-panel-dialog (step 2)
Wrapped in a dialog for editing existing panels

Subclasses are registered with

Register Class

and instantiated via ClassFactory.

Hierarchy (View Summary)

BaseAngularComponent
- BaseConfigPanel

Index

Constructors

constructor

new BaseConfigPanel(cdr: ChangeDetectorRef): BaseConfigPanel
Parameters
- cdr: ChangeDetectorRef
Returns BaseConfigPanel
Overrides BaseAngularComponent.constructor
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:60

Properties

`Protected`cdr

cdr: ChangeDetectorRef

configChanged

configChanged: EventEmitter<ConfigPanelResult> = ...

Emitted when configuration changes. Container should listen to this to update save button state, etc.

panel

panel: DashboardPanel | null = null

The existing panel (for editing) or null (for creating)

partType

partType: MJDashboardPartTypeEntity | null = null

The part type being configured

Provider

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.

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

"ɵfac": unknown

Accessors

config

get config(): PanelConfig | null
Returns PanelConfig | null
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:49
set config(value: PanelConfig | null): void
The initial configuration to populate form fields
Parameters
- value: PanelConfig | null
Returns void
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:43

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in base-types/dist/base-angular-component.d.ts:17

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in base-types/dist/base-angular-component.d.ts:25

RunReportToUse

get RunReportToUse(): IRunReportProvider
Returns either the default RunReport provider or the one specified in the Provider property, if it was specified

Returns IRunReportProvider
Inherited from BaseAngularComponent.RunReportToUse
- Defined in base-types/dist/base-angular-component.d.ts:29

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in base-types/dist/base-angular-component.d.ts:21

Methods

`Abstract`buildConfig

buildConfig(): PanelConfig
Build the configuration object from current form values.

Returns PanelConfig
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:73

`Protected`emitConfigChanged

emitConfigChanged(): void
Emit configuration changed event. Call this whenever form values change.

Returns void
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:126

getDefaultIcon

getDefaultIcon(): string
Get the default icon for this part type.

Returns string
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:103

`Abstract`getDefaultTitle

getDefaultTitle(): string
Get the default title for this part type.

Returns string
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:91

getIcon

getIcon(): string
Get the current icon for the panel.

Returns string
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:96

getResult

getResult(): ConfigPanelResult
Get the current configuration result. Called by container to get the final config when saving.

Returns ConfigPanelResult
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:111

`Abstract`getTitle

getTitle(): string
Get the current title for the panel.

Returns string
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:86

`Abstract`initFromConfig

initFromConfig(config: PanelConfig | null): void
Initialize form fields from a configuration. Called when config input changes.
Parameters
- config: PanelConfig | null
Returns void
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:68

validate

validate(): { errors: string[]; valid: boolean }
Validate the current form values.

Returns { errors: string[]; valid: boolean }
Validation result with valid flag and error messages
- Defined in dashboard-viewer/src/lib/config-panels/base-config-panel.ts:79

Class BaseConfigPanelAbstract

Register Class

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseConfigPanel

Properties

Protectedcdr

configChanged

panel

partType

Provider

Staticɵdir

Staticɵfac

Accessors

config

Returns PanelConfig | null

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

RunQueryToUse

Returns IRunQueryProvider

RunReportToUse

Returns IRunReportProvider

RunViewToUse

Returns IRunViewProvider

Methods

AbstractbuildConfig

Returns PanelConfig

ProtectedemitConfigChanged

Returns void

getDefaultIcon

Returns string

AbstractgetDefaultTitle

Returns string

getIcon

Returns string

getResult

Returns ConfigPanelResult

AbstractgetTitle

Returns string

AbstractinitFromConfig

Parameters

Returns void

validate

Returns { errors: string[]; valid: boolean }

Settings

On This Page

Class BaseConfigPanel`Abstract`

`Protected`cdr

`Static`ɵdir

`Static`ɵfac

`Abstract`buildConfig

`Protected`emitConfigChanged

`Abstract`getDefaultTitle

`Abstract`getTitle

`Abstract`initFromConfig