Contents
Introduction
You can include parameters in the URL for an InstantAtlas report to trigger various events. For each event, the syntax you should use in the URL is described in the sections below.
Open the Report with a Particular Indicator and Time Period Selected
Syntax:
[URL to report]?indicator=[indicator ID]&date=[date]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?indicator=i1&date=2003
If the indicator you wish to open does not have time periods, you can leave the ‘&date=[date]’ out of the URL.
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?indicator=i7
For the double map and double map time series a specific indicator and time period can be passed to each of the two maps
Syntax:
[URL to report]?indicator=[indicator ID]&date=[date]&indicator2=[indicator ID]&date2=[date]
For example:
Open the Report with a Particular Base Geography Selected
Syntax:
[URL to report]?geog=[position of the base geography in the data.js file starting with 0]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?geog=1
Note that some templates require more then one parameter to work correctly. This depends on the number of data explorers in your report. You will require a parameter for each of these explorers, e.g. two for the Double Map (data explorer map 1 and 2) and four for a Bubble Plot report (data explorer, x-axis, y-axis, color). In case of a Bubble Plot the correct URL would e.g. look something like this:
[URL to report]?geog=2&geog2=2&geog3=2&geog4=2
Open the Report with a Geographic Feature Selected
Syntax:
[URL to report]?select=[feature ID]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?select=22007
You can have more than one geographic feature selected when loading the report by using a comma delimited list.
Syntax:
[URL to report]?select=[feature ID1], [feature ID2], [feature ID3] ….
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?select=22007,22089,22103
A double map time series report allows you to select different geographies in both maps.
Syntax:
[URL to report]?select=[feature ID]&select2=[feature ID]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/dmts/atlas.html?select=22109&select2=15
Open the Report with a Comparison Feature Selected
Syntax:
[URL to report]?comparisonSelect=[feature ID]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?comparisonSelect=15
You can have more than one geographic feature selected when loading the report by using a comma delimited list.
Syntax:
[URL to report]?comparisonSelect=[feature ID1], [feature ID2], [feature ID3] ….
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?comparisonSelect=15,Louisiana
A double map time series report allows you to select different comparison geographies in both maps.
Syntax:
[URL to report]?comparisonSelect=[feature ID]&comparisonSelect2=[feature ID]
For example:
Open the Report with a Filter Applied
Syntax:
[URL to report]?filter=[filter ID],[filter value]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?filter=filter4,Cajun
The filter ID’s can be found by opening the data.js (or data.xml file for Flash reports) of the report in a text editor and searching for “filter”. The filter ID will be, for example, ‘filterX’ where X corresponds to the column number in your Geography and Filters worksheet.
If your filter values include spaces or ampersands you will need to replace these special characters in the URL by the following:
Ampersand = %26
Space= %20
You can see an example for this in the example link for double map time series reports below.
Please note that it is not possible to select filter values which contain a comma using URL parameters.
A double map time series report allows you to have a different filter applied in both maps.
Syntax:
[URL to report]? filter=[filter ID],[filter value]& filter2=[filter ID],[filter value]
For example:
Open the Report with a Particular Data File Loaded
Syntax:
[URL to report]?data=[path to the data file minus file extension]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?data=newdata
Open the Report with a Particular Configuration File Loaded
Syntax:
[URL to report]?config=[path to configuration file minus file extension]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?config=config_largemap
Open the Report with a Particular Stylesheet Loaded
Syntax:
[URL to report]?style=[path to style sheet file minus file extension]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?style=default_brown
Open the Report with a Particular map.js / map.swf.xml File Loaded
Syntax:
[URL to report]?map=[path to file minus file extension]
For example:
http://tools.instantatlas.com/demos/v6/v674/HTML/US/sm/atlas.html?map=newmap
Tips
The geographic feature ID, indicator ID, date, filter ID and filter value can all be found within the data.js or data.xml file of the report.
Any of the above parameters can be combined in a URL to trigger multiple actions. For example, to make a report open with a particular indicator selected, a filter applied and a different stylesheet loaded, the URL might look like this: