Knockout-Contrib / Knockout-Contrib/KoGrid

[Docs] aggLabelFilter details.

Open
#287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
277
Forks
124
PR merge metrics
No merged PRs in 30d

Description

edit:
Ok now I'm more confused, aggregates==groups and I'm missing something with templates....

edit:
A terminology issue. "groups" != "aggregates".

Aggregates are not explained (implemented?), leaving a gap in understanding of capabilities and assumption "agg" is talking about "groups" as it's the only feature that seems to match with the information given.

Original post showing my confusion before that realisation:

Google holds no example of anyone having ever used it.

aggLabelFilter (optional) : Same as the cellFilter but can be defined separately for aggregate row labels.

Is this what that means? Not triggered...

columnDefs: [
{
    field: 'agg_field_name', aggLabelFilter: function(data) {
        return 'hello';
    }
},

This doesn't do anything:

columnDefs: [
{
    field: 'normal_field_name', aggLabelFilter: function(data) {
        return 'hello';
    }
},

Doesn't seem to matter where I put it or how I interact with the grouping UI, the function is never called.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the documented aggLabelFilter option and the aggregate/grouping terminology raised in the issue. Compare the two columnDefs examples with the documented behavior, then update the relevant documentation so aggregate rows, label filtering, and the distinction between groups and aggregates are explained clearly. Confirm that the final wording addresses whether aggregates are implemented and when the callback is invoked.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.