Class ArtifactPartComponent

Runtime renderer for Artifact dashboard parts. Displays artifacts using mj-artifact-viewer-panel including reports, charts, and AI-generated content.

Hierarchy (View Summary)

BaseDashboardPart
- ArtifactPartComponent

Implements

AfterViewInit
OnDestroy

Index

Constructors

constructor

Accessors

currentUser environmentId hasArtifact IsEditing Panel ProviderToUse refreshTrigger RunQueryToUse RunViewToUse showCloseButton showHeader showMaximizeButton showTabs versionNumber

Constructors

constructor

new ArtifactPartComponent(
cdr: ChangeDetectorRef,
analyzeService: AnalyzeArtifactService,
): ArtifactPartComponent
Parameters
- cdr: ChangeDetectorRef
- analyzeService: AnalyzeArtifactService
Returns ArtifactPartComponent
Overrides BaseDashboardPart.constructor
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:208

Properties

artifactId

artifactId: string | null = null

`Protected`cdr

cdr: ChangeDetectorRef

ConfigureRequested

ConfigureRequested: EventEmitter<PartConfigureEvent> = ...

Emitted when user clicks configure button

CurrentUser

CurrentUser: UserInfo | null = null

Current user - required by the artifact viewer panel. Should be provided by the dashboard host or retrieved from a service.

DataChanged

DataChanged: EventEmitter<PartDataChangeEvent> = ...

Emitted when the part's data changes (e.g., selection in a grid)

EnvironmentId

EnvironmentId: string = ''

Environment ID - required by the artifact viewer panel. Should be provided by the dashboard host.

ErrorMessage

ErrorMessage: string | null = null

Error message if the part failed to load

HasArtifact

HasArtifact: boolean = false

IsLoading

IsLoading: boolean = false

Whether the part is currently loading

NavigationRequested

NavigationRequested: EventEmitter<DashboardNavRequestEvent> = ...

Emitted when the part requests navigation to another resource. Parent component handles actual routing based on the request type.

PartType

PartType: MJDashboardPartTypeEntity | null = null

The part type metadata

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.

RefreshTrigger

RefreshTrigger: Subject<{ artifactId: string; versionNumber: number }> = ...

RemoveRequested

RemoveRequested: EventEmitter<PartRemoveEvent> = ...

Emitted when user clicks remove button

ShowCloseButton

ShowCloseButton: boolean = false

ShowHeader

ShowHeader: boolean = false

ShowMaximizeButton

ShowMaximizeButton: boolean = false

ShowTabs

ShowTabs: boolean = true

VersionNumber

VersionNumber: number | undefined

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

"ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

Accessors

IsEditing

get IsEditing(): boolean
Returns boolean
Inherited from BaseDashboardPart.IsEditing
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:95
set IsEditing(value: boolean): void
Whether the dashboard is in edit mode
Parameters
- value: boolean
Returns void
Inherited from BaseDashboardPart.IsEditing
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:88

Panel

get Panel(): DashboardPanel | null
Returns DashboardPanel | null
Inherited from BaseDashboardPart.Panel
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:74
set Panel(value: DashboardPanel | null): void
The panel data including ID, title, icon, and configuration
Parameters
- value: DashboardPanel | null
Returns void
Inherited from BaseDashboardPart.Panel
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:67

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

refreshTrigger

get refreshTrigger(): Subject<{ artifactId: string; versionNumber: number }>
Returns Subject<{ artifactId: string; versionNumber: number }>
Deprecated
Use RefreshTrigger.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:185
set refreshTrigger(
value: Subject<{ artifactId: string; versionNumber: number }>,
): void
Parameters
- value: Subject<{ artifactId: string; versionNumber: number }>
Returns void
Deprecated
Use RefreshTrigger.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:189

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 BaseDashboardPart.RunQueryToUse
- Defined in packages/Angular/Generic/base-types/dist/base-angular-component.d.ts:25

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 BaseDashboardPart.RunViewToUse
- Defined in packages/Angular/Generic/base-types/dist/base-angular-component.d.ts:21

showCloseButton

get showCloseButton(): boolean
Returns boolean
Deprecated
Use ShowCloseButton.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:165
set showCloseButton(value: boolean): void
Parameters
- value: boolean
Returns void
Deprecated
Use ShowCloseButton.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:169

showHeader

get showHeader(): boolean
Returns boolean
Deprecated
Use ShowHeader.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:145
set showHeader(value: boolean): void
Parameters
- value: boolean
Returns void
Deprecated
Use ShowHeader.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:149

showMaximizeButton

get showMaximizeButton(): boolean
Returns boolean
Deprecated
Use ShowMaximizeButton.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:175
set showMaximizeButton(value: boolean): void
Parameters
- value: boolean
Returns void
Deprecated
Use ShowMaximizeButton.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:179

showTabs

