URL Parameters

The query string is the part of the URL that contains data to be passed to the InstantAtlas Report.

A typical URL containing a query string for InstantAtlas may be http://www.myorg.com/reports/atlas.html?indicator=i3&date=2011.

The query string is composed of a series of parameters that are separated from the URL by a question mark (?).

The query string for the above URL is indicator=i3&date=2011.

Each parameter is separated by an ampersand (&).

The parameter name and value are separated by an equals sign (=).

In this example, indicator=i3&date=2011 contains two parameters, which tell the report that it should load the indicator with an 'id' of 'i3' and a 'date' of '2011'.

Any parameter included in the URL query string will override the default functionality of the report.

File

• Point to a css file. Supply the path to the file, excluding the file extension. The stylesheet will override any styles in the default.css stylesheet. (v671)
  style=./support-files/custom-url/1/default
• Point to a different config.xml file. Supply the path to the file, excluding the file extension. (v671)
  config=./configs/single/config-alt
• Point to a different map.js file. Supply the path to the file, excluding the file extension. (v671)
  map=./data/nottinghamshire/map
• Point to a different data.js file. Supply the path to the file, excluding the file extension. (v671)
  data=./data/nottinghamshire/data
• Point to different map.js and data.js. Supply the path to the directory containg the files. (v671)
  dataPath=./data/louisiana/

Data

• Set the geography to be displayed. Supply the index of the geography. The first geography being "0", the second "1", the third "2" etc. (v671)
  geog=1
• Set the indicator to be displayed. Supply the id of the indicator. (v671)
  indicator=i2
• Set the indicator date to be displayed. Supply the date of the indicator. (v671)
  date=1980
• Set the geography, indicator and date. (v671)
  geog=1&indicator=i1&date=2002
• Set the indicator and date for the second map. Append the suffix "2" to the parameter names. (v671)
  indicator2=i1&date2=2002
• Load all the data at startup. Normally data is loaded on a theme by theme basis. This forces all themes to be loaded at startup. (v671)
  loadAllData=true

Feature selection and filtering

• Select features. Supply a comma separated list of feature ids. (v671)
  select=22055,22065,22099
• Select features in the second map. Append the suffix "2" to the parameter name. (v671)
  select2=12,7
• Select comparison areas. Supply a comma separated list of feature ids. (v672)
  comparisonSelect=15,11
• Filter the data. Supply the filter id and the value for that filter. (v671)
  filter=filter4,Northern Louisiana
• Filter the second data set. Append the suffix "2" to the parameter name. (v671)
  filter2=filter4,Northern Louisiana
• Filter features. Supply a comma separated list of feature ids. (v672)
  filteredFeatures=22055,22065,22099
• Filter features in the second map. Append the suffix "2" to the parameter name. (v672)
  filteredFeatures2=12,7

Map

• Set a different bounding box. A comma-separated list of the form [xMin],[yMin],[xMax],[yMax]. (v671)
  bbox=-10191354,3307842,-9830443,3622958

Configuration

Set any attribute or property contained in the config.xml file by providing a prefix along with the property id and its new value. (v671)

• Use prop_[property id]=[property value] for general properties.
  prop_ndecimal=2
  prop_legendBreaks=0;25;50;75;100
• Use comp_[component id]_[property id]=[property value] for component properties and attributes.
  comp_barChart_visible=false
  Size units (ie x, y, width, height) are specified as a percentage of the browser window size.
  comp_map_width=30
• Use pal_[property id]=[property value] for palette properties. Properties that can be set for the palettes are defaultPaletteId, defaultSchemeId, noClasses, maxNoClasses and minNoClasses.
  pal_defaultPaletteId=Sequential Purple
  pal_defaultSchemeId=categoricScheme8
  pal_noClasses=7
  pal_maxNoClasses=7
  pal_minNoClasses=4
• Combining multiple properties
  prop_legendBreaks=0;25;50;75;100
  comp_barChart_visible=false
  comp_timeSeries_width=77.5
  pal_defaultPaletteId=Sequential Purple
  comp_dataExplorer_visible=true

Printing

• Open the report in print preview mode. (v671)
  printmode=true