Member Junction
    Preparing search index...

    Class QueryViewerComponent

    A composite component that provides a complete query viewing experience. Features:

    • Automatic parameter form display when query has parameters
    • Grid state persistence to User Settings
    • Parameter persistence to User Settings
    • Entity linking for clickable record IDs
    • Auto-run capability when all required params have saved values
    <mj-query-viewer
      [QueryId]="selectedQueryId"
      [AutoRun]="true"
      (EntityLinkClick)="openRecord($event)">
    </mj-query-viewer>

    Hierarchy (View Summary)

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    AutoRun CompositionTokenClick CurrentPageNumber DataGrid EntityLinkClick ExecutionTimeMs HasRun IsLoading LastError LastRunParameters OpenQueryRecord PageSize ParameterFormValues PersistParameters PersistState Provider QueryComplete QueryData QueryError QueryInfo QueryStart QueryTotalRowCount ReadOnlyParameters RowDoubleClick SavedGridState SelectionChange SelectionMode ShowInfoPanel ShowParamsPanel ShowToolbar VisualConfig ɵdir ɵfac

    Accessors

    HasParameters MappedParameters ProviderToUse QueryId RunQueryToUse RunViewToUse SavedParams

    Methods

    CloseInfoPanel FetchAllRowsForExport ngOnDestroy ngOnInit OnCompositionTokenClick OnEntityLinkClick OnGridStateChange OnOpenQueryRecord OnPageChange OnParametersSubmit OnParamsPanelClose OnRefreshRequest OnRowDoubleClick OnSelectionChange OpenInfoPanel OpenParametersPanel Refresh RunQuery

    Constructors

    Properties

    AutoRun: boolean = true

    Whether to auto-run the query when all required params have saved values

    CompositionTokenClick: EventEmitter<CompositionTokenClickEvent> = ...

    Fired when a composition token ({{query:"..."}}) is clicked in the SQL info panel

    CurrentPageNumber: number = 1
    DataGrid: QueryDataGridComponent
    EntityLinkClick: EventEmitter<QueryEntityLinkClickEvent> = ...

    Fired when an entity link is clicked in the grid

    ExecutionTimeMs: number | null = null
    HasRun: boolean = false
    IsLoading: boolean = false
    LastError: string | null = null
    LastRunParameters: QueryParameterValues | null = null

    The parameter values the rows on screen were produced with (mapped ones included, server-set ones left out), or null before the first successful run. The grid's Open in Excel carries them.

    OpenQueryRecord: EventEmitter<{ queryId: string; queryName: string }> = ...

    Fired when user wants to open the full query record

    PageSize: number = 100

    Number of rows per page for server-side paging. Set to 0 to disable paging and load all rows at once.

    ParameterFormValues: QueryParameterValues = {}

    What the parameter form shows: the user's values, with the mapped ones over them.

    PersistParameters: boolean = true

    Whether to persist parameter values

    PersistState: boolean = true

    Whether to persist grid state

    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.

    QueryComplete: EventEmitter<RunQueryResult> = ...

    Fired when query execution completes

    QueryData: Record<string, unknown>[] = []
    QueryError: EventEmitter<Error> = ...

    Fired when query execution fails

    QueryInfo: MJQueryEntityExtended | null = null
    QueryStart: EventEmitter<void> = ...

    Fired when query execution starts

    QueryTotalRowCount: number = 0

    Paging state

    ReadOnlyParameters: string[] = []

    The names of the mapped parameters, which the parameter form shows read-only.

    RowDoubleClick: EventEmitter<QueryRowClickEvent> = ...

    Fired when a row is double-clicked

    SavedGridState: QueryGridState | null = null
    SelectionChange: EventEmitter<QuerySelectionChangedEvent> = ...

    Fired when selection changes

    SelectionMode: QueryGridSelectionMode = 'single'

    Selection mode for the grid

    ShowInfoPanel: boolean = false
    ShowParamsPanel: boolean = false
    ShowToolbar: boolean = true

    Whether to show the toolbar

    VisualConfig: QueryGridVisualConfig = {}

    Visual configuration for the grid

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

    Accessors

    • 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 RunViewToUse(): IRunViewProvider

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

      Returns IRunViewProvider

    Methods

    • Fetches the FULL result set for the current query, used by the grid's export flow so exports aren't capped at the on-screen page (bug B3). Bound as an arrow property so it can be passed to the grid's ExportDataProvider input without losing this. Loads up to EXPORT_MAX_RECORDS (kept in lockstep with the entity-viewer's export cap) and warns — rather than silently truncating — when the query returns more. Uses the provider-scoped RunQuery so it targets the correct server in multi-provider setups. Falls back to the currently-loaded page on failure.

      Returns Promise<Record<string, unknown>[]>

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods