Note: You are currently viewing documentation for Moodle 3.11. Up-to-date documentation for the latest stable version of Moodle may be available here: Dashboard Configuration: Configuring summarizers.

Dashboard Configuration: Configuring summarizers: Difference between revisions

From MoodleDocs
(Created page with " Back to index Summarizers are automatic sums that will aggregate values in the output. They are printed at bottom of the block, below the ouptut tables or...")
 
m (clean up, typos fixed: consistant → consistent)
 
Line 1: Line 1:
[[Dashboard Block | Back to index]]
[[Dashboard Block|Back to index]]


Summarizers are automatic sums that will aggregate values in the output.
Summarizers are automatic sums that will aggregate values in the output.
Line 7: Line 7:
[[Image:summarizer_settings.jpg]]
[[Image:summarizer_settings.jpg]]


===Summarizers===
==Summarizers==


One or more summarizers can be defined using the aliases columns. This field can hold a semi-column separated list
One or more summarizers can be defined using the aliases columns. This field can hold a semi-column separated list
of output column names. Note that summarizers are only consistant with numeric aggregable data. Examples of non relvant
of output column names. Note that summarizers are only consistent with numeric aggregable data. Examples of non relvant
information are :  
information are :  


Line 16: Line 16:
* Pre-aggregated information (such as means)
* Pre-aggregated information (such as means)


===Sums formatting===
==Sums formatting==


Alike many output descriptors, the final result of the sums can be post-formatted on base of the sprintf() function syntax.
Alike many output descriptors, the final result of the sums can be post-formatted on base of the sprintf() function syntax.
Line 22: Line 22:
stands for unformatted raw output.  
stands for unformatted raw output.  


===Sums Labels===
==Sums Labels==


To give end user consistency of the summarizer semantic, explicit labels can be used for display, rather technical column aliases.
To give end user consistency of the summarizer semantic, explicit labels can be used for display, rather technical column aliases.
You mya define here a semi-column spaated list of summarizer visible names, one per defined summarizer.
You mya define here a semi-column spaated list of summarizer visible names, one per defined summarizer.

Latest revision as of 19:58, 13 May 2022

Back to index

Summarizers are automatic sums that will aggregate values in the output.

They are printed at bottom of the block, below the ouptut tables or plotted graphs.

summarizer settings.jpg

Summarizers

One or more summarizers can be defined using the aliases columns. This field can hold a semi-column separated list of output column names. Note that summarizers are only consistent with numeric aggregable data. Examples of non relvant information are :

  • Text fields
  • Pre-aggregated information (such as means)

Sums formatting

Alike many output descriptors, the final result of the sums can be post-formatted on base of the sprintf() function syntax. There should be here one formatting formula per defined column in a semi-column separated list. As usual, empty strings stands for unformatted raw output.

Sums Labels

To give end user consistency of the summarizer semantic, explicit labels can be used for display, rather technical column aliases. You mya define here a semi-column spaated list of summarizer visible names, one per defined summarizer.