| 31 | | || [#SetViewCenterX2.1 SETVIEWCENTERX] || double || Optional || Set X coordinate for center of map. || |
| 32 | | || [#SetViewCenterY2.1 SETVIEWCENTERY] || double || Optional || Set Y coordinate for center of map. || |
| 33 | | || [#SetViewScale2.1 SETVIEWSCALE] || double || Optional || Set scale for map. || |
| 34 | | || [#SetDisplayDpi2.1 SETDISPLAYDPI] || integer || Optional || Set DPI for map. || |
| 35 | | || [#SetDisplayWidth2.1 SETDISPLAYWIDTH] || integer || Optional || Set width of image in pixels. || |
| 36 | | || [#SetDisplayHeight2.1 SETDISPLAYHEIGHT] || integer || Optional || Set height of image in pixels. || |
| 37 | | || [#ShowLayers2.1 SHOWLAYERS] || text || Optional || List of layers to display. || |
| 38 | | || [#HideLayers2.1 HIDELAYERS] || text || Optional || List of layers to hide. || |
| 39 | | || [#ShowGroups2.1 SHOWGROUPS] || text || Optional || List of groups to display. || |
| 40 | | || [#HideGroups2.1 HIDEGROUPS] || text || Optional || List of groups to hide. || |
| | 31 | || [#SetViewCenterX1.0 SETVIEWCENTERX] || double || Optional || Set X coordinate for center of map. || |
| | 32 | || [#SetViewCenterY1.0 SETVIEWCENTERY] || double || Optional || Set Y coordinate for center of map. || |
| | 33 | || [#SetViewScale1.0 SETVIEWSCALE] || double || Optional || Set scale for map. || |
| | 34 | || [#SetDisplayDpi1.0 SETDISPLAYDPI] || integer || Optional || Set DPI for map. || |
| | 35 | || [#SetDisplayWidth1.0 SETDISPLAYWIDTH] || integer || Optional || Set width of image in pixels. || |
| | 36 | || [#SetDisplayHeight1.0 SETDISPLAYHEIGHT] || integer || Optional || Set height of image in pixels. || |
| | 37 | || [#ShowLayers1.0 SHOWLAYERS] || text || Optional || List of layers to display. || |
| | 38 | || [#HideLayers1.0 HIDELAYERS] || text || Optional || List of layers to hide. || |
| | 39 | || [#ShowGroups1.0 SHOWGROUPS] || text || Optional || List of groups to display. || |
| | 40 | || [#HideGroups1.0 HIDEGROUPS] || text || Optional || List of groups to hide. || |
| 45 | | ==== SETVIEWCENTERX Parameter ==== #SetViewCenterX2.1 |
| 46 | | Sets the X coordinate for the center of the map. The coordinate is given in map coordinate system units. |
| 47 | | ==== SETVIEWCENTERY Parameter ==== #SetViewCenterY2.1 |
| 48 | | Sets the Y coordinate for the center of the map. The coordinate is given in map coordinate system units. |
| 49 | | ==== SETVIEWSCALE Parameter ==== #SetViewScale2.1 |
| 50 | | Sets the currently viewed scale for the map. This number should be greater than zero. |
| 51 | | ==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi2.1 |
| 52 | | Sets the display resolution for the screen. Typically 96 or 120 DPI. |
| 53 | | ==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth2.1 |
| 54 | | Sets the width of the resulting image in pixels. |
| 55 | | ==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight2.1 |
| 56 | | Sets the height of the resulting image in pixels. |
| 57 | | ==== SHOWLAYERS Parameter ==== #ShowLayers2.1 |
| 58 | | Comma separated list of the MgLayer::!GetObjectId() values for layers to show. Previously shown |
| 59 | | layers will continue to be shown. |
| 60 | | ==== HIDELAYERS Parameter ==== #HideLayers2.1 |
| 61 | | Comma separated list of the MgLayer::!GetObjectId() values for layers to hide. Previously hidden |
| 62 | | layers will remain hidden. |
| 63 | | ==== SHOWGROUPS Parameter ==== #ShowGroups2.1 |
| 64 | | Comma separated list of the MgGroup::!GetObjectId() values for groups to show. Previously shown |
| 65 | | groups will continue to be shown. Layers within the groups will retain their current hide/show status. |
| 66 | | ==== HIDEGROUPS Parameter ==== #HideGroups2.1 |
| 67 | | Comma separated list of the MgGroup::!GetObjectId() values for groups to hide. Previously hidden |
| 68 | | groups will remain hidden. Layers within the groups will retain their current hide/show status. |
| | 167 | == !GetMapImage == |
| | 168 | === Overview === |
| | 169 | !GetMapImage returns a rendered raster image containing all visible layers for the map. This API can be used to generate a raster image for a currently displayed map in the session repository or to display the initial view display an image for is used in conjuction with the !GetVisibleMapExtent HTTP API to provide dynamic map updates for end user interactions. |
| | 170 | === Parameters === |
| | 171 | || '''Name''' || '''Value''' || '''Required''' || '''Description''' || |
| | 172 | || [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute || |
| | 173 | || [#Version1.0 VERSION] || 1.0.0 || Yes || Operation version || |
| | 174 | || [#Session1.0 SESSION] || session identifier || Yes || !MapGuide session identifier containing map to display || |
| | 175 | || [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. || |
| | 176 | || [#Format1.0 FORMAT] || JPG/PNG || Yes || Image format for rendered image || |
| | 177 | || [#KeepSelection1.0 KEEPSELECTION] || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. || |
| | 178 | || [#SetViewCenterX1.0 SETVIEWCENTERX] || double || Optional || Set X coordinate for center of map. || |
| | 179 | || [#SetViewCenterY1.0 SETVIEWCENTERY] || double || Optional || Set Y coordinate for center of map. || |
| | 180 | || [#SetViewScale1.0 SETVIEWSCALE] || double || Optional || Set scale for map. || |
| | 181 | || [#SetDisplayDpi1.0 SETDISPLAYDPI] || integer || Optional || Set DPI for map. || |
| | 182 | || [#SetDisplayWidth1.0 SETDISPLAYWIDTH] || integer || Optional || Set width of image in pixels. || |
| | 183 | || [#SetDisplayHeight1.0 SETDISPLAYHEIGHT] || integer || Optional || Set height of image in pixels. || |
| | 184 | || [#ShowLayers1.0 SHOWLAYERS] || text || Optional || List of layers to display. || |
| | 185 | || [#HideLayers1.0 HIDELAYERS] || text || Optional || List of layers to hide. || |
| | 186 | || [#ShowGroups1.0 SHOWGROUPS] || text || Optional || List of groups to display. || |
| | 187 | || [#HideGroups1.0 HIDEGROUPS] || text || Optional || List of groups to hide. || |
| | 188 | ==== SETVIEWCENTERX Parameter ==== #SetViewCenterX1.0 |
| | 189 | Sets the X coordinate for the center of the map. The coordinate is given in map coordinate system units. |
| | 190 | ==== SETVIEWCENTERY Parameter ==== #SetViewCenterY1.0 |
| | 191 | Sets the Y coordinate for the center of the map. The coordinate is given in map coordinate system units. |
| | 192 | ==== SETVIEWSCALE Parameter ==== #SetViewScale1.0 |
| | 193 | Sets the currently viewed scale for the map. This number should be greater than zero. |
| | 194 | ==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi1.0 |
| | 195 | Sets the display resolution for the screen. Typically 96 or 120 DPI. |
| | 196 | ==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth1.0 |
| | 197 | Sets the width of the resulting image in pixels. |
| | 198 | ==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight1.0 |
| | 199 | Sets the height of the resulting image in pixels. |
| | 200 | ==== SHOWLAYERS Parameter ==== #ShowLayers1.0 |
| | 201 | Comma separated list of the MgLayer::!GetObjectId() values for layers to show. Previously shown |
| | 202 | layers will continue to be shown. |
| | 203 | ==== HIDELAYERS Parameter ==== #HideLayers1.0 |
| | 204 | Comma separated list of the MgLayer::!GetObjectId() values for layers to hide. Previously hidden |
| | 205 | layers will remain hidden. |
| | 206 | ==== SHOWGROUPS Parameter ==== #ShowGroups1.0 |
| | 207 | Comma separated list of the MgGroup::!GetObjectId() values for groups to show. Previously shown |
| | 208 | groups will continue to be shown. Layers within the groups will retain their current hide/show status. |
| | 209 | ==== HIDEGROUPS Parameter ==== #HideGroups1.0 |
| | 210 | Comma separated list of the MgGroup::!GetObjectId() values for groups to hide. Previously hidden |
| | 211 | groups will remain hidden. Layers within the groups will retain their current hide/show status. |
| | 212 | === Usage === |
| | 213 | === Technical Notes === |
