Class BaseDashboard`Abstract`

Make the base class a directive so we can use Angular functionality and sub-classes can be

Component

Hierarchy (view full)

BaseResourceComponent
- BaseDashboard

Implements

OnInit
OnDestroy

Constructors

constructor

new BaseDashboard(): BaseDashboard
Returns BaseDashboard
Inherited from BaseResourceComponent.constructor

Properties

Error

Error: EventEmitter<Error> = ...

Subclasses can emit anytime an error occurs.

Interaction

Interaction: EventEmitter<any> = ...

Subclasses can emit this event anytime they want to communicate with the container to let it know that something has happened of significance.

OpenEntityRecord

OpenEntityRecord: EventEmitter<{
EntityName: string;
RecordPKey: CompositeKey;
}> = ...

Subclasses can emit this event anytime they want to open a record within a particular entity. The container should handle this event and open the record.

Type declaration

EntityName: string
RecordPKey: CompositeKey

Provider

Provider: null | IMetadataProvider

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.

UserStateChanged

UserStateChanged: EventEmitter<any> = ...

Subclasses should emit this event anytime their internal state changes in a way that they'd like to persist.

`Protected` _config

_config: null | DashboardConfig = null

`Private` _visible

_visible: boolean = false

`Static` ɵdir

ɵdir: unknown

`Static` ɵfac

ɵfac: unknown

Accessors

Config

get Config(): null | DashboardConfig
Returns null | DashboardConfig
- Defined in Explorer/shared/src/lib/base-dashboard.ts:23
set Config(value): void
Set or change the dashboard configuration. Changing this property will NOT cause the dashboard to reload. Call Refresh() to do that.
Parameters
- value: DashboardConfig
Returns void
- Defined in Explorer/shared/src/lib/base-dashboard.ts:19

Data

get Data(): ResourceData
Returns ResourceData
Inherited from BaseResourceComponent.Data
- Defined in Explorer/shared/src/lib/base-resource-component.ts:9
set Data(value): void
Parameters
- value: ResourceData
Returns void
Inherited from BaseResourceComponent.Data
- Defined in Explorer/shared/src/lib/base-resource-component.ts:12

LoadComplete

get LoadComplete(): boolean
Returns boolean
Inherited from BaseResourceComponent.LoadComplete
- Defined in Explorer/shared/src/lib/base-resource-component.ts:17

LoadCompleteEvent

get LoadCompleteEvent(): any
Returns any
Inherited from BaseResourceComponent.LoadCompleteEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:28
set LoadCompleteEvent(value): void
Parameters
- value: any
Returns void
Inherited from BaseResourceComponent.LoadCompleteEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:31

LoadStarted

get LoadStarted(): boolean
Returns boolean
Inherited from BaseResourceComponent.LoadStarted
- Defined in Explorer/shared/src/lib/base-resource-component.ts:22

LoadStartedEvent

get LoadStartedEvent(): any
Returns any
Inherited from BaseResourceComponent.LoadStartedEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:36
set LoadStartedEvent(value): void
Parameters
- value: any
Returns void
Inherited from BaseResourceComponent.LoadStartedEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:39

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 BaseResourceComponent.ProviderToUse
- Defined in Generic/base-types/dist/base-angular-component.d.ts:17

ResourceRecordSavedEvent

get ResourceRecordSavedEvent(): any
Returns any
Inherited from BaseResourceComponent.ResourceRecordSavedEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:44
set ResourceRecordSavedEvent(value): void
Parameters
- value: any
Returns void
Inherited from BaseResourceComponent.ResourceRecordSavedEvent
- Defined in Explorer/shared/src/lib/base-resource-component.ts:47

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 BaseResourceComponent.RunQueryToUse
- Defined in Generic/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 BaseResourceComponent.RunReportToUse
- Defined in Generic/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 BaseResourceComponent.RunViewToUse
- Defined in Generic/base-types/dist/base-angular-component.d.ts:21

Methods

`Abstract` GetResourceDisplayName

