Skip to content

Summaries Specification

Zdravko Kolev edited this page Nov 21, 2018 · 47 revisions

Summaries Specification

Contents

  1. Revision history
  2. User Stories
  3. Functionality
  4. ARIA support
  5. Assumptions and Limitations
  6. References
Version User Date Notes
0.1 Zdravko Kolev 29.08.18 Grid summaries

Objectives

Summaries allow you to display types of summaries within a data container.

As a citizen 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 the summaries UI positioned bottom fixed above the pager and above the horizontal scroll. ...

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 on 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 right below the corresponding column in a summary UI.
  • summaries to be in 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 my summaries values. ...

Acceptance criteria

Must-have before we can consider the feature a sprint candidate

Additional Features Needed

  • 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, summarising 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.
  • change the position of the summary results (top, topfixed, bottom)
  • implement custom functions.
  • support an advanced summary results container that adjusts it's size and layout to the number of summaries switched on.

Describe behaviour, design, look and feel of the implemented feature. Always include visual mock-up

  • summaries are switch 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. Summaries results are aligned depending on type of the data in the corresponding column.
  • when filtering is applied, the sumamries are recalculated and show a function of the filtered data only.

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

Options

Name Description Type Default value Valid values

Methods

Name Description Return type Parameters

Events

Name Description Cancelable Parameters

Specify only if applicable

Assumptions Limitation Notes

Specify all referenced external sources, incl. competitors’ links. Remove before publishing outside Infragistics

Clone this wiki locally