[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Mapping Types ]

An array of datasets, each representing a group of geometric or mapping objects to be rendered on the map.

Each datatset defines a set of similar elements, such as circles, polygons, or markers, that are to be rendered with a shared style. There can be only one type within each dataset, but there may be multiple datasets for each type.

For example, a <mapData> object might consist of three datasets: the first describes yellow circles, the second describes orange circles, the third describes a green polyline.

<mapData> is rendered in layers, which are ordered from bottom to top as follows:

  • map layer
  • geometry
  • markers
  • Scale and Whereis® and branding.

Format

[
  {
    "style":<style>, 
    "type":<string>, 
    "values":[<?>] 
  }
]

Parameters

Name

Mandatory?

Description

style

N

Defines a common style for all elements in the dataset

type

Y

Must be one of "circle", "ellipse", "marker", "oval", "polygon", "polyline", "routeHandle", "heat"

values

Y

One or more objects corresponding with the identified type: <circle>, <ellipse>, <marker>, <polyline>, <polygon>, <routeHandle>, <heat>

For <routeHandle> submit the route handle ID retrieved from a previous route response, as a string.

 

 

NOTES

Within any layer, those datasets and data elements which are requested first are rendered first (at the bottom); those requested last are rendered last (on top).

Icon

Use routeHandle to display the geometry for one or more routes on the map. "values" should be submitted as a list of strings, each containing an ID retrieved from a previous Route request.

Icon

This object wraps the following objects defined elsewhere: