Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.core.mapengine
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Core.MapEngine
This class is for generating maps.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.Core.MapEngine
Members Summary
Public Constructors
- Parameters:N/A
- DeclaringType:N/A
- Summary:Create a new instance of the MapEngine.
Protected Constructors
Public Methods
- Parameters:RectangleShape,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates.
- Parameters:RectangleShape,Feature,Single,Single
- DeclaringType:N/A
- Summary:This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates.
- Parameters:RectangleShape,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This is a static function that allows you to pass in a world rectangle, a point in screen coordinates to center on, and a height and width in screen units. The function will center the rectangle based on the screen point, then adjust the rectangle's ratio based on the height and width in screen coordinates.
- Parameters:Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This is a function that allows you to pass a screen point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates.
- Parameters:Feature,Single,Single
- DeclaringType:N/A
- Summary:This is a function that allows you to pass in a feature to center on, as well as a height and width in screen units. The function will center the CurrentExtent based on the specified feature and adjust its ratio based on the height and width in screen coordinates.
- Parameters:PointShape,Single,Single
- DeclaringType:N/A
- Summary:This is a function that allows you to pass a world point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates.
- Parameters:N/A
- DeclaringType:N/A
- Summary:This API allows you close all of the layers (either static or dynamic).
- Parameters:IEnumerable<Layer>,Bitmap,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of layers on the specified “background” bitmap.
- Parameters:IEnumerable<Layer>,Int32,Int32,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of layers and return a new image with the specified width and height.
- DeclaringType:N/A
- Summary:Draw a group of layers on the specified “background” image.
- Parameters:Bitmap,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of AdornmentLayers on the specified “background” bitmap.
- Parameters:Int32,Int32,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of AdornmentLayers and return a new image with the specified width and height.
- Parameters:GeoImage,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of AdornmentLayers on the specified “background” image.
- Parameters:Bitmap,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of dynamic layers on the specified “background” bitmap.
- Parameters:Int32,Int32,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of dynamic layers and return a new image with the specified width and height.
- Parameters:GeoImage,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of dynamic layers on the specified “background” image.
- Parameters:Bitmap,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of static layers on the specified “background” bitmap.
- Parameters:Int32,Int32,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of static layers and return a new image with the specified width and height.
- Parameters:GeoImage,GeographyUnit
- DeclaringType:N/A
- Summary:Draw a group of static layers on the specified “background” image.
- Parameters:Object
- DeclaringType:Object
- Summary:N/A
- Parameters:String
- DeclaringType:N/A
- Summary:Find the feature layer by key (specified in the “name” parameter) within the collection of DynamicLayers.
- Parameters:String
- DeclaringType:N/A
- Summary:Find the raster layer by key (specified in the “name” parameter) within the collection of DynamicLayers.
- Parameters:String
- DeclaringType:N/A
- Summary:Finds a feature layer by key (specified in the “name” parameter) within the collection of StaticLayers.
- Parameters:String
- DeclaringType:N/A
- Summary:Find the raster layer by key (specified in the “name” parameter) within the collection of StaticLayers.
- Parameters:IEnumerable<Feature>
- DeclaringType:N/A
- Summary:This API gets the BoundingBox of a group of Features.
- Parameters:IEnumerable<BaseShape>
- DeclaringType:N/A
- Summary:This API gets the BoundingBox of a group of BaseShapes.
- Parameters:RectangleShape,Single,GeographyUnit
- DeclaringType:N/A
- Summary:This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit.
- Parameters:Single,GeographyUnit
- DeclaringType:N/A
- Summary:Get the current Scale responding to the CurrentExtent.
- Parameters:RectangleShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns an adjusted extent based on the ratio of the screen width and height.
- Parameters:Single,Single
- DeclaringType:N/A
- Summary:This method returns an adjusted extent based on the ratio of the screen width and height.
- Parameters:N/A
- DeclaringType:Object
- Summary:N/A
GetScreenDistanceBetweenTwoWorldPoints
- DeclaringType:N/A
- Summary:This method returns the number of pixels between two world points using the CurrentExtent as reference.
GetScreenDistanceBetweenTwoWorldPoints
- DeclaringType:N/A
- Summary:This method returns the number of pixels between two world points.
GetScreenDistanceBetweenTwoWorldPoints
- Parameters:PointShape,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns the number of pixels between two world points using the CurrentExtent as reference.
GetScreenDistanceBetweenTwoWorldPoints
- DeclaringType:N/A
- Summary:This method returns the number of pixels between two world points.
- Parameters:N/A
- DeclaringType:Object
- Summary:N/A
- Parameters:N/A
- DeclaringType:N/A
- Summary:Get the current MapSuiteCore.dll file version.
GetWorldDistanceBetweenTwoScreenPoints
- DeclaringType:N/A
- Summary:This method returns the distance in world units between two screen points by using the CurrentExtent as a reference.
GetWorldDistanceBetweenTwoScreenPoints
- DeclaringType:N/A
- Summary:This method returns the distance in world units between two screen points.
GetWorldDistanceBetweenTwoScreenPoints
- DeclaringType:N/A
- Summary:This method returns the distance in wold units between two screen points.
- Parameters:Collection<Feature>,IEnumerable<String>
- DeclaringType:N/A
- Summary:This method is a static API to get information about a group of passed-in features with the specified returningColumns, in the format of a DataTable.
- Parameters:N/A
- DeclaringType:N/A
- Summary:This API allows you to open all of the layers (either static or dynamic).
- Parameters:RectangleShape,PanDirection,Int32
- DeclaringType:N/A
- Summary:This method returns a panned extent.
- Parameters:PanDirection,Int32
- DeclaringType:N/A
- Summary:Update the CurrentExtent by using a panning operation.
- Parameters:Single,Int32
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by using a panning operation.
- Parameters:RectangleShape,Single,Int32
- DeclaringType:N/A
- Summary:This method returns a panned extent.
- DeclaringType:N/A
- Summary:This method returns an extent that is snapped to a zoom level in the provided zoom level set.
- Parameters:GeographyUnit,Single,Single,ZoomLevelSet
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set.
- Parameters:Feature,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.
- Parameters:Double,Double,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
- Parameters:RectangleShape,Double,Double,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from world coordinates.
- Parameters:RectangleShape,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from world coordinates.
- Parameters:RectangleShape,Feature,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from world coordinates.
- Parameters:PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
- Parameters:N/A
- DeclaringType:Object
- Summary:N/A
- Parameters:RectangleShape,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method returns world coordinates from screen coordinates.
- Parameters:RectangleShape,ScreenPointF,Single,Single
- DeclaringType:N/A
- Summary:This method returns world coordinates from screen coordinates.
- Parameters:Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method returns world coordinates from screen coordinates, based on the CurrentExtent.
- Parameters:ScreenPointF,Single,Single
- DeclaringType:N/A
- Summary:This method returns world coordinates from screen coordinates, based on the CurrentExtent.
- Parameters:RectangleShape,Int32
- DeclaringType:N/A
- Summary:This method returns a new extent that is zoomed in by the percentage provided.
- Parameters:Int32
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent that is zoomed in by the percentage provided.
- Parameters:RectangleShape,Int32,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed in.
- Parameters:RectangleShape,Int32,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed in.
- Parameters:Int32,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in.
- Parameters:Int32,Feature,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed in.
- Parameters:Int32,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method will update the CurrentExtent by using the ZoomIntoCenter operation.
- Parameters:RectangleShape,Int32,Feature,Single,Single
- DeclaringType:N/A
- Summary:This method returns a new extent that is zoomed in by the percentage provided.
- Parameters:RectangleShape,Int32
- DeclaringType:N/A
- Summary:This method returns a new extent that is zoomed out by the percentage provided.
- Parameters:Int32
- DeclaringType:N/A
- Summary:This method will update the CurrentExtent by using the ZoomOut operation.
- Parameters:RectangleShape,Int32,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed out.
- Parameters:RectangleShape,Int32,Feature,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed out.
- Parameters:RectangleShape,Int32,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method returns an extent that is centered and zoomed out.
- Parameters:Int32,Single,Single,Single,Single
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by using the ZoomOutToCenter operation.
- Parameters:Int32,Feature,Single,Single
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by using the ZoomOutToCenter operation.
- Parameters:Int32,PointShape,Single,Single
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by using the ZoomOutToCenter operation.
- Parameters:Double,GeographyUnit,Single,Single
- DeclaringType:N/A
- Summary:This method updates the CurrentExtent by zooming to a certain scale.
- Parameters:Double,RectangleShape,GeographyUnit,Single,Single
- DeclaringType:N/A
- Summary:This method returns a extent that has been zoomed into a certain scale.
Protected Methods
- Parameters:N/A
- DeclaringType:Object
- Summary:N/A
- Parameters:N/A
- DeclaringType:Object
- Summary:N/A
- Parameters:AdornmentLayerDrawingEventArgs
- DeclaringType:N/A
- Summary:This event is raised before an AdornmentLayer is drawn.
- Parameters:AdornmentLayerDrawnEventArgs
- DeclaringType:N/A
- Summary:This event is raised after an AdornmentLayer is drawn.
- Parameters:AdornmentLayersDrawingEventArgs
- DeclaringType:N/A
- Summary:This event is raised before AdornmentLayers are drawn.
- Parameters:AdornmentLayersDrawnEventArgs
- DeclaringType:N/A
- Summary:This event is raised after AdornmentLayers are drawn.
- Parameters:LayerDrawingEventArgs
- DeclaringType:N/A
- Summary:This event is raised before a Layer is drawn.
- Parameters:LayerDrawnEventArgs
- DeclaringType:N/A
- Summary:This event is raised after a Layer is drawn.
- Parameters:LayersDrawingEventArgs
- DeclaringType:N/A
- Summary:This event is raised before Layers are drawn.
- Parameters:LayersDrawnEventArgs
- DeclaringType:N/A
- Summary:This event is raised after Layers are drawn.
Public Properties
- Summary:This property holds a collection of AdornmentLayers to be drawn on the MapEngine.
- Return:GeoBrush
- Summary:Gets or sets the GeoBrush for the background of the MapEngine.
- Return:GeoCanvas
- Summary:Gets and sets the GeoCanvas used to draw the Layers.
- Return:RectangleShape
- Summary:This property gets or sets the current extent of the MapEngine.
- Summary:This property holds a group of Layers to be drawn on the MapEngine.
- Return:Boolean
- Summary:This property specifies whether the logo is shown on the Map or not.
- Summary:This property holds a group of Layers to be drawn on the MapEngine.
Protected Properties
Public Events
- Event Arguments:AdornmentLayerDrawingEventArgs
- Summary:This event is raised before an AdornmentLayer is drawn.
- Event Arguments:AdornmentLayerDrawnEventArgs
- Summary:This event is raised after an AdornmentLayer is drawn.
- Event Arguments:AdornmentLayersDrawingEventArgs
- Summary:This event is raised before AdornmentLayers are drawn.
- Event Arguments:AdornmentLayersDrawnEventArgs
- Summary:This event is raised after AdornmentLayers are drawn.
- Event Arguments:LayerDrawingEventArgs
- Summary:This event is raised before a Layer is drawn.
- Event Arguments:LayerDrawnEventArgs
- Summary:This event is raised after a Layer is drawn.
- Event Arguments:LayersDrawingEventArgs
- Summary:This event is raised before Layers are drawn.
- Event Arguments:LayersDrawnEventArgs
- Summary:This event is raised after Layers are drawn.
Public Constructors
MapEngine()
Create a new instance of the MapEngine.
Remarks
N/A
Parameters
Protected Constructors
Public Methods
CenterAt(RectangleShape,PointShape,Single,Single)
This is a static function that allows you to pass in a world rectangle, a world point to center on, and a height and width in screen units. The function will center the rectangle based on the point, then adjust the rectangle's ratio based on the height and width in screen coordinates.
Remarks
None
Return Value
- Return Type:RectangleShape
- Description:This method returns an adjusted extent centered on a point.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the current extent you want to center.
worldPoint
- Type: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.
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
- Return Type:RectangleShape
- Description:This method returns an adjusted extent centered on a point.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the current extent you want to center.
centerFeature
- Type: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.
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
- Return Type:RectangleShape
- Description:This method returns an adjusted extent centered on a point.
Parameters
worldExtent
- Type: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.
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
- Return 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.
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
- Return Type:Void
- Description:None.
Parameters
centerFeature
- Type: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.
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
- Return Type:Void
- Description:None.
Parameters
worldPoint
- Type: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.
CloseAllLayers()
This API allows you close all of the layers (either static or dynamic).
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
Draw(IEnumerable<Layer>,Bitmap,GeographyUnit)
Draw a group of layers on the specified “background” bitmap.
Remarks
N/A
Return Value
- Return Type:Bitmap
- Description:The resulting bitmap after drawing the target layers on the specified “background” bitmap.
Parameters
layers
- Type:IEnumerable<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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit)
Draw a group of layers and return a new image with the specified width and height.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the target layers based on the specified width and height.
Parameters
layers
- Type:IEnumerable<Layer>
- Description:This parameter specifies the target layers to be drawn.
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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
Draw(IEnumerable<Layer>,GeoImage,GeographyUnit)
Draw a group of layers on the specified “background” image.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the target layers on the specified “background” image.
Parameters
layers
- Type:IEnumerable<Layer>
- Description:This parameter specifies the target layers to be drawn.
image
- Type:GeoImage
- Description:This parameter specifies the “background” image of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawAdornmentLayers(Bitmap,GeographyUnit)
Draw a group of AdornmentLayers on the specified “background” bitmap.
Remarks
N/A
Return Value
- Return 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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
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
- Return Type: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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawAdornmentLayers(GeoImage,GeographyUnit)
Draw a group of AdornmentLayers on the specified “background” image.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the group of AdornmentLayers on the specified “background” image.
Parameters
image
- Type:GeoImage
- Description:This parameter specifies the “background” image of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawDynamicLayers(Bitmap,GeographyUnit)
Draw a group of dynamic layers on the specified “background” bitmap.
Remarks
N/A
Return Value
- Return 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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawDynamicLayers(Int32,Int32,GeographyUnit)
Draw a group of dynamic layers and return a new image with the specified width and height.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the group of dynamic layers based on the specified width and height.
Parameters
width
- Type:Int32
- Description:This parameter specifies the width of the returning image.
height
- Type:Int32
- Description:This parameter specifies the height of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawDynamicLayers(GeoImage,GeographyUnit)
Draw a group of dynamic layers on the specified “background” image.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the group of dynamic layers on the specified “background” image.
Parameters
image
- Type:GeoImage
- Description:This parameter specifies the “background” image of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawStaticLayers(Bitmap,GeographyUnit)
Draw a group of static layers on the specified “background” bitmap.
Remarks
N/A
Return Value
- Return 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:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawStaticLayers(Int32,Int32,GeographyUnit)
Draw a group of static layers and return a new image with the specified width and height.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the group of static layers based on the specified width and height.
Parameters
width
- Type:Int32
- Description:This parameter specifies the width of the returning image.
height
- Type:Int32
- Description:This parameter specifies the height of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
DrawStaticLayers(GeoImage,GeographyUnit)
Draw a group of static layers on the specified “background” image.
Remarks
N/A
Return Value
- Return Type:GeoImage
- Description:The resulting image after drawing the group of static layers on the specified “background” image.
Parameters
image
- Type:GeoImage
- Description:This parameter specifies the “background” image of the returning image.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
Equals(Object)
N/A
Remarks
N/A
Return Value
- Return Type:Boolean
- Description:N/A
Parameters
FindDynamicFeatureLayer(String)
Find the feature layer by key (specified in the “name” parameter) within the collection of DynamicLayers.
Remarks
N/A
Return Value
- Return Type:FeatureLayer
- Description:The corresponding FeatureLayer with the specified key in the MapControl.
Parameters
FindDynamicRasterLayer(String)
Find the raster layer by key (specified in the “name” parameter) within the collection of DynamicLayers.
Remarks
N/A
Return Value
- Return Type:RasterLayer
- Description:The corresponding RasterLayer with the specified key in the MapControl.
Parameters
FindStaticFeatureLayer(String)
Finds a feature layer by key (specified in the “name” parameter) within the collection of StaticLayers.
Remarks
N/A
Return Value
- Return Type:FeatureLayer
- Description:The corresponding FeatureLayer with the specified key in the MapControl.
Parameters
FindStaticRasterLayer(String)
Find the raster layer by key (specified in the “name” parameter) within the collection of StaticLayers.
Remarks
N/A
Return Value
- Return Type:RasterLayer
- Description:The corresponding RasterLayer with the passing specified in the MapControl.
Parameters
GetBoundingBoxOfItems(IEnumerable<Feature>)
This API gets the BoundingBox of a group of Features.
Remarks
N/A
Return Value
- Return Type:RectangleShape
- Description:The BoundingBox that contains all the features you passed in.
Parameters
features
- Type:IEnumerable<Feature>
- Description:The target group of Features to get the BoundingBox for.
GetBoundingBoxOfItems(IEnumerable<BaseShape>)
This API gets the BoundingBox of a group of BaseShapes.
Remarks
N/A
Return Value
- Return Type:RectangleShape
- Description:The BoundingBox that contains all the shapes you passed in.
Parameters
shapes
- Type:IEnumerable<BaseShape>
- Description:The target group of BaseShapes to get the BoundingBox for.
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
- Return Type:Double
- Description:N/A
Parameters
worldExtent
- Type: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:GeographyUnit
- Description:This parameter specifies the unit for the extent, the result will be different if choose DecimalDegree as Unit and Meter as Unit.
GetCurrentScale(Single,GeographyUnit)
Get the current Scale responding to the CurrentExtent.
Remarks
N/A
Return Value
- Return Type:Double
- Description:The calculated scale based on the CurrentExtent.
Parameters
screenWidth
- Type:Single
- Description:This parameter specifies the screen width responding to the CurrentExtent.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
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
- Return Type:RectangleShape
- Description:This method returns an adjusted extent based on the ratio of the screen width and height.
Parameters
worldExtent
- Type: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.
GetDrawingExtent(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.
Return Value
- Return Type:RectangleShape
- Description:This method returns an adjusted extent based on the ratio of the screen width and height.
Parameters
screenWidth
- Type:Single
- Description:This parameter is the width of the screen.
screenHeight
- Type:Single
- Description:This parameter is the height of the screen.
GetHashCode()
N/A
Remarks
N/A
Return Value
- Return Type:Int32
- Description:N/A
Parameters
GetScreenDistanceBetweenTwoWorldPoints(Feature,Feature,Single,Single)
This method returns the number of pixels between two world points using the CurrentExtent as reference.
Remarks
None
Return Value
- Return Type:Single
- Description:This method returns the number of pixels between two world points.
Parameters
worldPointFeature1
- Type:Feature
- Description:This parameter is the first pointFeture – the one you want to measure from.
worldPointFeature2
- Type:Feature
- Description:This parameter is the second pointFeature – 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.
GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single)
This method returns the number of pixels between two world points.
Remarks
None
Return Value
- Return Type:Single
- Description:This method returns the number of pixels between two world points.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
worldPoint1
- Type:PointShape
- Description:This parameter is the first point – the one you want to measure from.
worldPoint2
- Type: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.
GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single)
This method returns the number of pixels between two world points using the CurrentExtent as reference.
Remarks
None
Return Value
- Return Type:Single
- Description:This method returns the number of pixels between two world points.
Parameters
worldPoint1
- Type:PointShape
- Description:This parameter is the first point – the one you want to measure from.
worldPoint2
- Type: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.
GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,Feature,Feature,Single,Single)
This method returns the number of pixels between two world points.
Remarks
None
Return Value
- Return Type:Single
- Description:This method returns the number of pixels between two world points.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
worldPointFeature1
- Type:Feature
- Description:This parameter is the first point Feature – the one you want to measure from.
worldPointFeature2
- Type: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.
GetType()
N/A
Remarks
N/A
Return Value
- Return Type:Type
- Description:N/A
Parameters
GetVersion()
Get the current MapSuiteCore.dll file version.
Remarks
N/A
Return Value
- Return Type:String
- Description:A string representing the file version of MapSuiteCore.dll.
Parameters
GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit)
This method returns the distance in world units between two screen points by using the CurrentExtent as a reference.
Remarks
None
Return Value
- Return Type:Double
- Description:This method returns the distance in world units between two screen points.
Parameters
screenPoint1
- Type:ScreenPointF
- Description:This is the screen point you want to measure from.
screenPoint2
- Type: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.
mapUnit
- Type:GeographyUnit
- Description:This parameter specifies the MapUnit used in the current map.
distanceUnit
- Type:DistanceUnit
- Description:This is the geographic unit you want the result to show in.
GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit)
This method returns the distance in world units between two screen points.
Remarks
None
Return Value
- Return Type:Double
- Description:This method returns the distance in wold units between two screen points.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
screenPoint1
- Type:ScreenPointF
- Description:This is the screen point you want to measure from.
screenPoint2
- Type: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:GeographyUnit
- Description:This is the geographic unit of the world extent rectangle.
distanceUnit
- Type:DistanceUnit
- Description:This is the geographic unit you want the result to show in.
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
- Return Type:Double
- Description:N/A
Parameters
worldExtent
- Type: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:GeographyUnit
- Description:This is the geographic unit of the world extent you passed in.
distanceUnit
- Type:DistanceUnit
- Description:This is the geographic unit you want the result to show in.
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
- Return Type:DataTable
- Description:A DateTable of information about those passed-in features and the returning columnNames.
Parameters
features
- Type:Collection<Feature>
- Description:This parameter specifies the target features.
returningColumnNames
- Type:IEnumerable<String>
- Description:This parameter specifies the returning columnNames for the features.
OpenAllLayers()
This API allows you to open all of the layers (either static or dynamic).
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
Pan(RectangleShape,PanDirection,Int32)
This method returns a panned extent.
Remarks
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent you want to pan.
direction
- Type: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.
Pan(PanDirection,Int32)
Update the CurrentExtent by using a panning operation.
Remarks
None
Return Value
- Return Type:Void
- Description:None.
Parameters
panDirection
- Type: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.
Pan(Single,Int32)
This method updates the CurrentExtent by using a panning operation.
Remarks
None
Return Value
- Return Type:Void
- Description:None.
Parameters
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.
Pan(RectangleShape,Single,Int32)
This method returns a panned extent.
Remarks
Parameters
worldExtent
- Type: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.
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
- Return Type:RectangleShape
- Description:This method returns an extent that is snapped to a zoom level in the provided zoom level set.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent you want snapped.
worldExtentUnit
- Type: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:ZoomLevelSet
- Description:This parameter is the set of zoom levels you want to snap to.
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
- Return Type:Void
- Description:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set.
Parameters
worldExtentUnit
- Type: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:ZoomLevelSet
- Description:This parameter is the set of zoom levels you want to snap to.
ToScreenCoordinate(Feature,Single,Single)
This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.
Parameters
worldPointFeature
- Type: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.
ToScreenCoordinate(Double,Double,Single,Single)
This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
Parameters
worldX
- Type:Double
- Description:This parameter is the world point X you want converted to a screen point.
worldY
- Type:Double
- Description:This parameter is the world point Y you want converted to a screen point.
screenWidth
- Type:Single
- Description:This parameter is the width of the screen for the CurrentExtent.
screenHeight
- Type:Single
- Description:This parameter is the height of the screen for the CurrentExtent.
ToScreenCoordinate(RectangleShape,Double,Double,Single,Single)
This method returns screen coordinates from world coordinates.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from world coordinates.
Parameters
worldExtent
- Type: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.
ToScreenCoordinate(RectangleShape,PointShape,Single,Single)
This method returns screen coordinates from world coordinates.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from world coordinates.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
worldPoint
- Type: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.
ToScreenCoordinate(RectangleShape,Feature,Single,Single)
This method returns screen coordinates from world coordinates.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from world coordinates.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
worldPointFeature
- Type: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.
ToScreenCoordinate(PointShape,Single,Single)
This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
Remarks
None
Return Value
- Return Type:ScreenPointF
- Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.
Parameters
worldPoint
- Type: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 for the CurrentExtent.
screenHeight
- Type:Single
- Description:This parameter is the height of the screen for the CurrentExtent.
ToString()
N/A
Remarks
N/A
Return Value
- Return Type:String
- Description:N/A
Parameters
ToWorldCoordinate(RectangleShape,Single,Single,Single,Single)
This method returns world coordinates from screen coordinates.
Remarks
None
Return Value
- Return Type:PointShape
- Description:This method returns world coordinates from screen coordinates.
Parameters
worldExtent
- Type: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.
ToWorldCoordinate(RectangleShape,ScreenPointF,Single,Single)
This method returns world coordinates from screen coordinates.
Remarks
None
Return Value
- Return Type:PointShape
- Description:This method returns world coordinates from screen coordinates.
Parameters
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent.
screenPoint
- Type: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.
ToWorldCoordinate(Single,Single,Single,Single)
This method returns world coordinates from screen coordinates, based on the CurrentExtent.
Remarks
None
Return Value
- Return Type: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.
ToWorldCoordinate(ScreenPointF,Single,Single)
This method returns world coordinates from screen coordinates, based on the CurrentExtent.
Remarks
None
Return Value
- Return Type:PointShape
- Description:This method returns world coordinates from screen coordinates, based on the CurrentExtent.
Parameters
screenPoint
- Type: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.
ZoomIn(RectangleShape,Int32)
This method returns a new extent that is zoomed in by the percentage provided.
Remarks
None
Return Value
- Return Type:RectangleShape
- Description:This method returns a new extent that is zoomed in by the percentage provided.
Parameters
worldExtent
- Type: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.
ZoomIn(Int32)
This method updates the CurrentExtent that is zoomed in by the percentage provided.
Remarks
None
Return Value
- Return 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.
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
- Return Type:RectangleShape
- Description:This method returns an extent that is centered and zoomed in.
Parameters
worldExtent
- Type: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: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.
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
- Return Type:RectangleShape
- Description:This method returns an extent that is centered and zoomed in.
Parameters
worldExtent
- Type: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.
ZoomIntoCenter(Int32,Single,Single,Single,Single)
This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in.
Remarks
The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom in.
screenX
- Type:Single
- Description:This parameter is the screen X you want to center on.
screenY
- Type:Single
- Description:This parameter is the screen Y you want to center on.
screenWidth
- Type:Single
- Description:This parameter is the width of the screen.
screenHeight
- Type:Single
- Description:This parameter is the height of the screen.
ZoomIntoCenter(Int32,Feature,Single,Single)
This method returns an extent that is centered and zoomed in.
Remarks
The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:This method returns an extent that is centered and zoomed in.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom in.
centerFeature
- Type: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.
ZoomIntoCenter(Int32,PointShape,Single,Single)
This method will update the CurrentExtent by using the ZoomIntoCenter operation.
Remarks
The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom in.
worldPoint
- Type: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.
ZoomIntoCenter(RectangleShape,Int32,Feature,Single,Single)
This method returns a new extent that is zoomed in by the percentage provided.
Remarks
None
Return Value
- Return Type:RectangleShape
- Description:This method returns a new extent that is zoomed in by the percentage provided.
Parameters
worldExtent
- Type: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: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.
ZoomOut(RectangleShape,Int32)
This method returns a new extent that is zoomed out by the percentage provided.
Remarks
None
Return Value
- Return Type:RectangleShape
- Description:This method returns a new extent that is zoomed out by the percentage provided.
Parameters
worldExtent
- Type: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.
ZoomOut(Int32)
This method will update the CurrentExtent by using the ZoomOut operation.
Remarks
None
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom.
ZoomOutToCenter(RectangleShape,Int32,Single,Single,Single,Single)
This method returns an extent that is centered and zoomed out.
Remarks
The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:RectangleShape
- Description:This method returns an extent that is centered and zoomed out.
Parameters
worldExtent
- Type: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.
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.
ZoomOutToCenter(RectangleShape,Int32,Feature,Single,Single)
This method returns an extent that is centered and zoomed out.
Remarks
The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:RectangleShape
- Description:This method returns an extent that is centered and zoomed out.
Parameters
worldExtent
- Type: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: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.
ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single)
This method returns an extent that is centered and zoomed out.
Remarks
The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:RectangleShape
- Description:This method returns an extent that is centered and zoomed out.
Parameters
worldExtent
- Type: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: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.
ZoomOutToCenter(Int32,Single,Single,Single,Single)
This method updates the CurrentExtent by using the ZoomOutToCenter operation.
Remarks
The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom out.
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.
ZoomOutToCenter(Int32,Feature,Single,Single)
This method updates the CurrentExtent by using the ZoomOutToCenter operation.
Remarks
The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom out.
centerFeature
- Type:Feature
- Description:This parameter is the world point Feature you want the extent to be centered on.
screenWidth
- Type:Single
- Description:This parameter is the width of the screen.
screenHeight
- Type:Single
- Description:This parameter is the height of the screen.
ZoomOutToCenter(Int32,PointShape,Single,Single)
This method updates the CurrentExtent by using the ZoomOutToCenter operation.
Remarks
The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.
Return Value
- Return Type:Void
- Description:None.
Parameters
percentage
- Type:Int32
- Description:This parameter is the percentage by which you want to zoom out.
worldPoint
- Type: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.
ZoomToScale(Double,GeographyUnit,Single,Single)
This method updates the CurrentExtent by zooming to a certain scale.
Remarks
None
Return Value
- Return Type:Void
- Description:N/A
Parameters
targetScale
- Type:Double
- Description:This parameter is the scale you want to zoom into.
worldExtentUnit
- Type: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.
ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single)
This method returns a extent that has been zoomed into a certain scale.
Remarks
None
Return Value
- Return Type:RectangleShape
- Description:This method returns a extent that has been zoomed into a certain scale.
Parameters
targetScale
- Type:Double
- Description:This parameter is the scale you want to zoom into.
worldExtent
- Type:RectangleShape
- Description:This parameter is the world extent you want zoomed into the scale.
worldExtentUnit
- Type: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.
Protected Methods
Finalize()
N/A
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
MemberwiseClone()
N/A
Remarks
N/A
Return Value
- Return Type:Object
- Description:N/A
Parameters
OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs)
This event is raised before an AdornmentLayer is drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The AdornmentLayerDrawingEventArgs passed for the event raised.
OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs)
This event is raised after an AdornmentLayer is drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The AdornmentLayerDrawnEventArgs passed for the event raised.
OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs)
This event is raised before AdornmentLayers are drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The AdornmentLayersDrawingEventArgs passed for the event raised.
OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs)
This event is raised after AdornmentLayers are drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The AdornmentLayersDrawnEventArgs passed for the event raised.
OnLayerDrawing(LayerDrawingEventArgs)
This event is raised before a Layer is drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The LayerDrawingEventArgs passed for the event raised.
OnLayerDrawn(LayerDrawnEventArgs)
This event is raised after a Layer is drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
OnLayersDrawing(LayersDrawingEventArgs)
This event is raised before Layers are drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Description:The LayersDrawingEventArgs passed for the event raised.
OnLayersDrawn(LayersDrawnEventArgs)
This event is raised after Layers are drawn.
Remarks
N/A
Return Value
- Return Type:Void
- Description:N/A
Parameters
e
- Type:LayersDrawnEventArgs
- Description:The LayersDrawnEventArgs passed for the event raised.
Public Properties
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
Return Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]
BackgroundFillBrush
Gets or sets the GeoBrush for the background of the MapEngine.
Remarks
N/A
Return Value
Canvas
Gets and sets the GeoCanvas used to draw the Layers.
Remarks
N/A
Return Value
CurrentExtent
This property gets or sets the current extent of the MapEngine.
Remarks
The current extent is the rectangle that is currently being shown on the MapEngine.
Return Value
Return Type:RectangleShape
DynamicLayers
This property holds a group of Layers to be drawn on the MapEngine.
Remarks
This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API.
Return Value
Return Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]
ShowLogo
This property specifies whether the logo is shown on the Map or not.
Remarks
N/A
Return Value
Return Type:Boolean
StaticLayers
This property holds a group of Layers to be drawn on the MapEngine.
Remarks
This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API.
Return Value
Return Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]
Protected Properties
Public Events
AdornmentLayerDrawing
This event is raised before an AdornmentLayer is drawn.
Remarks
AdornmentLayerDrawn
This event is raised after an AdornmentLayer is drawn.
Remarks
AdornmentLayersDrawing
This event is raised before AdornmentLayers are drawn.
Remarks
AdornmentLayersDrawn
This event is raised after AdornmentLayers are drawn.
Remarks
LayerDrawing
This event is raised before a Layer is drawn.
Remarks
LayerDrawn
This event is raised after a Layer is drawn.
Remarks
LayersDrawing
This event is raised before Layers are drawn.
Remarks
LayersDrawn
This event is raised after Layers are drawn.
Remarks
thinkgeo.mapsuite.core.mapengine.1442486082.txt.gz · Last modified: 2015/09/17 10:34 by admin
