This class is for generating maps.

• System.Object
  • ThinkGeo.MapSuite.Core.MapEngine

MapEngine()

Create a new instance of the MapEngine.

N/A

ZoomOut(Int32)

This method will update the CurrentExtent by using the ZoomOut operation.

None

• Type:Void
• Description:None.

• percentage
  • Type:Int32
  • Description:This parameter is the percentage by which you want to zoom.

ZoomOutToCenter(Int32,PointShape,Single,Single)

This method updates the CurrentExtent by using the ZoomOutToCenter operation.

The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:None.

• 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,Feature,Single,Single)

This method updates the CurrentExtent by using the ZoomOutToCenter operation.

The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:None.

• 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,Single,Single,Single,Single)

This method updates the CurrentExtent by using the ZoomOutToCenter operation.

The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:None.

• 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.

Pan(PanDirection,Int32)

Update the CurrentExtent by using a panning operation.

None

• Type:Void
• Description:None.

• 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.

None

• Type:Void
• Description:None.

• 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.

ToScreenCoordinate(Double,Double,Single,Single)

This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.

• 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(PointShape,Single,Single)

This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from the specified world coordinates, based on the CurrentExtent.

• 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.

ToScreenCoordinate(Feature,Single,Single)

This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from the specified world coordinate pointFeature, based on the CurrentExtent.

• 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.

ToWorldCoordinate(Single,Single,Single,Single)

This method returns world coordinates from screen coordinates, based on the CurrentExtent.

None

• Type:PointShape
• Description:This method returns world coordinates from screen coordinates, based on the CurrentExtent.

• 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.

None

• Type:PointShape
• Description:This method returns world coordinates from screen coordinates, based on the CurrentExtent.

• 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.

SnapToZoomLevel(GeographyUnit,Single,Single,ZoomLevelSet)

This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set.

None

• Type:Void
• Description:This method updates the CurrentExtent by snapping to a zoom level in the provided zoom level set.

• 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.

ZoomToScale(Double,GeographyUnit,Single,Single)

This method updates the CurrentExtent by zooming to a certain scale.

None

• Type:Void
• Description:N/A

• 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.

FindStaticFeatureLayer(String)

Finds a feature layer by key (specified in the “name” parameter) within the collection of StaticLayers.

N/A

• Type:FeatureLayer
• Description:The corresponding FeatureLayer with the specified key in the MapControl.

• name
  • Type:String
  • Description:The key to find the final result feature layer.

FindStaticRasterLayer(String)

Find the raster layer by key (specified in the “name” parameter) within the collection of StaticLayers.

N/A

• Type:RasterLayer
• Description:The corresponding RasterLayer with the passing specified in the MapControl.

• name
  • Type:String
  • Description:The key to find the final result raster layer.

FindDynamicFeatureLayer(String)

Find the feature layer by key (specified in the “name” parameter) within the collection of DynamicLayers.

N/A

• Type:FeatureLayer
• Description:The corresponding FeatureLayer with the specified key in the MapControl.

• name
  • Type:String
  • Description:The key to find the final result feature layer.

FindDynamicRasterLayer(String)

Find the raster layer by key (specified in the “name” parameter) within the collection of DynamicLayers.

N/A

• Type:RasterLayer
• Description:The corresponding RasterLayer with the specified key in the MapControl.

• name
  • Type:String
  • Description:The key to find the final result raster layer.

GetDrawingExtent(Single,Single)

This method returns an adjusted extent based on the ratio of the screen width and height.

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.

• Type:RectangleShape
• Description:This method returns an adjusted extent based on the ratio of the screen width and height.

• screenWidth
  • Type:Single
  • Description:This parameter is the width of the screen.

• screenHeight
  • Type:Single
  • Description:This parameter is the height of the screen.

OpenAllLayers()

This API allows you to open all of the layers (either static or dynamic).

N/A

• Type:Void
• Description:N/A

CloseAllLayers()

This API allows you close all of the layers (either static or dynamic).

N/A

• Type:Void
• Description:N/A

CenterAt(PointShape,Single,Single)

This is a function that allows you to pass a world point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates.

This API will update the CurrentExtent.

• Type:Void
• Description:None.

• 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(Feature,Single,Single)

This is a function that allows you to pass in a feature to center on, as well as a height and width in screen units. The function will center the CurrentExtent based on the specified feature and adjust its ratio based on the height and width in screen coordinates.

This API will update the CurrentExtent.

• Type:Void
• Description:None.

• 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(Single,Single,Single,Single)

This is a function that allows you to pass a screen point to center on and a height and width in screen units. The function will update the current extent by centering on the point and adjusting its ratio based on the height and width in screen coordinates.