get showTabs(): boolean
Returns boolean
Deprecated
Use ShowTabs.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:155
set showTabs(value: boolean): void
Parameters
- value: boolean
Returns void
Deprecated
Use ShowTabs.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:159

versionNumber

get versionNumber(): number | undefined
Returns number | undefined
Deprecated
Use VersionNumber.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:135
set versionNumber(value: number | undefined): void
Parameters
- value: number | undefined
Returns void
Deprecated
Use VersionNumber.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:139

Methods

`Protected`cleanup

cleanup(): void
Cleanup resources. Called in ngOnDestroy. Override to unsubscribe from observables, etc.

Returns void
Overrides BaseDashboardPart.cleanup
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:365

`Protected`emitDataChanged

emitDataChanged(data: unknown): void
Emit a data change event
Parameters
- data: unknown
Returns void
Inherited from BaseDashboardPart.emitDataChanged
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:218

`Protected`emitNavigationRequest

emitNavigationRequest(request: DashboardNavRequest): void
Emit a navigation request event
Parameters
- request: DashboardNavRequest
Returns void
Inherited from BaseDashboardPart.emitNavigationRequest
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:348

getConfig

getConfig<T extends PanelConfig>(): T | null
Get the typed configuration for this part. Subclasses should override to return the specific config type.
Type Parameters
- T extends PanelConfig
Returns T | null
Inherited from BaseDashboardPart.getConfig
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:188

`Protected`initialize

initialize(): void
Initialize the part. Called in ngOnInit. Override to perform async initialization like loading data.

Returns void
Inherited from BaseDashboardPart.initialize
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:147

loadContent

loadContent(): Promise<void>
Load or reload the part's content based on current configuration. Override to implement actual data loading.

Returns Promise<void>
Overrides BaseDashboardPart.loadContent
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:224

ngAfterViewInit

ngAfterViewInit(): void
A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

Returns void
Implementation of AfterViewInit.ngAfterViewInit
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:218

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
Inherited from BaseDashboardPart.ngOnDestroy
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:139

ngOnInit

ngOnInit(): void
A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns void
Inherited from BaseDashboardPart.ngOnInit
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:135

onAnalyzeRequested

onAnalyzeRequested(
event: { artifactId: string; snapshot: DataSnapshot },
): Promise<void>
Parameters
- event: { artifactId: string; snapshot: DataSnapshot }
Returns Promise<void>
Deprecated
Use OnAnalyzeRequested.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:361

OnAnalyzeRequested

OnAnalyzeRequested(
event: { artifactId: string; snapshot: DataSnapshot },
): Promise<void>
Handler for the Analyze button on the embedded artifact viewer. Captures the live DataSnapshot, creates an analysis conversation with the snapshot attached as input, and emits a navigation request to open the new conversation in the host application.
Parameters
- event: { artifactId: string; snapshot: DataSnapshot }
Returns Promise<void>
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:341

`Protected`onEditModeChanged

onEditModeChanged(isEditing: boolean): void
Called when edit mode changes. Override to adjust UI for edit mode.
Parameters
- isEditing: boolean
Returns void
Inherited from BaseDashboardPart.onEditModeChanged
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:174

onNavigateToLink

onNavigateToLink(
    event: {
        artifactId?: string;
        id: string;
        type: "conversation" | "collection";
        versionId?: string;
        versionNumber?: number;
    },
): void
Parameters
- event: {
      artifactId?: string;
      id: string;
      type: "conversation" | "collection";
      versionId?: string;
      versionNumber?: number;
  }
Returns void
Deprecated
Use OnNavigateToLink.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:287

OnNavigateToLink

OnNavigateToLink(
    event: {
        artifactId?: string;
        id: string;
        type: "conversation" | "collection";
        versionId?: string;
        versionNumber?: number;
    },
): void
Handle navigation link events from artifact viewer (conversation/collection links)
Parameters
- event: {
      artifactId?: string;
      id: string;
      type: "conversation" | "collection";
      versionId?: string;
      versionNumber?: number;
  }
Returns void
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:271

onNavigationRequest

onNavigationRequest(event: NavigationRequest): void
Parameters
- event: NavigationRequest
Returns void
Deprecated
Use OnNavigationRequest.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:331

OnNavigationRequest

OnNavigationRequest(event: NavigationRequest): void
Handle general navigation request events from artifact viewer plugins
Parameters
- event: NavigationRequest
Returns void
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:321

onOpenEntityRecord

onOpenEntityRecord(
event: { compositeKey: CompositeKey; entityName: string },
): void
Parameters
- event: { compositeKey: CompositeKey; entityName: string }
Returns void
Deprecated
Use OnOpenEntityRecord.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:314

OnOpenEntityRecord

OnOpenEntityRecord(
event: { compositeKey: CompositeKey; entityName: string },
): void
Handle entity record navigation events from artifact viewer
Parameters
- event: { compositeKey: CompositeKey; entityName: string }
Returns void
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:294

`Protected`onPanelChanged

onPanelChanged(
newPanel: DashboardPanel | null,
oldPanel: DashboardPanel | null,
): void
Called when the panel input changes. Override to react to configuration changes.
Parameters
- newPanel: DashboardPanel | null
- oldPanel: DashboardPanel | null
Returns void
Inherited from BaseDashboardPart.onPanelChanged
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:163

refresh

refresh(): void
Returns void
Deprecated
Use Refresh.
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:264

Refresh

Refresh(): void
Refresh the artifact display

Returns void
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/artifact-part.component.ts:254

requestConfigure

requestConfigure(): void
Request configuration (edit the part settings)

Returns void
Inherited from BaseDashboardPart.requestConfigure
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:195

RequestOpenApplication

RequestOpenApplication(
    applicationId: string,
    resourceName?: string,
    openInNewTab?: boolean,
): void
Request navigation to another application
Parameters
- applicationId: string
- OptionalresourceName: string
- openInNewTab: boolean = false
Returns void
Inherited from BaseDashboardPart.RequestOpenApplication
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:309

RequestOpenDashboard

RequestOpenDashboard(
    dashboardId: string,
    categoryId?: string,
    openInNewTab?: boolean,
): void
Request navigation to another dashboard
Parameters
- dashboardId: string
- OptionalcategoryId: string
- openInNewTab: boolean = false
Returns void
Inherited from BaseDashboardPart.RequestOpenDashboard
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:271

RequestOpenEntityRecord

RequestOpenEntityRecord(
    entityName: string,
    recordId: string,
    mode?: "view" | "edit",
    openInNewTab?: boolean,
): void
Request navigation to open a specific entity record
Parameters
- entityName: string
- recordId: string
- mode: "view" | "edit" = 'view'
- openInNewTab: boolean = false
Returns void
Inherited from BaseDashboardPart.RequestOpenEntityRecord
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:251

RequestOpenNavItem

RequestOpenNavItem(
    navItemName: string,
    appName?: string,
    queryParams?: Record<string, string>,
    openInNewTab?: boolean,
): void
Request navigation to a specific nav item within an application. Supports setting URL query parameters after navigation.
Parameters
- navItemName: string
- OptionalappName: string
- OptionalqueryParams: Record<string, string>
- openInNewTab: boolean = false
Returns void
Inherited from BaseDashboardPart.RequestOpenNavItem
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:328

RequestOpenQuery

RequestOpenQuery(
    queryId: string,
    parameters?: Record<string, unknown>,
    autoExecute?: boolean,
    openInNewTab?: boolean,
): void
Request navigation to a query
Parameters
- queryId: string
- Optionalparameters: Record<string, unknown>
- autoExecute: boolean = true
- openInNewTab: boolean = false
Returns void
Inherited from BaseDashboardPart.RequestOpenQuery
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:289

requestRemove

requestRemove(): void
Request removal of this part

Returns void
Inherited from BaseDashboardPart.requestRemove
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:207

`Protected`setError

setError(message: string | null): void
Set error state
Parameters
- message: string | null
Returns void
Inherited from BaseDashboardPart.setError
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:238

`Protected`setLoading

setLoading(loading: boolean): void
Set loading state
Parameters
- loading: boolean
Returns void
Inherited from BaseDashboardPart.setLoading
- Defined in packages/Angular/Generic/dashboard-viewer/src/lib/parts/base-dashboard-part.ts:230

Class ArtifactPartComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ArtifactPartComponent

Properties

artifactId

Protectedcdr

ConfigureRequested

CurrentUser

DataChanged

EnvironmentId

ErrorMessage

HasArtifact

IsLoading

NavigationRequested

PartType

Provider

RefreshTrigger

RemoveRequested

ShowCloseButton

ShowHeader

ShowMaximizeButton

ShowTabs

VersionNumber

Staticɵdir

Staticɵfac

Accessors

currentUser

Returns UserInfo

environmentId

Returns string

hasArtifact

Returns boolean

Deprecated

Parameters

Returns void

Deprecated

IsEditing

Returns boolean

Parameters

Returns void

Panel

Returns DashboardPanel | null

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

refreshTrigger

Returns Subject<{ artifactId: string; versionNumber: number }>

Deprecated

Parameters

Returns void

Deprecated

RunQueryToUse

Returns IRunQueryProvider

RunViewToUse

Returns IRunViewProvider

showCloseButton

Returns boolean

Deprecated

Parameters

Returns void

Deprecated

showHeader

Returns boolean

Deprecated

Parameters

Returns void

Deprecated

showMaximizeButton

Returns boolean

Deprecated

`Protected`cdr

`Static`ɵdir

`Static`ɵfac

`Protected`cleanup

`Protected`emitDataChanged

`Protected`emitNavigationRequest

`Protected`initialize

`Protected`onEditModeChanged

`Protected`onPanelChanged