MapGuide RFC 4 - KML Support - Revision history

Wiki-Jasonbirch at 03:55, 16 March 2007

2007-03-16T03:55:46Z

Wiki-Tomfukushima at 22:26, 20 December 2006

2006-12-20T22:26:39Z

Wiki-Chrisclaydon at 18:28, 7 November 2006

2006-11-07T18:28:08Z

Wiki-Chrisclaydon at 18:43, 6 November 2006

2006-11-06T18:43:05Z

Wiki-Chrisclaydon at 18:31, 6 November 2006

2006-11-06T18:31:08Z

Wiki-Chrisclaydon at 18:28, 6 November 2006

2006-11-06T18:28:37Z

Wiki-Chrisclaydon at 21:04, 3 November 2006

2006-11-03T21:04:11Z

Wiki-Chrisclaydon at 20:52, 3 November 2006

2006-11-03T20:52:51Z

Wiki-Chrisclaydon at 18:04, 3 November 2006

2006-11-03T18:04:17Z

Wiki-Chrisclaydon at 17:58, 3 November 2006

2006-11-03T17:58:28Z

← Older revision		Revision as of 03:55, 16 March 2007
Line 1:		Line 1:
−	This page ~~contains an change request (RFC) for MapGuide Open Source.~~	+	This page has moved to the MapGuide Trac Wiki:
−	~~More MapGuide RFCs can be found on~~ the [[MapGuide ~~RFCs]] page.~~