This API will update the CurrentExtent.

• Type:Void
• Description:N/A

• 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.

GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape,Single,Single)

This method returns the number of pixels between two world points using the CurrentExtent as reference.

None

• Type:Single
• Description:This method returns the number of pixels between two world points.

• 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(Feature,Feature,Single,Single)

This method returns the number of pixels between two world points using the CurrentExtent as reference.

None

• Type:Single
• Description:This method returns the number of pixels between two world points.

• 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.

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.

None

• Type:Double
• Description:This method returns the distance in world units between two screen points.

• 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.

GetCurrentScale(Single,GeographyUnit)

Get the current Scale responding to the CurrentExtent.

N/A

• Type:Double
• Description:The calculated scale based on the CurrentExtent.

• 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.

Draw(IEnumerable<Layer>,GeoImage,GeographyUnit)

Draw a group of layers on the specified “background” image.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the target layers on the specified “background” image.

• 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.

Draw(IEnumerable<Layer>,Int32,Int32,GeographyUnit)

Draw a group of layers and return a new image with the specified width and height.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the target layers based on the specified width and height.

• 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.

DrawStaticLayers(GeoImage,GeographyUnit)

Draw a group of static layers on the specified “background” image.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of static layers on the specified “background” image.

• 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(GeoImage,GeographyUnit)

Draw a group of dynamic layers on the specified “background” image.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of dynamic layers on the specified “background” image.

• 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(GeoImage,GeographyUnit)

Draw a group of AdornmentLayers on the specified “background” image.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of AdornmentLayers on the specified “background” image.

• 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(Int32,Int32,GeographyUnit)

Draw a group of static layers and return a new image with the specified width and height.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of static layers based on the specified width and height.

• 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(Int32,Int32,GeographyUnit)

Draw a group of dynamic layers and return a new image with the specified width and height.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of dynamic layers based on the specified width and height.

• 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(Int32,Int32,GeographyUnit)

Draw a group of AdornmentLayers and return a new image with the specified width and height.

N/A

• Type:GeoImage
• Description:The resulting image after drawing the group of AdornmentLayers based on the specified width and height.

• 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>,Bitmap,GeographyUnit)

Draw a group of layers on the specified “background” bitmap.

N/A

• Type:Bitmap
• Description:The resulting bitmap after drawing the target layers on the specified “background” bitmap.

• 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.

DrawStaticLayers(Bitmap,GeographyUnit)

Draw a group of static layers on the specified “background” bitmap.

N/A

• Type:Bitmap
• Description:The resulting bitmap after drawing the group of static layers on the specified “background” bitmap.

• 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(Bitmap,GeographyUnit)

Draw a group of dynamic layers on the specified “background” bitmap.

N/A

• Type:Bitmap
• Description:The resulting bitmap after drawing the group of dynamic layers on the specified “background” bitmap.

• 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(Bitmap,GeographyUnit)

Draw a group of AdornmentLayers on the specified “background” bitmap.

N/A

• Type:Bitmap
• Description:The resulting bitmap after drawing the group of AdornmentLayers on the specified “background” bitmap.

• 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.

ZoomIn(Int32)

This method updates the CurrentExtent that is zoomed in by the percentage provided.

None

• Type:Void
• Description:This method updates the CurrentExtent that is zoomed in by the percentage provided.

• percentage
  • Type:Int32
  • Description:This parameter is the percentage by which you want to zoom in.

ZoomIntoCenter(Int32,PointShape,Single,Single)

This method will update the CurrentExtent by using the ZoomIntoCenter operation.

The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:None.

• 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(Int32,Feature,Single,Single)

This method returns an extent that is centered and zoomed in.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:This method returns an extent that is centered and zoomed in.

• 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,Single,Single,Single,Single)

This method updates the CurrentExtent based on a calculated rectangle that is centered and zoomed in.

The CurrentExtent will be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:Void
• Description:None.

• 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.

ToString()

N/A

N/A

• Type:String
• Description:N/A

Equals(Object)

N/A

N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

N/A

N/A

• Type:Int32
• Description:N/A

GetType()

N/A

N/A

• Type:Type
• Description:N/A

ZoomOut(RectangleShape,Int32)

This method returns a new extent that is zoomed out by the percentage provided.

None

• Type:RectangleShape
• Description:This method returns a new extent that is zoomed out by the percentage provided.

• 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.

ZoomOutToCenter(RectangleShape,Int32,PointShape,Single,Single)

This method returns an extent that is centered and zoomed out.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:RectangleShape
• Description:This method returns an extent that is centered and zoomed out.

• 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(RectangleShape,Int32,Feature,Single,Single)

This method returns an extent that is centered and zoomed out.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:RectangleShape
• Description:This method returns an extent that is centered and zoomed out.

