mobile menu

PPF Widgets

You are here
PPF Widgets

PPF Widgets

Widgets are a way to use the data retrieved from data sets in a report.

They range from data widgets, such as a graph or table, to report widgets, such as page refresh and image.

Click here to see how widgets are defined in a PPF file.

Graph

Display data as a graph. Click here to learn more.

Table

Display data as a table. Click here to learn more.

Summary

Display a summary of data in table format. Click here to learn more.

Indicator

Display individual indicators, like traffic lights, for metric results. Click here to learn more.

Text

Output text to the page. Text can be result dependant. Click here to learn more.

All Data

Get all the data for a data set in raw format. This allows for greater flexibility as users can create their own views and widgets if desired. Click here to learn more.

Refresh

Adds a page refresh timeout to a report. The timeout isn't visible but the page will refresh every x minutes. Click here to learn more.

Image

Add an image to the report. Images can be added manually to the report but must be uploaded to MCS in order to use. Using the image widget allows images to be imported from other sources. Click here to learn more.

How are widgets defined in the a PPF file?

The links above will explain the nuances of each widget. The details below will explain how to integrate them into the overall PPF file.

var ppf_widgets = { //RESERVED. 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
    }
}