<map_uri>/overview[.<format>]
ERROR: Variable (map_link) is undefined.
The overview resource, as a child resource of the map resource, is used to get the overview of the map. Parameters must be included in the URI, but not in the request body. The description of overview image or overview resource can be got through overview resource.
Supported methods
Supported output formats: PNG, BMP, GIF, JPG, RJSON, JSON, HTML, XML.
Implement the HTTP request on the following URI. In the URI, supermapiserver is the server name and WorldMap is the map name (mapName).
http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/overview.rjson
Gets the overview of the map or the description of the overview resource.
Parameters included in the URI when implementing the GET request on the overview resource can control the size, extent, etc. of the overview image and they cannot be placed in the request body.
| Field | Type | Definition |
| redirect | boolean | Whether to redirect. Whether to redirect. If true, the request would be redirected to the real address of the image; if false, the byte stream of the image would be in the response body. The default is true. |
| center | Point2D | The display center of the map. |
| scale | double | The scale of the map.For more details, see: The definition of scale. |
| width | int | The width of the display window/the output image. Must be used together with height. Priority is higher than viewer. |
| height | int | The height of the display window/the output image. Must be used together with width. Priority is higher than viewer. |
| viewer | Rectangle | Specifies the display window, that is, the size of the overview image. |
| transparent | boolean | Whether the map image is transparent or not. |
| viewBounds | Rectangle2D | The visible extent of the map displayed in the overview. |
| dynamicProjection | boolean | Whether dynamic projectioning is allowed. |
| prjCoordSys | PrjCoordSys | The requested map coordinate reference system. When the coordinated system set by this parameter is different from the map original coordinate system, the system will conduct the dynamic projection and return the map images. Please refer to the field structure of PrjCoordSys to build and it supports the method that passes into the coordinate reference system by passing epsgCode, such as: prjCoordSys={"epsgCode":3857}。 |
| random | boolean | Whether to use the random number method and the default is False. If it is TRUE and viewbounds isn't specified, the parameters that are not speified in scale and center parameter will be assigned with the random in the range. |
| _cache | boolean | Whether to use cache, the default is True. False means close all the caches. |
| customParams | String |
Custom parameters. Can be a string with any combination of characters. Users can pass custom parameters by using this field. |
| rectifyType | RectifyType | The rectification method. |
| clipRegion | Geometry | The clipped region on the map for display. This is an areal object, and is supported only when clipRegionEnabled = true, indicating that only the part of the map covered by clipRegion will be displayed. |
| clipRegionEnabled | boolean | Whether it is allowed to set the clip region. |
| customEntireBounds | Rectangle2D | Custom map bounds. Valid when customEntireBoundsEnabled is true. |
| customEntireBoundsEnabled | boolean | Whether customEntireBounds is enabled. |
| angle | double | The rotation of the current map. |
| antialias | boolean | Whether to apply antialiasing to the map. |
| backgroundStyle | Style | The background style of the map. |
| colorMode | MapColorMode | The color mode of the map. |
| markerAngleFixed | boolean | Whether the specified angle of the marker symbol is fixed. |
| maxVisibleTextSize | double | The maximum visible size of the text, in pixels. |
| maxVisibleVertex | int |
The maximum visible vertices of the geometric object. If a geometric feature has more than maxVisibleVertex vertices, the extra vertices will not be displayed. |
| minVisibleTextSize | double | The minimum visible size of the text, in pixels. |
| overlapDisplayed | boolean | When the map objects in the same range, whether to overlapped display and the default value is False. If it is True, the objects in the same range will be overlapped; If it is False, use overlapDisplayedOptions to control the objects don't overlapped display. |
| overlapDisplayedOptions | OverlapDisplayedOptions | The filter options used to avoid map objects overlapped displayed. When overlapDisplayed is set to false, it is used to enhance the processing of the the map object overlapped display. |
| paintBackground | boolean | Whether to render the background of the map. |
| textAngleFixed | boolean | Whether the angles of the text are fixed. |
| textOrientationFixed | boolean | Whether the orientations of the text are fixed. |
To get the overview image, specify the output format as PNG, BMP, GIF, or JPG. For instance http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/overview.png.
To get the description about the overview resource, specify the output format as RJSON, JSON, HTML, or XML. If the URI is http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/overview.rjson, the response will be as follows:
| Name | Type | Description |
| mapName | String | The map name. |
| imageUrl | String | The URI pointing to the overview image in PNG format. |
| viewBounds | Rectangle2D | The visible extent of the map displayed in the overview. |
| viewer | Rectangle | The size of the overview image. |
Implement the GET request on the overview resource with http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/overview.png?viewer={"leftTop":{"x":0,"y":0},"rightBottom":{"x":500,"y":500}}&viewBounds={"leftBottom":{"x":60,"y":0},"rightTop":{"x":100,"y":40}}&redirect=false and get the response in PNG format, as shown below:
To get the representation of the overview resource, implement the GET request on the overview resource with http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/overview.rjson?viewer={"leftTop":{"x":0,"y":0},"rightBottom":{"x":500,"y":500}}&viewBounds={"leftBottom":{"x":60,"y":0},"rightTop":{"x":100,"y":40}}&redirect=false and get the response in RJSON format, as shown below:
{
"imageUrl": "http://supermapiserver:8090/iserver/output/cache/625093188_1f4x1f4/39013634/38x32/15342x13063_1008402973.png",
"lastModified": 1288230618586,
"mapName": "WorldMap",
"viewBounds": {
"bottom": 11.749943697677603,
"left": 80.35018540207761,
"leftBottom": {
"x": 80.35018540207761,
"y": 11.749943697677603
},
"right": 111.9972141403224,
"rightTop": {
"x": 111.9972141403224,
"y": 43.3969724359224
},
"top": 43.3969724359224
},
"viewer": {
"bottom": 500,
"height": 500,
"left": 0,
"leftTop": {
"x": 0,
"y": 0
},
"right": 500,
"rightBottom": {
"x": 500,
"y": 500
},
"top": 0,
"width": 500
}
}
Returns the same HTTP response header as GET does, but no response entity is included. HEAD request can be used to get metadata from the response message header without transporting the entire response content. Metadata includes information about the media type, character encoding, compression encoding, the length of the entity content, etc. The HEAD operation of the overview resource can also have request parameters similar to those in the GET operation.
HEAD request can be used to check if the overview resource exists, or if the resource can be accessed by clients. It can also determine if the overview resource supports an output format <format> if performed on a URI with .<format> included.