Class BaseResourceComponent`Abstract`

Base class for all MJ Explorer navigation components - a navigation component is any component that can be displayed from a route

Hierarchy (view full)

BaseNavigationComponent
- BaseResourceComponent
  - BaseDashboard

Constructors

constructor

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

Properties

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.

`Private` _data

_data: ResourceData = ...

`Private` _loadComplete

_loadComplete: boolean = false

`Private` _loadCompleteEvent

_loadCompleteEvent: any = null

`Private` _loadStarted

_loadStarted: boolean = false

`Private` _loadStartedEvent

_loadStartedEvent: any = null

`Private` _resourceRecordSavedEvent

_resourceRecordSavedEvent: any = null

`Static` ɵdir

ɵdir: unknown

`Static` ɵfac

ɵfac: unknown

Accessors

Data

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

LoadComplete

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

LoadCompleteEvent

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

LoadStarted

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

LoadStartedEvent

get LoadStartedEvent(): any
Returns any
- Defined in Explorer/shared/src/lib/base-resource-component.ts:36
set LoadStartedEvent(value): void
Parameters
- value: any
Returns void
- 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 BaseNavigationComponent.ProviderToUse
- Defined in Generic/base-types/dist/base-angular-component.d.ts:17

ResourceRecordSavedEvent

get ResourceRecordSavedEvent(): any
Returns any
- Defined in Explorer/shared/src/lib/base-resource-component.ts:44
set ResourceRecordSavedEvent(value): void
Parameters
- value: any
Returns void
- 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 BaseNavigationComponent.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 BaseNavigationComponent.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 BaseNavigationComponent.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>
- Defined in Explorer/shared/src/lib/base-resource-component.ts:74

`Abstract` GetResourceIconClass

GetResourceIconClass(data): Promise<string>
Parameters
- data: ResourceData
Returns Promise<string>
- Defined in Explorer/shared/src/lib/base-resource-component.ts:76

`Protected` NotifyLoadComplete

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

`Protected` NotifyLoadStarted

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

`Protected` ResourceRecordSaved

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

Class BaseResourceComponentAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseResourceComponent

Properties

Provider

Private _data

Private _loadComplete

Private _loadCompleteEvent

Private _loadStarted

Private _loadStartedEvent

Private _resourceRecordSavedEvent

Static ɵdir

Static ɵfac

Accessors

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>

Abstract GetResourceIconClass

Parameters

Returns Promise<string>

Protected NotifyLoadComplete

Returns void

Protected NotifyLoadStarted

Returns void

Protected ResourceRecordSaved

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Class BaseResourceComponent`Abstract`

`Private` _data

`Private` _loadComplete

`Private` _loadCompleteEvent

`Private` _loadStarted

`Private` _loadStartedEvent

`Private` _resourceRecordSavedEvent

`Static` ɵdir

`Static` ɵfac

`Abstract` GetResourceDisplayName

`Abstract` GetResourceIconClass

`Protected` NotifyLoadComplete

`Protected` NotifyLoadStarted

`Protected` ResourceRecordSaved