• 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,Single,Single,Single,Single)

This method returns an extent that is centered and zoomed out.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:RectangleShape
• Description:This method returns an extent that is centered and zoomed out.

• 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.

Pan(RectangleShape,PanDirection,Int32)

This method returns a panned extent.

None

• Type:RectangleShape
• Description:This method returns a panned extent.

• 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(RectangleShape,Single,Int32)

This method returns a panned extent.

None

• Type:RectangleShape
• Description:This method returns a panned extent.

• 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.

ToScreenCoordinate(RectangleShape,Double,Double,Single,Single)

This method returns screen coordinates from world coordinates.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from world coordinates.

• 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.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from world coordinates.

• 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.

None

• Type:ScreenPointF
• Description:This method returns screen coordinates from world coordinates.

• 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.

ToWorldCoordinate(RectangleShape,Single,Single,Single,Single)

This method returns world coordinates from screen coordinates.

None

• Type:PointShape
• Description:This method returns world coordinates from screen coordinates.

• 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.

None

• Type:PointShape
• Description:This method returns world coordinates from screen coordinates.

• 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.

SnapToZoomLevel(RectangleShape,GeographyUnit,Single,Single,ZoomLevelSet)

This method returns an extent that is snapped to a zoom level in the provided zoom level set.

None

• Type:RectangleShape
• Description:This method returns an extent that is snapped to a zoom level in the provided zoom level set.

• 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.

ZoomToScale(Double,RectangleShape,GeographyUnit,Single,Single)

This method returns a extent that has been zoomed into a certain scale.

None

• Type:RectangleShape
• Description:This method returns a extent that has been zoomed into a certain scale.

• 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.

GetVersion()

Get the current MapSuiteCore.dll file version.

N/A

• Type:String
• Description:A string representing the file version of MapSuiteCore.dll.

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.

N/A

• Type:DataTable
• Description:A DateTable of information about those passed-in features and the returning columnNames.

• 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.

GetDrawingExtent(RectangleShape,Single,Single)

This method returns an adjusted extent based on the ratio of the screen width and height.

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.

• Type:RectangleShape
• Description:This method returns an adjusted extent based on the ratio of the screen width and height.

• 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.

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.

None

• Type:RectangleShape
• Description:This method returns an adjusted extent centered on a point.

• 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.

None

• Type:RectangleShape
• Description:This method returns an adjusted extent centered on a point.

• 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.

None

• Type:RectangleShape
• Description:This method returns an adjusted extent centered on a point.

• 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.

GetScreenDistanceBetweenTwoWorldPoints(RectangleShape,PointShape,PointShape,Single,Single)

This method returns the number of pixels between two world points.

None

• Type:Single
• Description:This method returns the number of pixels between two world points.

• 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(RectangleShape,Feature,Feature,Single,Single)

This method returns the number of pixels between two world points.

None

• Type:Single
• Description:This method returns the number of pixels between two world points.

• 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.

GetWorldDistanceBetweenTwoScreenPoints(RectangleShape,ScreenPointF,ScreenPointF,Single,Single,GeographyUnit,DistanceUnit)

This method returns the distance in world units between two screen points.

None

• Type:Double
• Description:This method returns the distance in wold units between two screen points.

• 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.

N/A

• Type:Double
• Description:N/A

• 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.

GetCurrentScale(RectangleShape,Single,GeographyUnit)

This Static API is used to calculate the scale based on the specified worldExtent and its corresponding ScreenWidth and MapUnit.

N/A

• Type:Double
• Description:N/A

• 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.

GetBoundingBoxOfItems(IEnumerable<BaseShape>)

This API gets the BoundingBox of a group of BaseShapes.

N/A

• Type:RectangleShape
• Description:The BoundingBox that contains all the shapes you passed in.

• shapes
  • Type:IEnumerable<BaseShape>
  • Description:The target group of BaseShapes to get the BoundingBox for.

GetBoundingBoxOfItems(IEnumerable<Feature>)

This API gets the BoundingBox of a group of Features.

N/A

• Type:RectangleShape
• Description:The BoundingBox that contains all the features you passed in.

• features
  • Type:IEnumerable<Feature>
  • Description:The target group of Features to get the BoundingBox for.

ZoomIn(RectangleShape,Int32)

This method returns a new extent that is zoomed in by the percentage provided.

None

• Type:RectangleShape
• Description:This method returns a new extent that is zoomed in by the percentage provided.

• 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.

ZoomIntoCenter(RectangleShape,Int32,PointShape,Single,Single)

This method returns an extent that is centered and zoomed in.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:RectangleShape
• Description:This method returns an extent that is centered and zoomed in.

