Vue Data GridContext

Version 36.2.0

This sections covers how shared contextual information can be passed around the grid.

Overview Copy Link

The context object is passed to all callbacks and events used in the grid. The purpose of the context object is to allow the client application to pass details to custom callbacks such as the Cell Renderers and Cell Editors.

any

Initial

Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks used by your application.

To update the context call api.setGridOption with the new context. Alternatively, if you maintain a reference to the context object it's values can be mutated directly.

Updating the context does not refresh the grid. The grid has no way of knowing which callbacks read which parts of the context, so the application must refresh whatever depends on it: api.refreshCells() re-runs value getters, cell class rules and cell renderers, api.refreshHeader() re-runs header value getters, and api.refreshClientSideRowModel('aggregate') recalculates aggregated values.

Typing the Context Copy Link

The context grid option is typed as any, so apply your own interface to it using as. That interface is then supplied to the TContext generic parameter of each callback or event interface that reads from the context, which types params.context.

interface IReportingContext {
    reportingCurrency: 'EUR' | 'GBP' | 'USD';
}

const gridOptions: GridOptions<IProduct> = {
    context: {
        reportingCurrency: 'EUR',
    } as IReportingContext,

    // other grid options ...
};

// TContext is the last generic parameter of ValueGetterParams<TData, TValue, TContext>
function reportingCurrencyValueGetter(params: ValueGetterParams<IProduct, IPrice, IReportingContext>) {
    // params.context.reportingCurrency is typed as 'EUR' | 'GBP' | 'USD'
    const reportingCurrency = params.context.reportingCurrency;
    // ...
}

TContext is always the last generic parameter of the interface and defaults to any when omitted, so it must be provided explicitly at each usage — unlike TData, it cannot be inferred from the grid options. See TypeScript Generics for how the grid's generic parameters fit together.

Context Object Example Copy Link

The example below demonstrates how the context object can be used. Note the following:

Selecting the reporting currency from the dropdown places it in the context object.
When the reporting currency is changed the cell renderer uses the currency supplied in the context object to calculate the value using: params.context.reportingCurrency.
The price column header is updated to show the selected currency using a header value getter using ctx.reportingCurrency.
Changing the context alone would leave the grid showing stale values, so api.refreshCells() and api.refreshHeader() are called afterwards to re-run the value getter and the header value getter.
The context is typed via the IReportingContext interface, supplied to the TContext generic parameter of ValueGetterParams and ICellRendererParams.

main.ts

import {
  createApp,
  defineComponent,
  onBeforeMount,
  ref,
  shallowRef,
} from "vue";
import { AgGridVue } from "ag-grid-vue3";
import {
  ClientSideRowModelModule,
  ColDef,
  ColGroupDef,
  GridApi,
  GridOptions,
  GridReadyEvent,
  HighlightChangesModule,
  ICellRendererParams,
  ModuleRegistry,
  RenderApiModule,
  ValueGetterParams,
  enableDevValidations,
} from "ag-grid-community";

if (process.env.NODE_ENV !== "production") {
  // Enable extended validations only for development
  enableDevValidations();
}

ModuleRegistry.registerModules([
  RenderApiModule,
  HighlightChangesModule,
  ClientSideRowModelModule,
]);

interface IPrice {
  currency: Currency;
  amount: number;
}
interface IProduct {
  product: string;
  price: IPrice;
}
interface IReportingContext {
  reportingCurrency: Currency;
}

const formatters: Record<Currency, Intl.NumberFormat> = {
  EUR: new Intl.NumberFormat("en-US", {
    style: "currency",
    currency: "EUR",
    minimumFractionDigits: 2,
  }),
  GBP: new Intl.NumberFormat("en-US", {
    style: "currency",
    currency: "GBP",
    minimumFractionDigits: 2,
  }),
  USD: new Intl.NumberFormat("en-US", {
    style: "currency",
    currency: "USD",
    minimumFractionDigits: 2,
  }),
};

const currencyComparator = (a: IPrice, b: IPrice) => {
  return a.amount - b.amount;
};

const currencyCellRenderer = (
  params: ICellRendererParams<IProduct, IPrice, IReportingContext>,
) => {
  const price = params.value;
  if (!price) {
    return "";
  }
  return formatters[price.currency]?.format(price.amount) ?? price.amount;
};

