The Tilt Maps Resource
The Tilt Map resource returns a tilted map image.
Resource URI
/tiltmap?[i=...]... Resource Parameters
| Parameter | Type | Description |
|---|---|---|
| app_id | String | Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials. |
| app_code | String | Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials. |
| c | Geo Coordinate | Position geo coordinate. The position marker dot is shown in this location if |
| ctr | Geo Coordinate | Map center point geo coordinate. If the position is on the border of the map, the dot might be cropped. Note: For Basic Map: If center point is not given in the request, the position parameter will be used as the center point, if no POIs (parameter poi) or custom text labels (parameter tx0,tx1,...) are requested. If the center point parameter is provided it is preferred over a given position parameter. In this situation, it is possible that the requested position (parameter c) is out of the map image. This parameter is ignored if parameter ectr is provided or POIs (parameter poi) or custom text labels (parameter tx0,tx1,...) are requested. Ignored if a geo search is also requested. Note: For Route: Using this overrides the automatically calculated route center point. Using this also enables free zoom level definition i.e. also zooming in (not only zooming out) is possible from automatically calculated zoom level. |
| e | Encoded Geo Coordinate | Encoded equivalent of position geo coordinate parameter |
| ectr | Encoded Geo Coordinate | Encoded equivalent of map center point geo coordinate parameter |
| f | Integer | Image format. It is possible to request the map image in following formats:
Note: For PNG8 images some of the colors may differ compared to full color images so use it with precaution. Note: For SVG: parameters w and h are ignored.Note: For Roadsign: Only PNG format is available. Note: For Companylogo: Only PNG and SVG formats is available. |
| h | Integer | Result image height in pixels, maximum 2048. Height and width parameter can be provided independently, i.e. there is no need to enter both to resize the image. |
| i | Boolean | Flag for showing address or position information box inside the map image (if address is available or position is allowed to be shown). Note: If geo search parameters such as co are provided, then the information shown is related to those parameter's values, if valid. |
| lat | Latitude | Latitude. Used together with longitude parameter lon. Note: For Basic Map: The latitude parameter takes no effect if position with parameter c or e is requested. |
| lon | Longitude | Longitude. Used together with latitude parameter lat. Note: For Basic Map: The longitude parameter takes no effect if position with parameter c is requested. |
| ml | String | Map label language.
Note: The languages listed in this document might not be up to date as they are dependant on the specific configuration on the server. |
| nocrop | Flag | Flag to avoid having cropped labels on the map. If the parameter is present in the request, the labels that do not fit completely on the image requested will not be on the map, if the parameter is not present, the default behavior will apply, that is, showing the labels even if they are cropped. |
| nocp | Flag | Flag for hiding copyright information on the map. Note: When this parameter is used, parameter scp will be ignored. |
| nodot | Flag | Flag for hiding position marker dot on the map. This has an effect only if position is requested. |
| pip | Integer | Shows small Picture-in-Picture map from the same location as the actual requested map on bottom right corner of the map image, using the given value as zoom level for the PiP-map. Positive value is used as absolute zoom level for the PiP-map and a negative value is interpreted as the number of levels to zoom out from main map's zoom level. If the parameter is provided, but no value or no valid value for the parameter is specified, the main map's zoom level zoomed out by 5 levels is used for the PiP-map. The PiP-map size is related to the requested map size (1/3 of the map's width and height). However, the PiP-map maximum size is 150x150px and the minimum size is 50x50px. Note: When the PiP zoom level is below 3 and fractional, then the value is rounded down. Note: When the PiP zoom level (either auto calculated or given) is equal or greater than the map zoom then the green area will not be shown. Note: The PiP-map is not shown if POIs (parameter poi) without nomrk flag are requested . Note: When the parameter ra is used, the PiP-map is not rotated if the PiP-map zoom level is below 3. |
| ppi | Integer | [Public] Resolution to be used. Only allows three values:
Note: When using this parameter the size of the logo will be adjusted to match the resolution. Note: Please note that mobile schemes can only be used with 250 ppi value, as mixing mobile and non mobile parameters is not allowed. |
| pview | String | Geopolotical View to be used. Use this parameter to render the map with boundaries based on international or local country views. Not specifying the parameter results in a default view of boundaries. If the parameter is specified and the view is supported, boundaries of the selected country view are being shown. The list includes but is not limited to:
|
| q | Integer | Image compression quality in percentage between 1-100, default is 85 if not specified. The parameter takes effect only if JPEG image format is used. |
| rad,rad0,rad1,... | Distance | Radius of an area. Note: Basic Map: Radius of the surrounding area to be shown on map around the map center point. Indexing in parameter name is not supported i.e. plain rad must be used. This parameter will be ignored if the zoom level parameter z is provided or POIs (with parameter poi) or text labels with parameter txN (where N means index 0..n) are requested. Note: Region and Heat Map: Radius of a circular area. Radii have to be distinguished by indexes in parameter name when showing multiple circular areas/regions. The index number is used for linking the radius to similarly indexed area/region having only one geo coordinate pair. When presenting only a single circular area/region, the index 0 of the parameter is not required i.e. plain rad can be used. Parameter will be ignored if the corresponding area/region parameter aN (where N means index 0..n) value consists of more than one geo coordinate pair (i.e. it is incorrectly defined). Please be aware that this is not applied when only one area/region exists, since they can have multiple geo coordinate values. |
| sb | String | Scale bars to show at bottom right corner of the map. The scale bar won't be drawn if it does not properly fit in the image. Value defines whether to show scale bar in kilometers/meters and/or in miles/feet.
Note: The scale bar won't be drawn if it does not properly fit in the image. |
| strict | Flag | Flag for validating in strict mode the request or not, if the server is already on strict mode it will make no effect. |
| style | String | Map style type. All available styles are defined by Map view server of the Map Image API. The list includes but is not limited to:
|
| t | Integer | Map scheme type. All available schemes are defined by Map view server of the Map Image API API. Currently this API supports the following set of schemes:
|
| ta | Double | Tilt Angle between 0 and 60 degrees. Note: For Tilt: When using this parameter the resulting w and h of the image might not be exactly the same as the ones requested in the url due to the distortion of the image caused by the rotation plus the tilting. |
| token | String | An URL-encoded Base64 string of typically, but not guaranteed to be 24 bytes generated based on the user's app ID and received after the registration process of the application.
|
| u | Distance | Radius of uncertain area around the requested position.
Note: For Basic Map: For it to be shown, it is required that the position is also requested. |
| w | Integer | Result image width in pixels, maximum 2048.
Note: For Roadsign and Companylogo: minimum is 24, maximum is 256. |
| z | Float | Zoom level for the map.
Note: When the request contains parameters having geo coordinate lists or multiple parameters having single geo coordinate pair as value, the zoom level is automatically calculated. In these cases the requested zoom level is applied only if it happens to be smaller than the automatically calculated one i.e. zooming out is desired. Note: For Route: When the request contains also center point ( ctr or ectr), the requested zoom level is applied always. Note: For levels below 5, the width and height cannot be 1024 or higher. Note: For Tilt Maps: For zoom levels over 5, the ceiling of h/cos(ta) cannot be 2048 or higher. Zoom level is not automatically calculated. |