Changes between Version 40 and Version 41 of HttpApi/RenderingService

Timestamp:

Apr 29, 2010, 1:07:27 PM (14 years ago)

Author:

trevorwekel

Comment:

--

HttpApi/RenderingService

@@ -242 +242 @@
 Sets center of map to (-114,51) and scale to 1:50000.  Turns on layers d5d01111 and d5d01118.  The visible layers are rendered as a 500 by 500 PNG image.  Any selection already defined by web extensions API calls will be drawn in blue regardless of scale.  Changes to center, scale and layer visibility are retained.  Features and labels will be clipped to the bounds of the image.
 === Technical Notes ===
+== !GetVisibleMapExtent ==#GetVisibleMapExtent2.0
+=== Overview ===
+Returns the visible map extent in map coordinate system units for the map specified by SESSION and MAPNAME.  !GetVisibleMapExtent in !MapGuide 2.0 is identical to [#GetVisibleMapExtent1.2 GetVisibleMapExtent in MapGuide 1.2] with the addition of a parameter to select either XML or JSON output for the result.  The XML output has the following form:
+{{{
+<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<Envelope>
+  <LowerLeftCoordinate>
+    <X>10</X>
+    <Y>10</Y>
+  </LowerLeftCoordinate>
+  <UpperRightCoordinate>
+    <X>20</X>
+    <Y>20</Y>
+  </UpperRightCoordinate>
+</Envelope>
+}}}
+And the JSON output has the following form:
+{{{
+}}}
+=== Parameters ===
+|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
+|| [#Operation1.0 OPERATION] || GETVISIBLEMAPEXTENT || 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. ||
+|| [#SetViewCenterX1.0 SETVIEWCENTERX] || double || Optional || Set X coordinate for center of map. ||
+|| [#SetViewCenterY1.0 SETVIEWCENTERY] || double || Optional || Set Y coordinate for center of map. ||
+|| [#SetViewScale1.0 SETVIEWSCALE] || double || Optional || Set scale for map. ||
+|| [#SetDisplayDpi1.0 SETDISPLAYDPI] || integer || Optional || Set DPI for map. ||
+|| [#SetDisplayWidth1.0 SETDISPLAYWIDTH] || integer || Optional || Set width of image in pixels. ||
+|| [#SetDisplayHeight1.0 SETDISPLAYHEIGHT] || integer || Optional || Set height of image in pixels. ||
+|| [#ShowLayers1.0 SHOWLAYERS] || text || Optional || List of layers to display. ||
+|| [#HideLayers1.0 HIDELAYERS] || text || Optional || List of layers to hide. ||
+|| [#ShowGroups1.0 SHOWGROUPS] || text || Optional || List of groups to display. ||
+|| [#HideGroups1.0 HIDEGROUPS] || text || Optional || List of groups to hide. ||
+|| [#OutputFormat2.0 FORMAT] || text || Optional || Desired output format. ||
+==== FORMAT Parameter ====#OutputFormat2.0
+Selects the output format for the result:
+ * "text/xml" - Output is given in XML format
+ * "application/json" - Output is given in JSON format
+=== Usage ===
+{{{
+http://localhost/mapguide/mapagent/mapagent.fcgi?OPERATION=GETVISIBLEMAPEXTENT
+    &VERSION=1.0.0
+    &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
+    &MAPNAME=WorldElevation
+    &SETVIEWCENTERX=-114.0
+    &SETVIEWCENTERY=51.0
+    &SETVIEWSCALE=50000
+    &SETDISPLAYHEIGHT=500
+    &SETDISPLAYWIDTH=500
+    &FORMAT=application/json
+}}}
+Sets the center point of the !WorldElevation map to (-114,51) and the scale to 1:50000.  The visible map extent is returned as JSON.  The display height and width for a subsequent
+[##GetDynamicMapOverlayImage1.2 GetDynamicMapOverlay] are set to 500 by 500.
 == !QueryMapFeatures ==#QueryMapFeatures2.0
 === Overview ===
@@ -389 +444 @@
 == !GetVisibleMapExtent ==#GetVisibleMapExtent1.2
 === Overview ===
-Returns the visible map extent for the map specified by SESSION and MAPNAME.  During the call, the map state can be modified by additional parameters such as SETVIEWCENTERX and SETVIEWSCALE. This API is typically called before [##GetDynamicMapOverlayImage1.2 GetDynamicMapOverlay] to set map state.  The returned XML document has the following format:
+Returns the visible map extent in map coordinate system units for the map specified by SESSION and MAPNAME.  During the call, the map state can be modified by additional
+parameters such as SETVIEWCENTERX and SETVIEWSCALE. This API is typically called before [##GetDynamicMapOverlayImage1.2 GetDynamicMapOverlay] to set map
+state.  The returned XML document has the following format:
 {{{
 <?xml version=\"1.0\" encoding=\"UTF-8\"?>
@@ -431 +488 @@
     &SETDISPLAYWIDTH=500
 }}}
-Sets the center point of the !WorldElevation map to (-114,51) and the scale to 1:50000.  The display height and width for a subsequent
+Sets the center point of the !WorldElevation map to (-114,51) and the scale to 1:50000.  The visible map extent is returned as an XML document.  The display height and width for a subsequent
 [##GetDynamicMapOverlayImage1.2 GetDynamicMapOverlay] are set to 500 by 500.
 === Technical Notes ===