// Rates taken from google at time of writing
const exchangeRates: Record<Currency, Partial<Record<Currency, number>>> = {
  EUR: { GBP: 0.72, USD: 1.08 },
  GBP: { EUR: 1.29, USD: 1.5 },
  USD: { GBP: 0.67, EUR: 0.93 },
};

function reportingCurrencyValueGetter(
  params: ValueGetterParams<IProduct, IPrice, IReportingContext>,
): IPrice {
  const price = params.data!.price;
  // params.context is typed as IReportingContext, so reportingCurrency is typed as Currency
  const reportingCurrency = params.context.reportingCurrency;
  const fxRate = exchangeRates[reportingCurrency][price.currency];
  return {
    currency: reportingCurrency,
    amount: fxRate ? price.amount * fxRate : price.amount,
  };
}

function getData(): IProduct[] {
  return [
    { product: "Product 1", price: { currency: "EUR", amount: 644 } },
    { product: "Product 2", price: { currency: "EUR", amount: 354 } },
    { product: "Product 3", price: { currency: "GBP", amount: 429 } },
    { product: "Product 4", price: { currency: "GBP", amount: 143 } },
    { product: "Product 5", price: { currency: "USD", amount: 345 } },
    { product: "Product 6", price: { currency: "USD", amount: 982 } },
  ];
}

const VueExample = defineComponent({
  template: `
        <div style="height: 100%">
                <div style="height: 10%">
      <select id="currency" v-on:change="currencyChanged()">
        <option value="EUR">EUR</option>
        <option value="GBP">GBP</option>
        <option value="USD">USD</option>
      </select>
    </div>
    <ag-grid-vue
      style="width: 100%; height: 90%;"
      @grid-ready="onGridReady"
      :columnDefs="columnDefs"
      :defaultColDef="defaultColDef"
      :rowData="rowData"
      :context="context"></ag-grid-vue>
        </div>
    `,
  components: {
    "ag-grid-vue": AgGridVue,
  },
  setup(props) {
    const gridApi = shallowRef<GridApi<IProduct> | null>(null);
    const columnDefs = ref<ColDef[]>([
      { field: "product" },
      { headerName: "Currency", field: "price.currency" },
      {
        headerName: "Price Local",
        field: "price",
        cellRenderer: currencyCellRenderer,
        comparator: currencyComparator,
        cellDataType: false,
      },
      {
        headerName: "Report Price",
        field: "price",
        cellRenderer: currencyCellRenderer,
        comparator: currencyComparator,
        valueGetter: reportingCurrencyValueGetter,
        headerValueGetter: "ctx.reportingCurrency",
      },
    ]);
    const defaultColDef = ref<ColDef>({
      flex: 1,
      enableCellChangeFlash: true,
    });
    const rowData = ref<IProduct[] | null>(getData());
    const context = ref({
      reportingCurrency: "EUR",
    } as IReportingContext);

    function currencyChanged() {
      const value = (document.getElementById("currency") as HTMLSelectElement)
        .value as Currency;
      gridApi.value.setGridOption("context", {
        reportingCurrency: value,
      } as IReportingContext);
      // Changing the context does not refresh the grid on its own - the cells and
      // headers that read from it must be refreshed explicitly.
      gridApi.value.refreshCells();
      gridApi.value.refreshHeader();
    }
    const onGridReady = (params: GridReadyEvent) => {
      gridApi.value = params.api;
    };

    return {
      gridApi,
      columnDefs,
      defaultColDef,
      rowData,
      context,
      onGridReady,
      currencyChanged,
    };
  },
});

const app = createApp(VueExample);
app.mount("#app");

Context & Expressions Example Copy Link

Below shows a complex example making use of value getters (using expressions) and class rules (again using expressions). The grid shows 'actual vs budget data and yearly total' for widget sales split by city and country.

