User Tools

Site Tools


thinkgeo.mapsuite.core.mapengine

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
thinkgeo.mapsuite.core.mapengine [2015/09/21 01:07]
admin
thinkgeo.mapsuite.core.mapengine [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.MapEngine ====== ====== ThinkGeo.MapSuite.Core.MapEngine ======
 +
 +{{section>​upgrade_map_suite_to_10.0}}
 +
 This class is for generating maps. This class is for generating maps.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
Line 15: Line 18:
 ==== Protected Constructors ==== ==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
 +** {{wiki:​PublicMethod.gif|}} ZoomOut(Int32) **
 +
 +This method will update the CurrentExtent by using the ZoomOut operation.
 +== Remarks ==
 +None
 +
 +== Return Value ==
 +  * Type:Void
 +  * Description:​None.
 +
 +== Parameters ==
 +  * //​percentage//​
 +    * Type:Int32
 +    * Description:​This parameter is the percentage by which you want to zoom.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​PointShape,​Single,​Single) **
 +
 +This method updates the CurrentExtent by using the ZoomOutToCenter operation.
 +== Remarks ==
 +The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
 +
 +== Return Value ==
 +  * Type:Void
 +  * Description:​None.
 +
 +== Parameters ==
 +  * //​percentage//​
 +    * Type:Int32
 +    * Description:​This parameter is the percentage by which you want to zoom out.
 +
 +  * //​worldPoint//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
 +    * Description:​This parameter is the world point you want the extent to be centered on.
 +
 +  * //​screenWidth//​
 +    * Type:Single
 +    * Description:​This parameter is the width of the screen.
 +
 +  * //​screenHeight//​
 +    * Type:Single
 +    * Description:​This parameter is the height of the screen.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​Feature,​Single,​Single) **
 +
 +This method updates the CurrentExtent by using the ZoomOutToCenter operation.
 +== Remarks ==
 +The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
 +
 +== Return Value ==
 +  * Type:Void
 +  * Description:​None.
 +
 +== Parameters ==
 +  * //​percentage//​
 +    * Type:Int32
 +    * Description:​This parameter is the percentage by which you want to zoom out.
 +
 +  * //​centerFeature//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]]
 +    * Description:​This parameter is the world point Feature you want the extent to be centered on.
 +
 +  * //​screenWidth//​
 +    * Type:Single
 +    * Description:​This parameter is the width of the screen.
 +
 +  * //​screenHeight//​
 +    * Type:Single
 +    * Description:​This parameter is the height of the screen.
 +
 +<div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​Single,​Single,​Single,​Single) ** ** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​Single,​Single,​Single,​Single) **
  
Line 745: Line 820:
     * Type:Int32     * Type:Int32
     * Description:​This parameter specifies the height of the returning image.     * Description:​This parameter specifies the height of the returning image.
 +
 +  * //mapUnit//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
 +    * Description:​This parameter specifies the MapUnit used in the current map.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} Draw(IEnumerable<​Layer>,​Bitmap,​GeographyUnit) **
 +
 +Draw a group of layers on the specified "​background"​ bitmap.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Bitmap
 +  * Description:​The resulting bitmap after drawing the target layers on the specified "​background"​ bitmap.
 +
 +== Parameters ==
 +  * //layers//
 +    * Type:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Layer|Layer]]>​
 +    * Description:​This parameter specifies the target layers to be drawn.
 +
 +  * //​gdiPlusBitmap//​
 +    * Type:Bitmap
 +    * Description:​This parameter specifies the "​background"​ bitmap of the returning bitmap.
 +
 +  * //mapUnit//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
 +    * Description:​This parameter specifies the MapUnit used in the current map.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} DrawStaticLayers(Bitmap,​GeographyUnit) **
 +
 +Draw a group of static layers on the specified "​background"​ bitmap.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Bitmap
 +  * Description:​The resulting bitmap after drawing the group of static layers on the specified "​background"​ bitmap.
 +
 +== Parameters ==
 +  * //​gdiPlusBitmap//​
 +    * Type:Bitmap
 +    * Description:​This parameter specifies the "​background"​ bitmap of the returning bitmap.
 +
 +  * //mapUnit//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
 +    * Description:​This parameter specifies the MapUnit used in the current map.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} DrawDynamicLayers(Bitmap,​GeographyUnit) **
 +
 +Draw a group of dynamic layers on the specified "​background"​ bitmap.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Bitmap
 +  * Description:​The resulting bitmap after drawing the group of dynamic layers on the specified "​background"​ bitmap.
 +
 +== Parameters ==
 +  * //​gdiPlusBitmap//​
 +    * Type:Bitmap
 +    * Description:​This parameter specifies the "​background"​ bitmap of the returning bitmap.
 +
 +  * //mapUnit//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
 +    * Description:​This parameter specifies the MapUnit used in the current map.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} DrawAdornmentLayers(Bitmap,​GeographyUnit) **
 +
 +Draw a group of AdornmentLayers on the specified "​background"​ bitmap.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Bitmap
 +  * Description:​The resulting bitmap after drawing the group of AdornmentLayers on the specified "​background"​ bitmap.
 +
 +== Parameters ==
 +  * //​gdiPlusBitmap//​
 +    * Type:Bitmap
 +    * Description:​This parameter specifies the "​background"​ bitmap of the returning bitmap.
  
   * //mapUnit//   * //mapUnit//
