Ag-grid column definition and `__metadata__` property

Question

I need to introduce object with my own properties in columnDefs object. After, I did it, I see in dev console

So, here has been written, that I could mean __metadata__ property. Does this property suit to mine purpose?

I've not found any information in types and docs about this property

Answer 1

ColDef has no custom state property that you could use. Certainly do not touch __metadata__. The name sounds like some internal implementation detail.

You can store your metadata in a separate object, for example using colId as a key:

columnDefs: ColDef[] = [
  {
    colId: 'id',
    field: 'id'
  },
  {
    colId: 'name',
    field: 'name'
  }
];

columnMetadata: {
  id: 'something custom',
  name: 'custom data'
}

private getColumnMetadata(column: Column) {
  return this.columnMetadata[column.getColId()];
}