The Location column is showing the aggregation groups, grouping by city and country.
The Monthly Data columns are affected by the context. Depending on the selected period, the data displayed is either actual (x_act) or budgeted (x_bud) data for the month (eg. jan_act when Jan is green, or jan_bud when Jan is red). Similarly, the background color is also changed using class rules dependent on the selected period.
sum(YTD) is the total of the 'actual' figures, i.e. adding up all the green. This also changes as the period is changed.
Changing the period mutates context.month in place and then calls api.refreshClientSideRowModel('aggregate') and api.refreshCells() to recalculate the aggregations and re-render the affected cells.

Notice that the example (including calculating the expression on the fly, the grid only calculates what's needed to be displayed) runs very fast (once the data is loaded) despite having over 6,000 rows.

This example is best viewed by opening it in a new tab.

main.ts

import {
  createApp,
  defineComponent,
  onBeforeMount,
  ref,
  shallowRef,
} from "vue";

import type {
  ColDef,
  ColGroupDef,
  GridApi,
  GridReadyEvent,
  ICellRendererParams,
  RowSelectionOptions,
} from "ag-grid-community";
import {
  CellStyleModule,
  ClientSideRowModelApiModule,
  ClientSideRowModelModule,
  ModuleRegistry,
  QuickFilterModule,
  RenderApiModule,
  RowSelectionModule,
  enableDevValidations,
} from "ag-grid-community";
import {
  FiltersToolPanelModule,
  RowGroupingModule,
  SetFilterModule,
} from "ag-grid-enterprise";
import { AgGridVue } from "ag-grid-vue3";

import "./styles.css";

if (process.env.NODE_ENV !== "production") {
  // Enable extended validations only for development
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelApiModule,
  RenderApiModule,
  RowSelectionModule,
  CellStyleModule,
  ClientSideRowModelModule,
  QuickFilterModule,
  RowGroupingModule,
  SetFilterModule,
  FiltersToolPanelModule,
]);

const VueExample = defineComponent({
  template: `
        <div style="height: 100%">
            <div class="test-container">
                <div class="test-header">
                    <input type="text" id="filter-text-box" style="width: 100px;" v-on:input="onQuickFilterChanged()" placeholder="Filter...">
                    <span style="padding-left: 20px;">
                        <b>Period:</b>
                        <button v-on:click="onChangeMonth(-1)"><i class="fa fa-chevron-left"></i></button>
                        <button v-on:click="onChangeMonth(1)"><i class="fa fa-chevron-right"></i></button>
                        <span id="monthName" style="width: 100px; display: inline-block;">Year to Jan</span>
                    </span>
                    <span style="padding-left: 20px;">
                        <b>Legend:</b>&nbsp;&nbsp;
                        <div class="cell-bud legend-box"></div> Actual&nbsp;&nbsp;
                        <div class="cell-act legend-box"></div> Budget
                    </span>
                </div>
                <ag-grid-vue
                
                style="width: 100%; height: 100%;"
                :columnDefs="columnDefs"
                :suppressMovableColumns="true"
                @grid-ready="onGridReady"
                :context="context"
                :defaultColDef="defaultColDef"
                :autoGroupColumnDef="autoGroupColumnDef"
                :rowSelection="rowSelection"
                :rowData="rowData"></ag-grid-vue></div>
        </div>
    `,
  components: {
    "ag-grid-vue": AgGridVue,
  },
  setup(props) {
    const columnDefs = ref<(ColDef | ColGroupDef)[]>([
      { field: "country", rowGroup: true, hide: true },
      {
        headerName: "Monthly Data",
        children: [
          {
            field: "jan",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            field: "feb",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            field: "mar",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            field: "apr",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            field: "may",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            field: "jun",
            cellRenderer: accountingCellRenderer,
            cellClass: "cell-figure",
            valueGetter: monthValueGetter,
            cellClassRules: monthCellClassRules,
            aggFunc: "sum",
          },
          {
            headerName: "YTD",
            cellClass: "cell-figure",
            cellRenderer: accountingCellRenderer,
            valueGetter: yearToDateValueGetter,
            aggFunc: "sum",
          },
        ],
      },
    ]);
    const gridApi = shallowRef<GridApi | null>(null);
    const defaultColDef = ref<ColDef>({
      flex: 1,
      minWidth: 120,
    });
    const context = ref(null);
    const autoGroupColumnDef = ref<ColDef>(null);
    const rowData = ref<any[]>(null);
    const rowSelection = ref<RowSelectionOptions>(null);

    onBeforeMount(() => {
      context.value = {
        month: 0,
        months: [
          "jan",
          "feb",
          "mar",
          "apr",
          "may",
          "jun",
          "jul",
          "aug",
          "sep",
          "oct",
          "nov",
          "dec",
        ],
      };
      autoGroupColumnDef.value = {
        headerName: "Location",
        field: "city",
        minWidth: 260,
        cellRenderer: "agGroupCellRenderer",
      };
      rowSelection.value = {
        mode: "multiRow",
        headerCheckbox: false,
        groupSelects: "descendants",
      };
    });

    const onChangeMonth = (i) => {
      var newMonth = (context.value.month += i);
      if (newMonth < -1) {
        newMonth = -1;
      }
      if (newMonth > 5) {
        newMonth = 5;
      }
      // Mutate the context object in place
      context.value.month = newMonth;
      document.querySelector("#monthName").textContent =
        monthNames[newMonth + 1];
      gridApi.value.refreshClientSideRowModel("aggregate");
      gridApi.value.refreshCells();
    };
    const onQuickFilterChanged = () => {
      gridApi.value.setGridOption(
        "quickFilterText",
        document.getElementById("filter-text-box").value,
      );
    };
    const onGridReady = (params: GridReadyEvent) => {
      gridApi.value = params.api;

      const updateData = (data) => {
        rowData.value = data;
      };

      fetch("https://www.ag-grid.com/example-assets/monthly-sales.json")
        .then((resp) => resp.json())
        .then((data) => updateData(data));
    };

    return {
      columnDefs,
      gridApi,
      context,
      defaultColDef,
      autoGroupColumnDef,
      rowSelection,
      rowData,
      onGridReady,
      onChangeMonth,
      onQuickFilterChanged,
    };
  },
});

