| 32 | | || [#SetViewCenterX1.0 SETVIEWCENTERX] || double || No || Set X coordinate for center of map. || |
| 33 | | || [#SetViewCenterY1.0 SETVIEWCENTERY] || double || No || Set Y coordinate for center of map. || |
| 34 | | || [#SetViewScale1.0 SETVIEWSCALE] || double || No || Set scale for map. || |
| 35 | | || [#SetDisplayDpi1.0 SETDISPLAYDPI] || integer || No || Set DPI for map. || |
| 36 | | || [#SetDisplayWidth1.0 SETDISPLAYWIDTH] || integer || No || Set width of image in pixels. || |
| 37 | | || [#SetDisplayHeight1.0 SETDISPLAYHEIGHT] || integer || No || Set height of image in pixels. || |
| 38 | | || [#ShowLayers1.0 SHOWLAYERS] || text || No || List of layers to display. || |
| 39 | | || [#HideLayers1.0 HIDELAYERS] || text || No || List of layers to hide. || |
| 40 | | || [#ShowGroups1.0 SHOWGROUPS] || text || No || List of groups to display. || |
| 41 | | || [#HideGroups1.0 HIDEGROUPS] || text || No || List of groups to hide. || |
| | 32 | || [#SetViewCenterX2.1 SETVIEWCENTERX] || double || No || Set X coordinate for center of map. || |
| | 33 | || [#SetViewCenterY2.1 SETVIEWCENTERY] || double || No || Set Y coordinate for center of map. || |
| | 34 | || [#SetViewScale2.1 SETVIEWSCALE] || double || No || Set scale for map. || |
| | 35 | || [#SetDisplayDpi2.1 SETDISPLAYDPI] || integer || No || Set DPI for map. || |
| | 36 | || [#SetDisplayWidth2.1 SETDISPLAYWIDTH] || integer || No || Set width of image in pixels. || |
| | 37 | || [#SetDisplayHeight2.1 SETDISPLAYHEIGHT] || integer || No || Set height of image in pixels. || |
| | 38 | || [#ShowLayers2.1 SHOWLAYERS] || text || No || List of layers to display. || |
| | 39 | || [#HideLayers2.1 HIDELAYERS] || text || No || List of layers to hide. || |
| | 40 | || [#ShowGroups2.1 SHOWGROUPS] || text || No || List of groups to display. || |
| | 41 | || [#HideGroups2.1 HIDEGROUPS] || text || No || List of groups to hide. || |
| 43 | | ==== BEHAVIOR Parameter ==== #Behavior2.0 |
| 44 | | |
| 45 | | The behavior parameter specifies how the rendering is performed. The value is encoded as a bitmask to facilitate |
| 46 | | future enhancements to the API. One or more bits may be combined to determine overall rendering behavior. |
| 47 | | |
| 48 | | || '''Value''' || '''Description''' || |
| 49 | | || 1 (!RenderSelection) || Renders the selected feature(s) || |
| 50 | | || 2 (!RenderLayers)|| Renders the features on the map || |
| 51 | | || 4 (!KeepSelection) || Renders the selected feature(s) even if they are outside the current scale || |
| 52 | | |
| 53 | | Examples: |
| 54 | | * BEHAVIOR=3 (!RenderSelection|!RenderLayers) will render selection and layers within the current scale |
| 55 | | * BEHAVIOR=5 (!RenderSelection|!KeepSelection) will render only the selection regardless of scale |
| | 43 | ==== CLIENTAGENT Parameter ==== #ClientAgent2.1 |
| | 44 | Descriptive text describing the client of the HTTP operation. Currently used values include "Ajax Viewer", "Fusion Viewer" |
| | 45 | "MapGuide Developer" and "MapGuide Maestro". |
| | 46 | ==== SETVIEWCENTERX Parameter ==== #SetViewCenterX2.1 |
| | 47 | ==== SETVIEWCENTERY Parameter ==== #SetViewCenterY2.1 |
| | 48 | ==== SETVIEWSCALE Parameter ==== #SetViewScale2.1 |
| | 49 | ==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi2.1 |
| | 50 | ==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth2.1 |
| | 51 | ==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight2.1 |
| | 52 | ==== SHOWLAYERS Parameter ==== #ShowLayers2.1 |
| | 53 | ==== HIDELAYERS Parameter ==== #HideLayers2.1 |
| | 54 | ==== SHOWGROUPS Parameter ==== #ShowGroups2.1 |
| | 55 | ==== HIDEGROUPS Parameter ==== #HideGroups2.1 |
| 78 | | = !MapGuide 1.0 APIs = |
| | 78 | = !MapGuide 2.0 APIs = |
| | 79 | == !GetDynamicMapOverlayImage == |
| | 80 | === Overview === |
| | 81 | !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. |
| | 82 | === Parameters === |
| | 83 | || '''Name''' || '''Value''' || '''Required''' || '''Description''' || |
| | 84 | || [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute || |
| | 85 | || [#Version1.0 VERSION] || 2.0.0 || Yes || Operation version || |
| | 86 | || [#Session1.0 SESSION] || session identifier || Yes || !MapGuide session identifier containing map to display || |
| | 87 | || [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. || |
| | 88 | || [#Format1.0 FORMAT] || JPG/PNG/PNG8 || Yes || Image format for rendered image || |
| | 89 | || [#Behavior2.0 BEHAVIOR] || bitmask || Yes || Bitmask representing rendering behavior. See below for more details.|| |
| | 90 | || [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() || |
| | 91 | || [#SelectionColor2.0 SELECTIONCOLOR] || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. || |
| | 92 | |
| | 93 | ==== BEHAVIOR Parameter ==== #Behavior2.0 |
| | 94 | The behavior parameter specifies how the rendering is performed. The value is encoded as a bitmask to facilitate |
| | 95 | future enhancements to the API. One or more bits may be combined to determine overall rendering behavior. |
| | 96 | |
| | 97 | || '''Value''' || '''Description''' || |
| | 98 | || 1 (!RenderSelection) || Renders the selected feature(s) || |
| | 99 | || 2 (!RenderLayers)|| Renders the features on the map || |
| | 100 | || 4 (!KeepSelection) || Renders the selected feature(s) even if they are outside the current scale || |
| | 101 | |
| | 102 | Examples: |
| | 103 | * BEHAVIOR=3 (!RenderSelection|!RenderLayers) will render selection and layers within the current scale |
| | 104 | * BEHAVIOR=5 (!RenderSelection|!KeepSelection) will render only the selection regardless of scale |
| | 105 | |
| | 106 | ==== SELECTIONCOLOR Parameter ==== #SelectionColor2.0 |
| | 107 | Color for selected objects expressed in hexadecimal RGBA format 0xRRGGBBAA. |
| | 108 | === Usage === |
| | 109 | === Technical Notes === |
| | 110 | |
| | 111 | = !MapGuide 1.2 APIs = |
| 93 | | || [#SetViewCenterX1.0 SETVIEWCENTERX] || double || No || Set X coordinate for center of map. || |
| 94 | | || [#SetViewCenterY1.0 SETVIEWCENTERY] || double || No || Set Y coordinate for center of map. || |
| 95 | | || [#SetViewScale1.0 SETVIEWSCALE] || double || No || Set scale for map. || |
| 96 | | || [#SetDisplayDpi1.0 SETDISPLAYDPI] || integer || No || Set DPI for map. || |
| 97 | | || [#SetDisplayWidth1.0 SETDISPLAYWIDTH] || integer || No || Set width of image in pixels. || |
| 98 | | || [#SetDisplayHeight1.0 SETDISPLAYHEIGHT] || integer || No || Set height of image in pixels. || |
| 99 | | || [#ShowLayers1.0 SHOWLAYERS] || text || No || List of layers to display. || |
| 100 | | || [#HideLayers1.0 HIDELAYERS] || text || No || List of layers to hide. || |
| 101 | | || [#ShowGroups1.0 SHOWGROUPS] || text || No || List of groups to display. || |
| 102 | | || [#HideGroups1.0 HIDEGROUPS] || text || No || List of groups to hide. || |
| 111 | | ==== KEEPSELECTION Parameter ==== |
| 112 | | ==== SELECTIONCOLOR Parameter ==== #SelectionColor1.0 |
| 113 | | ==== SETVIEWCENTERX Parameter ==== #SetViewCenterX1.0 |
| 114 | | ==== SETVIEWCENTERY Parameter ==== #SetViewCenterY1.0 |
| 115 | | ==== SETVIEWSCALE Parameter ==== #SetViewScale1.0 |
| 116 | | ==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi1.0 |
| 117 | | ==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth1.0 |
| 118 | | ==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight1.0 |
| 119 | | ==== SHOWLAYERS Parameter ==== #ShowLayers1.0 |
| 120 | | ==== HIDELAYERS Parameter ==== #HideLayers1.0 |
| 121 | | ==== SHOWGROUPS Parameter ==== #ShowGroups1.0 |
| 122 | | ==== HIDEGROUPS Parameter ==== #HideGroups1.0 |
| | 132 | ==== KEEPSELECTION Parameter ==== #KeepSelection1.0 |
| | 133 | |
| | 134 | |