−	~~=Status=~~	+	http://trac.osgeo.org/mapguide/wiki/MapGuideRfc4
−
−	*Submission Date:
−	*Last Modified Date:
−	*Author: Chris Claydon
−	*RFC Status: As designed, this was implemented before the RFC process was put in place. This document serves as documentation.
−	*Implementation Status: completed
−	*Voting History:
−	*Assigned PSC guide(s):
−
−	~~=Overview=~~
−
−	Google Earth allows external data to be overlaid upon its own vast collection of satellite imagery and vector graphics. It does this by supporting KML - an XML-based format that can be used to define how external vector and raster data may be dynamically loaded and displayed within the Google Earth application.
−
−	~~=Motivation=~~
−
−	By integrating MapGuide with Google Earth, we provide a compelling way for users to visualize their data in relation to the planet as a whole. In addition to satellite imagery, Google provides a large amount of useful content, such as road networks, points of interest, voting districts etc. By serving up MapGuide data via KML (and its compressed form, KMZ) we allow users to incorporate their specific data set with Google's.
−
−	So, for example, if a MapGuide data set contained information about underground pipes and sewers, this information could be overlaid on a satellite image showing individual streets and houses. This would greatly facilitate the process of estimating exactly which homes and streets would be affected by any maintenance required on those pipes.
−
−	~~=Funding~~/~~Resources=~~
−
−	~~Resources supplied by Autodesk.~~
−
−	~~=Proposed Changes=~~
−
−	~~A new service will be added to MapGuide that supports three request types - GetMapKml, GetLayerKml and GetFeaturesKml.~~
−
−	~~'''GetMapKml''' is designed to be the single point of user-initiated contact with the server. It takes the following parameters:~~
−
−	~~OPERATION = GetMapKml~~
−
−	~~VERSION = 1~~
−
−	~~MAPDEFINITION = <map definition stored in repository>~~
−
−	~~DPI = <the resolution of the display used by the caller> (defaults to 96)~~
−
−	~~FORMAT = KML, KMZ or XML~~
−
−	This request can be made from a URL link in a web page. It generates a KML document representing the requested map definition. This document contains one NetworkLink element for each layer in the map. Google Earth uses these elements to make GetLayerKml requests back to MapGuide to retrieve further dynamic data for each layer.
−
−	~~If the format is KMZ, the KML document is compressed inside a zip file before being returned in the response~~. ~~The mime types returned for KML and KMZ responses cause Google Earth to start up automatically and display the content of the document~~. ~~If the requested format is XML, the mime type returned is text~~/~~xml, and the text of the KML document is typically displayed directly in the browser window.~~
−
−	'''GetLayerKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:
−
−	~~OPERATION = GetLayerKml~~
−
−	~~VERSION = 1~~
−
−	~~LAYERDEFINITION = <layer definition stored in repository>~~
−
−	~~DPI = <the resolution of the display used by the caller> (defaults to 96)~~
−
−	~~FORMAT = KML, KMZ or XML~~
−
−	~~BBOX = <minx,miny,maxx,mayy> the current map extent in WGS84 lat~~/~~lon coordinates~~
−
−	~~WIDTH = the current map width in pixels~~
−
−	~~HEIGHT = the current map height in pixels~~
−
−	The KML generated by the GetMapKml request populates the first 5 of these parameters, and the link is formatted in such a way that Google Earth provides the BBOX, WIDTH and HEIGHT parameters corresponding to its current view.
−
−	GetLayerKml returns a KML document containing a <NetworkLink> element corresponding to each scale range supported by the layer that is currently visible. <Region> elements are used to instruct Google Earth only to request data via these links when the current scale falls within the scale range and when the current map extent intersects the extent of the data.
−
−	'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:
−
−	~~OPERATION = GetFeaturesKml~~
−
−	~~VERSION = 1~~
−
−	~~LAYERDEFINITION = <layer definition stored in repository>~~
−
−	~~DPI = <the resolution of the display used by the caller> (defaults to 96)~~
−
−	~~FORMAT = KML, KMZ or XML~~
−
−	~~BBOX = <minx,miny,maxx,mayy> the current map extent in WGS84 lat~~/~~lon coordinates~~
−
−	~~WIDTH = the current map width in pixels~~
−
−	~~HEIGHT = the current map height in pixels~~
−
−	GetFeaturesKml returns the actual content to be rendered on the map. For feature layers, a KML document is returned that contains the features represented in vector format, plus style information such as the color, line width etc. For raster layers, the raster image is returned in PNG format. Drawing layers (from DWF files) will not be supported (yet).
−
−	~~=Implications=~~
−
−	~~This section allows discussion of the repercussions of the change, such as whether there will be any breakage in backwards compatibility, if documentation will need to be updated, etc.~~
−
−	~~=Test Plan=~~
−
−	~~How the proposed change will be tested, if applicable. New unit tests should be detailed here???~~

@@ Line 7: / Line 7: @@
 *Last Modified Date:
 *Author: Chris Claydon
-*RFC Status: (draft, proposed/pending vote, adopted or rejected)
+*RFC Status: As designed, this was implemented before the RFC process was put in place. This document serves as documentation.
-*Implementation Status: under development
+*Implementation Status: completed
 *Voting History:
 *Assigned PSC guide(s):

← Older revision		Revision as of 18:28, 7 November 2006
Line 70:		Line 70:
	'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:		'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:

		+	OPERATION = GetFeaturesKml

		+	VERSION = 1

		+	LAYERDEFINITION = <layer definition stored in repository>
		+
		+	DPI = <the resolution of the display used by the caller> (defaults to 96)
		+
		+	FORMAT = KML, KMZ or XML
		+
		+	BBOX = <minx,miny,maxx,mayy> the current map extent in WGS84 lat/lon coordinates
		+
		+	WIDTH = the current map width in pixels
		+
		+	HEIGHT = the current map height in pixels
		+
		+	GetFeaturesKml returns the actual content to be rendered on the map. For feature layers, a KML document is returned that contains the features represented in vector format, plus style information such as the color, line width etc. For raster layers, the raster image is returned in PNG format. Drawing layers (from DWF files) will not be supported (yet).

	=Implications=		=Implications=

← Older revision		Revision as of 18:43, 6 November 2006
Line 65:		Line 65:

	The KML generated by the GetMapKml request populates the first 5 of these parameters, and the link is formatted in such a way that Google Earth provides the BBOX, WIDTH and HEIGHT parameters corresponding to its current view.		The KML generated by the GetMapKml request populates the first 5 of these parameters, and the link is formatted in such a way that Google Earth provides the BBOX, WIDTH and HEIGHT parameters corresponding to its current view.
		+
		+	GetLayerKml returns a KML document containing a <NetworkLink> element corresponding to each scale range supported by the layer that is currently visible. <Region> elements are used to instruct Google Earth only to request data via these links when the current scale falls within the scale range and when the current map extent intersects the extent of the data.

	'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:		'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:

@@ Line 32: / Line 32: @@
 '''GetMapKml''' is designed to be the single point of user-initiated contact with the server. It takes the following parameters:
-OPERATION=GetMapKml
+OPERATION = GetMapKml
-VERSION=1
+VERSION = 1
-MAPDEFINITION=<map definition stored in repository>
+MAPDEFINITION = <map definition stored in repository>
-DPI=<the resolution of the display used by the caller> (defaults to 96)
+DPI = <the resolution of the display used by the caller> (defaults to 96)
-FORMAT=KML, KMZ or XML
+FORMAT = KML, KMZ or XML
 This request can be made from a URL link in a web page. It generates a KML document representing the requested map definition. This document contains one NetworkLink element for each layer in the map. Google Earth uses these elements to make GetLayerKml requests back to MapGuide to retrieve further dynamic data for each layer.

← Older revision		Revision as of 18:28, 6 November 2006
Line 47:		Line 47:

	'''GetLayerKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:		'''GetLayerKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:
		+
		+	OPERATION = GetLayerKml
		+
		+	VERSION = 1
		+
		+	LAYERDEFINITION = <layer definition stored in repository>
		+
		+	DPI = <the resolution of the display used by the caller> (defaults to 96)
		+
		+	FORMAT = KML, KMZ or XML
		+
		+	BBOX = <minx,miny,maxx,mayy> the current map extent in WGS84 lat/lon coordinates
		+
		+	WIDTH = the current map width in pixels
		+
		+	HEIGHT = the current map height in pixels
		+
		+	The KML generated by the GetMapKml request populates the first 5 of these parameters, and the link is formatted in such a way that Google Earth provides the BBOX, WIDTH and HEIGHT parameters corresponding to its current view.
		+
		+	'''GetFeaturesKml''' is designed to be called only by Google Earth. Its format may change in order to accomodate future enhancements to our KML support. It is therefore not recommended to call this operation directly. It supports the following parameters:
		+

@@ Line 28: / Line 28: @@
 =Proposed Changes=
-This is a more detailed description of the actual changes desired.  The contents of this section will vary based on the target of the RFC, be it a technical change, website change, or process change.  For example, for a technical change, items such as files, XML schema changes, and API chances would be identified.  For a process change, the new process would be laid out in detail.  For a website change, the files affected would be listed.
+A new service will be added to MapGuide that supports three request types - GetMapKml, GetLayerKml and GetFeaturesKml.
 =Implications=

@@ Line 19: / Line 19: @@
 By integrating MapGuide with Google Earth, we provide a compelling way for users to visualize their data in relation to the planet as a whole. In addition to satellite imagery, Google provides a large amount of useful content, such as road networks, points of interest, voting districts etc. By serving up MapGuide data via KML (and its compressed form, KMZ) we allow users to incorporate their specific data set with Google's.
 =Funding/Resources=
-This section will confirm that the proposed feature has enough support to proceed.  This would typically mean that the entity making the changes would put forward the RFC, but a non-developer could potentially do so if they are sure they have the funding to cover the change.
+Resources supplied by Autodesk.
 =Proposed Changes=