Member Junction
    Preparing search index...

    Class QueryDataGridComponent

    A data grid component for displaying query results with full interactivity. Features:

    • Client-side sorting with multi-column support
    • Column resizing, reordering, and visibility toggle
    • Entity linking for columns with SourceEntityID
    • State persistence to User Settings
    • Export to Excel/CSV
    • Row selection (single, multiple, checkbox modes)
    <mj-query-data-grid
      [queryInfo]="query"
      [data]="queryResults"
      [selectionMode]="'multiple'"
      (entityLinkClick)="onEntityLinkClick($event)">
    </mj-query-data-grid>

    Hierarchy (View Summary)

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    AllowColumnReorder AllowColumnResize AllowSorting ColumnDefs Columns DefaultColDef EntityLinkClick ExcelMenuId ExportDataProvider ExportDialogConfig GridApi GridOptions GridStateChange Height InitialGridState IsLoading IsOpeningInExcel IsPreparingExport OpenInExcelTooltip PageChange PageNumber PageSize ParameterValues PersistState Provider RefreshRequest RowClick RowDetailData RowDetailIndex RowDoubleClick SelectedRows SelectionChange SelectionMode ShowExcelMenu ShowExport ShowExportDialog ShowOpenInExcel ShowRefresh ShowRowCount ShowRowDetailPanel ShowSelectionCount ShowToolbar SortState Theme TotalRowCount VisualConfig ɵdir ɵfac

    Accessors

    CanOpenInExcel ColumnConfigs Data ProviderToUse QueryInfo RowCount RunQueryToUse RunViewToUse SelectionCount

    Methods

    ApplyGridState ClearSelection CloseExcelMenu CloseRowDetailPanel Export FlushState GetContainerClasses GetGridState GetRowId GetRowSelectionConfig GetSelectedRows NavigateRowDetail ngOnDestroy ngOnInit OnColumnMoved OnColumnResized OnExcelMenuEscape OnExportDialogClosed OnExportSnapshotFromMenu OnGridReady OnOpenInExcelFromMenu OnRowClicked OnRowDetailEntityLinkClick OnRowDoubleClicked OnSelectionChanged OnSortChanged OpenExportDialog OpenInExcel OpenRowDetailPanel Refresh ToggleExcelMenu

    Constructors

    Properties

    AllowColumnReorder: boolean = true

    Whether to allow column reordering

    AllowColumnResize: boolean = true

    Whether to allow column resizing

    AllowSorting: boolean = true

    Whether to allow sorting

    ColumnDefs: ColDef<any, any>[] = []
    Columns: QueryGridColumnConfig[] = []
    DefaultColDef: ColDef = ...

    Default column settings - enables sorting, resizing

    EntityLinkClick: EventEmitter<QueryEntityLinkClickEvent> = ...

    Fired when an entity link is clicked

    ExcelMenuId: string = ...

    Unique DOM id pairing the unified Export/Excel disclosure trigger with its action popover.

    ExportDataProvider: (() => Promise<Record<string, unknown>[]>) | null = null

    Optional provider that returns the FULL result set for export. When the grid is server-side paged, Data only holds the current page (default 100 rows), so exporting Data would silently cap the export at the page size (bug B3/C1). A host that owns the query (with its parameters) can supply this callback to fetch every matching row on demand; the grid awaits it when the user exports without an explicit row selection. When not provided, export falls back to the loaded page.

    ExportDialogConfig: ExportDialogConfig | null = null
    GridApi: GridApi<any> | null = null
    GridOptions: GridOptions = ...
    GridStateChange: EventEmitter<QueryGridStateChangedEvent> = ...

    Fired when grid state changes (for persistence)

    Height: string = '100%'

    Height of the grid container

    InitialGridState: QueryGridState | null = null

    Initial grid state (for restoring from persistence)

    IsLoading: boolean = false

    External loading state - when true, shows loading overlay

    IsOpeningInExcel: boolean = false

    True while Open in Excel is building the workbook.

    IsPreparingExport: boolean = false

    True while an export is fetching the full result set via ExportDataProvider.

    OpenInExcelTooltip: string = OPEN_QUERY_IN_EXCEL_TOOLTIP

    The Open in Excel button's tooltip.

    PageChange: EventEmitter<PageChangeEvent> = ...

    Fired when the user navigates to a different page

    PageNumber: number = 1

    Current page number (1-based) for server-side paging

    PageSize: number = 100

    Page size for server-side paging

    ParameterValues: QueryParameterValues | null = null

    The parameter values of the query's last run. Open in Excel carries them into the workbook (never server-set ones); the host that ran the query supplies them.

    PersistState: boolean = true

    Whether to automatically persist grid state (column widths, order, sort) to User Settings

    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.

    RefreshRequest: EventEmitter<void> = ...

    Fired when refresh is requested

    RowClick: EventEmitter<QueryRowClickEvent> = ...

    Fired when a row is clicked

    RowDetailData: Record<string, unknown> | null = null
    RowDetailIndex: number = 0
    RowDoubleClick: EventEmitter<QueryRowClickEvent> = ...

    Fired when a row is double-clicked

    SelectedRows: Record<string, unknown>[] = []
    SelectionChange: EventEmitter<QuerySelectionChangedEvent> = ...

    Fired when selection changes

    SelectionMode: QueryGridSelectionMode = 'multiple'

    Selection mode for the grid

    ShowExcelMenu: boolean = false

    True while the unified Export/Excel toolbar action popover is open.

    ShowExport: boolean = true

    Whether to show export button

    ShowExportDialog: boolean = false
    ShowOpenInExcel: boolean = true

    Whether to show the Open in Excel button. It appears only for a saved query, when the MemberJunction host serves the Excel add-in and every required parameter has a value.

    ShowRefresh: boolean = true

    Whether to show refresh button

    ShowRowCount: boolean = true

    Whether to show row count in toolbar

    ShowRowDetailPanel: boolean = false
    ShowSelectionCount: boolean = true

    Whether to show selection count in toolbar

    ShowToolbar: boolean = true

    Whether to show the toolbar

    SortState: QueryGridSortState[] = []
    Theme: Theme = ...
    TotalRowCount: number = 0

    Total row count for server-side paging (from RunQueryResult.TotalRowCount). When > 0 and TotalPages > 1, the data pager is displayed below the grid.

    VisualConfig: QueryGridVisualConfig = {}

    Visual configuration

    "ɵ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

    • 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