AbstractProtectedcdrEmitted when user clicks configure button
Emitted when the part's data changes (e.g., selection in a grid)
Error message if the part failed to load
Whether the part is currently loading
Emitted when the part requests navigation to another resource. Parent component handles actual routing based on the request type.
The part type metadata
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.
Emitted when user clicks remove button
StaticɵdirStaticɵfacWhether the dashboard is in edit mode
The panel data including ID, title, icon, and configuration
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified
Returns either the default RunReport provider or the one specified in the Provider property, if it was specified
Returns either the default RunView provider or the one specified in the Provider property, if it was specified
ProtectedcleanupCleanup resources. Called in ngOnDestroy. Override to unsubscribe from observables, etc.
ProtectedemitEmit a data change event
ProtectedemitGet the typed configuration for this part. Subclasses should override to return the specific config type.
ProtectedinitializeInitialize the part. Called in ngOnInit. Override to perform async initialization like loading data.
AbstractloadLoad or reload the part's content based on current configuration. Override to implement actual data loading.
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.
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.
ProtectedonCalled when edit mode changes. Override to adjust UI for edit mode.
ProtectedonCalled when the panel input changes. Override to react to configuration changes.
Request configuration (edit the part settings)
Request navigation to another dashboard
OptionalcategoryId: stringRequest navigation to a specific nav item within an application. Supports setting URL query parameters after navigation.
OptionalappName: stringOptionalqueryParams: Record<string, string>Request removal of this part
ProtectedsetSet error state
ProtectedsetSet loading state
Base class for dashboard part renderers.
Each part type (View, Query, Artifact, WebURL, etc.) has a renderer component that extends this class. The renderer is responsible for:
Subclasses are registered with @RegisterClass(BaseDashboardPart, 'PartTypeName') and instantiated via ClassFactory using the DashboardPartType.DriverClass field.
This allows new part types to be added by:
Register Class