Changes between Version 19 and Version 20 of HttpApi/RenderingService

Timestamp:

04/28/10 06:05:18 (15 years ago)

Author:

trevorwekel

Comment:

--

HttpApi/RenderingService

@@ -27 +27 @@
 || [#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.||
@@ -45 +44 @@
 "!MapGuide Developer" and "!MapGuide Maestro".
 ==== SETVIEWCENTERX Parameter ==== #SetViewCenterX2.1
+Sets the X coordinate for the center of the map.  The coordinate is given in map coordinate system units. 
 ==== SETVIEWCENTERY Parameter ==== #SetViewCenterY2.1
+Sets the Y coordinate for the center of the map.  The coordinate is given in map coordinate system units. 
 ==== SETVIEWSCALE Parameter ==== #SetViewScale2.1
+Sets the currently viewed scale for the map.  This number should be greater than zero.
 ==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi2.1
+Sets the display resolution for the screen.  Typically 96 or 120 DPI.
 ==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth2.1
+Sets the width of the resulting image in pixels.
 ==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight2.1
+Sets the height of the resulting image in pixels.
 ==== SHOWLAYERS Parameter ==== #ShowLayers2.1
+Comma separated list of the MgLayer::!GetObjectId() values for layers to show.  Previously shown
+layers will continue to be shown.
 ==== HIDELAYERS Parameter ==== #HideLayers2.1
+Comma separated list of the MgLayer::!GetObjectId() values for layers to hide.  Previously hidden
+layers will remain hidden.
 ==== SHOWGROUPS Parameter ==== #ShowGroups2.1
+Comma separated list of the MgGroup::!GetObjectId() values for groups to show.  Previously shown
+groups will continue to be shown.  Layers within the groups will retain their current hide/show status.
 ==== HIDEGROUPS Parameter ==== #HideGroups2.1
+Comma separated list of the MgGroup::!GetObjectId() values for groups to hide.  Previously hidden
+groups will remain hidden.  Layers within the groups will retain their current hide/show status.
 === Usage ===
+{{{
+http://localhost/mapguide/mapagent.fcgi?OPERATION=GETDYNAMICMAPOVERLAYIMAGE
+                                        &VERSION=2.1.0
+                                        &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
+                                        &MAPNAME=WorldElevation
+                                        &FORMAT=PNG8
+                                        &BEHAVIOR=7
+                                        &SELECTIONCOLOR=0xFF000080
+                                        &SETVIEWCENTERX=-114.0
+                                        &SETVIEWCENTERY=51.0
+                                        &SETVIEWSCALE=50000
+                                        &SETDISPLAYHEIGHT=500
+                                        &SETDISPLAYWIDTH=500
+                                        &SHOWLAYERS=d5d01111-5f75-102c-8000-02004c4f4f50,d5d01118-5f75-102c-8000-02004c4f4f50
+}}}
+Sets center of map to (-114,51) and scale to 1:50000.  Turns on layers d5d01111 and d5d01118.  The visible layers and any selection are then rendered as a 500 by 500 eight bit PNG image.  The selection is drawn in partially transparent red.
 === Technical Notes ===
 == !GetMapImage ==
@@ -88 +117 @@
 || [#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. ||
 
@@ -107 +135 @@
 Color for selected objects expressed in hexadecimal RGBA format 0xRRGGBBAA.
 === Usage ===
+{{{
+http://localhost/mapguide/mapagent.fcgi?OPERATION=GETDYNAMICMAPOVERLAYIMAGE
+                                        &VERSION=2.0.0
+                                        &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
+                                        &MAPNAME=WorldElevation
+                                        &FORMAT=PNG
+                                        &BEHAVIOR=5
+                                        &SELECTIONCOLOR=0xFF000080
+}}}
+Renders the selection regardless of current scale for the !WorldElevation map from session Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
+as a 32 bit PNG image.  The selection is drawn in partially transparent red.
 === Technical Notes ===
 
@@ -120 +159 @@
 || [#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. ||
 
@@ -136 +174 @@
  * "PNG" for 32 bit PNG
  * "PNG8" for 8 bit PNG  '''Note: This was added in !MapGuide 2.0.'''
-==== SELECTION Parameter ==== #Selection1.0
 ==== KEEPSELECTION Parameter ==== #KeepSelection1.0
 Determines whether the selection is visible outside of the scale range for the selected feature(s).  If "1", the selection will be visible even