Line 855: Line 1014:
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​PublicMethod.gif|}} ​ZoomOut(Int32) **+** {{wiki:​PublicMethod.gif|}} ​ToString() **
  
-This method ​will update the CurrentExtent ​by using the ZoomOut operation.+N/A 
 +== Remarks == 
 +N/A 
 + 
 +== Return Value == 
 +  * Type:​String 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} Equals(Object) ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 + 
 +== Return Value == 
 +  * Type:​Boolean 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +  * //obj// 
 +    * Type:​Object 
 +    * Description:​N/​A 
 + 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetHashCode() ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 + 
 +== Return Value == 
 +  * Type:​Int32 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 + 
 +== Return Value == 
 +  * Type:Type 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOut(RectangleShape,​Int32) ** 
 + 
 +This method ​returns a new extent that is zoomed out by the percentage provided.
 == Remarks == == Remarks ==
 None None
  
 == Return Value == == Return Value ==
-  * Type:Void +  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​None.+  * Description:​This method returns a new extent that is zoomed out by the percentage provided.
  
 == Parameters == == Parameters ==
 +  * //​worldExtent//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
 +    * Description:​This parameter is the world extent you want to zoom.
 +
   * //​percentage//​   * //​percentage//​
     * Type:Int32     * Type:Int32
-    * Description:​This parameter is the percentage by which you want to zoom.+    * Description:​This parameter is the percentage by which you want to zoom out.
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​PointShape,​Single,​Single) **+** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​PointShape,​Single,​Single) **
  
-This method ​updates the CurrentExtent by using the ZoomOutToCenter operation.+This method ​returns an extent that is centered and zoomed out.
 == Remarks == == Remarks ==
-The CurrentExtent ​will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.+The resulting rectangle ​will already ​be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
  
 == Return Value == == Return Value ==
-  * Type:Void +  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​None.+  * Description:​This method returns an extent that is centered and zoomed out.
  
 == Parameters == == Parameters ==
 +  * //​worldExtent//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
 +    * Description:​This parameter is the world extent you want to center and zoom.
 +
   * //​percentage//​   * //​percentage//​
     * Type:Int32     * Type:Int32
Line 899: Line 1118:
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​PublicMethod.gif|}} ZoomOutToCenter(Int32,​Feature,​Single,​Single) **+** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​Feature,​Single,​Single) **
  
-This method ​updates the CurrentExtent by using the ZoomOutToCenter operation.+This method ​returns an extent that is centered and zoomed out.
 == Remarks == == Remarks ==
-The CurrentExtent ​will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.+The resulting rectangle ​will already ​be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
  
 == Return Value == == Return Value ==
-  * Type:Void +  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​None.+  * Description:​This method returns an extent that is centered and zoomed out.
  
 == Parameters == == Parameters ==
 +  * //​worldExtent//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
 +    * Description:​This parameter is the world extent you want to center and zoom.
 +
   * //​percentage//​   * //​percentage//​
     * Type:Int32     * Type:Int32
Line 916: Line 1139:
   * //​centerFeature//​   * //​centerFeature//​
     * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]]     * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]]
-    * Description:​This parameter is the world point Feature ​you want the extent to be centered on.+    * Description:​This parameter is the feature ​you want the extent to be centered on.
  
   * //​screenWidth//​   * //​screenWidth//​
Line 926: Line 1149:
     * Description:​This parameter is the height of the screen.     * Description:​This parameter is the height of the screen.
  
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} ToString() ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:String 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} Equals(Object) ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:​Boolean 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //obj// 
-    * Type:Object 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} GetHashCode() ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:Int32 
-  * Description:​N/​A 
- 
-== Parameters == 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}} GetType() ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:Type 
-  * Description:​N/​A 
- 
-== Parameters == 
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​Single,​Single,​Single,​Single) ** ** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​Single,​Single,​Single,​Single) **
Line 1286: Line 1457:
  
 == Parameters == == Parameters ==
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} LoadDataTable(Collection<​Feature>,​IEnumerable<​String>​) **
 +
 +This method is a static API to get information about a group of passed-in features with the specified returningColumns,​ in the format of a DataTable.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:​DataTable
 +  * Description:​A DateTable of information about those passed-in features and the returning columnNames.
 +
 +== Parameters ==
 +  * //​features//​
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​
 +    * Description:​This parameter specifies the target features.
 +
 +  * //​returningColumnNames//​
 +    * Type:​IEnumerable<​String>​
 +    * Description:​This parameter specifies the returning columnNames for the features.
 +
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} GetDrawingExtent(RectangleShape,​Single,​Single) ** ** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} GetDrawingExtent(RectangleShape,​Single,​Single) **
Line 1717: Line 1908:
     * Type:Single     * Type:Single
     * Description:​This parameter is the screen Y you want to center on.     * Description:​This parameter is the screen Y you want to center on.
