- width / height
- Both parameters are required. These parameters describe the native dimensions of the map in pixels. All the coordinates used in paths are considerate to be inside of the bounding box described with the provided width and height.
- paths
- This required parameter describes the regions of which the map consists using SVG paths. This is a JS object which keys are region codes and values are also objects which contain two string parameters:
name
andpath
. The latter uses SVG path data syntax to describe the shape of the region. Here is an example of US map:paths: { US-AK: { name: "Alaska", path: "M89.36,517.03l0.84,0.08l0.09,0.36l-0.3..." }, US-AL: { name: "Alabama", path: "M608.66,337.47l25.17,-2.91l19.4..." }, US-AR: { name: "Arkansas", path: "M498.73,376.99l-1.42,-38.01l-4.48,-23.98l37.68..." }, ... }
- projection
-
This parameter is required in case you want to plot the markers on the map by latitude and longitude. This is an object which has two parameters:
-
centralMeridian
- number expressed in degrees. Non-zero value is used to generate some maps where regions crosses the standard zero meridian. -
type
- type of the projection used to generate the map. At the moment the following projection are supported by the client side: Miller Cylindrical projection, Mercator projection, Albers Equal-Area Conic projection and Lambert Conformal Conic projection.
projection: { centralMeridian: -100, type: "aea" }
-
- insets
- Insets are used to present some distant territories without big increase of the map scale. For instance Alaska and Hawaii are usually places on the map of US in corners or bellow the mainland. This parameter is also optional and used only when it's necessary to plot markers on the map based on the latitude and longitude of the point. Actually each item of
insets
array just translates a rectangle on the map to the real projected coordinates expressed in meters. Here is an example of inset for Alaska on the US map:insets: [{ "left": 0 "top": 440, "width": 220, "height": 147 "bbox":[{ "y": -8441281.712315228, "x": -5263934.893342895 },{ "y": -6227992.545028123, "x": -1949631.2950683108 } }]