GetResourceDisplayName(data): Promise<string>
Parameters
- data: ResourceData
Returns Promise<string>
Inherited from BaseResourceComponent.GetResourceDisplayName
- Defined in Explorer/shared/src/lib/base-resource-component.ts:74

GetResourceIconClass

GetResourceIconClass(data): Promise<string>
Sub-classes can override this to provide a custom icon class
Parameters
- data: ResourceData
Returns Promise<string>
Overrides BaseResourceComponent.GetResourceIconClass
- Defined in Explorer/shared/src/lib/base-dashboard.ts:86

`Protected` NotifyLoadComplete

NotifyLoadComplete(): void
Returns void
Inherited from BaseResourceComponent.NotifyLoadComplete
- Defined in Explorer/shared/src/lib/base-resource-component.ts:51

`Protected` NotifyLoadStarted

NotifyLoadStarted(): void
Returns void
Inherited from BaseResourceComponent.NotifyLoadStarted
- Defined in Explorer/shared/src/lib/base-resource-component.ts:58

Refresh

Refresh(): void
This method will result in the dashboard being reloaded.

Returns void
- Defined in Explorer/shared/src/lib/base-dashboard.ts:59

`Protected` ResourceRecordSaved

ResourceRecordSaved(resourceRecordEntity): void
Parameters
- resourceRecordEntity: BaseEntity<unknown>
Returns void
Inherited from BaseResourceComponent.ResourceRecordSaved
- Defined in Explorer/shared/src/lib/base-resource-component.ts:67

SetVisible

SetVisible(visible): void
This method can be used by a container to let the dashboard know that it is being opened/closed. Base class just sets a flag.
Parameters
- visible: boolean
Returns void
- Defined in Explorer/shared/src/lib/base-dashboard.ts:67

`Protected` `Abstract` initDashboard

initDashboard(): void
Subclasses can override this method to perform any initialization they need. This method only runs once when the dashboard is created.

Returns void
- Defined in Explorer/shared/src/lib/base-dashboard.ts:74

`Protected` `Abstract` loadData

loadData(): void
Subclasses should override this method to load their data. This method is called when the dashboard is created and when Refresh() is called.

Returns void
- Defined in Explorer/shared/src/lib/base-dashboard.ts:79

ngOnDestroy

ngOnDestroy(): void
Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in Explorer/shared/src/lib/base-dashboard.ts:54

ngOnInit

ngOnInit(): Promise<void>
Returns Promise<void>
Implementation of OnInit.ngOnInit
- Defined in Explorer/shared/src/lib/base-dashboard.ts:49

Class BaseDashboardAbstract

Component

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseDashboard

Properties

Error

Interaction

OpenEntityRecord

Type declaration

EntityName: string

RecordPKey: CompositeKey

Provider

UserStateChanged

Protected _config

Private _visible

Static ɵdir

Static ɵfac

Accessors

Config

Returns null | DashboardConfig

Parameters

Returns void

Data

Returns ResourceData

Parameters

Returns void

LoadComplete

Returns boolean

LoadCompleteEvent

Returns any

Parameters

Returns void

LoadStarted

Returns boolean

LoadStartedEvent

Returns any

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

ResourceRecordSavedEvent

Returns any

Parameters

Returns void

RunQueryToUse

Returns IRunQueryProvider

RunReportToUse

Returns IRunReportProvider

RunViewToUse

Returns IRunViewProvider

Methods

Abstract GetResourceDisplayName

Parameters

Returns Promise<string>

GetResourceIconClass

Parameters

Returns Promise<string>

Protected NotifyLoadComplete

Returns void

Protected NotifyLoadStarted

Returns void

Refresh

Returns void

Protected ResourceRecordSaved

Parameters

Returns void

SetVisible

Parameters

Returns void

Protected Abstract initDashboard

Returns void

Protected Abstract loadData

Class BaseDashboard`Abstract`

`Protected` _config

`Private` _visible

`Static` ɵdir

`Static` ɵfac

`Abstract` GetResourceDisplayName

`Protected` NotifyLoadComplete

`Protected` NotifyLoadStarted

`Protected` ResourceRecordSaved

`Protected` `Abstract` initDashboard

`Protected` `Abstract` loadData