- 
-  * //​screenWidth//​ 
-    * Type:Single 
-    * Description:​This parameter is the width of the screen. 
- 
-  * //​screenHeight//​ 
-    * Type:Single 
-    * Description:​This parameter is the height of the screen. 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOut(RectangleShape,​Int32) ** 
- 
-This method returns a new extent that is zoomed out by the percentage provided. 
-== Remarks == 
-None 
- 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​This method returns a new extent that is zoomed out by the percentage provided. 
- 
-== Parameters == 
-  * //​worldExtent//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-    * Description:​This parameter is the world extent you want to zoom. 
- 
-  * //​percentage//​ 
-    * Type:Int32 
-    * Description:​This parameter is the percentage by which you want to zoom out. 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​PointShape,​Single,​Single) ** 
- 
-This method returns an extent that is centered and zoomed out. 
-== Remarks == 
-The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. 
- 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​This method returns an extent that is centered and zoomed out. 
- 
-== Parameters == 
-  * //​worldExtent//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-    * Description:​This parameter is the world extent you want to center and zoom. 
- 
-  * //​percentage//​ 
-    * Type:Int32 
-    * Description:​This parameter is the percentage by which you want to zoom out. 
- 
-  * //​worldPoint//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] 
-    * Description:​This parameter is the world point you want the extent to be centered on. 
- 
-  * //​screenWidth//​ 
-    * Type:Single 
-    * Description:​This parameter is the width of the screen. 
- 
-  * //​screenHeight//​ 
-    * Type:Single 
-    * Description:​This parameter is the height of the screen. 
- 
-<div newline></​div>​ 
-** {{wiki:​PublicMethod.gif|}}{{wiki:​Static.gif|}} ZoomOutToCenter(RectangleShape,​Int32,​Feature,​Single,​Single) ** 
- 
-This method returns an extent that is centered and zoomed out. 
-== Remarks == 
-The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. 
- 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-  * Description:​This method returns an extent that is centered and zoomed out. 
- 
-== Parameters == 
-  * //​worldExtent//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
-    * Description:​This parameter is the world extent you want to center and zoom. 
- 
-  * //​percentage//​ 
-    * Type:Int32 
-    * Description:​This parameter is the percentage by which you want to zoom out. 
- 
-  * //​centerFeature//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]] 
-    * Description:​This parameter is the feature you want the extent to be centered on. 
  
   * //​screenWidth//​   * //​screenWidth//​
Line 1987: Line 2094:
 This collection of Layers StaticLayers will be drawn when calling the DrawAdornmentLayers API. This collection of Layers StaticLayers will be drawn when calling the DrawAdornmentLayers API.
 == Return Value == == Return Value ==
-  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.AdornmentLayer, ​MapSuitePortableCore, Version=8.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]+  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.AdornmentLayer, ​MapSuiteCore, Version=9.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]
  
 ** {{wiki:​PublicProperty.gif|}} CurrentExtent ** ** {{wiki:​PublicProperty.gif|}} CurrentExtent **
Line 2003: Line 2110:
 This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API. This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API.
 == Return Value == == Return Value ==
-  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.Layer, ​MapSuitePortableCore, Version=8.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]+  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.Layer, ​MapSuiteCore, Version=9.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]
  
 ** {{wiki:​PublicProperty.gif|}} DynamicLayers ** ** {{wiki:​PublicProperty.gif|}} DynamicLayers **
Line 2011: Line 2118:
 This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API. This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API.
 == Return Value == == Return Value ==
-  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.Layer, ​MapSuitePortableCore, Version=8.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]+  * Type:​[[ThinkGeo.MapSuite.Core.GeoCollection<​T>​[[ThinkGeo.MapSuite.Core.Layer, ​MapSuiteCore, Version=9.0.0.0, Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<​T>​]]
  
 ** {{wiki:​PublicProperty.gif|}} BackgroundFillBrush ** ** {{wiki:​PublicProperty.gif|}} BackgroundFillBrush **
thinkgeo.mapsuite.core.mapengine.1442797645.txt.gz · Last modified: 2015/09/21 01:07 by admin