This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.mapengine [2015/09/21 08:13] admin |
thinkgeo.mapsuite.portablecore.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 8: | Line 11: | ||
** {{wiki:PublicMethod.gif|}} MapEngine() ** | ** {{wiki:PublicMethod.gif|}} MapEngine() ** | ||
- | Create a new instance of the MapEngine. | + | * //Create a new instance of the MapEngine.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
+ | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(Int32,Int32,GeographyUnit) ** | ||
+ | |||
+ | * //Draw a group of static layers and return a new image with the specified width and height.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
+ | * Description:The resulting image after drawing the group of static layers based on the specified width and height. | ||
+ | |||
+ | == Parameters == | ||
+ | * //width// | ||
+ | * 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. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(Int32,Int32,GeographyUnit) ** | ||
+ | |||
+ | * //Draw a group of dynamic layers and return a new image with the specified width and height.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
+ | * Description:The resulting image after drawing the group of dynamic layers based on the specified width and height. | ||
+ | |||
+ | == Parameters == | ||
+ | * //width// | ||
+ | * 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. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(Int32,Int32,GeographyUnit) ** | ||
+ | |||
+ | * //Draw a group of AdornmentLayers and return a new image with the specified width and height.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
+ | * Description:The resulting image after drawing the group of AdornmentLayers based on the specified width and height. | ||
+ | |||
+ | == Parameters == | ||
+ | * //width// | ||
+ | * 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. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} ZoomIn(Int32) ** | ||
+ | |||
+ | * //This method updates the CurrentExtent that is zoomed in by the percentage provided.// | ||
+ | == Remarks == | ||
+ | * //None// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:This method updates the CurrentExtent that is zoomed in by the percentage provided. | ||
+ | |||
+ | == Parameters == | ||
+ | * //percentage// | ||
+ | * Type:Int32 | ||
+ | * Description:This parameter is the percentage by which you want to zoom in. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,PointShape,Single,Single) ** | ||
+ | |||
+ | * //This method will update the CurrentExtent by using the ZoomIntoCenter operation.// | ||
+ | == Remarks == | ||
+ | * //The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:None. | ||
+ | |||
+ | == Parameters == | ||
+ | * //percentage// | ||
+ | * Type:Int32 | ||
+ | * Description:This parameter is the percentage by which you want to zoom in. | ||
+ | |||
+ | * //worldPoint// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
+ | * Description:This parameter is the world point you want the extent to be centered on. | ||
+ | |||
+ | * //screenWidth// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the width in screen coordinates. | ||
+ | |||
+ | * //screenHeight// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the height in screen coordinates. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Feature,Single,Single) ** | ||
+ | |||
+ | * //This method returns an extent that is centered and zoomed in.// | ||
+ | == Remarks == | ||
+ | * //The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:This method returns an extent that is centered and zoomed in. | ||
+ | |||
+ | == Parameters == | ||
+ | * //percentage// | ||
+ | * Type:Int32 | ||
+ | * Description:This parameter is the percentage by which you want to zoom in. | ||
+ | |||
+ | * //centerFeature// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
+ | * Description:This parameter is the world point you want the extent to be centered on. | ||
+ | |||
+ | * //screenWidth// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the width in screen coordinates. | ||
+ | |||
+ | * //screenHeight// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the height in screen coordinates. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Single,Single,Single,Single) ** | ||
+ | |||
+ | * //This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in.// | ||
+ | == Remarks == | ||
+ | * //The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:None. | ||
+ | |||
+ | == Parameters == | ||
+ | * //percentage// | ||
+ | * Type:Int32 | ||
+ | * Description:This parameter is the percentage by which you want to zoom in. | ||
+ | |||
+ | * //screenX// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the screen X you want to center on. | ||
+ | |||
+ | * //screenY// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the screen Y you want to center on. | ||
+ | |||
+ | * //screenWidth// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the width of the screen. | ||
+ | |||
+ | * //screenHeight// | ||
+ | * Type:Single | ||
+ | * Description:This parameter is the height of the screen. | ||
+ | |||
+ | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} ZoomOut(Int32) ** | ** {{wiki:PublicMethod.gif|}} ZoomOut(Int32) ** | ||
- | This method will update the CurrentExtent by using the ZoomOut operation. | + | * //This method will update the CurrentExtent by using the ZoomOut operation.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 33: | Line 212: | ||
** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,PointShape,Single,Single) ** | ||
- | This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | * //This method updates the CurrentExtent by using the ZoomOutToCenter operation.// |
== Remarks == | == Remarks == | ||
- | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// |
== Return Value == | == Return Value == | ||
Line 61: | Line 240: | ||
** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Feature,Single,Single) ** | ||
- | This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | * //This method updates the CurrentExtent by using the ZoomOutToCenter operation.// |
== Remarks == | == Remarks == | ||
- | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// |
== Return Value == | == Return Value == | ||
Line 89: | Line 268: | ||
** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ZoomOutToCenter(Int32,Single,Single,Single,Single) ** | ||
- | This method updates the CurrentExtent by using the ZoomOutToCenter operation. | + | * //This method updates the CurrentExtent by using the ZoomOutToCenter operation.// |
== Remarks == | == Remarks == | ||
- | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// |
== Return Value == | == Return Value == | ||
Line 121: | Line 300: | ||
** {{wiki:PublicMethod.gif|}} Pan(PanDirection,Int32) ** | ** {{wiki:PublicMethod.gif|}} Pan(PanDirection,Int32) ** | ||
- | Update the CurrentExtent by using a panning operation. | + | * //Update the CurrentExtent by using a panning operation.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 141: | Line 320: | ||
** {{wiki:PublicMethod.gif|}} Pan(Single,Int32) ** | ** {{wiki:PublicMethod.gif|}} Pan(Single,Int32) ** | ||
- | This method updates the CurrentExtent by using a panning operation. | + | * //This method updates the CurrentExtent by using a panning operation.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 161: | Line 340: | ||
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Double,Double,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Double,Double,Single,Single) ** | ||
- | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * //This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 189: | Line 368: | ||
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(PointShape,Single,Single) ** | ||
- | This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent. | + | * //This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 213: | Line 392: | ||
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Feature,Single,Single) ** | ||
- | This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent. | + | * //This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 237: | Line 416: | ||
** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Single,Single,Single,Single) ** | ||
- | This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | * //This method returns world coordinates from screen coordinates, based on the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 265: | Line 444: | ||
** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(ScreenPointF,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(ScreenPointF,Single,Single) ** | ||
- | This method returns world coordinates from screen coordinates, based on the CurrentExtent. | + | * //This method returns world coordinates from screen coordinates, based on the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 289: | Line 468: | ||
** {{wiki:PublicMethod.gif|}} SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet) ** | ** {{wiki:PublicMethod.gif|}} SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet) ** | ||
- | This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set. | + | * //This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 317: | Line 496: | ||
** {{wiki:PublicMethod.gif|}} ZoomToScale(Double,GeographyUnit,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} ZoomToScale(Double,GeographyUnit,Single,Single) ** | ||
- | This method updates the CurrentExtent by zooming to a certain scale. | + | * //This method updates the CurrentExtent by zooming to a certain scale.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 345: | Line 524: | ||
** {{wiki:PublicMethod.gif|}} FindStaticFeatureLayer(String) ** | ** {{wiki:PublicMethod.gif|}} FindStaticFeatureLayer(String) ** | ||
- | Finds a feature layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | * //Finds a feature layer by key (specified in the "name" parameter) within the collection of StaticLayers.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 361: | Line 540: | ||
** {{wiki:PublicMethod.gif|}} FindStaticRasterLayer(String) ** | ** {{wiki:PublicMethod.gif|}} FindStaticRasterLayer(String) ** | ||
- | Find the raster layer by key (specified in the "name" parameter) within the collection of StaticLayers. | + | * //Find the raster layer by key (specified in the "name" parameter) within the collection of StaticLayers.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 377: | Line 556: | ||
** {{wiki:PublicMethod.gif|}} FindDynamicFeatureLayer(String) ** | ** {{wiki:PublicMethod.gif|}} FindDynamicFeatureLayer(String) ** | ||
- | Find the feature layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | * //Find the feature layer by key (specified in the "name" parameter) within the collection of DynamicLayers.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 393: | Line 572: | ||
** {{wiki:PublicMethod.gif|}} FindDynamicRasterLayer(String) ** | ** {{wiki:PublicMethod.gif|}} FindDynamicRasterLayer(String) ** | ||
- | Find the raster layer by key (specified in the "name" parameter) within the collection of DynamicLayers. | + | * //Find the raster layer by key (specified in the "name" parameter) within the collection of DynamicLayers.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 409: | Line 588: | ||
** {{wiki:PublicMethod.gif|}} GetDrawingExtent(Single,Single) ** | ** {{wiki:PublicMethod.gif|}} GetDrawingExtent(Single,Single) ** | ||
- | This method returns an adjusted extent based on the ratio of the screen width and height. | + | * //This method returns an adjusted extent based on the ratio of the screen width and height.// |
== Remarks == | == 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 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 == | ||
Line 429: | Line 608: | ||
** {{wiki:PublicMethod.gif|}} OpenAllLayers() ** | ** {{wiki:PublicMethod.gif|}} OpenAllLayers() ** | ||
- | This API allows you to open all of the layers (either static or dynamic). | + | * //This API allows you to open all of the layers (either static or dynamic).// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 441: | Line 620: | ||
** {{wiki:PublicMethod.gif|}} CloseAllLayers() ** | ** {{wiki:PublicMethod.gif|}} CloseAllLayers() ** | ||
- | This API allows you close all of the layers (either static or dynamic). | + | * //This API allows you close all of the layers (either static or dynamic).// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 453: | Line 632: | ||
** {{wiki:PublicMethod.gif|}} CenterAt(PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} CenterAt(PointShape,Single,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. | + | * //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.// |
== Remarks == | == Remarks == | ||
- | This API will update the CurrentExtent. | + | * //This API will update the CurrentExtent.// |
== Return Value == | == Return Value == | ||
Line 477: | Line 656: | ||
** {{wiki:PublicMethod.gif|}} CenterAt(Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} CenterAt(Feature,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. | + | * //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 == | == Remarks == | ||
- | This API will update the CurrentExtent. | + | * //This API will update the CurrentExtent.// |
== Return Value == | == Return Value == | ||
Line 501: | Line 680: | ||
** {{wiki:PublicMethod.gif|}} CenterAt(Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} 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 == | ||
Line 529: | Line 708: | ||
** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single) ** | ||
- | This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | * //This method returns the number of pixels between two world points using the CurrentExtent as reference.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 557: | Line 736: | ||
** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single) ** | ||
- | This method returns the number of pixels between two world points using the CurrentExtent as reference. | + | * //This method returns the number of pixels between two world points using the CurrentExtent as reference.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 585: | Line 764: | ||
** {{wiki:PublicMethod.gif|}} GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}} 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. | + | * //This method returns the distance in world units between two screen points by using the CurrentExtent as a reference.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 621: | Line 800: | ||
** {{wiki:PublicMethod.gif|}} GetCurrentScale(Single,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} GetCurrentScale(Single,GeographyUnit) ** | ||
- | Get the current Scale responding to the CurrentExtent. | + | * //Get the current Scale responding to the CurrentExtent.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 641: | Line 820: | ||
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,GeoImage,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,GeoImage,GeographyUnit) ** | ||
- | Draw a group of layers on the specified "background" image. | + | * //Draw a group of layers on the specified "background" image.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 665: | Line 844: | ||
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit) ** | ||
- | Draw a group of layers and return a new image with the specified width and height. | + | * //Draw a group of layers and return a new image with the specified width and height.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 693: | Line 872: | ||
** {{wiki:PublicMethod.gif|}} DrawStaticLayers(GeoImage,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(GeoImage,GeographyUnit) ** | ||
- | Draw a group of static layers on the specified "background" image. | + | * //Draw a group of static layers on the specified "background" image.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 713: | Line 892: | ||
** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(GeoImage,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} 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 == | ||
Line 733: | Line 912: | ||
** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(GeoImage,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(GeoImage,GeographyUnit) ** | ||
- | Draw a group of AdornmentLayers on the specified "background" image. | + | * //Draw a group of AdornmentLayers on the specified "background" image.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 751: | Line 930: | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(Int32,Int32,GeographyUnit) ** | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | Draw a group of static layers and return a new image with the specified width and height. | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:String |
- | * Description:The resulting image after drawing the group of static layers based on the specified width and height. | + | * Description:N/A |
== Parameters == | == Parameters == | ||
- | * //width// | ||
- | * 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. | ||
- | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(Int32,Int32,GeographyUnit) ** | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | Draw a group of dynamic layers and return a new image with the specified width and height. | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Boolean |
- | * Description:The resulting image after drawing the group of dynamic layers based on the specified width and height. | + | * Description:N/A |
== Parameters == | == Parameters == | ||
- | * //width// | + | * //obj// |
- | * Type:Int32 | + | * Type:Object |
- | * Description:This parameter specifies the width of the returning image. | + | * Description:N/A |
- | + | ||
- | * //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. | + | |
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(Int32,Int32,GeographyUnit) ** | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | Draw a group of AdornmentLayers and return a new image with the specified width and height. | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Int32 |
- | * Description:The resulting image after drawing the group of AdornmentLayers based on the specified width and height. | + | * Description:N/A |
== Parameters == | == Parameters == | ||
- | * //width// | ||
- | * 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. | ||
- | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Layer>,Bitmap,GeographyUnit) ** | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | Draw a group of layers on the specified "background" bitmap. | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:Bitmap | + | * Type:Type |
- | * Description:The resulting bitmap after drawing the target layers on the specified "background" bitmap. | + | * Description:N/A |
== Parameters == | == Parameters == | ||
- | * //layers// | ||
- | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | ||
- | * Description:This parameter specifies the target layers to be drawn. | ||
- | |||
- | * //gdiPlusBitmap// | ||
- | * Type:Bitmap | ||
- | * Description:This parameter specifies the "background" bitmap of the returning bitmap. | ||
- | |||
- | * //mapUnit// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
- | * Description:This parameter specifies the MapUnit used in the current map. | ||
- | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawStaticLayers(Bitmap,GeographyUnit) ** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIn(RectangleShape,Int32) ** |
- | Draw a group of static layers on the specified "background" bitmap. | + | * //This method returns a new extent that is zoomed in by the percentage provided.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //None// |
== Return Value == | == Return Value == | ||
- | * Type:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * Description:The resulting bitmap after drawing the group of static layers on the specified "background" bitmap. | + | * Description:This method returns a new extent that is zoomed in by the percentage provided. |
== Parameters == | == Parameters == | ||
- | * //gdiPlusBitmap// | + | * //worldExtent// |
- | * Type:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * Description:This parameter specifies the "background" bitmap of the returning bitmap. | + | * Description:This parameter is the world extent you want to zoom. |
- | * //mapUnit// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
- | * Description:This parameter specifies the MapUnit used in the current map. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawDynamicLayers(Bitmap,GeographyUnit) ** | ||
- | |||
- | Draw a group of dynamic layers on the specified "background" bitmap. | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Bitmap | ||
- | * Description:The resulting bitmap after drawing the group of dynamic layers on the specified "background" bitmap. | ||
- | |||
- | == Parameters == | ||
- | * //gdiPlusBitmap// | ||
- | * Type:Bitmap | ||
- | * Description:This parameter specifies the "background" bitmap of the returning bitmap. | ||
- | |||
- | * //mapUnit// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
- | * Description:This parameter specifies the MapUnit used in the current map. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} DrawAdornmentLayers(Bitmap,GeographyUnit) ** | ||
- | |||
- | Draw a group of AdornmentLayers on the specified "background" bitmap. | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Bitmap | ||
- | * Description:The resulting bitmap after drawing the group of AdornmentLayers on the specified "background" bitmap. | ||
- | |||
- | == Parameters == | ||
- | * //gdiPlusBitmap// | ||
- | * Type:Bitmap | ||
- | * Description:This parameter specifies the "background" bitmap of the returning bitmap. | ||
- | |||
- | * //mapUnit// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
- | * Description:This parameter specifies the MapUnit used in the current map. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ZoomIn(Int32) ** | ||
- | |||
- | This method updates the CurrentExtent that is zoomed in by the percentage provided. | ||
- | == Remarks == | ||
- | None | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:This method updates the CurrentExtent that is zoomed in by the percentage provided. | ||
- | |||
- | == Parameters == | ||
* //percentage// | * //percentage// | ||
* Type:Int32 | * Type:Int32 | ||
Line 923: | Line 1002: | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,PointShape,Single,Single) ** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single) ** |
- | This method will update the CurrentExtent by using the ZoomIntoCenter operation. | + | * //This method returns an extent that is centered and zoomed in.// |
== Remarks == | == Remarks == | ||
- | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// |
== Return Value == | == Return Value == | ||
- | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * Description:None. | + | * Description:This method returns an extent that is centered and zoomed in. |
== Parameters == | == Parameters == | ||
+ | * //worldExtent// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:This parameter is the world extent that you want centered and zoomed. | ||
+ | |||
* //percentage// | * //percentage// | ||
* Type:Int32 | * Type:Int32 | ||
Line 951: | Line 1034: | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Feature,Single,Single) ** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,Feature,Single,Single) ** |
- | This method returns an extent that is centered and zoomed in. | + | * //This method returns a new extent that is zoomed in by the percentage provided.// |
== Remarks == | == Remarks == | ||
- | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //None// |
== Return Value == | == Return Value == | ||
- | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * Description:This method returns an extent that is centered and zoomed in. | + | * Description:This method returns a new extent that is zoomed in by the percentage provided. |
== Parameters == | == Parameters == | ||
+ | * //worldExtent// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:This parameter is the world extent you want to zoom. | ||
+ | |||
* //percentage// | * //percentage// | ||
* Type:Int32 | * Type:Int32 | ||
Line 968: | Line 1055: | ||
* //centerFeature// | * //centerFeature// | ||
* Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
- | * Description:This parameter is the world point you want the extent to be centered on. | + | * Description:This parameter is the world point feature you want the extent to be centered on. |
* //screenWidth// | * //screenWidth// | ||
Line 979: | Line 1066: | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ZoomIntoCenter(Int32,Single,Single,Single,Single) ** | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single) ** |
- | This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in. | + | * //This method returns an extent that is centered and zoomed in.// |
== Remarks == | == Remarks == | ||
- | The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | + | * //The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.// |
== Return Value == | == Return Value == | ||
- | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | * Description:None. | + | * Description:This method returns an extent that is centered and zoomed in. |
== Parameters == | == Parameters == | ||
+ | * //worldExtent// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:This parameter is the world extent you want to center and zoom. | ||
+ | |||
* //percentage// | * //percentage// | ||
* Type:Int32 | * Type:Int32 | ||
Line 1010: | Line 1101: | ||
* Description:This parameter is the height of the screen. | * Description:This parameter is the height of the screen. | ||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:String | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Boolean | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //obj// | ||
- | * Type:Object | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Int32 | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Type | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOut(RectangleShape,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOut(RectangleShape,Int32) ** | ||
- | This method returns a new extent that is zoomed out by the percentage provided. | + | * //This method returns a new extent that is zoomed out by the percentage provided.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1085: | Line 1124: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single) ** | ||
- | This method returns an extent that is centered and zoomed out. | + | * //This method returns an extent that is centered and zoomed out.// |
== Remarks == | == 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 == | ||
Line 1117: | Line 1156: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single) ** | ||
- | This method returns an extent that is centered and zoomed out. | + | * //This method returns an extent that is centered and zoomed out.// |
== Remarks == | == 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 == | ||
Line 1149: | Line 1188: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single) ** | ||
- | This method returns an extent that is centered and zoomed out. | + | * //This method returns an extent that is centered and zoomed out.// |
== Remarks == | == 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 == | ||
Line 1185: | Line 1224: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,PanDirection,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,PanDirection,Int32) ** | ||
- | This method returns a panned extent. | + | * //This method returns a panned extent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1209: | Line 1248: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,Single,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} Pan(RectangleShape,Single,Int32) ** | ||
- | This method returns a panned extent. | + | * //This method returns a panned extent.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1233: | Line 1272: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Double,Double,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Double,Double,Single,Single) ** | ||
- | This method returns screen coordinates from world coordinates. | + | * //This method returns screen coordinates from world coordinates.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1265: | Line 1304: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,PointShape,Single,Single) ** | ||
- | This method returns screen coordinates from world coordinates. | + | * //This method returns screen coordinates from world coordinates.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1293: | Line 1332: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToScreenCoordinate(RectangleShape,Feature,Single,Single) ** | ||
- | This method returns screen coordinates from world coordinates. | + | * //This method returns screen coordinates from world coordinates.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1321: | Line 1360: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,Single,Single,Single,Single) ** | ||
- | This method returns world coordinates from screen coordinates. | + | * //This method returns world coordinates from screen coordinates.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1353: | Line 1392: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single) ** | ||
- | This method returns world coordinates from screen coordinates. | + | * //This method returns world coordinates from screen coordinates.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1381: | Line 1420: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet) ** | ||
- | This method returns an extent that is snapped to a zoom level in the provided zoom level set. | + | * //This method returns an extent that is snapped to a zoom level in the provided zoom level set.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1413: | Line 1452: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single) ** | ||
- | This method returns a extent that has been zoomed into a certain scale. | + | * //This method returns a extent that has been zoomed into a certain scale.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1445: | Line 1484: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetVersion() ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetVersion() ** | ||
- | Get the current MapSuiteCore.dll file version. | + | * //Get the current MapSuiteCore.dll file version.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1454: | Line 1493: | ||
== Parameters == | == Parameters == | ||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} LoadDataTable(Collection<Feature>,IEnumerable<String>) ** | ||
- | |||
- | This method is a static API to get information about a group of passed-in features with the specified returningColumns, in the format of a DataTable. | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:DataTable | ||
- | * Description:A DateTable of information about those passed-in features and the returning columnNames. | ||
- | |||
- | == Parameters == | ||
- | * //features// | ||
- | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
- | * Description:This parameter specifies the target features. | ||
- | |||
- | * //returningColumnNames// | ||
- | * Type:IEnumerable<String> | ||
- | * Description:This parameter specifies the returning columnNames for the features. | ||
- | |||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetDrawingExtent(RectangleShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetDrawingExtent(RectangleShape,Single,Single) ** | ||
- | This method returns an adjusted extent based on the ratio of the screen width and height. | + | * //This method returns an adjusted extent based on the ratio of the screen width and height.// |
== Remarks == | == 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. | + | * //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 == | == Return Value == | ||
Line 1501: | Line 1520: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //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 == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1529: | Line 1548: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Feature,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. | + | * //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 == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1557: | Line 1576: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Single,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CenterAt(RectangleShape,Single,Single,Single,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. | + | * //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.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1589: | Line 1608: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single) ** | ||
- | This method returns the number of pixels between two world points. | + | * //This method returns the number of pixels between two world points.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1621: | Line 1640: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single) ** | ||
- | This method returns the number of pixels between two world points. | + | * //This method returns the number of pixels between two world points.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1653: | Line 1672: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit) ** | ||
- | This method returns the distance in world units between two screen points. | + | * //This method returns the distance in world units between two screen points.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 1693: | Line 1712: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,Single,Single,Single,Single,Single,Single,GeographyUnit,DistanceUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,Single,Single,Single,Single,Single,Single,GeographyUnit,DistanceUnit) ** | ||
- | This method returns the distance in wold units between two screen points. | + | * //This method returns the distance in wold units between two screen points.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1741: | Line 1760: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetCurrentScale(RectangleShape,Single,GeographyUnit) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetCurrentScale(RectangleShape,Single,GeographyUnit) ** | ||
- | This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit. | + | * //This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1765: | Line 1784: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<BaseShape>) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<BaseShape>) ** | ||
- | This API gets the BoundingBox of a group of BaseShapes. | + | * //This API gets the BoundingBox of a group of BaseShapes.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1781: | Line 1800: | ||
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<Feature>) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetBoundingBoxOfItems(IEnumerable<Feature>) ** | ||
- | This API gets the BoundingBox of a group of Features. | + | * //This API gets the BoundingBox of a group of Features.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1793: | Line 1812: | ||
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
* Description:The target group of Features to get the BoundingBox for. | * Description:The target group of Features to get the BoundingBox for. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIn(RectangleShape,Int32) ** | ||
- | |||
- | This method returns a new extent that is zoomed in by the percentage provided. | ||
- | == Remarks == | ||
- | None | ||
- | |||
- | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This method returns a new extent that is zoomed in by the percentage provided. | ||
- | |||
- | == Parameters == | ||
- | * //worldExtent// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This parameter is the world extent you want to zoom. | ||
- | |||
- | * //percentage// | ||
- | * Type:Int32 | ||
- | * Description:This parameter is the percentage by which you want to zoom in. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single) ** | ||
- | |||
- | This method returns an extent that is centered and zoomed in. | ||
- | == Remarks == | ||
- | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | ||
- | |||
- | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This method returns an extent that is centered and zoomed in. | ||
- | |||
- | == Parameters == | ||
- | * //worldExtent// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This parameter is the world extent that you want centered and zoomed. | ||
- | |||
- | * //percentage// | ||
- | * Type:Int32 | ||
- | * Description:This parameter is the percentage by which you want to zoom in. | ||
- | |||
- | * //worldPoint// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
- | * Description:This parameter is the world point you want the extent to be centered on. | ||
- | |||
- | * //screenWidth// | ||
- | * Type:Single | ||
- | * Description:This parameter is the width in screen coordinates. | ||
- | |||
- | * //screenHeight// | ||
- | * Type:Single | ||
- | * Description:This parameter is the height in screen coordinates. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,Feature,Single,Single) ** | ||
- | |||
- | This method returns a new extent that is zoomed in by the percentage provided. | ||
- | == Remarks == | ||
- | None | ||
- | |||
- | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This method returns a new extent that is zoomed in by the percentage provided. | ||
- | |||
- | == Parameters == | ||
- | * //worldExtent// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This parameter is the world extent you want to zoom. | ||
- | |||
- | * //percentage// | ||
- | * Type:Int32 | ||
- | * Description:This parameter is the percentage by which you want to zoom in. | ||
- | |||
- | * //centerFeature// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
- | * Description:This parameter is the world point feature you want the extent to be centered on. | ||
- | |||
- | * //screenWidth// | ||
- | * Type:Single | ||
- | * Description:This parameter is the width in screen coordinates. | ||
- | |||
- | * //screenHeight// | ||
- | * Type:Single | ||
- | * Description:This parameter is the height in screen coordinates. | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single) ** | ||
- | |||
- | This method returns an extent that is centered and zoomed in. | ||
- | == Remarks == | ||
- | The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards. | ||
- | |||
- | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This method returns an extent that is centered and zoomed in. | ||
- | |||
- | == Parameters == | ||
- | * //worldExtent// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:This parameter is the world extent you want to center and zoom. | ||
- | |||
- | * //percentage// | ||
- | * Type:Int32 | ||
- | * Description:This parameter is the percentage by which you want to zoom in. | ||
- | |||
- | * //screenX// | ||
- | * Type:Single | ||
- | * Description:This parameter is the screen X you want to center on. | ||
- | |||
- | * //screenY// | ||
- | * Type:Single | ||
- | * Description:This parameter is the screen Y you want to center on. | ||
- | |||
- | * //screenWidth// | ||
- | * Type:Single | ||
- | * Description:This parameter is the width of the screen. | ||
- | |||
- | * //screenHeight// | ||
- | * Type:Single | ||
- | * Description:This parameter is the height of the screen. | ||
<div newline></div> | <div newline></div> | ||
Line 1918: | Line 1817: | ||
** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs) ** | ||
- | This event is raised before AdornmentLayers are drawn. | + | * //This event is raised before AdornmentLayers are drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1934: | Line 1833: | ||
** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs) ** | ||
- | This event is raised after AdornmentLayers are drawn. | + | * //This event is raised after AdornmentLayers are drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1950: | Line 1849: | ||
** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs) ** | ||
- | This event is raised before an AdornmentLayer is drawn. | + | * //This event is raised before an AdornmentLayer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1966: | Line 1865: | ||
** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs) ** | ||
- | This event is raised after an AdornmentLayer is drawn. | + | * //This event is raised after an AdornmentLayer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1982: | Line 1881: | ||
** {{wiki:ProtectedMethod.gif|}} OnLayersDrawing(LayersDrawingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnLayersDrawing(LayersDrawingEventArgs) ** | ||
- | This event is raised before Layers are drawn. | + | * //This event is raised before Layers are drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 1998: | Line 1897: | ||
** {{wiki:ProtectedMethod.gif|}} OnLayersDrawn(LayersDrawnEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnLayersDrawn(LayersDrawnEventArgs) ** | ||
- | This event is raised after Layers are drawn. | + | * //This event is raised after Layers are drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 2014: | Line 1913: | ||
** {{wiki:ProtectedMethod.gif|}} OnLayerDrawing(LayerDrawingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnLayerDrawing(LayerDrawingEventArgs) ** | ||
- | This event is raised before a Layer is drawn. | + | * //This event is raised before a Layer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 2030: | Line 1929: | ||
** {{wiki:ProtectedMethod.gif|}} OnLayerDrawn(LayerDrawnEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnLayerDrawn(LayerDrawnEventArgs) ** | ||
- | This event is raised after a Layer is drawn. | + | * //This event is raised after a Layer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 2046: | Line 1945: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 2058: | Line 1957: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 2071: | Line 1970: | ||
** {{wiki:PublicProperty.gif|}} Canvas ** | ** {{wiki:PublicProperty.gif|}} Canvas ** | ||
- | Gets and sets the GeoCanvas used to draw the Layers. | + | * //Gets and sets the GeoCanvas used to draw the Layers.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
Line 2079: | Line 1978: | ||
** {{wiki:PublicProperty.gif|}} ShowLogo ** | ** {{wiki:PublicProperty.gif|}} ShowLogo ** | ||
- | This property specifies whether the logo is shown on the Map or not. | + | * //This property specifies whether the logo is shown on the Map or not.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 2087: | Line 1986: | ||
** {{wiki:PublicProperty.gif|}} AdornmentLayers ** | ** {{wiki:PublicProperty.gif|}} 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 == | ||
- | * 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, MapSuitePortableCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] |
** {{wiki:PublicProperty.gif|}} CurrentExtent ** | ** {{wiki:PublicProperty.gif|}} 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 == | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
Line 2103: | Line 2002: | ||
** {{wiki:PublicProperty.gif|}} StaticLayers ** | ** {{wiki:PublicProperty.gif|}} 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 DrawStaticLayers API.// |
== Return Value == | == Return Value == | ||
- | * 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, MapSuitePortableCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] |
** {{wiki:PublicProperty.gif|}} DynamicLayers ** | ** {{wiki:PublicProperty.gif|}} 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 DrawDynamicLayers API.// |
== Return Value == | == Return Value == | ||
- | * 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, MapSuitePortableCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] |
** {{wiki:PublicProperty.gif|}} BackgroundFillBrush ** | ** {{wiki:PublicProperty.gif|}} BackgroundFillBrush ** | ||
- | Gets or sets the GeoBrush for the background of the MapEngine. | + | * //Gets or sets the GeoBrush for the background of the MapEngine.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | ||
Line 2128: | Line 2027: | ||
==== Public Events ==== | ==== Public Events ==== | ||
** {{wiki:PublicEvent.gif|}} LayersDrawing ** | ** {{wiki:PublicEvent.gif|}} LayersDrawing ** | ||
- | This event is raised before Layers are 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.LayersDrawingEventArgs|LayersDrawingEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} LayersDrawn ** | ** {{wiki:PublicEvent.gif|}} LayersDrawn ** | ||
- | This event is raised after Layers are 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.LayersDrawnEventArgs|LayersDrawnEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} LayerDrawing ** | ** {{wiki:PublicEvent.gif|}} LayerDrawing ** | ||
- | This event is raised before a Layer is 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.LayerDrawingEventArgs|LayerDrawingEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} LayerDrawn ** | ** {{wiki:PublicEvent.gif|}} LayerDrawn ** | ||
- | This event is raised after a Layer is 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.LayerDrawnEventArgs|LayerDrawnEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawing ** | ** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawing ** | ||
- | This event is raised before AdornmentLayers are 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.AdornmentLayersDrawingEventArgs|AdornmentLayersDrawingEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawn ** | ** {{wiki:PublicEvent.gif|}} AdornmentLayersDrawn ** | ||
- | This event is raised after AdornmentLayers are 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.AdornmentLayersDrawnEventArgs|AdornmentLayersDrawnEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawing ** | ** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawing ** | ||
- | This event is raised before an AdornmentLayer is drawn. | + | * //This event is raised before an AdornmentLayer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawingEventArgs|AdornmentLayerDrawingEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawn ** | ** {{wiki:PublicEvent.gif|}} AdornmentLayerDrawn ** | ||
- | This event is raised after an AdornmentLayer is drawn. | + | * //This event is raised after an AdornmentLayer is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.AdornmentLayerDrawnEventArgs|AdornmentLayerDrawnEventArgs]] | ||