Rendering Service HTTP APIs

{{{
#!html
<h1>Rendering Service HTTP APIs</h1>
}}}
----

'''Revision History'''

||'''Revision'''||'''Date'''||'''Author'''||'''Comment'''||
||0.1||April 16, 2010||Trevor Wekel||Initial documentation pass||

[[PageOutline(1-3,Table of Contents,inline)]]

= Overview =
This document describes the Rendering Service HTTP APIs supported by the !MapGuide mapagent.  The Rendering Service APIs are used to render a map into a bitmapped image.  In addition to bitmap rendering, the APIs support basic updates to the underlying !MgMap object state including changes to center, scale, and layer visibility.

= !MapGuide 2.1 APIs =
== !GetDynamicMapOverlayImage ==
=== Overview ===
!GetDynamicMapOverlayImage returns a rendered raster image containing all visbile layers at the current center and scale for the map.  This API is used in conjuction with the !GetVisibleMapExtent HTTP API to provide dynamic map updates for end user interactions.
=== Parameters ===
|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
|| [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
|| [#Version1.0 VERSION] || 2.1.0 || Yes || Operation version ||
|| [#ClientAgent2.1 CLIENTAGENT] || text || Optional || Descriptive text for client ||
|| [#Session1.0 SESSION] || session identifier || Yes || !MapGuide session identifier containing map to display ||
|| [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
|| [#Format1.0 FORMAT] || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
|| [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
|| [#SelectionColor2.0 SELECTIONCOLOR] || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
|| [#Behavior2.0 BEHAVIOR] || bitmask || Yes || Bitmask representing rendering behavior.  See below for more details.||
|| [#SetViewCenterX2.1 SETVIEWCENTERX] || double || No || Set X coordinate for center of map. ||
|| [#SetViewCenterY2.1 SETVIEWCENTERY] || double || No || Set Y coordinate for center of map. ||
|| [#SetViewScale2.1 SETVIEWSCALE] || double || No || Set scale for map. ||
|| [#SetDisplayDpi2.1 SETDISPLAYDPI] || integer || No || Set DPI for map. ||
|| [#SetDisplayWidth2.1 SETDISPLAYWIDTH] || integer || No || Set width of image in pixels. ||
|| [#SetDisplayHeight2.1 SETDISPLAYHEIGHT] || integer || No || Set height of image in pixels. ||
|| [#ShowLayers2.1 SHOWLAYERS] || text || No || List of layers to display. ||
|| [#HideLayers2.1 HIDELAYERS] || text || No || List of layers to hide. ||
|| [#ShowGroups2.1 SHOWGROUPS] || text || No || List of groups to display. ||
|| [#HideGroups2.1 HIDEGROUPS] || text || No || List of groups to hide. ||

==== CLIENTAGENT Parameter ==== #ClientAgent2.1
Descriptive text describing the client of the HTTP operation.  Currently used values include "Ajax Viewer", "Fusion Viewer"
"MapGuide Developer" and "MapGuide Maestro".
==== SETVIEWCENTERX Parameter ==== #SetViewCenterX2.1
==== SETVIEWCENTERY Parameter ==== #SetViewCenterY2.1
==== SETVIEWSCALE Parameter ==== #SetViewScale2.1
==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi2.1
==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth2.1
==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight2.1
==== SHOWLAYERS Parameter ==== #ShowLayers2.1
==== HIDELAYERS Parameter ==== #HideLayers2.1
==== SHOWGROUPS Parameter ==== #ShowGroups2.1
==== HIDEGROUPS Parameter ==== #HideGroups2.1
=== Usage ===
=== Technical Notes ===
== !GetMapImage ==
=== Overview ===
=== Parameters ===
=== Usage ===
=== Technical Notes ===
== !GetMapLegendImage ==
=== Overview ===
=== Parameters ===
=== Usage ===
=== Technical Notes ===
== !GetVisibleMapExtent ==
=== Overview ===
=== Parameters ===
=== Usage ===
=== Technical Notes ===
== !QueryMapFeatures ==
=== Overview ===
=== Parameters ===
=== Usage ===
=== Technical Notes ===
= !MapGuide 2.0 APIs =
== !GetDynamicMapOverlayImage ==
=== Overview ===
!GetDynamicMapOverlayImage returns a rendered raster image containing all visbile layers at the current center and scale for the map.  This API is used in conjuction with the !GetVisibleMapExtent HTTP API to provide dynamic map updates for end user interactions.
=== Parameters ===
|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
|| [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
|| [#Version1.0 VERSION] || 2.0.0 || Yes || Operation version ||
|| [#Session1.0 SESSION] || session identifier || Yes || !MapGuide session identifier containing map to display ||
|| [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
|| [#Format1.0 FORMAT] || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
|| [#Behavior2.0 BEHAVIOR] || bitmask || Yes || Bitmask representing rendering behavior.  See below for more details.||
|| [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
|| [#SelectionColor2.0 SELECTIONCOLOR] || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||

==== BEHAVIOR Parameter ==== #Behavior2.0
The behavior parameter specifies how the rendering is performed.  The value is encoded as a bitmask to facilitate
future enhancements to the API.  One or more bits may be combined to determine overall rendering behavior.

|| '''Value''' || '''Description''' ||
|| 1 (!RenderSelection) || Renders the selected feature(s) ||
|| 2 (!RenderLayers)||  Renders the features on the map ||
|| 4 (!KeepSelection) || Renders the selected feature(s) even if they are outside the current scale ||

Examples: 
 * BEHAVIOR=3 (!RenderSelection|!RenderLayers) will render selection and layers within the current scale
 * BEHAVIOR=5 (!RenderSelection|!KeepSelection) will render only the selection regardless of scale

==== SELECTIONCOLOR Parameter ==== #SelectionColor2.0
Color for selected objects expressed in hexadecimal RGBA format 0xRRGGBBAA.
=== Usage ===
=== Technical Notes ===

= !MapGuide 1.2 APIs =
== !GetDynamicMapOverlayImage ==
=== Overview ===
!GetDynamicMapOverlayImage returns a rendered raster image containing all visbile layers at the current center and scale for the map.  This API is used in conjuction with the !GetVisibleMapExtent HTTP API to provide dynamic map updates for end user interactions.
=== Parameters ===
|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
|| [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
|| [#Version1.0 VERSION] || 1.0.0 || Yes || Operation version ||
|| [#Session1.0 SESSION] || session identifier || Yes || !MapGuide session identifier containing map to display ||
|| [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
|| [#Format1.0 FORMAT] || JPG/PNG || Yes || Image format for rendered image ||
|| [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
|| [#KeepSelection1.0 KEEPSELECTION] || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. ||

==== OPERATION Parameter ==== #Operation1.0
==== VERSION Parameter ==== #Version1.0
==== SESSION Parameter ==== #Session1.0
==== MAPNAME Parameter ==== #MapName1.0
==== FORMAT Parameter ==== #Format1.0
Image format for the rendered image.  PNG8 support was added in !MapGuide 2.0.
==== SELECTION Parameter ==== #Selection1.0
==== KEEPSELECTION Parameter ==== #KeepSelection1.0


=== Usage ===
=== Technical Notes ===