Pushpin LE API Catalog

Pushpin™ LE API Catalog (Version 0.9)

API Catalog

Map Controls
Map Types
Map Layers
Scales and Zoom Level
Indicator IDs
Color Ramps
Icons
Widget IDs

The Pushpin LE API Catalog provides a list of available ids or predefined objects that can be used with the API. The following sections list what is currently supported by the API.

Map Controls

The following are map controls currently supported by the API. These are added by using PMap.addControl(control). For example:

map.addControl(new PLargeMapControl());

Class	Description
`PLargeMapControl`	Large zoom and pan controls, including the zoom slider. Appears on the top left corner of the map
`PSmallMapControl`	Small zoom and pan controls. Appears on the top left corner of the map
`PSmallZoomControl`	Small zoom controls. Appears on the top left corner of the map
`PMapTypeControl`	Controls for toggling between the normal map (map.P_MAPTYPE_NORMAL) and satellite (map.P_MAPTYPE_SATELLITE). Appears on the top right corner of the map.

Map Types

The following are predefined map types currently supported by the API. These are objects that can be accessed via the PMap class. These are set by using PMap.setMapType(maptype). For example:

map.setMapType(map.P_MAPTYPE_SATELLITE);

Object	Description
`P_MAPTYPE_NORMAL`	This is the default map type when dynamic layers are used. It contains `P_MAPLAYER_BASE`, `P_MAPLAYER_POLY`, `P_MAPLAYER_POINTLINE` and `P_MAPLAYER_CITIES`. All layers are turned on by default.
`P_MAPTYPE_SATELLITE`	This is the satellite map type with dynamic layers. It contains `P_MAPLAYER_SATELLITE`, `P_MAPLAYER_POLY`, `P_MAPLAYER_TPOINTLINE` and `P_MAPLAYER_CITIES`. All layers are turned on by default.

The following are predefined map layers currently supported by the API. These are objects that can be accessed via the PMap class and provide easy access to the layers in the map type. Custom layers can be created with Rendermap and the layer object made accessible. For example, to access a layer and turn it off, you can use:

map.P_MAPLAYER_POINTLINE.off();

Object	Description
`P_MAPLAYER_BASE`	This was created with `P_MAPLAYER_BASE_ID` for the `P_MAPTYPE_NORMAL` map type. This is turned on by default.
`P_MAPLAYER_POLY`	This was created with `P_MAPLAYER_POLY_ID` for the `P_MAPTYPE_NORMAL` and `P_MAPTYPE_SATELLITE` map type. This is turned on by default.
`P_MAPLAYER_POINTLINE`	This was created with `P_MAPLAYER_POINTLINE_ID` for the `P_MAPTYPE_NORMAL` map type. This is turned on by default.
`P_MAPLAYER_CITIES`	This was created with `P_MAPLAYER_CITIES_ID` for the `P_MAPTYPE_NORMAL` and `P_MAPTYPE_SATELLITE` map type. This is turned on by default.
`P_MAPLAYER_SATELLITE`	This was created with `P_MAPLAYER_SATELLITE_ID` for the `P_MAPTYPE_SATELLITE` map type. This is turned on by default.
`P_MAPLAYER_TPOINTLINE`	This was created with `P_MAPLAYER_TPOINTLINE_ID` for the `P_MAPTYPE_SATELLITE` map type. This is turned on by default.

Scales and Zoom Levels

The following are scales that are available for our map layers. An array of scales can be defined for map types (in descending order). For example:

maptype.setScales([1152000, 576000, 288000, 144000, 72000]);

Scale	Default Zoom Level
9000	1
18000	2
36000	3
72000	4
144000	5
288000	6
576000	7
1152000	8
2304000	9
4608000	10
9216000	11
18432000	12
36864000	13
73728000	14
147456000	15

Indicator IDs

The following is a list of IDs of indicators or thematic variables currently supported by the API. Value-added market information data can be purchased separately in transaction bundles. Here is an example for adding an indicator to the map.

map.setIndicatorById(5);

ID	Name	Description	Unit	Source	Year
`1`	Total Population	Total Population	Number	US Department of Census	2000
`3`	Median Income	Median Income	$	US Department of Census	2000
`5`	Median Age	Median Age	Years	US Department of Census	2000
`21`	Median Cash Rent	Median Cash Rent	$	US Department of Census	2000

Color Ramps

The following are predefined color ramps that work well with our maps. This can be set by the PLegend object. For example:

map.getLegend().setColorRamp(P_COLORRAMP_RED);

Object	Colors	Description
`P_COLORRAMP_GREEN`		This is the default green color ramp.
`P_COLORRAMP_BROWN`		This is a brown color ramp.
`P_COLORRAMP_RED`		This is a red color ramp.
`P_COLORRAMP_REDPURPLE`		This is a red to purple color ramp.

Icons

The following are special strings that can be specified to create custom Pushpin icons. For example:

var smallIcon = new PIcon("PushpinSmall");

String	Image	Description
`PushpinSmall`		This is a smaller version of the default marker.
`PushpinLogo`		This is the icon that is used in the Pushpin logo

Widget IDs

The following are widget IDs currently supported by the API. These are enums that can be used to create predefined Pushpin widgets. For example:

var widget = new PWidget(map, document.getElementById("widget"), P_WIDGET_LAYER_ID);

ID	Description
`P_WIDGET_LAYER_ID`	This creates the map layers widget which allows you to toggle layers from the current map type.
`P_WIDGET_INDICATOR_ID`	This creates the thematic widget for choosing indicators. This displays the legend for the chosen indicator. `PMap.setIndicatorList(indicators)` needs to be called before adding the widget to populate the indicators used by the widget.