Overview
Widgets display data retrieved from data sets in a report. They range from data widgets such as graphs and tables to report widgets such as page refresh and images.
Available Widgets
| Widget | Description |
|---|---|
| Graph | Display data in a graph view. |
| Table | Display data in a table view. |
| Summary | Display a summary of data in a table format. |
| Indicator | Display individual indicators (e.g., traffic lights) for metric results. |
| Text | Output text to the report. |
| All Data | Retrieve all data for a data set in raw format, allowing custom views and widgets. |
| Refresh | Add a page refresh timeout to a report. The page refreshes automatically every specified number of minutes. |
| Image | Add an image from external sources. Images can also be added manually but must be uploaded to MCS first. |
| Tile | A tile that can be used as a button to link to other resources. |
| Threshold Pie Chart | A pie chart showing the spread of a specific metric's results as good, okay, or bad. |
Defining Widgets in a PPF File
Each widget type has its own configuration keys (see the links above). All widgets must be defined within the reserved ppf_widgets variable:
var ppf_widgets = { // All widgets MUST be part of the ppf_widgets variable name
graph: {
// Graph widget definition would go here
},
table: {
// Table widget definition would go here
},
image: {
// Image widget definition would go here
}
}