• 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,Feature,Single,Single)

This method returns a new extent that is zoomed in by the percentage provided.

None

• Type:RectangleShape
• Description:This method returns a new extent that is zoomed in by the percentage provided.

• 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.

ZoomIntoCenter(RectangleShape,Int32,Single,Single,Single,Single)

This method returns an extent that is centered and zoomed in.

The resulting rectangle will already be adjusted for the ratio of the screen. You do not need to call GetDrawingExtent afterwards.

• Type:RectangleShape
• Description:This method returns an extent that is centered and zoomed in.

• 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.

OnAdornmentLayersDrawing(AdornmentLayersDrawingEventArgs)

This event is raised before AdornmentLayers are drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:AdornmentLayersDrawingEventArgs
  • Description:The AdornmentLayersDrawingEventArgs passed for the event raised.

OnAdornmentLayersDrawn(AdornmentLayersDrawnEventArgs)

This event is raised after AdornmentLayers are drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:AdornmentLayersDrawnEventArgs
  • Description:The AdornmentLayersDrawnEventArgs passed for the event raised.

OnAdornmentLayerDrawing(AdornmentLayerDrawingEventArgs)

This event is raised before an AdornmentLayer is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:AdornmentLayerDrawingEventArgs
  • Description:The AdornmentLayerDrawingEventArgs passed for the event raised.

OnAdornmentLayerDrawn(AdornmentLayerDrawnEventArgs)

This event is raised after an AdornmentLayer is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:AdornmentLayerDrawnEventArgs
  • Description:The AdornmentLayerDrawnEventArgs passed for the event raised.

OnLayersDrawing(LayersDrawingEventArgs)

This event is raised before Layers are drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:LayersDrawingEventArgs
  • Description:The LayersDrawingEventArgs passed for the event raised.

OnLayersDrawn(LayersDrawnEventArgs)

This event is raised after Layers are drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:LayersDrawnEventArgs
  • Description:The LayersDrawnEventArgs passed for the event raised.

OnLayerDrawing(LayerDrawingEventArgs)

This event is raised before a Layer is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:LayerDrawingEventArgs
  • Description:The LayerDrawingEventArgs passed for the event raised.

OnLayerDrawn(LayerDrawnEventArgs)

This event is raised after a Layer is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:LayerDrawnEventArgs
  • Description:The LayerDrawnEventArgs passed for the event raised.

Finalize()

N/A

N/A

• Type:Void
• Description:N/A

MemberwiseClone()

N/A

N/A

• Type:Object
• Description:N/A

Canvas

Gets and sets the GeoCanvas used to draw the Layers.

N/A

• Type:GeoCanvas

ShowLogo

This property specifies whether the logo is shown on the Map or not.

N/A

• Type:Boolean

AdornmentLayers

This property holds a collection of AdornmentLayers to be drawn on the MapEngine.

This collection of Layers StaticLayers will be drawn when calling the DrawAdornmentLayers API.

• Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]

CurrentExtent

This property gets or sets the current extent of the MapEngine.

The current extent is the rectangle that is currently being shown on the MapEngine.

• Type:RectangleShape

StaticLayers

This property holds a group of Layers to be drawn on the MapEngine.

This collection of Layers StaticLayers will be drawn when calling the DrawStaticLayers API.

• Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]

DynamicLayers

This property holds a group of Layers to be drawn on the MapEngine.

This collection of Layers StaticLayers will be drawn when calling the DrawDynamicLayers API.

• Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]

BackgroundFillBrush

Gets or sets the GeoBrush for the background of the MapEngine.

N/A

• Type:GeoBrush

LayersDrawing This event is raised before Layers are drawn.

N/A

Event Arguments:LayersDrawingEventArgs

LayersDrawn This event is raised after Layers are drawn.

N/A

Event Arguments:LayersDrawnEventArgs

LayerDrawing This event is raised before a Layer is drawn.

N/A

Event Arguments:LayerDrawingEventArgs

LayerDrawn This event is raised after a Layer is drawn.

N/A

Event Arguments:LayerDrawnEventArgs

AdornmentLayersDrawing This event is raised before AdornmentLayers are drawn.

N/A

Event Arguments:AdornmentLayersDrawingEventArgs

AdornmentLayersDrawn This event is raised after AdornmentLayers are drawn.

N/A

Event Arguments:AdornmentLayersDrawnEventArgs

AdornmentLayerDrawing This event is raised before an AdornmentLayer is drawn.

N/A

Event Arguments:AdornmentLayerDrawingEventArgs

AdornmentLayerDrawn This event is raised after an AdornmentLayer is drawn.

N/A

Event Arguments:AdornmentLayerDrawnEventArgs