thinkgeo.mapsuite.core.mapengine
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.mapengine [2015/09/17 10:34] 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 5: | Line 8: | ||
| ***ThinkGeo.MapSuite.Core.MapEngine** | ***ThinkGeo.MapSuite.Core.MapEngine** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} MapEngine() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#MapEngine()|MapEngine]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Create a new instance of the MapEngine. | + | |
| - | </div> | + | |
| - | === Protected Constructors === | + | Create a new instance of the MapEngine. |
| - | === Public Methods === | + | == Remarks == |
| - | <div class_table> | + | N/A |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#CenterAt(RectangleShape,PointShape,Single,Single)|CenterAt]]** | + | == Parameters == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | <div newline></div> |
| - | * **DeclaringType**:N/A | + | ==== Protected Constructors ==== |
| - | * **Summary**:This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | ==== Public Methods ==== |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} ZoomOut(Int32) ** |
| - | <div class_table> | + | This method will update the CurrentExtent by using the ZoomOut operation. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#CenterAt(RectangleShape,Feature,Single,Single)|CenterAt]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#CenterAt(RectangleShape,Single,Single,Single,Single)|CenterAt]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,Single,Single,Single | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a static function that allows you to pass in a world rectangle, a point in screen coordinates to center on, and a height and width in screen units. The function will center the rectangle based on the screen point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#CenterAt(Single,Single,Single,Single)|CenterAt]]** | + | * //percentage// |
| - | * **Parameters**:Single,Single,Single,Single | + | * Type:Int32 |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the percentage by which you want to zoom. |
| - | * **Summary**:This is a function that allows you to pass a screen point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#CenterAt(Feature,Single,Single)|CenterAt]]** | + | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,PointShape,Single,Single) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a function that allows you to pass in a feature to center on, as well as a height and width in screen units. The function will center the CurrentExtent based on the specified feature and adjust its ratio based on the height and width in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by using the ZoomOutToCenter operation. |
| - | **{{wiki:PublicMethod.gif|}}[[#CenterAt(PointShape,Single,Single)|CenterAt]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a function that allows you to pass a world point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#CloseAllLayers()|CloseAllLayers]]** | + | * Type:Void |
| - | * **Parameters**:N/A | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This API allows you close all of the layers (either static or dynamic). | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Layer>,Bitmap,GeographyUnit)|Draw]]** | + | * //percentage// |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]>,Bitmap,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Int32 |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | * **Summary**:Draw a group of layers on the specified "background" bitmap. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //worldPoint// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit)|Draw]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]>,Int32,Int32,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the world point you want the extent to be centered on. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of layers and return a new image with the specified width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Layer>,GeoImage,GeographyUnit)|Draw]]** | + | * Type:Single |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]>,[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the width of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of layers on the specified "background" image. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawAdornmentLayers(Bitmap,GeographyUnit)|DrawAdornmentLayers]]** | + | * Type:Single |
| - | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the height of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of AdornmentLayers on the specified "background" bitmap. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawAdornmentLayers(Int32,Int32,GeographyUnit)|DrawAdornmentLayers]]** | + | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Feature,Single,Single) ** |
| - | * **Parameters**:Int32,Int32,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of AdornmentLayers and return a new image with the specified width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by using the ZoomOutToCenter operation. |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawAdornmentLayers(GeoImage,GeographyUnit)|DrawAdornmentLayers]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of AdornmentLayers on the specified "background" image. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawDynamicLayers(Bitmap,GeographyUnit)|DrawDynamicLayers]]** | + | * Type:Void |
| - | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of dynamic layers on the specified "background" bitmap. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawDynamicLayers(Int32,Int32,GeographyUnit)|DrawDynamicLayers]]** | + | * //percentage// |
| - | * **Parameters**:Int32,Int32,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Int32 |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | * **Summary**:Draw a group of dynamic layers and return a new image with the specified width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //centerFeature// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawDynamicLayers(GeoImage,GeographyUnit)|DrawDynamicLayers]]** | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the world point Feature you want the extent to be centered on. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of dynamic layers on the specified "background" image. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawStaticLayers(Bitmap,GeographyUnit)|DrawStaticLayers]]** | + | * Type:Single |
| - | * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the width of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of static layers on the specified "background" bitmap. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawStaticLayers(Int32,Int32,GeographyUnit)|DrawStaticLayers]]** | + | * Type:Single |
| - | * **Parameters**:Int32,Int32,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Description:This parameter is the height of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of static layers and return a new image with the specified width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawStaticLayers(GeoImage,GeographyUnit)|DrawStaticLayers]]** | + | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Single,Single,Single,Single) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Draw a group of static layers on the specified "background" image. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by using the ZoomOutToCenter operation. |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Remarks == |
| - | * **Parameters**:Object | + | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#FindDynamicFeatureLayer(String)|FindDynamicFeatureLayer]]** | + | * Type:Void |
| - | * **Parameters**:String | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Find the feature layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#FindDynamicRasterLayer(String)|FindDynamicRasterLayer]]** | + | * //percentage// |
| - | * **Parameters**:String | + | * Type:Int32 |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | * **Summary**:Find the raster layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenX// |
| - | **{{wiki:PublicMethod.gif|}}[[#FindStaticFeatureLayer(String)|FindStaticFeatureLayer]]** | + | * Type:Single |
| - | * **Parameters**:String | + | * Description:This parameter is the screen X you want to center on. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Finds a feature layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenY// |
| - | **{{wiki:PublicMethod.gif|}}[[#FindStaticRasterLayer(String)|FindStaticRasterLayer]]** | + | * Type:Single |
| - | * **Parameters**:String | + | * Description:This parameter is the screen Y you want to center on. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Find the raster layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetBoundingBoxOfItems(IEnumerable<Feature>)|GetBoundingBoxOfItems]]** | + | * Type:Single |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Description:This parameter is the width of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This API gets the BoundingBox of a group of Features. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetBoundingBoxOfItems(IEnumerable<BaseShape>)|GetBoundingBoxOfItems]]** | + | * Type:Single |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> | + | * Description:This parameter is the height of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This API gets the BoundingBox of a group of BaseShapes. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetCurrentScale(RectangleShape,Single,GeographyUnit)|GetCurrentScale]]** | + | ** {{wiki:PublicMethod.gif|}} Pan(PanDirection,Int32) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit. | + | |
| - | </div> | + | |
| - | <div class_table> | + | Update the CurrentExtent by using a panning operation. |
| - | **{{wiki:PublicMethod.gif|}}[[#GetCurrentScale(Single,GeographyUnit)|GetCurrentScale]]** | + | == Remarks == |
| - | * **Parameters**:Single,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Get the current Scale responding to the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetDrawingExtent(RectangleShape,Single,Single)|GetDrawingExtent]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,Single | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an adjusted extent based on the ratio of the screen width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetDrawingExtent(Single,Single)|GetDrawingExtent]]** | + | * //panDirection// |
| - | * **Parameters**:Single,Single | + | * Type:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]] |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the direction you want to pan. |
| - | * **Summary**:This method returns an adjusted extent based on the ratio of the screen width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //percentage// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:This parameter is the percentage by which you want to pan. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single)|GetScreenDistanceBetweenTwoWorldPoints]]** | + | ** {{wiki:PublicMethod.gif|}} Pan(Single,Int32) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Feature|Feature]],[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by using a panning operation. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single)|GetScreenDistanceBetweenTwoWorldPoints]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the number of pixels between two world points. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single)|GetScreenDistanceBetweenTwoWorldPoints]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Description:None. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single)|GetScreenDistanceBetweenTwoWorldPoints]]** | + | * //degree// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.Feature|Feature]],[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Type:Single |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the angle in degrees in which you want to pan. |
| - | * **Summary**:This method returns the number of pixels between two world points. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //percentage// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:This parameter is the percentage by which you want to pan. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetVersion()|GetVersion]]** | + | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Double,Double,Single,Single) ** |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Get the current MapSuiteCore.dll file version. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. |
| - | **{{wiki:PublicMethod.gif|}}[[#GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit)|GetWorldDistanceBetweenTwoScreenPoints]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],Single,Single,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the distance in world units between two screen points by using the CurrentExtent as a reference. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit)|GetWorldDistanceBetweenTwoScreenPoints]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],Single,Single,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | * Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the distance in world units between two screen points. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,Single,Single,Single,Single,Single,Single,GeographyUnit,DistanceUnit)|GetWorldDistanceBetweenTwoScreenPoints]]** | + | * //worldX// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,Single,Single,Single,Single,Single,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | * Type:Double |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the world point X you want converted to a screen point. |
| - | * **Summary**:This method returns the distance in wold units between two screen points. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //worldY// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#LoadDataTable(Collection<Feature>,IEnumerable<String>)|LoadDataTable]]** | + | * Type:Double |
| - | * **Parameters**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,IEnumerable<String> | + | * Description:This parameter is the world point Y you want converted to a screen point. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**: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. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#OpenAllLayers()|OpenAllLayers]]** | + | * Type:Single |
| - | * **Parameters**:N/A | + | * Description:This parameter is the width of the screen for the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This API allows you to open all of the layers (either static or dynamic). | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#Pan(RectangleShape,PanDirection,Int32)|Pan]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]],Int32 | + | * Description:This parameter is the height of the screen for the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a panned extent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Pan(PanDirection,Int32)|Pan]]** | + | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(PointShape,Single,Single) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]],Int32 | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Update the CurrentExtent by using a panning operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. |
| - | **{{wiki:PublicMethod.gif|}}[[#Pan(Single,Int32)|Pan]]** | + | == Remarks == |
| - | * **Parameters**:Single,Int32 | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by using a panning operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#Pan(RectangleShape,Single,Int32)|Pan]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,Int32 | + | * Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a panned extent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet)|SnapToZoomLevel]]** | + | * //worldPoint// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single,Single,[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the world point you want converted to a screen point. |
| - | * **Summary**:This method returns an extent that is snapped to a zoom level in the provided zoom level set. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet)|SnapToZoomLevel]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single,Single,[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Description:This parameter is the width of the screen for the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToScreenCoordinate(Feature,Single,Single)|ToScreenCoordinate]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Description:This parameter is the height of the screen for the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#ToScreenCoordinate(Double,Double,Single,Single)|ToScreenCoordinate]]** | + | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Feature,Single,Single) ** |
| - | * **Parameters**:Double,Double,Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToScreenCoordinate(RectangleShape,Double,Double,Single,Single)|ToScreenCoordinate]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Double,Double,Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns screen coordinates from world coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToScreenCoordinate(RectangleShape,PointShape,Single,Single)|ToScreenCoordinate]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Description:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns screen coordinates from world coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToScreenCoordinate(RectangleShape,Feature,Single,Single)|ToScreenCoordinate]]** | + | * //worldPointFeature// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the world coordinate pointFeature you want converted to a screen point. |
| - | * **Summary**:This method returns screen coordinates from world coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToScreenCoordinate(PointShape,Single,Single)|ToScreenCoordinate]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Description:This parameter is the width of the screen for the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:Single |
| - | * **Parameters**:N/A | + | * Description:This parameter is the height of the screen for the CurrentExtent. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToWorldCoordinate(RectangleShape,Single,Single,Single,Single)|ToWorldCoordinate]]** | + | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Single,Single,Single,Single) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Single,Single,Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns world coordinates from screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method returns world coordinates from screen coordinates, based on the CurrentExtent. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single)|ToWorldCoordinate]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns world coordinates from screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#ToWorldCoordinate(Single,Single,Single,Single)|ToWorldCoordinate]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Parameters**:Single,Single,Single,Single | + | * Description:This method returns world coordinates from screen coordinates, based on the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#ToWorldCoordinate(ScreenPointF,Single,Single)|ToWorldCoordinate]]** | + | * //screenX// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]],Single,Single | + | * Type:Single |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the X of the point you want converted to world coordinates. |
| - | * **Summary**:This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenY// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomIn(RectangleShape,Int32)|ZoomIn]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32 | + | * Description:This parameter is the Y of the point you want converted to world coordinates. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a new extent that is zoomed in by the percentage provided. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomIn(Int32)|ZoomIn]]** | + | * Type:Single |
| - | * **Parameters**:Int32 | + | * Description:This parameter is the width of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent that is zoomed in by the percentage provided. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single)|ZoomIntoCenter]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Description:This parameter is the height of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an extent that is centered and zoomed in. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single)|ZoomIntoCenter]]** | + | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(ScreenPointF,Single,Single) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Single,Single,Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an extent that is centered and zoomed in. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method returns world coordinates from screen coordinates, based on the CurrentExtent. |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomIntoCenter(Int32,Single,Single,Single,Single)|ZoomIntoCenter]]** | + | == Remarks == |
| - | * **Parameters**:Int32,Single,Single,Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomIntoCenter(Int32,Feature,Single,Single)|ZoomIntoCenter]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Description:This method returns world coordinates from screen coordinates, based on the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an extent that is centered and zoomed in. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomIntoCenter(Int32,PointShape,Single,Single)|ZoomIntoCenter]]** | + | * //screenPoint// |
| - | * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the point you want converted to world coordinates. |
| - | * **Summary**:This method will update the CurrentExtent by using the ZoomIntoCenter operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomIntoCenter(RectangleShape,Int32,Feature,Single,Single)|ZoomIntoCenter]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Description:This parameter is the width of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a new extent that is zoomed in by the percentage provided. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomOut(RectangleShape,Int32)|ZoomOut]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32 | + | * Description:This parameter is the height of the screen. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a new extent that is zoomed out by the percentage provided. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomOut(Int32)|ZoomOut]]** | + | ** {{wiki:PublicMethod.gif|}} SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet) ** |
| - | * **Parameters**:Int32 | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method will update the CurrentExtent by using the ZoomOut operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single)|ZoomOutToCenter]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Single,Single,Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an extent that is centered and zoomed out. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single)|ZoomOutToCenter]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Description:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an extent that is centered and zoomed out. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single)|ZoomOutToCenter]]** | + | * //worldExtentUnit// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **DeclaringType**:N/A | + | * Description:This parameter is the geographic unit of the CurrentExtent. |
| - | * **Summary**:This method returns an extent that is centered and zoomed out. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomOutToCenter(Int32,Single,Single,Single,Single)|ZoomOutToCenter]]** | + | * Type:Single |
| - | * **Parameters**:Int32,Single,Single,Single,Single | + | * Description:This parameter is the screen width. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomOutToCenter(Int32,Feature,Single,Single)|ZoomOutToCenter]]** | + | * Type:Single |
| - | * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.Feature|Feature]],Single,Single | + | * Description:This parameter is the screen height. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //zoomLevelSet// |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomOutToCenter(Int32,PointShape,Single,Single)|ZoomOutToCenter]]** | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] |
| - | * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Single,Single | + | * Description:This parameter is the set of zoom levels you want to snap to. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#ZoomToScale(Double,GeographyUnit,Single,Single)|ZoomToScale]]** | + | ** {{wiki:PublicMethod.gif|}} ZoomToScale(Double,GeographyUnit,Single,Single) ** |
| - | * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single,Single | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method updates the CurrentExtent by zooming to a certain scale. | + | |
| - | </div> | + | |
| - | <div class_table> | + | This method updates the CurrentExtent by zooming to a certain scale. |
| - | **{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single)|ZoomToScale]]** | + | == Remarks == |
| - | * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]],Single,Single | + | None |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns a extent that has been zoomed into a certain scale. | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | == Return Value == |
| - | <div class_table> | + | * Type:Void |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * Description:N/A |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * //targetScale// |
| - | * **Parameters**:N/A | + | * Type:Double |
| - | * **DeclaringType**:Object | + | * Description:This parameter is the scale you want to zoom into. |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //worldExtentUnit// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs)|OnAdornmentLayerDrawing]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | + | * Description:This parameter is the geographic unit of the CurrentExtent. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised before an AdornmentLayer is drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenWidth// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs)|OnAdornmentLayerDrawn]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | + | * Description:This parameter is the screen width. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised after an AdornmentLayer is drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //screenHeight// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs)|OnAdornmentLayersDrawing]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] | + | * Description:This parameter is the screen height. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised before AdornmentLayers are drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs)|OnAdornmentLayersDrawn]]** | + | ** {{wiki:PublicMethod.gif|}} FindStaticFeatureLayer(String) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised after AdornmentLayers are drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | Finds a feature layer by key (specified in the "name" parameter) within the collection of StaticLayers. |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnLayerDrawing(LayerDrawingEventArgs)|OnLayerDrawing]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] | + | N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised before a Layer is drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnLayerDrawn(LayerDrawnEventArgs)|OnLayerDrawn]]** | + | * Type:[[ThinkGeo.MapSuite.Core.FeatureLayer|FeatureLayer]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] | + | * Description:The corresponding FeatureLayer with the specified key in the MapControl. |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised after a Layer is drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnLayersDrawing(LayersDrawingEventArgs)|OnLayersDrawing]]** | + | * //name// |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] | + | * Type:String |
| - | * **DeclaringType**:N/A | + | * Description:The key to find the final result feature layer. |
| - | * **Summary**:This event is raised before Layers are drawn. | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnLayersDrawn(LayersDrawnEventArgs)|OnLayersDrawn]]** | + | ** {{wiki:PublicMethod.gif|}} FindStaticRasterLayer(String) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This event is raised after Layers are drawn. | + | |
| - | </div> | + | |
| - | === Public Properties === | + | Find the raster layer by key (specified in the "name" parameter) within the collection of StaticLayers. |
| - | **{{wiki:PublicProperty.gif|}}[[#AdornmentLayers|AdornmentLayers]]** | + | == Remarks == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | + | N/A |
| - | * **Summary**:This property holds a collection of AdornmentLayers to be drawn on the MapEngine. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#BackgroundFillBrush|BackgroundFillBrush]]** | + | == Return Value == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | + | * Type:[[ThinkGeo.MapSuite.Core.RasterLayer|RasterLayer]] |
| - | * **Summary**:Gets or sets the GeoBrush for the background of the MapEngine. | + | * Description:The corresponding RasterLayer with the passing specified in the MapControl. |
| - | **{{wiki:PublicProperty.gif|}}[[#Canvas|Canvas]]** | + | == Parameters == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * //name// |
| - | * **Summary**:Gets and sets the GeoCanvas used to draw the Layers. | + | * Type:String |
| + | * Description:The key to find the final result raster layer. | ||
| - | **{{wiki:PublicProperty.gif|}}[[#CurrentExtent|CurrentExtent]]** | + | <div newline></div> |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} FindDynamicFeatureLayer(String) ** |
| - | * **Summary**:This property gets or sets the current extent of the MapEngine. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#DynamicLayers|DynamicLayers]]** | + | Find the feature layer by key (specified in the "name" parameter) within the collection of DynamicLayers. |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | + | == Remarks == |
| - | * **Summary**:This property holds a group of Layers to be drawn on the MapEngine. | + | N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#ShowLogo|ShowLogo]]** | + | == Return Value == |
| - | * **Return**:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.FeatureLayer|FeatureLayer]] |
| - | * **Summary**:This property specifies whether the logo is shown on the Map or not. | + | * Description:The corresponding FeatureLayer with the specified key in the MapControl. |
| - | **{{wiki:PublicProperty.gif|}}[[#StaticLayers|StaticLayers]]** | + | == Parameters == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | + | * //name// |
| - | * **Summary**:This property holds a group of Layers to be drawn on the MapEngine. | + | * Type:String |
| + | * Description:The key to find the final result feature layer. | ||
| - | === Protected Properties === | + | <div newline></div> |
| - | === Public Events === | + | ** {{wiki:PublicMethod.gif|}} FindDynamicRasterLayer(String) ** |
| - | **{{wiki:PublicEvent.gif|}}[[#AdornmentLayerDrawing|AdornmentLayerDrawing]]** | + | |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | + | |
| - | * **Summary**:This event is raised before an AdornmentLayer is drawn. | + | |
| - | **{{wiki:PublicEvent.gif|}}[[#AdornmentLayerDrawn|AdornmentLayerDrawn]]** | + | Find the raster layer by key (specified in the "name" parameter) within the collection of DynamicLayers. |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | + | == Remarks == |
| - | * **Summary**:This event is raised after an AdornmentLayer is drawn. | + | N/A |
| - | **{{wiki:PublicEvent.gif|}}[[#AdornmentLayersDrawing|AdornmentLayersDrawing]]** | + | == Return Value == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.RasterLayer|RasterLayer]] |
| - | * **Summary**:This event is raised before AdornmentLayers are drawn. | + | * Description:The corresponding RasterLayer with the specified key in the MapControl. |
| - | **{{wiki:PublicEvent.gif|}}[[#AdornmentLayersDrawn|AdornmentLayersDrawn]]** | + | == Parameters == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] | + | * //name// |
| - | * **Summary**:This event is raised after AdornmentLayers are drawn. | + | * Type:String |
| + | * Description:The key to find the final result raster layer. | ||
| - | **{{wiki:PublicEvent.gif|}}[[#LayerDrawing|LayerDrawing]]** | + | <div newline></div> |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] | + | ** {{wiki:PublicMethod.gif|}} GetDrawingExtent(Single,Single) ** |
| - | * **Summary**:This event is raised before a Layer is drawn. | + | |
| - | **{{wiki:PublicEvent.gif|}}[[#LayerDrawn|LayerDrawn]]** | + | This method returns an adjusted extent based on the ratio of the screen width and height. |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] | + | == Remarks == |
| - | * **Summary**:This event is raised after a Layer is drawn. | + | This function is used because the extent to draw must be the rame ratio as the screen width and height. If they are not, then the image drawn will be stretched or compressed. We always adjust the extent upwards to ensure that no matter how we adjust it, the original extent will fit within the new extent. This ensures that everything you wanted to see in the first extent is visible and maybe a bit more. |
| - | **{{wiki:PublicEvent.gif|}}[[#LayersDrawing|LayersDrawing]]** | + | == Return Value == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Summary**:This event is raised before Layers are drawn. | + | * Description:This method returns an adjusted extent based on the ratio of the screen width and height. |
| - | **{{wiki:PublicEvent.gif|}}[[#LayersDrawn|LayersDrawn]]** | + | == Parameters == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] | + | * //screenWidth// |
| - | * **Summary**:This event is raised after Layers are drawn. | + | * Type:Single |
| + | * Description:This parameter is the width of the screen. | ||
| - | ===== Public Constructors ===== | + | * //screenHeight// |
| - | === MapEngine() === | + | * Type:Single |
| - | Create a new instance of the MapEngine. | + | * Description:This parameter is the height of the screen. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | ===== Protected Constructors ===== | + | |
| - | ===== Public Methods ===== | + | |
| - | === CenterAt(RectangleShape,PointShape,Single,Single) === | + | |
| - | This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} OpenAllLayers() ** |
| - | * **Description**:This method returns an adjusted extent centered on a point. | + | |
| - | ==== Parameters ==== | + | This API allows you to open all of the layers (either static or dynamic). |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | N/A |
| - | * **Description**:This parameter is the current extent you want to center. | + | |
| - | **worldPoint** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:Void |
| - | * **Description**:This parameter is the world point you want to center on. | + | * Description:N/A |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | <div newline></div> |
| - | * **Description**:This parameter is the width of the screen. | + | ** {{wiki:PublicMethod.gif|}} CloseAllLayers() ** |
| - | **screenHeight** | + | This API allows you close all of the layers (either static or dynamic). |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | N/A |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === CenterAt(RectangleShape,Feature,Single,Single) === | + | * Type:Void |
| - | This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | <div newline></div> |
| - | * **Description**:This method returns an adjusted extent centered on a point. | + | ** {{wiki:PublicMethod.gif|}} CenterAt(PointShape,Single,Single) ** |
| - | ==== Parameters ==== | + | This is a function that allows you to pass a world point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | This API will update the CurrentExtent. |
| - | * **Description**:This parameter is the current extent you want to center. | + | |
| - | **centerFeature** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:Void |
| - | * **Description**:This parameter is the world point feature you want to center on. | + | * Description:None. |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldPoint// |
| - | * **Description**:This parameter is the width of the screen. | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| + | * Description:This parameter is the world point you want to center on. | ||
| - | **screenHeight** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the width of the screen. |
| - | [[#Public Methods|Go Back]] | + | * //screenHeight// |
| - | === CenterAt(RectangleShape,Single,Single,Single,Single) === | + | * Type:Single |
| - | This is a static function that allows you to pass in a world rectangle, a point in screen coordinates to center on, and a height and width in screen units. The function will center the rectangle based on the screen point, then adjust the rectangle's ratio based on the height and width in screen coordinates. | + | * Description:This parameter is the height of the screen. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} CenterAt(Feature,Single,Single) ** |
| - | * **Description**:This method returns an adjusted extent centered on a point. | + | |
| - | ==== Parameters ==== | + | This is a function that allows you to pass in a feature to center on, as well as a height and width in screen units. The function will center the CurrentExtent based on the specified feature and adjust its ratio based on the height and width in screen coordinates. |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | This API will update the CurrentExtent. |
| - | * **Description**:This parameter is the current extent you want to center. | + | |
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:None. | ||
| - | **screenX** | + | == Parameters == |
| - | * **Type**:Single | + | * //centerFeature// |
| - | * **Description**:This parameter is the X coordinate on the screen to center to. | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| + | * Description:This parameter is the world point feature you want to center on. | ||
| - | **screenY** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the Y coordinate on the screen to center to. | + | * Description:This parameter is the width of the screen. |
| - | **screenWidth** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the height of the screen. |
| - | **screenHeight** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}} CenterAt(Single,Single,Single,Single) ** |
| - | * **Description**:This parameter is the height of the screen. | + | |
| - | [[#Public Methods|Go Back]] | ||
| - | === CenterAt(Single,Single,Single,Single) === | ||
| This is a function that allows you to pass a screen point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. | This is a function that allows you to pass a screen point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| This API will update the CurrentExtent. | This API will update the CurrentExtent. | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenX** | + | * //screenX// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the X coordinate on the screen to center on. | + | * Description:This parameter is the X coordinate on the screen to center on. |
| - | **screenY** | + | * //screenY// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the Y coordinate on the screen to center on. | + | * Description:This parameter is the Y coordinate on the screen to center on. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the width of the screen. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the height of the screen. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === CenterAt(Feature,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single) ** |
| - | This is a function that allows you to pass in a feature to center on, as well as a height and width in screen units. The function will center the CurrentExtent based on the specified feature and adjust its ratio based on the height and width in screen coordinates. | + | |
| - | ==== Remarks ==== | + | |
| - | This API will update the CurrentExtent. | + | |
| - | **Return Value** | + | This method returns the number of pixels between two world points using the CurrentExtent as reference. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None. | + | None |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **centerFeature** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Description:This method returns the number of pixels between two world points. |
| - | * **Description**:This parameter is the world point feature you want to center on. | + | |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldPoint1// |
| - | * **Description**:This parameter is the width of the screen. | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| + | * Description:This parameter is the first point -- the one you want to measure from. | ||
| - | **screenHeight** | + | * //worldPoint2// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the second point -- the one you want to measure to. |
| - | [[#Public Methods|Go Back]] | + | * //screenWidth// |
| - | === CenterAt(PointShape,Single,Single) === | + | * Type:Single |
| - | This is a function that allows you to pass a world point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates. | + | * Description:This parameter is the width of the screen. |
| - | ==== Remarks ==== | + | |
| - | This API will update the CurrentExtent. | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:Void | + | * Type:Single |
| - | * **Description**:None. | + | * Description:This parameter is the height of the screen. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **worldPoint** | + | ** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single) ** |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | |
| - | * **Description**:This parameter is the world point you want to center on. | + | |
| - | **screenWidth** | + | This method returns the number of pixels between two world points using the CurrentExtent as reference. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the width of the screen. | + | None |
| - | **screenHeight** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This method returns the number of pixels between two world points. |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === CloseAllLayers() === | + | * //worldPointFeature1// |
| - | This API allows you close all of the layers (either static or dynamic). | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | ==== Remarks ==== | + | * Description:This parameter is the first pointFeture -- the one you want to measure from. |
| - | N/A | + | |
| - | **Return Value** | + | * //worldPointFeature2// |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:N/A | + | * Description:This parameter is the second pointFeature -- the one you want to measure to. |
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | [[#Public Methods|Go Back]] | + | * Type:Single |
| - | === Draw(IEnumerable<Layer>,Bitmap,GeographyUnit) === | + | * Description:This parameter is the width of the screen. |
| - | Draw a group of layers on the specified "background" bitmap. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:Bitmap | + | * Type:Single |
| - | * **Description**:The resulting bitmap after drawing the target layers on the specified "background" bitmap. | + | * Description:This parameter is the height of the screen. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **layers** | + | ** {{wiki:PublicMethod.gif|}} GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) ** |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | + | |
| - | * **Description**:This parameter specifies the target layers to be drawn. | + | |
| - | **gdiPlusBitmap** | + | This method returns the distance in world units between two screen points by using the CurrentExtent as a reference. |
| - | * **Type**:Bitmap | + | == Remarks == |
| - | * **Description**:This parameter specifies the "background" bitmap of the returning bitmap. | + | None |
| - | **mapUnit** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Double |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This method returns the distance in world units between two screen points. |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit) === | + | * //screenPoint1// |
| - | Draw a group of layers and return a new image with the specified width and height. | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | ==== Remarks ==== | + | * Description:This is the screen point you want to measure from. |
| - | N/A | + | |
| + | * //screenPoint2// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| + | * Description:This is the screen point you want to measure to. | ||
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Single |
| - | * **Description**:The resulting image after drawing the target layers based on the specified width and height. | + | * Description:This parameter is the width of the screen. |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | **layers** | + | * Type:Single |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | + | * Description:This parameter is the height of the screen. |
| - | * **Description**:This parameter specifies the target layers to be drawn. | + | |
| - | **width** | + | * //mapUnit// |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the width of the returning image. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | **height** | + | * //distanceUnit// |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| - | * **Description**:This parameter specifies the height of the returning image. | + | * Description:This is the geographic unit you want the result to show in. |
| - | **mapUnit** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | ** {{wiki:PublicMethod.gif|}} GetCurrentScale(Single,GeographyUnit) ** |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | |
| - | [[#Public Methods|Go Back]] | + | Get the current Scale responding to the CurrentExtent. |
| - | === Draw(IEnumerable<Layer>,GeoImage,GeographyUnit) === | + | == Remarks == |
| - | Draw a group of layers on the specified "background" image. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Double |
| - | * **Description**:The resulting image after drawing the target layers on the specified "background" image. | + | * Description:The calculated scale based on the CurrentExtent. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **layers** | + | * //screenWidth// |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | + | * Type:Single |
| - | * **Description**:This parameter specifies the target layers to be drawn. | + | * Description:This parameter specifies the screen width responding to the CurrentExtent. |
| - | **image** | + | * //mapUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the "background" image of the returning image. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | **mapUnit** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,GeoImage,GeographyUnit) ** |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | |
| - | [[#Public Methods|Go Back]] | + | Draw a group of layers on the specified "background" image. |
| - | === DrawAdornmentLayers(Bitmap,GeographyUnit) === | + | == Remarks == |
| - | Draw a group of AdornmentLayers on the specified "background" bitmap. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting bitmap after drawing the group of AdornmentLayers on the specified "background" bitmap. | + | * Description:The resulting image after drawing the target layers on the specified "background" image. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **gdiPlusBitmap** | + | * //layers// |
| - | * **Type**:Bitmap | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> |
| - | * **Description**:This parameter specifies the "background" bitmap of the returning bitmap. | + | * Description:This parameter specifies the target layers to be drawn. |
| - | **mapUnit** | + | * //image// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the "background" image of the returning image. |
| - | [[#Public Methods|Go Back]] | + | * //mapUnit// |
| - | === DrawAdornmentLayers(Int32,Int32,GeographyUnit) === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | Draw a group of AdornmentLayers and return a new image with the specified width and height. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit) ** |
| - | * **Description**:The resulting image after drawing the group of AdornmentLayers based on the specified width and height. | + | |
| - | ==== Parameters ==== | + | Draw a group of layers and return a new image with the specified width and height. |
| - | **width** | + | == Remarks == |
| - | * **Type**:Int32 | + | |
| - | * **Description**:This parameter specifies the width of the returning image. | + | |
| - | + | ||
| - | **height** | + | |
| - | * **Type**:Int32 | + | |
| - | * **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. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === DrawAdornmentLayers(GeoImage,GeographyUnit) === | + | |
| - | Draw a group of AdornmentLayers on the specified "background" image. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting image after drawing the group of AdornmentLayers on the specified "background" image. | + | * Description:The resulting image after drawing the target layers based on the specified width and height. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **image** | + | * //layers// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> |
| - | * **Description**:This parameter specifies the "background" image of the returning image. | + | * Description:This parameter specifies the target layers to be drawn. |
| - | **mapUnit** | + | * //width// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Int32 |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the width of the returning image. |
| - | [[#Public Methods|Go Back]] | + | * //height// |
| - | === DrawDynamicLayers(Bitmap,GeographyUnit) === | + | * Type:Int32 |
| - | Draw a group of dynamic layers on the specified "background" bitmap. | + | * Description:This parameter specifies the height of the returning image. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //mapUnit// |
| - | * **Return Type**:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:The resulting bitmap after drawing the group of dynamic layers on the specified "background" bitmap. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **gdiPlusBitmap** | + | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(GeoImage,GeographyUnit) ** |
| - | * **Type**:Bitmap | + | |
| - | * **Description**:This parameter specifies the "background" bitmap of the returning bitmap. | + | |
| - | **mapUnit** | + | Draw a group of static layers on the specified "background" image. |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | == Remarks == |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === DrawDynamicLayers(Int32,Int32,GeographyUnit) === | + | |
| - | Draw a group of dynamic layers and return a new image with the specified width and height. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting image after drawing the group of dynamic layers based on the specified width and height. | + | * Description:The resulting image after drawing the group of static layers on the specified "background" image. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **width** | + | * //image// |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:This parameter specifies the width of the returning image. | + | * Description:This parameter specifies the "background" image of the returning image. |
| - | **height** | + | * //mapUnit// |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the height of the returning image. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | **mapUnit** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(GeoImage,GeographyUnit) ** |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | |
| - | [[#Public Methods|Go Back]] | ||
| - | === DrawDynamicLayers(GeoImage,GeographyUnit) === | ||
| Draw a group of dynamic layers on the specified "background" image. | Draw a group of dynamic layers on the specified "background" image. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting image after drawing the group of dynamic layers on the specified "background" image. | + | * Description:The resulting image after drawing the group of dynamic layers on the specified "background" image. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **image** | + | * //image// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:This parameter specifies the "background" image of the returning image. | + | * Description:This parameter specifies the "background" image of the returning image. |
| - | **mapUnit** | + | * //mapUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === DrawStaticLayers(Bitmap,GeographyUnit) === | + | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(GeoImage,GeographyUnit) ** |
| - | Draw a group of static layers on the specified "background" bitmap. | + | |
| - | ==== Remarks ==== | + | Draw a group of AdornmentLayers on the specified "background" image. |
| + | == Remarks == | ||
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting bitmap after drawing the group of static layers on the specified "background" bitmap. | + | * Description:The resulting image after drawing the group of AdornmentLayers on the specified "background" image. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **gdiPlusBitmap** | + | * //image// |
| - | * **Type**:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:This parameter specifies the "background" bitmap of the returning bitmap. | + | * Description:This parameter specifies the "background" image of the returning image. |
| - | **mapUnit** | + | * //mapUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(Int32,Int32,GeographyUnit) ** | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === DrawStaticLayers(Int32,Int32,GeographyUnit) === | ||
| Draw a group of static layers and return a new image with the specified width and height. | Draw a group of static layers and return a new image with the specified width and height. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting image after drawing the group of static layers based on the specified width and height. | + | * Description:The resulting image after drawing the group of static layers based on the specified width and height. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **width** | + | * //width// |
| - | * **Type**:Int32 | + | * Type:Int32 |
| - | * **Description**:This parameter specifies the width of the returning image. | + | * Description:This parameter specifies the width of the returning image. |
| - | **height** | + | * //height// |
| - | * **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** | + | * //mapUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === DrawStaticLayers(GeoImage,GeographyUnit) === | + | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(Int32,Int32,GeographyUnit) ** |
| - | Draw a group of static layers on the specified "background" image. | + | |
| - | ==== Remarks ==== | + | Draw a group of dynamic layers and return a new image with the specified width and height. |
| + | == Remarks == | ||
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The resulting image after drawing the group of static layers on the specified "background" image. | + | * Description:The resulting image after drawing the group of dynamic layers based on the specified width and height. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **image** | + | * //width// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Int32 |
| - | * **Description**:This parameter specifies the "background" image of the returning image. | + | * Description:This parameter specifies the width of the returning image. |
| - | **mapUnit** | + | * //height// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Int32 |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the height of the returning image. |
| - | [[#Public Methods|Go Back]] | + | * //mapUnit// |
| - | === Equals(Object) === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | N/A | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Boolean | + | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(Int32,Int32,GeographyUnit) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | Draw a group of AdornmentLayers and return a new image with the specified width and height. |
| - | **obj** | + | == Remarks == |
| - | * **Type**:Object | + | |
| - | * **Description**:N/A | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === FindDynamicFeatureLayer(String) === | + | |
| - | Find the feature layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.FeatureLayer|FeatureLayer]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:The corresponding FeatureLayer with the specified key in the MapControl. | + | * Description:The resulting image after drawing the group of AdornmentLayers based on the specified width and height. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **name** | + | * //width// |
| - | * **Type**:String | + | * Type:Int32 |
| - | * **Description**:The key to find the final result feature layer. | + | * Description:This parameter specifies the width of the returning image. |
| - | [[#Public Methods|Go Back]] | + | * //height// |
| - | === FindDynamicRasterLayer(String) === | + | * Type:Int32 |
| - | Find the raster layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | * Description:This parameter specifies the height of the returning image. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //mapUnit// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RasterLayer|RasterLayer]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:The corresponding RasterLayer with the specified key in the MapControl. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **name** | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,Bitmap,GeographyUnit) ** |
| - | * **Type**:String | + | |
| - | * **Description**:The key to find the final result raster layer. | + | |
| - | [[#Public Methods|Go Back]] | + | Draw a group of layers on the specified "background" bitmap. |
| - | === FindStaticFeatureLayer(String) === | + | == Remarks == |
| - | Finds a feature layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.FeatureLayer|FeatureLayer]] | + | * Type:Bitmap |
| - | * **Description**:The corresponding FeatureLayer with the specified key in the MapControl. | + | * Description:The resulting bitmap after drawing the target layers on the specified "background" bitmap. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **name** | + | * //layers// |
| - | * **Type**:String | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> |
| - | * **Description**:The key to find the final result feature layer. | + | * Description:This parameter specifies the target layers to be drawn. |
| - | [[#Public Methods|Go Back]] | + | * //gdiPlusBitmap// |
| - | === FindStaticRasterLayer(String) === | + | * Type:Bitmap |
| - | Find the raster layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | * Description:This parameter specifies the "background" bitmap of the returning bitmap. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //mapUnit// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RasterLayer|RasterLayer]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:The corresponding RasterLayer with the passing specified in the MapControl. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **name** | + | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(Bitmap,GeographyUnit) ** |
| - | * **Type**:String | + | |
| - | * **Description**:The key to find the final result raster layer. | + | |
| - | [[#Public Methods|Go Back]] | + | Draw a group of static layers on the specified "background" bitmap. |
| - | === GetBoundingBoxOfItems(IEnumerable<Feature>) === | + | == Remarks == |
| - | This API gets the BoundingBox of a group of Features. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Bitmap |
| - | * **Description**:The BoundingBox that contains all the features you passed in. | + | * Description:The resulting bitmap after drawing the group of static layers on the specified "background" bitmap. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **features** | + | * //gdiPlusBitmap// |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Type:Bitmap |
| - | * **Description**:The target group of Features to get the BoundingBox for. | + | * Description:This parameter specifies the "background" bitmap of the returning bitmap. |
| - | [[#Public Methods|Go Back]] | + | * //mapUnit// |
| - | === GetBoundingBoxOfItems(IEnumerable<BaseShape>) === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | This API gets the BoundingBox of a group of BaseShapes. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(Bitmap,GeographyUnit) ** |
| - | * **Description**:The BoundingBox that contains all the shapes you passed in. | + | |
| - | ==== Parameters ==== | + | Draw a group of dynamic layers on the specified "background" bitmap. |
| - | **shapes** | + | == Remarks == |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> | + | |
| - | * **Description**:The target group of BaseShapes to get the BoundingBox for. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === GetCurrentScale(RectangleShape,Single,GeographyUnit) === | + | |
| - | This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Double | + | * Type:Bitmap |
| - | * **Description**:N/A | + | * Description:The resulting bitmap after drawing the group of dynamic layers on the specified "background" bitmap. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //gdiPlusBitmap// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Bitmap |
| - | * **Description**:This parameter specifies the worldExtent used to calculate the current scale. | + | * Description:This parameter specifies the "background" bitmap of the returning bitmap. |
| - | **screenWidth** | + | * //mapUnit// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the screenWidth corresponding to the worldExtent. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | **mapUnit** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(Bitmap,GeographyUnit) ** |
| - | * **Description**:This parameter specifies the unit for the extent, the result will be different if choose DecimalDegree as Unit and Meter as Unit. | + | |
| - | [[#Public Methods|Go Back]] | + | Draw a group of AdornmentLayers on the specified "background" bitmap. |
| - | === GetCurrentScale(Single,GeographyUnit) === | + | == Remarks == |
| - | Get the current Scale responding to the CurrentExtent. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Double | + | * Type:Bitmap |
| - | * **Description**:The calculated scale based on the CurrentExtent. | + | * Description:The resulting bitmap after drawing the group of AdornmentLayers on the specified "background" bitmap. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenWidth** | + | * //gdiPlusBitmap// |
| - | * **Type**:Single | + | * Type:Bitmap |
| - | * **Description**:This parameter specifies the screen width responding to the CurrentExtent. | + | * Description:This parameter specifies the "background" bitmap of the returning bitmap. |
| - | **mapUnit** | + | * //mapUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This parameter specifies the MapUnit used in the current map. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === GetDrawingExtent(RectangleShape,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}} ZoomIn(Int32) ** |
| - | This method returns an adjusted extent based on the ratio of the screen width and height. | + | |
| - | ==== Remarks ==== | + | |
| - | This function is used because the extent to draw must be the rame ratio as the screen width and height. If they are not, then the image drawn will be stretched or compressed. We always adjust the extent upwards to ensure that no matter how we adjust it, the original extent will fit within the new extent. This ensures that everything you wanted to see in the first extent is visible and maybe a bit more. This function takes a height and width in screen coordinates, then looks at a world extent passed, and returns an adjusted world rectangle so that the ratio to height and width in screen and world coordinates match. | + | |
| - | **Return Value** | + | This method updates the CurrentExtent that is zoomed in by the percentage provided. |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:This method returns an adjusted extent based on the ratio of the screen width and height. | + | None |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:Void |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This method updates the CurrentExtent that is zoomed in by the percentage provided. |
| - | * **Description**:This parameter is the world extent you want to adjust for drawing. | + | |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | * //percentage// |
| - | * **Description**:This parameter is the width of the screen. | + | * Type:Int32 |
| + | * Description:This parameter is the percentage by which you want to zoom in. | ||
| - | **screenHeight** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the height of the screen. | + | |
| - | [[#Public Methods|Go Back]] | + | This method will update the CurrentExtent by using the ZoomIntoCenter operation. |
| - | === GetDrawingExtent(Single,Single) === | + | == Remarks == |
| - | This method returns an adjusted extent based on the ratio of the screen width and height. | + | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | ==== Remarks ==== | + | |
| - | This function is used because the extent to draw must be the rame ratio as the screen width and height. If they are not, then the image drawn will be stretched or compressed. We always adjust the extent upwards to ensure that no matter how we adjust it, the original extent will fit within the new extent. This ensures that everything you wanted to see in the first extent is visible and maybe a bit more. | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Void |
| - | * **Description**:This method returns an adjusted extent based on the ratio of the screen width and height. | + | * Description:None. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenWidth** | + | * //percentage// |
| - | * **Type**:Single | + | * Type:Int32 |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the percentage by which you want to zoom in. |
| - | **screenHeight** | + | * //worldPoint// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the world point you want the extent to be centered on. |
| - | [[#Public Methods|Go Back]] | + | * //screenWidth// |
| - | === GetHashCode() === | + | * Type:Single |
| - | N/A | + | * Description:This parameter is the width in screen coordinates. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:Int32 | + | * Type:Single |
| - | * **Description**:N/A | + | * Description:This parameter is the height in screen coordinates. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Feature,Single,Single) ** |
| - | === GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single) === | + | |
| - | This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | This method returns an extent that is centered and zoomed in. |
| - | * **Return Type**:Single | + | == Remarks == |
| - | * **Description**:This method returns the number of pixels between two world points. | + | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldPointFeature1** | + | * Type:Void |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Description:This method returns an extent that is centered and zoomed in. |
| - | * **Description**:This parameter is the first pointFeture -- the one you want to measure from. | + | |
| - | **worldPointFeature2** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * //percentage// |
| - | * **Description**:This parameter is the second pointFeature -- the one you want to measure to. | + | * Type:Int32 |
| + | * Description:This parameter is the percentage by which you want to zoom in. | ||
| - | **screenWidth** | + | * //centerFeature// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the world point you want the extent to be centered on. |
| - | **screenHeight** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the width in screen coordinates. |
| - | [[#Public Methods|Go Back]] | + | * //screenHeight// |
| - | === GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single) === | + | * Type:Single |
| - | This method returns the number of pixels between two world points. | + | * Description:This parameter is the height in screen coordinates. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Single | + | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Single,Single,Single,Single) ** |
| - | * **Description**:This method returns the number of pixels between two world points. | + | |
| - | ==== Parameters ==== | + | This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in. |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **worldPoint1** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:Void |
| - | * **Description**:This parameter is the first point -- the one you want to measure from. | + | * Description:None. |
| - | **worldPoint2** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * //percentage// |
| - | * **Description**:This parameter is the second point -- the one you want to measure to. | + | * Type:Int32 |
| + | * Description:This parameter is the percentage by which you want to zoom in. | ||
| - | **screenWidth** | + | * //screenX// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the screen X you want to center on. |
| - | **screenHeight** | + | * //screenY// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the screen Y you want to center on. |
| - | [[#Public Methods|Go Back]] | + | * //screenWidth// |
| - | === GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single) === | + | * Type:Single |
| - | This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | * Description:This parameter is the width of the screen. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:Single | + | * Type:Single |
| - | * **Description**:This method returns the number of pixels between two world points. | + | * Description:This parameter is the height of the screen. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **worldPoint1** | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | |
| - | * **Description**:This parameter is the first point -- the one you want to measure from. | + | |
| - | **worldPoint2** | + | N/A |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | == Remarks == |
| - | * **Description**:This parameter is the second point -- the one you want to measure to. | + | N/A |
| - | **screenWidth** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:String |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:N/A |
| - | **screenHeight** | + | == Parameters == |
| - | * **Type**:Single | + | <div newline></div> |
| - | * **Description**:This parameter is the height of the screen. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | [[#Public Methods|Go Back]] | + | N/A |
| - | === GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single) === | + | == Remarks == |
| - | This method returns the number of pixels between two world points. | + | N/A |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Single | + | * Type:Boolean |
| - | * **Description**:This method returns the number of pixels between two world points. | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //obj// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Object |
| - | * **Description**:This parameter is the world extent. | + | * Description:N/A |
| - | **worldPointFeature1** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | * **Description**:This parameter is the first point Feature -- the one you want to measure from. | + | |
| - | **worldPointFeature2** | + | N/A |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | == Remarks == |
| - | * **Description**:This parameter is the second point Feature -- the one you want to measure to. | + | N/A |
| - | **screenWidth** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Int32 |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:N/A |
| - | **screenHeight** | + | == Parameters == |
| - | * **Type**:Single | + | <div newline></div> |
| - | * **Description**:This parameter is the height of the screen. | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | [[#Public Methods|Go Back]] | ||
| - | === GetType() === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Type | + | * Type:Type |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === GetVersion() === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOut(RectangleShape,Int32) ** |
| - | Get the current MapSuiteCore.dll file version. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This method returns a new extent that is zoomed out by the percentage provided. |
| - | * **Return Type**:String | + | == Remarks == |
| - | * **Description**:A string representing the file version of MapSuiteCore.dll. | + | |
| - | + | ||
| - | ==== Parameters ==== | + | |
| - | [[#Public Methods|Go Back]] | + | |
| - | === GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) === | + | |
| - | This method returns the distance in world units between two screen points by using the CurrentExtent as a reference. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns the distance in world units between two screen points. | + | * Description:This method returns a new extent that is zoomed out by the percentage provided. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenPoint1** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This is the screen point you want to measure from. | + | * Description:This parameter is the world extent you want to zoom. |
| - | **screenPoint2** | + | * //percentage// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:Int32 |
| - | * **Description**:This is the screen point you want to measure to. | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the width of the screen. | + | |
| - | **screenHeight** | + | This method returns an extent that is centered and zoomed out. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | **mapUnit** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter specifies the MapUnit used in the current map. | + | * Description:This method returns an extent that is centered and zoomed out. |
| - | **distanceUnit** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | * //worldExtent// |
| - | * **Description**:This is the geographic unit you want the result to show in. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to center and zoom. | ||
| - | [[#Public Methods|Go Back]] | + | * //percentage// |
| - | === GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) === | + | * Type:Int32 |
| - | This method returns the distance in world units between two screen points. | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //worldPoint// |
| - | * **Return Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This method returns the distance in wold units between two screen points. | + | * Description:This parameter is the world point you want the extent to be centered on. |
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the width of the screen. |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **screenPoint1** | + | * //screenHeight// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:Single |
| - | * **Description**:This is the screen point you want to measure from. | + | * Description:This parameter is the height of the screen. |
| - | **screenPoint2** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single) ** |
| - | * **Description**:This is the screen point you want to measure to. | + | |
| - | **screenWidth** | + | This method returns an extent that is centered and zoomed out. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the width of the screen. | + | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | **screenHeight** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This method returns an extent that is centered and zoomed out. |
| - | **worldExtentUnit** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * //worldExtent// |
| - | * **Description**:This is the geographic unit of the world extent rectangle. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to center and zoom. | ||
| - | **distanceUnit** | + | * //percentage// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | * Type:Int32 |
| - | * **Description**:This is the geographic unit you want the result to show in. | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | [[#Public Methods|Go Back]] | + | * //centerFeature// |
| - | === GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,Single,Single,Single,Single,Single,Single,GeographyUnit,DistanceUnit) === | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns the distance in wold units between two screen points. | + | * Description:This parameter is the feature you want the extent to be centered on. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:Double | + | * Type:Single |
| - | * **Description**:N/A | + | * Description:This parameter is the width of the screen. |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the height of the screen. |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **screenPoint1X** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single) ** |
| - | * **Description**:This parameter is the X of the point you want to measure from. | + | |
| - | **screenPoint1Y** | + | This method returns an extent that is centered and zoomed out. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the Y of the point you want to measure from. | + | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | **screenPoint2X** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the X of the point you want to measure to. | + | * Description:This method returns an extent that is centered and zoomed out. |
| - | **screenPoint2Y** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldExtent// |
| - | * **Description**:This parameter is the Y of the point you want to measure to. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to center and zoom. | ||
| - | **screenWidth** | + | * //percentage// |
| - | * **Type**:Single | + | * Type:Int32 |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the percentage by which you want to zoom out. |
| - | **screenHeight** | + | * //screenX// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the screen X you want to center on. |
| - | **worldExtentUnit** | + | * //screenY// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:Single |
| - | * **Description**:This is the geographic unit of the world extent you passed in. | + | * Description:This parameter is the screen Y you want to center on. |
| - | **distanceUnit** | + | * //screenWidth// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | + | * Type:Single |
| - | * **Description**:This is the geographic unit you want the result to show in. | + | * Description:This parameter is the width of the screen. |
| - | [[#Public Methods|Go Back]] | + | * //screenHeight// |
| - | === LoadDataTable(Collection<Feature>,IEnumerable<String>) === | + | * Type:Single |
| - | 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. | + | * Description:This parameter is the height of the screen. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:DataTable | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,PanDirection,Int32) ** |
| - | * **Description**:A DateTable of information about those passed-in features and the returning columnNames. | + | |
| - | ==== Parameters ==== | + | This method returns a panned extent. |
| - | **features** | + | == Remarks == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | None |
| - | * **Description**:This parameter specifies the target features. | + | |
| - | **returningColumnNames** | + | == Return Value == |
| - | * **Type**:IEnumerable<String> | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter specifies the returning columnNames for the features. | + | * Description:This method returns a panned extent. |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === OpenAllLayers() === | + | * //worldExtent// |
| - | This API allows you to open all of the layers (either static or dynamic). | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Remarks ==== | + | * Description:This parameter is the world extent you want to pan. |
| - | N/A | + | |
| + | * //direction// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]] | ||
| + | * Description:This parameter is the direction you want to pan. | ||
| + | |||
| + | * //percentage// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter is the percentage by which you want to pan. | ||
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,Single,Int32) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === Pan(RectangleShape,PanDirection,Int32) === | ||
| This method returns a panned extent. | This method returns a panned extent. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns a panned extent. | + | * Description:This method returns a panned extent. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world extent you want to pan. | + | * Description:This parameter is the world extent you want to pan. |
| - | **direction** | + | * //degree// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]] | + | * Type:Single |
| - | * **Description**:This parameter is the direction you want to pan. | + | * Description:This parameter is the angle in degrees in which you want to pan. |
| - | **percentage** | + | * //percentage// |
| - | * **Type**:Int32 | + | * Type:Int32 |
| - | * **Description**:This parameter is the percentage by which you want to pan. | + | * Description:This parameter is the percentage by which you want to pan. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Pan(PanDirection,Int32) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Double,Double,Single,Single) ** |
| - | Update the CurrentExtent by using a panning operation. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | This method returns screen coordinates from world coordinates. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None. | + | |
| - | + | ||
| - | ==== Parameters ==== | + | |
| - | **panDirection** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]] | + | |
| - | * **Description**:This parameter is the direction you want to pan. | + | |
| - | + | ||
| - | **percentage** | + | |
| - | * **Type**:Int32 | + | |
| - | * **Description**:This parameter is the percentage by which you want to pan. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === Pan(Single,Int32) === | + | |
| - | This method updates the CurrentExtent by using a panning operation. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Description**:None. | + | * Description:This method returns screen coordinates from world coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **degree** | + | * //worldExtent// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the angle in degrees in which you want to pan. | + | * Description:This parameter is the world extent. |
| - | **percentage** | + | * //worldX// |
| - | * **Type**:Int32 | + | * Type:Double |
| - | * **Description**:This parameter is the percentage by which you want to pan. | + | * Description:This parameter is the world X you want converted to screen points. |
| - | [[#Public Methods|Go Back]] | + | * //worldY// |
| - | === Pan(RectangleShape,Single,Int32) === | + | * Type:Double |
| - | This method returns a panned extent. | + | * Description:This parameter is the world Y you want converted to screen points. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Single |
| - | * **Description**:This method returns a panned extent. | + | * Description:This parameter is the width of the screen. |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the height of the screen. |
| - | * **Description**:This parameter is the world extent you want to pan. | + | |
| - | **degree** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the angle in degrees in which you want to pan. | + | |
| - | **percentage** | + | This method returns screen coordinates from world coordinates. |
| - | * **Type**:Int32 | + | == Remarks == |
| - | * **Description**:This parameter is the percentage by which you want to pan. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet) === | + | |
| - | This method returns an extent that is snapped to a zoom level in the provided zoom level set. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Description**:This method returns an extent that is snapped to a zoom level in the provided zoom level set. | + | * Description:This method returns screen coordinates from world coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world extent you want snapped. | + | * Description:This parameter is the world extent. |
| - | **worldExtentUnit** | + | * //worldPoint// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This parameter is the geographic unit of the world extent parameter. | + | * Description:This parameter is the world point you want converted to a screen point. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen width. | + | * Description:This parameter is the width of the screen. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen height. | + | * Description:This parameter is the height of the screen. |
| - | **zoomLevelSet** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Feature,Single,Single) ** |
| - | * **Description**:This parameter is the set of zoom levels you want to snap to. | + | |
| - | [[#Public Methods|Go Back]] | + | This method returns screen coordinates from world coordinates. |
| - | === SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet) === | + | == Remarks == |
| - | This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Description**:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. | + | * Description:This method returns screen coordinates from world coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtentUnit** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the geographic unit of the CurrentExtent. | + | * Description:This parameter is the world extent. |
| - | **screenWidth** | + | * //worldPointFeature// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:This parameter is the screen width. | + | * Description:This parameter is the world point feature you want converted to a screen point. |
| - | **screenHeight** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen height. | + | * Description:This parameter is the width of the screen. |
| - | **zoomLevelSet** | + | * //screenHeight// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | + | * Type:Single |
| - | * **Description**:This parameter is the set of zoom levels you want to snap to. | + | * Description:This parameter is the height of the screen. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ToScreenCoordinate(Feature,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,Single,Single,Single,Single) ** |
| - | This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. | + | |
| - | ==== Remarks ==== | + | This method returns world coordinates from screen coordinates. |
| + | == Remarks == | ||
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. | + | * Description:This method returns world coordinates from screen coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldPointFeature** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world coordinate pointFeature you want converted to a screen point. | + | * Description:This parameter is the world extent. |
| - | **screenWidth** | + | * //screenX// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen for the CurrentExtent. | + | * Description:This parameter is the X coordinate of the point you want converted to world coordinates. |
| - | **screenHeight** | + | * //screenY// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen for the CurrentExtent. | + | * Description:This parameter is the Y coordinate of the point you want converted to world coordinates. |
| - | [[#Public Methods|Go Back]] | + | * //screenWidth// |
| - | === ToScreenCoordinate(Double,Double,Single,Single) === | + | * Type:Single |
| - | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * Description:This parameter is the width of the screen. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:Single |
| - | * **Description**:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * Description:This parameter is the height of the screen. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **worldX** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single) ** |
| - | * **Type**:Double | + | |
| - | * **Description**:This parameter is the world point X you want converted to a screen point. | + | |
| - | **worldY** | + | This method returns world coordinates from screen coordinates. |
| - | * **Type**:Double | + | == Remarks == |
| - | * **Description**:This parameter is the world point Y you want converted to a screen point. | + | |
| - | + | ||
| - | **screenWidth** | + | |
| - | * **Type**:Single | + | |
| - | * **Description**:This parameter is the width of the screen for the CurrentExtent. | + | |
| - | + | ||
| - | **screenHeight** | + | |
| - | * **Type**:Single | + | |
| - | * **Description**:This parameter is the height of the screen for the CurrentExtent. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === ToScreenCoordinate(RectangleShape,Double,Double,Single,Single) === | + | |
| - | This method returns screen coordinates from world coordinates. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This method returns screen coordinates from world coordinates. | + | * Description:This method returns world coordinates from screen coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world extent. | + | * Description:This parameter is the world extent. |
| - | **worldX** | + | * //screenPoint// |
| - | * **Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Description**:This parameter is the world X you want converted to screen points. | + | * Description:This parameter is the screen point you want converted to a world point. |
| - | **worldY** | + | * //screenWidth// |
| - | * **Type**:Double | + | * Type:Single |
| - | * **Description**:This parameter is the world Y you want converted to screen points. | + | * Description:This parameter is the width of the screen. |
| - | **screenWidth** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the height of the screen. |
| - | **screenHeight** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet) ** |
| - | * **Description**:This parameter is the height of the screen. | + | |
| - | [[#Public Methods|Go Back]] | + | This method returns an extent that is snapped to a zoom level in the provided zoom level set. |
| - | === ToScreenCoordinate(RectangleShape,PointShape,Single,Single) === | + | == Remarks == |
| - | This method returns screen coordinates from world coordinates. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns screen coordinates from world coordinates. | + | * Description:This method returns an extent that is snapped to a zoom level in the provided zoom level set. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world extent. | + | * Description:This parameter is the world extent you want snapped. |
| - | **worldPoint** | + | * //worldExtentUnit// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter is the world point you want converted to a screen point. | + | * Description:This parameter is the geographic unit of the world extent parameter. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the screen width. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the screen height. |
| - | [[#Public Methods|Go Back]] | + | * //zoomLevelSet// |
| - | === ToScreenCoordinate(RectangleShape,Feature,Single,Single) === | + | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] |
| - | This method returns screen coordinates from world coordinates. | + | * Description:This parameter is the set of zoom levels you want to snap to. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single) ** |
| - | * **Description**:This method returns screen coordinates from world coordinates. | + | |
| - | ==== Parameters ==== | + | This method returns a extent that has been zoomed into a certain scale. |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | None |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **worldPointFeature** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world point feature you want converted to a screen point. | + | * Description:This method returns a extent that has been zoomed into a certain scale. |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | * //targetScale// |
| - | * **Description**:This parameter is the width of the screen. | + | * Type:Double |
| + | * Description:This parameter is the scale you want to zoom into. | ||
| - | **screenHeight** | + | * //worldExtent// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the world extent you want zoomed into the scale. |
| - | [[#Public Methods|Go Back]] | + | * //worldExtentUnit// |
| - | === ToScreenCoordinate(PointShape,Single,Single) === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * Description:This parameter is the geographic unit of the world extent parameter. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:Single |
| - | * **Description**:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * Description:This parameter is the screen width. |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | **worldPoint** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Description:This parameter is the screen height. |
| - | * **Description**:This parameter is the world point you want converted to a screen point. | + | |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetVersion() ** |
| - | * **Description**:This parameter is the width of the screen for the CurrentExtent. | + | |
| - | **screenHeight** | + | Get the current MapSuiteCore.dll file version. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen for the CurrentExtent. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === ToString() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:String | + | * Type:String |
| - | * **Description**:N/A | + | * Description:A string representing the file version of MapSuiteCore.dll. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ToWorldCoordinate(RectangleShape,Single,Single,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} LoadDataTable(Collection<Feature>,IEnumerable<String>) ** |
| - | This method returns world coordinates from screen coordinates. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | 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. |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | == Remarks == |
| - | * **Description**:This method returns world coordinates from screen coordinates. | + | N/A |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:DataTable |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:A DateTable of information about those passed-in features and the returning columnNames. |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **screenX** | + | == Parameters == |
| - | * **Type**:Single | + | * //features// |
| - | * **Description**:This parameter is the X coordinate of the point you want converted to world coordinates. | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| + | * Description:This parameter specifies the target features. | ||
| - | **screenY** | + | * //returningColumnNames// |
| - | * **Type**:Single | + | * Type:IEnumerable<String> |
| - | * **Description**:This parameter is the Y coordinate of the point you want converted to world coordinates. | + | * Description:This parameter specifies the returning columnNames for the features. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetDrawingExtent(RectangleShape,Single,Single) ** |
| - | * **Description**:This parameter is the width of the screen. | + | |
| - | **screenHeight** | + | This method returns an adjusted extent based on the ratio of the screen width and height. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | This function is used because the extent to draw must be the rame ratio as the screen width and height. If they are not, then the image drawn will be stretched or compressed. We always adjust the extent upwards to ensure that no matter how we adjust it, the original extent will fit within the new extent. This ensures that everything you wanted to see in the first extent is visible and maybe a bit more. This function takes a height and width in screen coordinates, then looks at a world extent passed, and returns an adjusted world rectangle so that the ratio to height and width in screen and world coordinates match. |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single) === | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns world coordinates from screen coordinates. | + | * Description:This method returns an adjusted extent based on the ratio of the screen width and height. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * //worldExtent// |
| - | * **Description**:This method returns world coordinates from screen coordinates. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to adjust for drawing. | ||
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the width of the screen. |
| - | * **Description**:This parameter is the world extent. | + | |
| - | **screenPoint** | + | * //screenHeight// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:Single |
| - | * **Description**:This parameter is the screen point you want converted to a world point. | + | * Description:This parameter is the height of the screen. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the width of the screen. | + | |
| - | **screenHeight** | + | This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === ToWorldCoordinate(Single,Single,Single,Single) === | + | |
| - | This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | * Description:This method returns an adjusted extent centered on a point. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenX** | + | * //worldExtent// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the X of the point you want converted to world coordinates. | + | * Description:This parameter is the current extent you want to center. |
| - | **screenY** | + | * //worldPoint// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This parameter is the Y of the point you want converted to world coordinates. | + | * Description:This parameter is the world point you want to center on. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the width of the screen. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the height of the screen. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ToWorldCoordinate(ScreenPointF,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Feature,Single,Single) ** |
| - | This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | |
| - | ==== Remarks ==== | + | This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates. |
| + | == Remarks == | ||
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | * Description:This method returns an adjusted extent centered on a point. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **screenPoint** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the point you want converted to world coordinates. | + | * Description:This parameter is the current extent you want to center. |
| - | **screenWidth** | + | * //centerFeature// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the world point feature you want to center on. |
| - | **screenHeight** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the width of the screen. |
| - | [[#Public Methods|Go Back]] | + | * //screenHeight// |
| - | === ZoomIn(RectangleShape,Int32) === | + | * Type:Single |
| - | This method returns a new extent that is zoomed in by the percentage provided. | + | * Description:This parameter is the height of the screen. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Single,Single,Single,Single) ** |
| - | * **Description**:This method returns a new extent that is zoomed in by the percentage provided. | + | |
| - | ==== Parameters ==== | + | This is a static function that allows you to pass in a world rectangle, a point in screen coordinates to center on, and a height and width in screen units. The function will center the rectangle based on the screen point, then adjust the rectangle's ratio based on the height and width in screen coordinates. |
| - | **worldExtent** | + | == Remarks == |
| - | * **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 in. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === ZoomIn(Int32) === | + | |
| - | This method updates the CurrentExtent that is zoomed in by the percentage provided. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method updates the CurrentExtent that is zoomed in by the percentage provided. | + | * Description:This method returns an adjusted extent centered on a point. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **percentage** | + | * //worldExtent// |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | * Description:This parameter is the current extent you want to center. |
| - | [[#Public Methods|Go Back]] | + | * //screenX// |
| - | === ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single) === | + | * Type:Single |
| - | This method returns an extent that is centered and zoomed in. | + | * Description:This parameter is the X coordinate on the screen to center to. |
| - | ==== Remarks ==== | + | |
| - | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | * //screenY// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Single |
| - | * **Description**:This method returns an extent that is centered and zoomed in. | + | * Description:This parameter is the Y coordinate on the screen to center to. |
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the width of the screen. |
| - | * **Description**:This parameter is the world extent that you want centered and zoomed. | + | |
| - | **percentage** | + | * //screenHeight// |
| - | * **Type**:Int32 | + | * Type:Single |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | * Description:This parameter is the height of the screen. |
| - | **worldPoint** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the world point you want the extent to be centered on. | + | |
| - | **screenWidth** | + | This method returns the number of pixels between two world points. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the width in screen coordinates. | + | None |
| - | **screenHeight** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height in screen coordinates. | + | * Description:This method returns the number of pixels between two world points. |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single) === | + | * //worldExtent// |
| - | This method returns an extent that is centered and zoomed in. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Remarks ==== | + | * Description:This parameter is the world extent. |
| - | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | * //worldPoint1// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This method returns an extent that is centered and zoomed in. | + | * Description:This parameter is the first point -- the one you want to measure from. |
| - | ==== Parameters ==== | + | * //worldPoint2// |
| - | **worldExtent** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the second point -- the one you want to measure to. |
| - | * **Description**:This parameter is the world extent you want to center and zoom. | + | |
| - | **percentage** | + | * //screenWidth// |
| - | * **Type**:Int32 | + | * Type:Single |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | * Description:This parameter is the width of the screen. |
| - | **screenX** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen X you want to center on. | + | * Description:This parameter is the height of the screen. |
| - | **screenY** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single) ** |
| - | * **Description**:This parameter is the screen Y you want to center on. | + | |
| - | **screenWidth** | + | This method returns the number of pixels between two world points. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the width of the screen. | + | None |
| - | **screenHeight** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This method returns the number of pixels between two world points. |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === ZoomIntoCenter(Int32,Single,Single,Single,Single) === | + | * //worldExtent// |
| - | This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Remarks ==== | + | * Description:This parameter is the world extent. |
| - | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | * //worldPointFeature1// |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:None. | + | * Description:This parameter is the first point Feature -- the one you want to measure from. |
| - | ==== Parameters ==== | + | * //worldPointFeature2// |
| - | **percentage** | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Type**:Int32 | + | * Description:This parameter is the second point Feature -- the one you want to measure to. |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | |
| - | **screenX** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen X you want to center on. | + | * Description:This parameter is the width of the screen. |
| - | **screenY** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the screen Y you want to center on. | + | * Description:This parameter is the height of the screen. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) ** |
| - | * **Description**:This parameter is the width of the screen. | + | |
| - | **screenHeight** | + | This method returns the distance in world units between two screen points. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | None |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === ZoomIntoCenter(Int32,Feature,Single,Single) === | + | * Type:Double |
| - | This method returns an extent that is centered and zoomed in. | + | * Description:This method returns the distance in wold units between two screen points. |
| - | ==== Remarks ==== | + | |
| - | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //worldExtent// |
| - | * **Description**:This method returns an extent that is centered and zoomed in. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent. | ||
| - | ==== Parameters ==== | + | * //screenPoint1// |
| - | **percentage** | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Type**:Int32 | + | * Description:This is the screen point you want to measure from. |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | |
| - | **centerFeature** | + | * //screenPoint2// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] |
| - | * **Description**:This parameter is the world point you want the extent to be centered on. | + | * Description:This is the screen point you want to measure to. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width in screen coordinates. | + | * Description:This parameter is the width of the screen. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height in screen coordinates. | + | * Description:This parameter is the height of the screen. |
| - | [[#Public Methods|Go Back]] | + | * //worldExtentUnit// |
| - | === ZoomIntoCenter(Int32,PointShape,Single,Single) === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | This method will update the CurrentExtent by using the ZoomIntoCenter operation. | + | * Description:This is the geographic unit of the world extent rectangle. |
| - | ==== Remarks ==== | + | |
| - | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | * //distanceUnit// |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| - | * **Description**:None. | + | * Description:This is the geographic unit you want the result to show in. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **percentage** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,Single,Single,Single,Single,Single,Single,GeographyUnit,DistanceUnit) ** |
| - | * **Type**:Int32 | + | |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | |
| - | **worldPoint** | + | This method returns the distance in wold units between two screen points. |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | == Remarks == |
| - | * **Description**:This parameter is the world point you want the extent to be centered on. | + | N/A |
| - | **screenWidth** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Double |
| - | * **Description**:This parameter is the width in screen coordinates. | + | * Description:N/A |
| - | **screenHeight** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldExtent// |
| - | * **Description**:This parameter is the height in screen coordinates. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent. | ||
| - | [[#Public Methods|Go Back]] | + | * //screenPoint1X// |
| - | === ZoomIntoCenter(RectangleShape,Int32,Feature,Single,Single) === | + | * Type:Single |
| - | This method returns a new extent that is zoomed in by the percentage provided. | + | * Description:This parameter is the X of the point you want to measure from. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | * //screenPoint1Y// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Single |
| - | * **Description**:This method returns a new extent that is zoomed in by the percentage provided. | + | * Description:This parameter is the Y of the point you want to measure from. |
| - | ==== Parameters ==== | + | * //screenPoint2X// |
| - | **worldExtent** | + | * Type:Single |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This parameter is the X of the point you want to measure to. |
| - | * **Description**:This parameter is the world extent you want to zoom. | + | |
| - | **percentage** | + | * //screenPoint2Y// |
| - | * **Type**:Int32 | + | * Type:Single |
| - | * **Description**:This parameter is the percentage by which you want to zoom in. | + | * Description:This parameter is the Y of the point you want to measure to. |
| - | **centerFeature** | + | * //screenWidth// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:Single |
| - | * **Description**:This parameter is the world point feature you want the extent to be centered on. | + | * Description:This parameter is the width of the screen. |
| - | **screenWidth** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width in screen coordinates. | + | * Description:This parameter is the height of the screen. |
| - | **screenHeight** | + | * //worldExtentUnit// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Description**:This parameter is the height in screen coordinates. | + | * Description:This is the geographic unit of the world extent you passed in. |
| - | [[#Public Methods|Go Back]] | + | * //distanceUnit// |
| - | === ZoomOut(RectangleShape,Int32) === | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| - | This method returns a new extent that is zoomed out by the percentage provided. | + | * Description:This is the geographic unit you want the result to show in. |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetCurrentScale(RectangleShape,Single,GeographyUnit) ** |
| - | * **Description**:This method returns a new extent that is zoomed out by the percentage provided. | + | |
| - | ==== Parameters ==== | + | This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit. |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | N/A |
| - | * **Description**:This parameter is the world extent you want to zoom. | + | |
| - | **percentage** | + | == Return Value == |
| - | * **Type**:Int32 | + | * Type:Double |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | * Description:N/A |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === ZoomOut(Int32) === | + | * //worldExtent// |
| - | This method will update the CurrentExtent by using the ZoomOut operation. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Remarks ==== | + | * Description:This parameter specifies the worldExtent used to calculate the current scale. |
| - | None | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:Void | + | * Type:Single |
| - | * **Description**:None. | + | * Description:This parameter specifies the screenWidth corresponding to the worldExtent. |
| - | ==== Parameters ==== | + | * //mapUnit// |
| - | **percentage** | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | * **Type**:Int32 | + | * Description:This parameter specifies the unit for the extent, the result will be different if choose DecimalDegree as Unit and Meter as Unit. |
| - | * **Description**:This parameter is the percentage by which you want to zoom. | + | |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<BaseShape>) ** |
| - | 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** | + | This API gets the BoundingBox of a group of BaseShapes. |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:This method returns an extent that is centered and zoomed out. | + | N/A |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:The BoundingBox that contains all the shapes you passed in. |
| - | * **Description**:This parameter is the world extent you want to center and zoom. | + | |
| - | **percentage** | + | == Parameters == |
| - | * **Type**:Int32 | + | * //shapes// |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
| + | * Description:The target group of BaseShapes to get the BoundingBox for. | ||
| - | **screenX** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<Feature>) ** |
| - | * **Description**:This parameter is the screen X you want to center on. | + | |
| - | **screenY** | + | This API gets the BoundingBox of a group of Features. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the screen Y you want to center on. | + | N/A |
| - | **screenWidth** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:The BoundingBox that contains all the features you passed in. |
| - | **screenHeight** | + | == Parameters == |
| - | * **Type**:Single | + | * //features// |
| - | * **Description**:This parameter is the height of the screen. | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| + | * Description:The target group of Features to get the BoundingBox for. | ||
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIn(RectangleShape,Int32) ** |
| - | 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** | + | This method returns a new extent that is zoomed in by the percentage provided. |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:This method returns an extent that is centered and zoomed out. | + | None |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:This method returns a new extent that is zoomed in by the percentage provided. |
| - | * **Description**:This parameter is the world extent you want to center and zoom. | + | |
| - | **percentage** | + | == Parameters == |
| - | * **Type**:Int32 | + | * //worldExtent// |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to zoom. | ||
| - | **centerFeature** | + | * //percentage// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:Int32 |
| - | * **Description**:This parameter is the feature you want the extent to be centered on. | + | * Description:This parameter is the percentage by which you want to zoom in. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single) ** |
| - | * **Description**:This parameter is the width of the screen. | + | |
| - | **screenHeight** | + | This method returns an extent that is centered and zoomed in. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | |
| - | + | ||
| - | [[#Public Methods|Go Back]] | + | |
| - | === 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. | 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 == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This method returns an extent that is centered and zoomed out. | + | * Description:This method returns an extent that is centered and zoomed in. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **worldExtent** | + | * //worldExtent// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world extent you want to center and zoom. | + | * Description:This parameter is the world extent that you want centered and zoomed. |
| - | **percentage** | + | * //percentage// |
| - | * **Type**:Int32 | + | * Type:Int32 |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | * Description:This parameter is the percentage by which you want to zoom in. |
| - | **worldPoint** | + | * //worldPoint// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Description**:This parameter is the world point you want the extent to be centered on. | + | * Description:This parameter is the world point you want the extent to be centered on. |
| - | **screenWidth** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the width in screen coordinates. |
| - | **screenHeight** | + | * //screenHeight// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the height in screen coordinates. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ZoomOutToCenter(Int32,Single,Single,Single,Single) === | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,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** | + | This method returns a new extent that is zoomed in by the percentage provided. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None. | + | None |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **percentage** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Type**:Int32 | + | * Description:This method returns a new extent that is zoomed in by the percentage provided. |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | |
| - | **screenX** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldExtent// |
| - | * **Description**:This parameter is the screen X you want to center on. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to zoom. | ||
| - | **screenY** | + | * //percentage// |
| - | * **Type**:Single | + | * Type:Int32 |
| - | * **Description**:This parameter is the screen Y you want to center on. | + | * Description:This parameter is the percentage by which you want to zoom in. |
| - | **screenWidth** | + | * //centerFeature// |
| - | * **Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * **Description**:This parameter is the width of the screen. | + | * Description:This parameter is the world point feature you want the extent to be centered on. |
| - | **screenHeight** | + | * //screenWidth// |
| - | * **Type**:Single | + | * Type:Single |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the width in screen coordinates. |
| - | [[#Public Methods|Go Back]] | + | * //screenHeight// |
| - | === ZoomOutToCenter(Int32,Feature,Single,Single) === | + | * Type:Single |
| - | This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | * Description:This parameter is the height in screen coordinates. |
| - | ==== Remarks ==== | + | |
| - | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single) ** |
| - | * **Description**:None. | + | |
| - | ==== Parameters ==== | + | This method returns an extent that is centered and zoomed in. |
| - | **percentage** | + | == Remarks == |
| - | * **Type**:Int32 | + | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | |
| - | **centerFeature** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:This parameter is the world point Feature you want the extent to be centered on. | + | * Description:This method returns an extent that is centered and zoomed in. |
| - | **screenWidth** | + | == Parameters == |
| - | * **Type**:Single | + | * //worldExtent// |
| - | * **Description**:This parameter is the width of the screen. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter is the world extent you want to center and zoom. | ||
| - | **screenHeight** | + | * //percentage// |
| - | * **Type**:Single | + | * Type:Int32 |
| - | * **Description**:This parameter is the height of the screen. | + | * Description:This parameter is the percentage by which you want to zoom in. |
| - | [[#Public Methods|Go Back]] | + | * //screenX// |
| - | === ZoomOutToCenter(Int32,PointShape,Single,Single) === | + | * Type:Single |
| - | This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | * Description:This parameter is the screen X you want to center on. |
| - | ==== Remarks ==== | + | |
| - | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | |
| - | **Return Value** | + | * //screenY// |
| - | * **Return Type**:Void | + | * Type:Single |
| - | * **Description**:None. | + | * Description:This parameter is the screen Y you want to center on. |
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | **percentage** | + | * Type:Single |
| - | * **Type**:Int32 | + | * Description:This parameter is the width of the screen. |
| - | * **Description**:This parameter is the percentage by which you want to zoom out. | + | |
| - | **worldPoint** | + | * //screenHeight// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:Single |
| - | * **Description**:This parameter is the world point you want the extent to be centered on. | + | * Description:This parameter is the height of the screen. |
| - | **screenWidth** | + | <div newline></div> |
| - | * **Type**:Single | + | ==== Protected Methods ==== |
| - | * **Description**:This parameter is the width of the screen. | + | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs) ** |
| - | **screenHeight** | + | This event is raised before AdornmentLayers are drawn. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the height of the screen. | + | N/A |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === ZoomToScale(Double,GeographyUnit,Single,Single) === | + | * Type:Void |
| - | This method updates the CurrentExtent by zooming to a certain scale. | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //e// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] |
| + | * Description:The AdornmentLayersDrawingEventArgs passed for the event raised. | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **targetScale** | + | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs) ** |
| - | * **Type**:Double | + | |
| - | * **Description**:This parameter is the scale you want to zoom into. | + | |
| - | **worldExtentUnit** | + | This event is raised after AdornmentLayers are drawn. |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | == Remarks == |
| - | * **Description**:This parameter is the geographic unit of the CurrentExtent. | + | N/A |
| - | **screenWidth** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Void |
| - | * **Description**:This parameter is the screen width. | + | * Description:N/A |
| - | **screenHeight** | + | == Parameters == |
| - | * **Type**:Single | + | * //e// |
| - | * **Description**:This parameter is the screen height. | + | * Type:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] |
| + | * Description:The AdornmentLayersDrawnEventArgs passed for the event raised. | ||
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single) === | + | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs) ** |
| - | This method returns a extent that has been zoomed into a certain scale. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | **Return Value** | + | This event is raised before an AdornmentLayer is drawn. |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:This method returns a extent that has been zoomed into a certain scale. | + | N/A |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **targetScale** | + | * Type:Void |
| - | * **Type**:Double | + | * Description:N/A |
| - | * **Description**:This parameter is the scale you want to zoom into. | + | |
| - | **worldExtent** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //e// |
| - | * **Description**:This parameter is the world extent you want zoomed into the scale. | + | * Type:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] |
| + | * Description:The AdornmentLayerDrawingEventArgs passed for the event raised. | ||
| - | **worldExtentUnit** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | + | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs) ** |
| - | * **Description**:This parameter is the geographic unit of the world extent parameter. | + | |
| - | **screenWidth** | + | This event is raised after an AdornmentLayer is drawn. |
| - | * **Type**:Single | + | == Remarks == |
| - | * **Description**:This parameter is the screen width. | + | N/A |
| - | **screenHeight** | + | == Return Value == |
| - | * **Type**:Single | + | * Type:Void |
| - | * **Description**:This parameter is the screen height. | + | * Description:N/A |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | ===== Protected Methods ===== | + | * //e// |
| - | === Finalize() === | + | * Type:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] |
| - | N/A | + | * Description:The AdornmentLayerDrawnEventArgs passed for the event raised. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:ProtectedMethod.gif|}} OnLayersDrawing(LayersDrawingEventArgs) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | This event is raised before Layers are drawn. |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | === MemberwiseClone() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Object | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | === OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs) === | + | * Type:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] |
| - | This event is raised before an AdornmentLayer is drawn. | + | * Description:The LayersDrawingEventArgs passed for the event raised. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:ProtectedMethod.gif|}} OnLayersDrawn(LayersDrawnEventArgs) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | This event is raised after Layers are drawn. |
| - | **e** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | + | |
| - | * **Description**:The AdornmentLayerDrawingEventArgs passed for the event raised. | + | |
| - | + | ||
| - | [[#Protected Methods|Go Back]] | + | |
| - | === OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs) === | + | |
| - | This event is raised after an AdornmentLayer is drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | * //e// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] |
| - | * **Description**:The AdornmentLayerDrawnEventArgs passed for the event raised. | + | * Description:The LayersDrawnEventArgs passed for the event raised. |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | === OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs) === | + | ** {{wiki:ProtectedMethod.gif|}} OnLayerDrawing(LayerDrawingEventArgs) ** |
| - | This event is raised before AdornmentLayers are drawn. | + | |
| - | ==== Remarks ==== | + | This event is raised before a Layer is drawn. |
| + | == Remarks == | ||
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | * //e// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] |
| - | * **Description**:The AdornmentLayersDrawingEventArgs passed for the event raised. | + | * Description:The LayerDrawingEventArgs passed for the event raised. |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | === OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs) === | + | ** {{wiki:ProtectedMethod.gif|}} OnLayerDrawn(LayerDrawnEventArgs) ** |
| - | This event is raised after AdornmentLayers are drawn. | + | |
| - | ==== Remarks ==== | + | This event is raised after a Layer is drawn. |
| + | == Remarks == | ||
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | * //e// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] |
| - | * **Description**:The AdornmentLayersDrawnEventArgs passed for the event raised. | + | * Description:The LayerDrawnEventArgs passed for the event raised. |
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | [[#Protected Methods|Go Back]] | + | N/A |
| - | === OnLayerDrawing(LayerDrawingEventArgs) === | + | == Remarks == |
| - | This event is raised before a Layer is drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | * **Description**:The LayerDrawingEventArgs passed for the event raised. | + | |
| - | [[#Protected Methods|Go Back]] | + | N/A |
| - | === OnLayerDrawn(LayerDrawnEventArgs) === | + | == Remarks == |
| - | This event is raised after a Layer is drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Object |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] | + | ==== Public Properties ==== |
| - | * **Description**:The LayerDrawnEventArgs passed for the event raised. | + | ** {{wiki:PublicProperty.gif|}} Canvas ** |
| - | [[#Protected Methods|Go Back]] | + | Gets and sets the GeoCanvas used to draw the Layers. |
| - | === OnLayersDrawing(LayersDrawingEventArgs) === | + | == Remarks == |
| - | This event is raised before Layers are drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} ShowLogo ** |
| - | * **Return Type**:Void | + | |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | This property specifies whether the logo is shown on the Map or not. |
| - | **e** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] | + | |
| - | * **Description**:The LayersDrawingEventArgs passed for the event raised. | + | |
| - | + | ||
| - | [[#Protected Methods|Go Back]] | + | |
| - | === OnLayersDrawn(LayersDrawnEventArgs) === | + | |
| - | This event is raised after Layers are drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} AdornmentLayers ** |
| - | * **Return Type**:Void | + | |
| - | * **Description**:N/A | + | |
| - | + | ||
| - | ==== Parameters ==== | + | |
| - | **e** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] | + | |
| - | * **Description**:The LayersDrawnEventArgs passed for the event raised. | + | |
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === AdornmentLayers === | ||
| This property holds a collection of AdornmentLayers to be drawn on the MapEngine. | This property holds a collection of AdornmentLayers to be drawn on the MapEngine. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| 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 == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.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>]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} CurrentExtent ** |
| - | === BackgroundFillBrush === | + | |
| - | Gets or sets the GeoBrush for the background of the MapEngine. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | + | |
| - | + | ||
| - | [[#Public Properties|Go Back]] | + | |
| - | === Canvas === | + | |
| - | Gets and sets the GeoCanvas used to draw the Layers. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === CurrentExtent === | ||
| This property gets or sets the current extent of the MapEngine. | This property gets or sets the current extent of the MapEngine. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| The current extent is the rectangle that is currently being shown on the MapEngine. | The current extent is the rectangle that is currently being shown on the MapEngine. | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} StaticLayers ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === DynamicLayers === | ||
| This property holds a group of Layers to be drawn on the MapEngine. | This property holds a group of Layers to be drawn on the MapEngine. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| - | This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API. | + | This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API. |
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.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>]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} DynamicLayers ** |
| - | === ShowLogo === | + | |
| - | This property specifies whether the logo is shown on the Map or not. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Boolean | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === StaticLayers === | ||
| This property holds a group of Layers to be drawn on the MapEngine. | This property holds a group of Layers to be drawn on the MapEngine. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| - | This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API. | + | This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API. |
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.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>]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} BackgroundFillBrush ** |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | Gets or sets the GeoBrush for the background of the MapEngine. |
| - | === AdornmentLayerDrawing === | + | == Remarks == |
| - | This event is raised before an AdornmentLayer is drawn. | + | |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | + | ==== Protected Properties ==== |
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} LayersDrawing ** | ||
| + | This event is raised before Layers are drawn. | ||
| + | == Remarks == | ||
| + | N/A | ||
| - | [[#Public Events|Go Back]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] |
| - | === AdornmentLayerDrawn === | + | |
| - | This event is raised after an AdornmentLayer is drawn. | + | ** {{wiki:PublicEvent.gif|}} LayersDrawn ** |
| - | ==== Remarks ==== | + | This event is raised after Layers are drawn. |
| + | == Remarks == | ||
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} LayerDrawing ** |
| - | === AdornmentLayersDrawing === | + | This event is raised before a Layer is drawn. |
| - | This event is raised before AdornmentLayers are drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} LayerDrawn ** |
| - | === AdornmentLayersDrawn === | + | This event is raised after a Layer is drawn. |
| - | This event is raised after AdornmentLayers are drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawing ** |
| - | === LayerDrawing === | + | This event is raised before AdornmentLayers are drawn. |
| - | This event is raised before a Layer is drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayerDrawingEventArgs|LayerDrawingEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawn ** |
| - | === LayerDrawn === | + | This event is raised after AdornmentLayers are drawn. |
| - | This event is raised after a Layer is drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayerDrawnEventArgs|LayerDrawnEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawing ** |
| - | === LayersDrawing === | + | This event is raised before an AdornmentLayer is drawn. |
| - | This event is raised before Layers are drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs|LayersDrawingEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawn ** |
| - | === LayersDrawn === | + | This event is raised after an AdornmentLayer is drawn. |
| - | This event is raised after Layers are drawn. | + | == Remarks == |
| - | ==== Remarks ==== | + | |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.LayersDrawnEventArgs|LayersDrawnEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] |
| - | [[#Public Events|Go Back]] | ||
thinkgeo.mapsuite.core.mapengine.1442486082.txt.gz · Last modified: 2015/09/17 10:34 by admin