Changes between Version 19 and Version 20 of HttpApi/RenderingService


Ignore:
Timestamp:
Apr 28, 2010, 6:05:18 AM (14 years ago)
Author:
trevorwekel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HttpApi/RenderingService

    v19 v20  
    2727|| [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
    2828|| [#Format1.0 FORMAT] || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
    29 || [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
    3029|| [#SelectionColor2.0 SELECTIONCOLOR] || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
    3130|| [#Behavior2.0 BEHAVIOR] || bitmask || Yes || Bitmask representing rendering behavior.  See below for more details.||
     
    4544"!MapGuide Developer" and "!MapGuide Maestro".
    4645==== SETVIEWCENTERX Parameter ==== #SetViewCenterX2.1
     46Sets the X coordinate for the center of the map.  The coordinate is given in map coordinate system units.
    4747==== SETVIEWCENTERY Parameter ==== #SetViewCenterY2.1
     48Sets the Y coordinate for the center of the map.  The coordinate is given in map coordinate system units.
    4849==== SETVIEWSCALE Parameter ==== #SetViewScale2.1
     50Sets the currently viewed scale for the map.  This number should be greater than zero.
    4951==== SETDISPLAYDPI Parameter ==== #SetDisplayDpi2.1
     52Sets the display resolution for the screen.  Typically 96 or 120 DPI.
    5053==== SETDISPLAYWIDTH Parameter ==== #SetDisplayWidth2.1
     54Sets the width of the resulting image in pixels.
    5155==== SETDISPLAYHEIGHT Parameter ==== #SetDisplayHeight2.1
     56Sets the height of the resulting image in pixels.
    5257==== SHOWLAYERS Parameter ==== #ShowLayers2.1
     58Comma separated list of the MgLayer::!GetObjectId() values for layers to show.  Previously shown
     59layers will continue to be shown.
    5360==== HIDELAYERS Parameter ==== #HideLayers2.1
     61Comma separated list of the MgLayer::!GetObjectId() values for layers to hide.  Previously hidden
     62layers will remain hidden.
    5463==== SHOWGROUPS Parameter ==== #ShowGroups2.1
     64Comma separated list of the MgGroup::!GetObjectId() values for groups to show.  Previously shown
     65groups will continue to be shown.  Layers within the groups will retain their current hide/show status.
    5566==== HIDEGROUPS Parameter ==== #HideGroups2.1
     67Comma separated list of the MgGroup::!GetObjectId() values for groups to hide.  Previously hidden
     68groups will remain hidden.  Layers within the groups will retain their current hide/show status.
    5669=== Usage ===
     70{{{
     71http://localhost/mapguide/mapagent.fcgi?OPERATION=GETDYNAMICMAPOVERLAYIMAGE
     72                                        &VERSION=2.1.0
     73                                        &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
     74                                        &MAPNAME=WorldElevation
     75                                        &FORMAT=PNG8
     76                                        &BEHAVIOR=7
     77                                        &SELECTIONCOLOR=0xFF000080
     78                                        &SETVIEWCENTERX=-114.0
     79                                        &SETVIEWCENTERY=51.0
     80                                        &SETVIEWSCALE=50000
     81                                        &SETDISPLAYHEIGHT=500
     82                                        &SETDISPLAYWIDTH=500
     83                                        &SHOWLAYERS=d5d01111-5f75-102c-8000-02004c4f4f50,d5d01118-5f75-102c-8000-02004c4f4f50
     84}}}
     85Sets 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.
    5786=== Technical Notes ===
    5887== !GetMapImage ==
     
    88117|| [#Format1.0 FORMAT] || JPG/PNG/PNG8 || Yes || Image format for rendered image ||
    89118|| [#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() ||
    91119|| [#SelectionColor2.0 SELECTIONCOLOR] || RGBA hex color || Yes || Selection color encoded in hexadecimal RGBA format 0xRRGGBBAA. ||
    92120
     
    107135Color for selected objects expressed in hexadecimal RGBA format 0xRRGGBBAA.
    108136=== Usage ===
     137{{{
     138http://localhost/mapguide/mapagent.fcgi?OPERATION=GETDYNAMICMAPOVERLAYIMAGE
     139                                        &VERSION=2.0.0
     140                                        &SESSION=Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
     141                                        &MAPNAME=WorldElevation
     142                                        &FORMAT=PNG
     143                                        &BEHAVIOR=5
     144                                        &SELECTIONCOLOR=0xFF000080
     145}}}
     146Renders the selection regardless of current scale for the !WorldElevation map from session Session:d5d05422-5f75-102c-8000-02004c4f4f50_en_7F0000010AFC0AFB0AFA
     147as a 32 bit PNG image.  The selection is drawn in partially transparent red.
    109148=== Technical Notes ===
    110149
     
    120159|| [#MapName1.0 MAPNAME] || text || Yes || Name of the map to display.[[BR]]This corresponds to the !GetName() value for the resource identifier. ||
    121160|| [#Format1.0 FORMAT] || JPG/PNG || Yes || Image format for rendered image ||
    122 || [#Selection1.0 SELECTION] || XML selection text || Optional || XML representing selected features generated from !MgSelection.!ToXml() ||
    123161|| [#KeepSelection1.0 KEEPSELECTION] || 0/1 || Optional || If true, render selected feature(s) even if they are outside the current scale. ||
    124162
     
    136174 * "PNG" for 32 bit PNG
    137175 * "PNG8" for 8 bit PNG  '''Note: This was added in !MapGuide 2.0.'''
    138 ==== SELECTION Parameter ==== #Selection1.0
    139176==== KEEPSELECTION Parameter ==== #KeepSelection1.0
    140177Determines whether the selection is visible outside of the scale range for the selected feature(s).  If "1", the selection will be visible even