Data Binding in Apex Grid

Change the data source at runtime

The component supports changing its data source at runtime. If the new source has a different “shape” than the previous one make sure to update your column configuration as well.

grid.data = [...{
  /** records follow */
}];

// Update the column configuration to represent the new data.
grid.columns = [...];

If the grid has autoGenerate enabled, it will “infer” the new column configuration only if the old one is reset.

grid.autoGenerate = true;

/** Reset the previous column collection */
grid.columns = [];

/** After the new binding the grid will infer the column collection from the bound data. */
grid.data = [];

The sort/filter states of the Apex grid are kept when changing the data source in this manner. Usually you will want to reset them by calling either clearSort() and/or clearFilter().

In the sample below, the grid has column auto-generation enabled. When you click on the switch data button, the column collection is reset, and a new data source is bound to the grid.

Data Binding in Apex Grid

Stay Updated