This is an old revision of the document!


Adding an Infographic

You add an Infographic to the list by following the steps below…

Create a new Folder in the Display List directory

In your infographics directory, you can create a folder for every infographic you have. Note that while it's not required, we suggest avoiding spaces in your folder names.

For instance, if you wanted to create a “Current Temperatures” report, you would make a folder called current_temperatures.


Create an Empty Script File

Now, create a Javascript source file inside the folder you just created.

This should be called generate.js.


Copy/Create an info.json file for the report

The info.json file gives the system some details about the report - most importantly, it's human-readable name.

Info files have several possible attributes…

LineExampleMeaning
nameDaily TemperatureThe name for the Infographic shown in the web interface
folderBlankA folders that the Infographic will appear in when browsing the list of displays
lightmodefalseIf true the display will open by default with in light-mode (with a white background & black lines
titlefalseSet this to true if the display includes its own title block or name at the top of the page. If false, one will be added
backgroundnoneOverrides the background colour of the page.
responsivefalseIf false, assumed to be 16:9 aspect ratio. If true, assumed to adapt to the currently available window size.

Create the Script

Finally, you'll need to write the script.