var monthValueGetter =
  '(ctx.month < ctx.months.indexOf(colDef.field)) ? data[colDef.field + "_bud"] : data[colDef.field + "_act"]';

var monthCellClassRules = {
  "cell-act": "ctx.month < ctx.months.indexOf(colDef.field)",
  "cell-bud": "ctx.month >= ctx.months.indexOf(colDef.field)",
  "cell-negative": "x < 0",
};

var yearToDateValueGetter =
  'var total = 0; ctx.months.forEach( function(monthName, monthIndex) { if (monthIndex<=ctx.month) { total += data[monthName + "_act"]; } }); return total; ';

var accountingCellRenderer = function (params: ICellRendererParams) {
  if (params.value == null) {
    return "";
  } else if (params.value >= 0) {
    return params.value.toLocaleString();
  } else {
    return "(" + Math.abs(params.value).toLocaleString() + ")";
  }
};

var monthNames = [
  "Budget Only",
  "Year to Jan",
  "Year to Feb",
  "Year to Mar",
  "Year to Apr",
  "Year to May",
  "Year to Jun",
  "Year to Jul",
  "Year to Aug",
  "Year to Sep",
  "Year to Oct",
  "Year to Nov",
  "Full Year",
];

createApp(VueExample).mount("#app");

styles.css

.ag-basic .ag-cell {
    padding-top: 2px !important;
    padding-bottom: 2px !important;
}

label {
    font-weight: normal !important;
}

.cell-act {
    background: rgba(255, 0, 0, 0.1);
}

.cell-bud {
    background: rgba(0, 255, 0, 0.1);
}

.legend-box {
    display: inline-block;
    border: 1px solid black;
    width: 12px;
    height: 12px;
}

.cell-figure {
    text-align: right;
}

.test-grid {
    flex-grow: 1;
}

.test-container {
    height: 100%;
    display: flex;
    flex-direction: column;
    font-family: Verdana, Geneva, Tahoma, sans-serif;
    font-size: 14px;
}

.test-container button {
    font-size: 14px;
    line-height: 20px;
}

.test-header {
    margin-left: 20px;
}

Getting Started

AI Features

Layout & Styling

Charting

Core Features

Advanced Features

Vue Data GridContext

Overview Copy Link

Typing the Context Copy Link

Context Object Example Copy Link

Context & Expressions Example Copy Link