The Turnpoint Resource
The Turnpoint resource returns turning points represented by an arrow drawn on top of the map image. The orientation of the turning point starting position by default is northwards. The zoom level for the map image is determined automatically based on the waypoints and display size (width and height parameters).
The service always turns the map even without parameter ra, therefore a compass is always displayed.
It also supports different map schemes, image sizes, image formats as well as showing a compass and customizing the color and thickness of the drawn arrow.
Resource URI
/turnpoint?[lc=...]... 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. If you use the app ID/app code option, you need to include an |
| app_code | String | Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. If you use the app ID/app code option, you need to include an |
| apiKey | String | A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://developer.here.com/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time. |
| 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. |
| lc,lc0,lc1,... | Color | Line color. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain lc can be used. If no line colors are defined, default blue line colors are used. Note: For Region: Outline color of area/region. It is used only if fill color fc for corresponding index is not given i.e. outline and fill color cannot be combined. If no outline color is defined for some area/region, default fill color will be used for it, if fill color for corresponding area/region index is not given. The parameter is ignored if no a parameter is given. Note: For Route: Route line color.Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed line color parameter before the gap. Note: For Turning Point: This is the arrow line color. Use parameter lc without index for Turning Point since it does not support the indexing i.e. multiple line colors. |
| lw,lw0,lw1,... | Integer | Line width. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain lw can be used. If no line widths are defined, default value 4 for line widths is used. Note: Valid values are from 1 to 20. Note: For Region: Outline width of area/region. Outline width is used only if outline color lc for corresponding index is given, and fill color fc for corresponding index is not given. Note: For Route: Route line width. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the width of the last available indexed line width parameter before the gap. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the route line with similarly indexed parameter sc. Note: For Turning Point: Arrow line width.Use parameter lw without index for Turning Point since it does not support the indexing i.e. multiple line widths. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the arrow line with parameter sc. Note: For Routing: Since only one route is supported only one value will be used. Therefore lw or lw0 might be used, but only one of them. The rest of the values provided will be ignored. |
| 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. |
| nocmp | Flag | Flag for hiding the compass on the map. Note: The compass is automatically hidden if the image is smaller than 240. The compass size is calculated determining the final map image width and height. The size is 40 if image is 240, otherwise is 0.1 times the size of the image minus 100. |
| 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. |
| ppi | Integer | [Public] Resolution to be used. Only allows below mentioned four 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 | Geopolitical 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. |
| r,r0,r1,... | Geo Coordinate List | The route waypoints, given as list of geo coordinates. Note: For Route: Routes have to be distinguished by indexes in the parameter name when showing multiple routes on same map i.e. r0, r1 etc. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters. When presenting only a single route, the index 0 of the parameter is not required i.e. plain r can be used. Note: For Turning Point: Only fixed index 0 i.e. r0 is currently supported. |
| ra | Floating point number | The rotation angle of the map in degrees between 0-360. If given angle is 0, the image is not rotated at all and the compass is not displayed. If angle is greater than 360 or less than 0, the value is normalized (e.g. 380 to 20, -10 to 350). Note: If this parameter is not requested or the value is empty or invalid, an automatic northward orientation (determined by the first two coordinate pairs of the given route points with parameter r0) is performed for the map. Note: This parameter is disabled for zoom level less than 3, it will ignore the value . Note: After rotation, it may happen that pois, circles, custom texts or other artifacts on the image may get outside the picture. |
| sc,sc0,sc1,... | Color | Shadow/border color. Note: For Turning Point use parameter sc without index for the arrow border color. Note: For Route: The border colors have to be distinguished by indexes when showing multiple routes. The index number is used for linking the border color to similarly indexed route. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed border color parameter before the gap. When presenting only a single route, the index 0 of the parameter is not required i.e. plain sc can be used. Note: For Routing: Since only one route is supported only one value will be used. Therefore sc or sc0 might be used, but only one of them. The rest of the values provided will be ignored. |
| scp | String | ID of service owner specific copyright. Shows service specific additional copyright information together with map data copyright. The value must be a valid ID/key of a pre-configured service specific copyright i.e. the parameter value itself is not shown on map. Note: This parameter is ignored if flag parameter nocp is requested. The service specific copyright is not shown if it does not properly fit to the image. |
| strict | Flag | Flag for validating the request in strict mode. If the flag is provided request will be validated in strict mode. If the server is already running in strict mode, then it will supercede this parameter. |
| style | String | Map style type. All available styles are defined by Map view server of the HERE Map Image v1. The list includes but is not limited to:
|
| t | Integer | Map scheme type. All available schemes are defined by Map view server of the HERE Map Image v1 API. Currently this API supports the following set of schemes:
|
| w | Integer | Result image width in pixels, maximum 2048.
Note: For Roadsign and Companylogo: minimum is 24, maximum is 256. |
