ProtectedcdrThe props the component gets: mapped values, prop defaults, and a callback per declared event.
Emitted 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
True after a wired event of this part fired with a value, until the selection is cleared.
Whether the part names a component.
The part's inputs as last worked out from its mappings. Null when it has no mappings: it runs as before.
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.
Emitted when the part raises one of the events it declares (a View part's RecordSelected, a
Query part's RowSelected, a component's declared events). Values null: the selection was cleared.
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
The component's specification, once loaded.
The events of this part a dashboard wire listens to. After one fires, the part offers Clear selection.
StaticɵdirStaticɵfacProtectedInputThis part's input mappings, from its config. Empty when it has none.
Why the part can't run with its mappings (a broken mapping, a missing input), or null.
Whether the dashboard is in edit mode
The panel data including ID, title, icon, and configuration
The dashboard's properties and their values as this part sees them, set by the viewer when the dashboard has properties or the part has input mappings. Null (the default): the part ignores its mappings and runs exactly as before. A new context reapplies the part's inputs only when the values it runs with change.
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified
ProtectedResolutionThe context the part's token defaults are worked out with: the provider's user and the browser's zone.
Returns either the default RunQuery 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
ProtectedApplyNew input values: the component re-renders with new props; the component isn't reloaded.
ProtectedcleanupCleanup resources. Called in ngOnDestroy. Override to unsubscribe from observables, etc.
Clears the selection a wired event of this part set, so the dashboard property goes back to its host value or default.
ProtectedemitEmit a data change event
ProtectedemitProtectedEmitRaises one of the part's events. Values null clears the selection it set.
Get 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.
Load or reload the part's content based on current configuration. Override to implement actual data loading.
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.
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.
The component asked to open a record.
ProtectedonCalled when the panel input changes. Override to react to configuration changes.
ProtectedOnCalled when the viewer hands the part a new context. Reapplies the inputs only when the values the part runs with changed, so a property the part doesn't map, or a value its own event set, never refreshes it.
An event the component raised through callbacks.NotifyEvent: a declared one is a part event.
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
ProtectedUpdateRecords the inputs the part declares and works out their values from its mappings. Returns null, and the part runs exactly as before, when it has no mappings.
Runtime renderer for Interactive Component dashboard parts.
Renders a registered component (
MJ: Components, by name, and namespace and version when the part gives them) in the React host, with its props from the part's input mappings and, for an unmapped prop, the prop's owndefaultValue. The React host'sutilities(md,rv,rq) come from the part'sProviderToUse, so the dashboard's provider reaches the component's data access.The component's declared events are the part's events: each is passed to the component as a callback prop of the same name (
onSelect(id)), and is also heard when the component raises it throughcallbacks.NotifyEvent. Its values are the event's declared parameters.