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