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)

Example

<mj-query-data-grid
  [queryInfo]="query"
  [data]="queryResults"
  [selectionMode]="'multiple'"
  (entityLinkClick)="onEntityLinkClick($event)">
</mj-query-data-grid>

Implements

OnInit
OnDestroy

Index

Constructors

constructor

Accessors

ColumnConfigs Data QueryInfo RowCount SelectionCount

Constructors

constructor

new QueryDataGridComponent(
    cdr: ChangeDetectorRef,
    elementRef: ElementRef,
    exportService: ExportService,
): QueryDataGridComponent
Parameters
- cdr: ChangeDetectorRef
- elementRef: ElementRef
- exportService: ExportService
Returns QueryDataGridComponent
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:368

Properties

AllowColumnReorder

AllowColumnReorder: boolean = true

Whether to allow column reordering

AllowColumnResize

AllowColumnResize: boolean = true

Whether to allow column resizing

AllowSorting

AllowSorting: boolean = true

Whether to allow sorting

ColumnDefs

ColumnDefs: ColDef<any, any>[] = []

Columns

Columns: QueryGridColumnConfig[] = []

DefaultColDef

DefaultColDef: ColDef = ...

Default column settings - enables sorting, resizing

EntityLinkClick

EntityLinkClick: EventEmitter<QueryEntityLinkClickEvent> = ...

Fired when an entity link is clicked

ExportDialogConfig

ExportDialogConfig: ExportDialogConfig | null = null

GridApi

GridApi: GridApi<any> | null = null

GridOptions

GridOptions: GridOptions = ...

GridStateChange

GridStateChange: EventEmitter<QueryGridStateChangedEvent> = ...

Fired when grid state changes (for persistence)

Height

Height: string = '100%'

Height of the grid container

InitialGridState

InitialGridState: QueryGridState | null = null

Initial grid state (for restoring from persistence)

IsLoading

IsLoading: boolean = false

External loading state - when true, shows loading overlay

PageChange

PageChange: EventEmitter<PageChangeEvent> = ...

Fired when the user navigates to a different page

PageNumber

PageNumber: number = 1

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

PageSize

PageSize: number = 100

Page size for server-side paging

PersistState

PersistState: boolean = true

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

RefreshRequest

RefreshRequest: EventEmitter<void> = ...

Fired when refresh is requested

RowClick

RowClick: EventEmitter<QueryRowClickEvent> = ...

Fired when a row is clicked

RowDetailData

RowDetailData: Record<string, unknown> | null = null

RowDetailIndex

RowDetailIndex: number = 0

RowDoubleClick

RowDoubleClick: EventEmitter<QueryRowClickEvent> = ...

Fired when a row is double-clicked

SelectedRows

SelectedRows: Record<string, unknown>[] = []

SelectionChange

SelectionChange: EventEmitter<QuerySelectionChangedEvent> = ...

Fired when selection changes

SelectionMode

SelectionMode: QueryGridSelectionMode = 'multiple'

Selection mode for the grid

ShowExport

ShowExport: boolean = true

Whether to show export button

ShowExportDialog

ShowExportDialog: boolean = false

ShowRefresh

ShowRefresh: boolean = true

Whether to show refresh button

ShowRowCount

ShowRowCount: boolean = true

Whether to show row count in toolbar

ShowRowDetailPanel

ShowRowDetailPanel: boolean = false

ShowSelectionCount

ShowSelectionCount: boolean = true

Whether to show selection count in toolbar

ShowToolbar

ShowToolbar: boolean = true

Whether to show the toolbar

SortState

SortState: QueryGridSortState[] = []

Theme

Theme: Theme = ...

TotalRowCount

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

VisualConfig: QueryGridVisualConfig = {}

Visual configuration

Accessors

ColumnConfigs

get ColumnConfigs(): QueryGridColumnConfig[] | null
Returns QueryGridColumnConfig[] | null
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:151
set ColumnConfigs(value: QueryGridColumnConfig[] | null): void
Optional pre-built column configurations for ad-hoc queries without saved metadata. When provided, overrides both QueryInfo-derived columns and auto-inferred columns. Enables entity linking without requiring a saved Query or QueryInfo object.

Set this BEFORE setting Data to ensure columns are configured before the grid renders.
Parameters
- value: QueryGridColumnConfig[] | null
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:143

Data

get Data(): Record<string, unknown>[]
Returns Record<string, unknown>[]
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:193
set Data(value: Record<string, unknown>[]): void
The query result data to display in the grid.
Parameters
- value: Record<string, unknown>[]
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:170

QueryInfo

get QueryInfo(): MJQueryEntityExtended | null
Returns MJQueryEntityExtended | null
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:130
set QueryInfo(value: MJQueryEntityExtended | null): void
The QueryInfo metadata for the query being displayed. Used to derive column configurations and entity linking.
Parameters
- value: MJQueryEntityExtended | null
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:119

