[data grid] Can't group by nested value in fields

[maxd]

Steps to reproduce

I want to group rows by the model column but DataGridPremium can't do this:

As you can see the model column is empty.

MVP for reproducing this problem: link. The MVP is based on the first example from this page.

This happens because DataGridPremium can't extract values from fields in nested objects (e.g. from device.model and device.serial_number fields). Try to uncomment the model and serial_number fields in the rows array. When you make this you'll receive the error: row.device is undefined. If you fix this (e.g. replace row.device.??? with row.device?.xxx in valueGetter methods) the grouping will work fine:

Current behavior

The DataGridPremium can't group by field in nested objects i.e. it can group by model field in such {model: "X"} row but can't group by the same field in {device: {model: 'x'}} row when valueGetter extract this value.

Expected behavior

The DataGridPremium should group by field in nested objects extracted with valueGetter method from column definition.

Context

No response

Your environment

No response

Search keywords: grouping by nested fields

[michelengelen]

@MBilalShafi could you have a look at this one? Thanks!

[maxd]

I have found the solution to this problem. The groupingValueGetter method should be defined for extract nested fields:

...
groupingValueGetter: (_value, row) => row.device.model,
...

It's confusing. Is it possible to use the valueGetter method to extract nested fields if the groupingValueGetter method is undefined?

[michelengelen]

I have found the solution to this problem. The groupingValueGetter method should be defined for extract nested fields:

...
groupingValueGetter: (_value, row) => row.device.model,
...

It's confusing. Is it possible to use the valueGetter method to extract nested fields if the groupingValueGetter method is undefined?

No, that's not possible. As stated in the docs the groupingValueGetter is specifically used for grouping. It can be a different value as the one received from the valueGetter.

Does using that solve your use-case?

[flaviendelangle]

I went through all the discussions on the PR where I created the row grouping to find a reason not to fallback to valueGetter when groupingValueGetter is not defined, and I could not find any.

Not saying that we should change our behavior, just that remember a smart reason not to when we created this feature, it was just not discussed 👍

[maxd]

Does using that solve your use-case?

@michelengelen Yes, this solved the problem but I suppose it'll be better to mention in the documentation that the row grouping functionality uses the groupingValueGetter method instead of the valueGetter one to extract the value used for grouping i.e. both these methods should be defined if you are extracting values from nested fields.

[flaviendelangle]

but I suppose it'll be better to mention in the documentation that the row grouping functionality uses the groupingValueGetter

It's documented here
Maybe the discoverability of this section is not good enough

[michelengelen]

We could possibly add a callout and a crosslink here: Value getter

[github-actions]

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

We value your feedback @maxd! How was your experience with our support team?
If you could spare a moment, we'd love to hear your thoughts in this brief Support Satisfaction survey. Your insights help us improve!