StatPlanet Cloud enables you to customize and optimize all aspects of your dashboards, so you can best meet the diverse needs of different users or user groups.
With the Platinum subscription, you can create unlimited StatPlanet Cloud dashboards or instances, each of which can be linked to a different set of data, settings and map files.
Besides the wide range of customization options available through the settings file, you can also use the StatPlanet Cloud API to dynamically create custom dashboards. The API can be used to query StatPlanet Cloud by specifying specific parameters, such as which indicator and graph type to select.
If you require API functionality with XML and/or SDMX support, please contact us.
StatPlanet Cloud API
The StatPlanet Cloud API enables the application to be queried using any of the following parameters:
- Indicator (one or multiple, for multiple-indicator graph types)
- Graph type (any of the 8 graph types)
- Time (for example, a particular year, or a time range)
- Map areas (for example, pre-selecting several districts in a country map)
- Map region (for example, zooming into Europe in a world map, or a specific state in a USA county-level map)
- Data file (the location of the data file relative to the StatPlanet Cloud webpage, which is 'data/data.csv', by default)
The parameters can be specified either in the URL, or within the web-page, so they can also be dynamically set - such as using PHP.
The URL parameters should be in the following format, replacing the text in blue with the desired parameters. You can specify up to six parameters, separated by the & symbol:
The following example selects an indicator with ID '3' (which in this example points to 'Internet users per 100 people'), visualization type '3' (time series graph), time range '1980' to '2014', and countries 'Brazil, China, Russia and USA' (referenced through their ISO codes), with no map region or data file parameter:
You can customize your dashboard (selecting an indicator, graph type, etc.) and automatically get the URL parameters for the current dashboard by clicking the link icon, as indicated in the image below. You can find it in the bottom of the StatPlanet Cloud dashboard.
Within the HTML file, the parameters can be specified in exactly the same way, but excluding the URL. They are specified in the StatPlanet_Cloud.html file, under * CONFIGURATION *, using the startupParams variable:
startupParams = ""; //specify the startup parameters within the quotation marks.
The same example as the one above would be specified as follows:
startupParams = "i=3&v=3&t=1980,2014&s=BRA,CHN,RUS,USA";
Specifying the data, settings and map files
The files loaded by StatPlanet Cloud are specified in the StatPlanet_Cloud.html file, under * CONFIGURATION *, for example:
var data_file = "data/data.csv";
var settings_file = "data/settings.csv";
var map_file = "map/map.js";
As specified above, the data file to use ('data_file') can be overridden through the URL parameter 'file'.