RowCount

get RowCount(): number
Returns number
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1124

SelectionCount

get SelectionCount(): number
Returns number
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1128

Methods

ApplyGridState

ApplyGridState(state: QueryGridState): void
Parameters
- state: QueryGridState
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:835

ClearSelection

ClearSelection(): void
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1110

CloseRowDetailPanel

CloseRowDetailPanel(): void
Closes the row detail panel

Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1203

Export

Export(
options?: Partial<ExportOptions>,
download?: boolean,
): Promise<ExportResult>
Export grid data directly without showing dialog
Parameters
- Optionaloptions: Partial<ExportOptions>
- download: boolean = true
Returns Promise<ExportResult>
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1052

FlushState

FlushState(): void
Flushes any pending state changes immediately. Call this before destroying the component or switching queries to ensure all state changes are persisted.

Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:954

GetContainerClasses

GetContainerClasses(): Record<string, boolean>
Returns CSS classes for the container based on visual config

Returns Record<string, boolean>
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:986

GetGridState

GetGridState(): QueryGridState
Returns QueryGridState
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:822

GetRowId

GetRowId(params: GetRowIdParams): string
Parameters
- params: GetRowIdParams
Returns string
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1157

GetRowSelectionConfig

GetRowSelectionConfig(): RowSelectionOptions | undefined
Returns RowSelectionOptions | undefined
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1136

GetSelectedRows

GetSelectedRows(): Record<string, unknown>[]
Returns Record<string, unknown>[]
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1120

NavigateRowDetail

NavigateRowDetail(direction: "prev" | "next"): void
Navigate to the previous row in the detail panel
Parameters
- direction: "prev" | "next"
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1212

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:399

ngOnInit

ngOnInit(): void
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
Implementation of OnInit.ngOnInit
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:394

OnColumnMoved

OnColumnMoved(event: ColumnMovedEvent): void
Parameters
- event: ColumnMovedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:798

OnColumnResized

OnColumnResized(event: ColumnResizedEvent): void
Parameters
- event: ColumnResizedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:787

OnExportDialogClosed

OnExportDialogClosed(result: ExportDialogResult): void
Handle export dialog close
Parameters
- result: ExportDialogResult
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1043

OnGridReady

OnGridReady(event: GridReadyEvent): void
Parameters
- event: GridReadyEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:410

OnRowClicked

OnRowClicked(event: RowClickedEvent): void
Parameters
- event: RowClickedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:725

OnRowDetailEntityLinkClick

OnRowDetailEntityLinkClick(event: RowDetailEntityLinkEvent): void
Handle entity link click from the row detail panel
Parameters
- event: RowDetailEntityLinkEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1239

OnRowDoubleClicked

OnRowDoubleClicked(event: RowDoubleClickedEvent): void
Parameters
- event: RowDoubleClickedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:737

OnSelectionChanged

OnSelectionChanged(event: SelectionChangedEvent): void
Parameters
- event: SelectionChangedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:746

OnSortChanged

OnSortChanged(event: SortChangedEvent): void
Parameters
- event: SortChangedEvent
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:766

OpenExportDialog

OpenExportDialog(): void
Opens the export dialog with current grid data

Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1019

OpenRowDetailPanel

OpenRowDetailPanel(rowData: Record<string, unknown>, rowIndex: number): void
Opens the row detail panel with the given row data
Parameters
- rowData: Record<string, unknown>
- rowIndex: number
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1193

Refresh

Refresh(): void
Returns void
- Defined in query-viewer/src/lib/query-data-grid/query-data-grid.component.ts:1012

Class QueryDataGridComponent

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QueryDataGridComponent

Properties

AllowColumnReorder

AllowColumnResize

AllowSorting

ColumnDefs

Columns

DefaultColDef

EntityLinkClick

ExportDialogConfig

GridApi

GridOptions

GridStateChange

Height

InitialGridState

IsLoading

PageChange

PageNumber

PageSize

PersistState

RefreshRequest

RowClick

RowDetailData

RowDetailIndex

RowDoubleClick

SelectedRows

SelectionChange

SelectionMode

ShowExport

ShowExportDialog

ShowRefresh

ShowRowCount

ShowRowDetailPanel

ShowSelectionCount

ShowToolbar

SortState

Theme

TotalRowCount

VisualConfig

Accessors

ColumnConfigs

Returns QueryGridColumnConfig[] | null

Parameters

Returns void

Data

Returns Record<string, unknown>[]

Parameters

Returns void

QueryInfo

Returns MJQueryEntityExtended | null

Parameters

Returns void

RowCount

Returns number

SelectionCount

Returns number

Methods

ApplyGridState

Parameters

Returns void

ClearSelection

Returns void

CloseRowDetailPanel

Returns void

Export

Parameters

Returns Promise<ExportResult>

FlushState

Returns void