Changes between Version 1 and Version 2 of maestro/MaestroAPI/samples/4.0/CreateRuntimeMap

Timestamp:

Nov 22, 2011, 4:22:02 AM (12 years ago)

Author:

jng

Comment:

--

maestro/MaestroAPI/samples/4.0/CreateRuntimeMap

@@ -1 +1 @@
 = Creating and working with a Runtime Map =
 
-The IMappingService interface provides the means of creating and working with the runtime map.
+The IMappingService interface provides the means of creating and working with the runtime map. Note that you must call Save() on the Runtime Map before using any API that operates on the Runtime Map (eg. Rendering)
 
 The following example shows how to create a new RuntimeMap
@@ -47 +47 @@
 
 }}}
+
+This sample shows how to open an existing Runtime Map. If you want to open a runtime map created by the official API (ie. One created when loading a Web Layout or Application Definition), you will have to use a resource id of the following format:
+
+{{{
+Session:<session-id>://<map-name>.Map
+}}}
+
+(C#)
+{{{
+
+IServerConnection conn = ConnectionProviderRegistry.CreateConnection("Maestro.Http", 
+    "Username", "Administrator",
+    "Password", "admin",
+    "Url", "http://localhost/mapguide/mapagent/mapagent.fcgi");
+
+//Create the Mapping Service. Some implementations of IServerConnection may not support this service, so
+//its best to inspect the capability object of this connection to determine if this service type is supported
+IMappingService mapSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+
+ResourceIdentifier rtMapId = new ResourceIdentifier(mapName, ResourceTypes.RuntimeMap, conn.SessionID);
+RuntimeMap rtMap = mapSvc.OpenMap(rtMapId);
+
+}}}
+
+This samples shows to to manipulate the state of the runtime map. In this case, toggling the visibility of the Parcels layer
+
+(C#)
+{{{
+
+IServerConnection conn = ConnectionProviderRegistry.CreateConnection("Maestro.Http", 
+    "Username", "Administrator",
+    "Password", "admin",
+    "Url", "http://localhost/mapguide/mapagent/mapagent.fcgi");
+
+//Create the Mapping Service. Some implementations of IServerConnection may not support this service, so
+//its best to inspect the capability object of this connection to determine if this service type is supported
+IMappingService mapSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+
+ResourceIdentifier rtMapId = new ResourceIdentifier(mapName, ResourceTypes.RuntimeMap, conn.SessionID);
+RuntimeMap rtMap = mapSvc.OpenMap(rtMapId);
+
+//Toggle visibility of the Parcels layer
+rtMap.Layers["Parcels"].Visible = false;
+
+//Any changes to map state require calling Save()
+rtMap.Save();
+
+}}}
+
+This example shows how to render an opened Runtime Map to a file
+
+(C#)
+{{{
+
+IServerConnection conn = ConnectionProviderRegistry.CreateConnection("Maestro.Http", 
+    "Username", "Administrator",
+    "Password", "admin",
+    "Url", "http://localhost/mapguide/mapagent/mapagent.fcgi");
+
+//Create the Mapping Service. Some implementations of IServerConnection may not support this service, so
+//its best to inspect the capability object of this connection to determine if this service type is supported
+IMappingService mapSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+
+ResourceIdentifier rtMapId = new ResourceIdentifier(mapName, ResourceTypes.RuntimeMap, conn.SessionID);
+RuntimeMap rtMap = mapSvc.OpenMap(rtMapId);
+
+using(Stream stream = mapSvc.RenderDynamicOverlay(map, null, "PNG"))
+{
+    //Write this stream out to a file
+    using (var fs = new FileStream("RenderMap.png", FileMode.OpenOrCreate))
+    {
+        int read = 0;
+        do
+        {
+            read = source.Read(buf, 0, buf.Length);
+            target.Write(buf, 0, read);
+        } while (read > 0);
+    }
+}
+
+}}}