-
Notifications
You must be signed in to change notification settings - Fork 161
Summaries Specification
Version | User | Date | Notes |
---|---|---|---|
0.1 | Zdravko Kolev | 29.08.18 | Grid summaries |
0.2 | Stefan Ivanov | 21.11.18 | Grid summaries, Tree-grid summaries, Hierarchical summaries |
Summaries allow you to display types of summaries within a data container.
As a developer, I want to:
-
implement summaries per column, so that I can give the user quick access to data summaries.
-
have already set defaults summaries, depending on the type of data in the column, so that I can save time:
-
numeric
: min, max, average, sum, count -
string
: count -
date
: latest, earliest, count (count - counts all cells that are Not empty)
-
-
be able to modify/edit/delete the "default summaries", so that they fit my specific needs.
-
provide UI to enable the user to see the summaries per column per type of summary. The UI is visible only if summaries are switched on.
-
provide UI to enable the user to switch on and off summaries per column per summary function.
-
have global grid summaries UI positioned bottom fixed above the pager and above the horizontal scroll.
-
have per-data-island summaries positioned within the tree grid / grouped flat grid body at the end of the data island. tree grid grouped flat grid
...
As an user, I want to:
- to toggle on and off specific summaries of single column, or the entire grid.
- summaries to be relevant to the type of data per column (numeric, string, data).
- the summary of the column to be a function of all column values, even if paging is applied.
- a summary result of a column shows a label and a value. And is positioned at the appropriate location below corresponding column data in a summary UI.
- summaries to be displayed in a table layout.
- that if a column is moving the summaries move accordingly.
- that editing a cell will automatically update the total summaries.
- that hiding/deleting/modifying a column will hide/delete/modify its total summaries accordingly.
- that sorting will not to change the summaries values.
- that when multiple summaries stack at the end of data island, there is a clear visual indication where one group of summaries ends and another one begins.
- that a summary row is distinguishable from the following group by row
...
Must-have before we can consider the feature a sprint candidate
- support min occurrence/max occurrence for string
- support null/empty occurrence, or vice-versa, unique values, % empty, % filled, % unique
- support inGroups summaries
- implement filtered summaries
- For example, summarizing can be handled server side code or client side code
- Additionally, the end-user should be able to add a custom summary like ""((ColA+ColB)/2)"" and apply it to the specific column summary.
- set the position of the summary row for the data-island-related summaries to bottom (default) and top
- implement custom functions.
- support an advanced summary results container that adjusts it's size and layout to the number of summaries switched on.
Describe behavior, design, look and feel of the implemented feature. Always include visual mock-up
- summaries are switched on per column
- each summary type has a label (min/max etc)
- all similar types of summaries are positioned in one row, e.g. min first row, max second row.
- all summary labels are aligned at the start of the column. When a grid is grouped by or a tree gird has summaries, the data-island summary rows have the first-column summary aligned with an indent that reflects the nesting. Summary results are also aligned depending on type of the data in the corresponding column.
- when filtering is applied, the summaries are recalculated and show a function of the filtered data only.
flat grid grouped flat grid tree grid
3.1. End User Experience
3.2. Developer Experience
3.3. Globalization/Localization
Describe any special localization requirements such as the number of localizable strings, regional formats
3.4. User Interface
Include a diagram linking the elements with the visual representation of the feature
3.5. Navigation
3.6. API
Name | Description | Type | Default value | Valid values |
---|---|---|---|---|
Name | Description | Return type | Parameters |
---|---|---|---|
Name | Description | Cancelable | Parameters |
---|---|---|---|
Specify only if applicable
Assumptions | Limitation Notes |
---|---|
Specify all referenced external sources, incl. competitors’ links. Remove before publishing outside Infragistics