Changes between Version 7 and Version 8 of HttpApi/RenderingService

Timestamp:

04/16/10 11:04:50 (15 years ago)

Author:

trevorwekel

Comment:

--

HttpApi/RenderingService

@@ -15 +15 @@
 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 and later APIs =
+= !MapGuide 2.0 and later 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''' || '''Supported[[BR]]In Version''' || '''Description''' ||
-|| OPERATION || GETDYNAMICMAPOVERLAYIMAGE || Yes || 1.0.0(+) || Operation to execute ||
-|| VERSION || 1.0.0/2.0.0/2.1.0 || Yes || 1.0.0(+) || Operation version ||
-|| CLIENTAGENT || text || Optional || 1.0.0(+) || Descriptive text for client ||
-|| SESSION || session identifier || Yes || 1.0.0(+) || !MapGuide session identifier containing map to display ||
-|| MAPNAME || text || Yes || 1.0.0(+) || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
-|| FORMAT || JPG/PNG/PNG8 || Yes || 1.0.0(+) || Image format for rendered image ||
-|| SELECTION || XML selection text || Optional || 1.0.0(+) || XML representing selected features generated from !MgSelection.!ToXml() ||
-|| KEEPSELECTION || 0/1 || Optional || 1.0.0 only || If true, render selected feature(s) even if they are outside the current scale. ||
-|| BEHAVIOR || bitmask || Yes || 2.0.0(+) || Bitmask representing rendering behavior.  See below for more details.||
-|| SELECTIONCOLOR || RGBA hex color || Yes || 2.0.0(+)|| Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
+|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
+|| OPERATION || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
+|| VERSION || 2.0.0/2.1.0 || Yes || Operation version ||
+|| CLIENTAGENT || text || Optional || Descriptive text for client ||
+|| SESSION || session identifier || Yes || !MapGuide session identifier containing map to display ||
+|| MAPNAME || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
+|| FORMAT || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
+|| SELECTION || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
+|| BEHAVIOR || bitmask || Yes || Bitmask representing rendering behavior.  See below for more details.||
+|| SELECTIONCOLOR || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
 
 ==== BEHAVIOR Parameter ====
@@ -67 +66 @@
 === Usage ===
 === Technical Notes ===
+= !MapGuide 1.0 and later 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''' ||
+|| OPERATION || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
+|| VERSION || 1.0.0 || Yes || Operation version ||
+|| CLIENTAGENT || text || Optional || Descriptive text for client ||
+|| SESSION || session identifier || Yes || !MapGuide session identifier containing map to display ||
+|| MAPNAME || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
+|| FORMAT || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
+|| SELECTION || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
+|| KEEPSELECTION || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. ||
+|| SELECTIONCOLOR || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
+
+==== SELECTION Parameter ====
+
+The selection parameter...
+Examples: 
+ * example 1
+ * example 2
+=== Usage ===
+=== Technical Notes ===