Interface · v2.7.0

NgbGridChartConfig

Configuration for the Grid to Chart composite widget.

Import

import type { NgbGridChartConfig } from '@angular-bootstrap/ngbootstrap';

Declaration

interface NgbGridChartConfig<T = any>

Properties

`mode`

mode: NgbGridChartMode

`rows`

Tabular rows used by the grid and chart builders.

rows: T[]

`dimension`

Primary label column (e.g. product name).

dimension: NgbDataDimensionDef<T>

`subDimension`

Optional secondary line under the dimension label (e.g. category).

subDimension?: NgbDataDimensionDef<T>

`metrics`

Metrics available for charts / sparklines.

metrics: NgbDataMetricDef<T>[]

`rowSelectionMetrics`

Metrics plotted for row-selection mode (defaults to all metrics).

rowSelectionMetrics?: NgbDataMetricDef<T>[]

`selectedMetricKeys`

Keys of metrics enabled in column-selection mode.

selectedMetricKeys?: string[]

`selectedRowIds`

Row ids selected in row-selection mode.

selectedRowIds?: Array<string | number>

`chartType`

chartType?: NgbDataChartType

`chartTitle`

chartTitle?: string

`valueFormatter`

valueFormatter?: (value: number) => string

`fullGrid`

Full-grid mode options (metric + grouping).

fullGrid?: Partial<NgbFullGridChartOptions<T>>

`sparkline`

sparkline?: NgbGridChartSparklineOptions<T>

`trailingColumns`

Extra grid columns appended after metric columns (e.g. growth %).

trailingColumns?: Array<{
        field: string;
        header: string;
        type?: 'text' | 'number';
        width?: number;
    }>

Referenced types

Source: types/angular-bootstrap-ngbootstrap.d.ts in the installed @angular-bootstrap/ngbootstrap package. Angular compiler metadata and private members are omitted.