Class QueryPivotComponent

A generic pivot table component that runs any saved Query or ad-hoc query parameters, groups and aggregates rows across dimensions and time grains, handles comparison windows, formats null values as em dashes ('—'), and renders via mj-query-data-grid.

Example

<mj-query-pivot
  [QueryName]="'AIUsageHourly'"
  [DimensionColumns]="['Agent']"
  [MeasureColumns]="[{ Key: 'TotalCost', Label: 'Cost', Format: 'currency' }]"
  (RowActivated)="onRowSelected($event)">
</mj-query-pivot>

Hierarchy (View Summary)

BaseAngularComponent
- QueryPivotComponent

Implements

OnInit
OnDestroy

Constructors

constructor

new QueryPivotComponent(cdr: ChangeDetectorRef): QueryPivotComponent
Parameters
- cdr: ChangeDetectorRef
Returns QueryPivotComponent
Overrides BaseAngularComponent.constructor
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:261

Properties

AutoRun

AutoRun: boolean = true

Whether to automatically execute the query when inputs initialize or change

CategoryPath

CategoryPath: string | null = null

Category path of the saved Query

ColumnConfigs

ColumnConfigs: QueryGridColumnConfig[] = []

DataSource

DataSource: "Materialized" | "Live" = 'Materialized'

Data source to query from: 'Materialized' (default) or 'Live'

ExecutionTimeMs

ExecutionTimeMs: number | null = null

GroupedRowCount

GroupedRowCount: number = 0

Height

Height: string = '100%'

Height of the pivot container

IsLoading

IsLoading: boolean = false

External loading state override

LastError

LastError: string | null = null

PivotComplete

PivotComplete: EventEmitter<PivotResult> = ...

Fired when pivot calculation finishes

PivotedData

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

Provider

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

QueryComplete: EventEmitter<RunQueryResult> = ...

Fired when query execution completes

QueryError

QueryError: EventEmitter<Error> = ...

Fired when query execution encounters an error

QueryStart

QueryStart: EventEmitter<void> = ...

Fired when query execution starts

RawData

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

RowActivated

RowActivated: EventEmitter<Record<string, unknown>> = ...

Emitted when a row is clicked or activated.

SelectionMode

SelectionMode: QueryGridSelectionMode = 'single'

Grid row selection mode

ShowToolbar

ShowToolbar: boolean = true

Whether to show the grid toolbar

TotalInputRows

TotalInputRows: number = 0

VisualConfig

VisualConfig: QueryGridVisualConfig = {}

Visual configuration passed to data grid

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

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

Accessors

ColumnLabels

get ColumnLabels(): Record<string, string>
Returns Record<string, string>
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:180
set ColumnLabels(value: Record<string, string>): void
Header titles for dimension/time columns, keyed by column name.
Parameters
- value: Record<string, string>
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:175

ComparisonPeriodColumn

get ComparisonPeriodColumn(): string | null
Returns string | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:170
set ComparisonPeriodColumn(value: string | null): void
Optional column identifying comparison/previous period rows
Parameters
- value: string | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:165

ComparisonWindow

get ComparisonWindow(): boolean
Returns boolean
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:160
set ComparisonWindow(value: boolean): void
Whether to compute comparison window metrics and deltas
Parameters
- value: boolean
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:155

Data

get Data(): Record<string, unknown>[] | null
Returns Record<string, unknown>[] | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:206
set Data(value: Record<string, unknown>[] | null): void
Optional raw data input (bypasses remote query execution if supplied)
Parameters
- value: Record<string, unknown>[] | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:199

DimensionColumns

get DimensionColumns(): string[]
Returns string[]
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:120
set DimensionColumns(value: string[]): void
Array of column names to group by
Parameters
- value: string[]
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:115

Grain

get Grain(): PivotTimeGrain | null
Returns PivotTimeGrain | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:150
set Grain(value: PivotTimeGrain | null): void
Grain for time bucketing: 'hour' | 'day'
Parameters
- value: PivotTimeGrain | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:145

HiddenColumns

get HiddenColumns(): string[]
Returns string[]
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:190
set HiddenColumns(value: string[]): void
Dimension columns used for grouping but not displayed (e.g. an ID shown via its name column).
Parameters
- value: string[]
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:185

Loading

get Loading(): boolean
Returns boolean
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:265

MeasureColumns

get MeasureColumns(): PivotMeasureColumn[]
Returns PivotMeasureColumn[]
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:130
set MeasureColumns(value: PivotMeasureColumn[]): void
Array of measure specifications to aggregate
Parameters
- value: PivotMeasureColumn[]
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:125

Parameters

get Parameters(): Record<string, unknown> | null
Returns Record<string, unknown> | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:100
set Parameters(value: Record<string, unknown> | null): void
Parameter values to supply to the query
Parameters
- value: Record<string, unknown> | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:95

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in base-types/dist/base-angular-component.d.ts:17

QueryID

get QueryID(): string | null
Returns string | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:80
set QueryID(value: string | null): void
ID of the saved Query (alternative to QueryName)
Parameters
- value: string | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:75

QueryName

get QueryName(): string | null
Returns string | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:67
set QueryName(value: string | null): void
Name of the saved Query to execute
Parameters
- value: string | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:62

QueryParams

get QueryParams(): RunQueryParams | null
Returns RunQueryParams | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:90
set QueryParams(value: RunQueryParams | null): void
Full RunQueryParams object passed by host
Parameters
- value: RunQueryParams | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:85

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in base-types/dist/base-angular-component.d.ts:25

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in base-types/dist/base-angular-component.d.ts:21

TimeColumn

get TimeColumn(): string | null
Returns string | null
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:140
set TimeColumn(value: string | null): void
Optional date/time column for time bucketing
Parameters
- value: string | null
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:135

Methods

ApplyPivot

ApplyPivot(rows: Record<string, unknown>[]): void
Purely calculates the pivot over provided rows and updates the view.
Parameters
- rows: Record<string, unknown>[]
Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:366

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-pivot/query-pivot.component.ts:278

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-pivot/query-pivot.component.ts:269

Refresh

Refresh(): void
Refreshes the query execution.

Returns void
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:391

Run

Run(): Promise<void>
Executes the query and calculates the pivot results.

Returns Promise<void>
- Defined in query-viewer/src/lib/query-pivot/query-pivot.component.ts:312

Class QueryPivotComponent

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QueryPivotComponent

Properties

AutoRun

CategoryPath

ColumnConfigs

DataSource

ExecutionTimeMs

GroupedRowCount

Height

IsLoading

LastError

PivotComplete

PivotedData

Provider

QueryComplete

QueryError

QueryStart

RawData

RowActivated

SelectionMode

ShowToolbar

TotalInputRows

VisualConfig

Staticɵdir

Staticɵfac

Accessors

ColumnLabels

Returns Record<string, string>

Parameters

Returns void

ComparisonPeriodColumn

Returns string | null

Parameters

Returns void

ComparisonWindow

Returns boolean

Parameters

Returns void

Data

Returns Record<string, unknown>[] | null

Parameters

Returns void

DimensionColumns

Returns string[]

Parameters

Returns void

Grain

Returns PivotTimeGrain | null

Parameters

Returns void

HiddenColumns

Returns string[]

Parameters

Returns void

Loading

Returns boolean

MeasureColumns

Returns PivotMeasureColumn[]

Parameters

Returns void

Parameters

Returns Record<string, unknown> | null

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

QueryID

Returns string | null

`Static`ɵdir

`Static`ɵfac