Changes between Version 23 and Version 24 of HttpApi/RenderingService


Ignore:
Timestamp:
Apr 28, 2010, 11:50:31 AM (14 years ago)
Author:
trevorwekel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HttpApi/RenderingService

    v23 v24  
    137137|| [#KeepSelection1.0 KEEPSELECTION] || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. ||
    138138
    139 ==== OPERATION Parameter ==== #Operation1.0
    140 Name of HTTP operation to execute.  This parameter is case sensitive.  Operation names should be all uppercase.
    141 ==== VERSION Parameter ==== #Version1.0
    142 Version of operation to execute.  This version number corresponds to the version of !MapGuide where the operation was changed or introduced.
    143 ==== SESSION Parameter ==== #Session1.0
    144 Session identifier for the map.  The session identifier is typically created using MgSite::!CreateSession() or the CREATESESSION HTTP operation.
    145 ==== MAPNAME Parameter ==== #MapName1.0
    146 The map name is the resource name of the map.  For example "!WorldElevation" is the resource name for "!Library://Maps/World/WorldElevation.MapDefinition".
    147 ==== FORMAT Parameter ==== #Format1.0
    148 Image format for the rendered image.  Legal values are:
    149  * "JPG" for 24 bit JPEG
    150  * "PNG" for 32 bit PNG
    151  * "PNG8" for 8 bit PNG  '''Note: This was added in !MapGuide 2.0.'''
    152 ==== KEEPSELECTION Parameter ==== #KeepSelection1.0
    153 Determines whether the selection is visible outside of the scale range for the selected feature(s).  If "1", the selection will be visible even
    154 when the feature scale range is outside of the current map scale.
     139
    155140
    156141=== Usage ===
     
    170155=== Parameters ===
    171156|| '''Name''' || '''Value'''  || '''Required''' || '''Description''' ||
    172 || [#Operation1.0 OPERATION] || GETDYNAMICMAPOVERLAYIMAGE || Yes || Operation to execute ||
     157|| [#Operation1.0 OPERATION] || GETMAPIMAGE || Yes || Operation to execute ||
    173158|| [#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. ||
     159|| [#Session1.0 SESSION] || session identifier || Optional || !MapGuide session identifier containing map to display.[[BR]]SESSION or USERNAME and PASSWORD must be specified. ||
     160|| [#Username1.0 USERNAME] || text || Optional || !MapGuide user id.[[BR]]SESSION or USERNAME and PASSWORD must be specified.||
     161|| [#Password1.0 PASSWORD] || text || Optional || Password for !MapGuide user.[[BR]]SESSION or USERNAME and PASSWORD must be specified. ||
     162|| [#MapName1.0 MAPNAME] || text || Optional || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier.[[BR]]MAPNAME or MAPDEFINITION must be specified. ||
     163|| [#MapDefinition1.0 MAPDEFINITION] || text || Optional || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier.[[BR]]MAPNAME or MAPDEFINITION must be specified. ||
    176164|| [#Format1.0 FORMAT] || JPG/PNG || Yes || Image format for rendered image ||
    177165|| [#KeepSelection1.0 KEEPSELECTION] || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. ||
     
    186174|| [#ShowGroups1.0 SHOWGROUPS] || text || Optional || List of groups to display. ||
    187175|| [#HideGroups1.0 HIDEGROUPS] || text || Optional || List of groups to hide. ||
     176==== OPERATION Parameter ==== #Operation1.0
     177Name of HTTP operation to execute.  This parameter is case sensitive.  Operation names should be all uppercase.
     178==== VERSION Parameter ==== #Version1.0
     179Version of operation to execute.  This version number corresponds to the version of !MapGuide where the operation was changed or introduced.
     180==== SESSION Parameter ==== #Session1.0
     181Session identifier for the map.  The session identifier is typically created using MgSite::!CreateSession() or the CREATESESSION HTTP operation.
     182==== USERNAME Parameter ==== #Username1.0
     183!MapGuide user id with permission to access the map definition.
     184==== PASSWORD Parameter ==== #Username1.0
     185Password for !MapGuide user.
     186==== MAPNAME Parameter ==== #MapName1.0
     187The map name is the resource name of the map.  For example "!WorldElevation" is the resource name for "!Library://Maps/World/WorldElevation.MapDefinition".
     188==== FORMAT Parameter ==== #Format1.0
     189Image format for the rendered image.  Legal values are:
     190 * "JPG" for 24 bit JPEG
     191 * "PNG" for 32 bit PNG
     192 * "PNG8" for 8 bit PNG  '''Note: This was added in !MapGuide 2.0.'''
     193==== KEEPSELECTION Parameter ==== #KeepSelection1.0
     194Determines whether the selection is visible outside of the scale range for the selected feature(s).  If "1", the selection will be visible even
     195when the feature scale range is outside of the current map scale.
    188196==== SETVIEWCENTERX Parameter ==== #SetViewCenterX1.0
    189197Sets the X coordinate for the center of the map.  The coordinate is given in map coordinate system units.
     
    193201Sets the currently viewed scale for the map.  This number should be greater than zero.
    194202==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi1.0
    195 Sets the display resolution for the screen.  Typically 96 or 120 DPI.
     203Sets the display resolution for the device.  Typically 96 or 120 DPI.
    196204==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth1.0
    197205Sets the width of the resulting image in pixels.
     
    211219groups will remain hidden.  Layers within the groups will retain their current hide/show status.
    212220=== Usage ===
    213 === Technical Notes ===
     221{{{
     222http://localhost/mapguide/mapagent.fcgi?OPERATION=GETMAPIMAGE
     223                                        &VERSION=1.0.0
     224                                        &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
     225                                        &MAPNAME=WorldElevation
     226                                        &FORMAT=PNG
     227                                        &SETVIEWCENTERX=-114.0
     228                                        &SETVIEWCENTERY=51.0
     229                                        &SETVIEWSCALE=50000
     230                                        &SETDISPLAYHEIGHT=500
     231                                        &SETDISPLAYWIDTH=500
     232                                        &SHOWLAYERS=d5d01111-5f75-102c-8000-02004c4f4f50,d5d01118-5f75-102c-8000-02004c4f4f50
     233}}}
     234Sets 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 eight bit PNG image.  Any selection already defined by web extensions API calls will be drawn in blue.  Changes to center, scale and layer visibility are retained.
     235{{{
     236http://localhost/mapguide/mapagent.fcgi?OPERATION=GETMAPIMAGE
     237                                        &VERSION=1.0.0
     238                                        &USERNAME=Anonymous
     239                                        &PASSWORD=
     240                                        &MAPDEFINITION=Library://Maps/World/WorldElevation.MapDefinition
     241                                        &FORMAT=PNG
     242                                        &SETVIEWCENTERX=-114.0
     243                                        &SETVIEWCENTERY=51.0
     244                                        &SETVIEWSCALE=50000
     245                                        &SETDISPLAYHEIGHT=500
     246                                        &SETDISPLAYWIDTH=500
     247                                        &SHOWLAYERS=d5d01111-5f75-102c-8000-02004c4f4f50,d5d01118-5f75-102c-8000-02004c4f4f50
     248}}}
     249Creates a temporary map.  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 eight bit PNG image.  No selection is defined or drawn.
     250=== Technical Notes ===