Member Junction
    Preparing search index...

    Class BaseArtifactViewerPluginComponentAbstract

    Abstract base component for all artifact viewer plugins. Provides common functionality and enforces the contract. Note: This is an abstract class and should not be declared in Angular module.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    artifactVersion cssClass? height? navigationRequest? Provider readonly tabsChanged? ɵdir ɵfac

    Accessors

    hasDisplayContent isShowingElevatedDisplay parentShouldShowRawContent ProviderToUse RunQueryToUse RunReportToUse RunViewToUse SupportsFeedback

    Methods

    AskUserForFeedback GetAdditionalTabs? getContent GetCurrentStateSnapshot getDescription getDisplayName getDisplayTitle getRawContent GetStandardTabRemovals? parseJsonContent triggerBrowserDownload

    Constructors

    Properties

    artifactVersion: MJArtifactVersionEntity

    The artifact version to display

    cssClass?: string

    Optional: Additional CSS classes to apply

    height?: string

    Optional: Custom height for the viewer (defaults to auto)

    navigationRequest?: EventEmitter<NavigationRequest>

    Optional: Emitted when the plugin wants to navigate to a different app/nav item. Plugins that need app-level navigation (e.g., "Open Query" navigating to the Data Explorer's Queries nav item) should instantiate this emitter and emit a NavigationRequest. The event bubbles up through the artifact viewer chain to the host application where NavigationService handles the actual navigation.

    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.

    readonly: boolean = true

    Optional: Whether the viewer is in readonly mode

    tabsChanged?: EventEmitter<void>

    Optional: Emitted when the plugin's additional tabs change after async loading. Plugins that load data asynchronously (e.g., from a component registry) should emit this when loading completes and new tabs become available. The parent panel listens for this to re-run change detection and render the updated tab list.

    "ɵdir": unknown
    "ɵfac": unknown

    Accessors

    • get hasDisplayContent(): boolean

      Whether this plugin has content to display in the Display tab. Used by the parent wrapper to determine if the Display tab should be shown.

      Subclasses should override this getter to return true when they have meaningful content to display.

      Default: false (subclasses must opt-in to showing Display tab)

      Returns boolean

    • get isShowingElevatedDisplay(): boolean

      Whether this plugin is showing an "elevated" display (e.g., extracted markdown/HTML) vs raw content. When true and content type is JSON, the wrapper will show a JSON tab.

      Subclasses should override this getter to return the appropriate value based on their current display state. For example, JSON plugin returns true when showing displayMarkdown or displayHtml, false when showing raw JSON editor.

      Default: false (showing raw content)

      Returns boolean

    • get parentShouldShowRawContent(): boolean

      Whether the parent wrapper should show a raw content tab (e.g., JSON tab for JSON content). This gives plugins fine-grained control over the parent's tab display.

      Use cases:

      • JSON plugin with extract rules: true (show JSON tab to view source)
      • Component plugin: true (show JSON tab even when displaying elevated component)
      • Code plugin: false (already showing raw content)

      Subclasses can override this to control parent behavior. Default: true (parent should show raw content tab if applicable)

      Returns boolean

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunReportToUse(): IRunReportProvider

      Returns either the default RunReport provider or the one specified in the Provider property, if it was specified

      Returns IRunReportProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    • Ask the user for feedback on the current artifact. Called by the artifact viewer panel when the user clicks the feedback button in the header. Each plugin implements its own feedback UX (dialog, panel, inline form, etc.).

      Default: no-op. Subclasses should override to implement artifact-type-specific feedback.

      Returns void

    • Return a point-in-time snapshot of the data this viewer is currently displaying. Every viewer plugin MUST implement this with type-appropriate content.

      Guidelines for file-based viewers:

      • PDF: page count, current page in interpretation, extracted text summary in custom
      • Excel: each sheet as a DataTable in tables[], active sheet in activeTab
      • Word: section count in interpretation, extracted text in custom
      • For all: use getDisplayTitle() for snap.title

      Returns DataSnapshot | null

      A DataSnapshot describing the current state, or null if no data is available.

    • Get list of standard tabs that this plugin wants to hide/remove. Use this when the plugin provides custom alternatives to standard tabs.

      Example: Component viewer provides custom "Resolved JSON" tab, so removes standard "JSON" tab

      Returns string[]

      Array of standard tab names to remove (case-insensitive) Valid values: 'JSON', 'Details', 'Links' Note: 'Display' cannot be removed (it's the main view)

    • Trigger a browser file download from a URL. Shared by all file-backed viewer plugins (PDF, XLSX, DOCX) so the fetch → blob → object-URL → anchor pattern lives in exactly one place.

      Parameters

      • url: string
      • fileName: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods