User Tools

Site Tools

Trace:

Sidebar

Products

Professional Services

Demos and Downloads

Help and Support

thinkgeo.mapsuite.iosedition.overlay

This is an old revision of the document!

Table of Contents

ThinkGeo.MapSuite.iOSEdition.Overlay

<!– Class –> This class is the base class of all overlays in this overlay system.

Remarks

The <strong>Overlay</strong> has the similar concept as the layer. Different types of overlays stack over each other to form a map. An overlay object is responsible for getting the configuration infomation from the user.

Usually an overlay represents an image with transparent background that is laid upon other overlay such as <strong>LayerOverlay</strong>, <strong>WmsOverlay</strong>. While the <strong>MarkerOverlay</strong> will not be rendered as an image, it is actually represents a control that holds bunch of marker images on the map.

Inheritance Hierarchy

*System.Object ThinkGeo.MapSuite.iOSEdition.Overlay *ThinkGeo.MapSuite.iOSEdition.AdornmentOverlay *ThinkGeo.MapSuite.iOSEdition.BingMapsTileOverlay *ThinkGeo.MapSuite.iOSEdition.EditInteractiveOverlay *ThinkGeo.MapSuite.iOSEdition.ExtentInteractiveOverlay *ThinkGeo.MapSuite.iOSEdition.GoogleMapsTileOverlay *ThinkGeo.MapSuite.iOSEdition.InteractiveOverlay *ThinkGeo.MapSuite.iOSEdition.LayerOverlay *ThinkGeo.MapSuite.iOSEdition.MarkerOverlay *ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay *ThinkGeo.MapSuite.iOSEdition.OpenStreetMapTileOverlay *ThinkGeo.MapSuite.iOSEdition.PopupOverlay *ThinkGeo.MapSuite.iOSEdition.TileOverlay *ThinkGeo.MapSuite.iOSEdition.TrackInteractiveOverlay *ThinkGeo.MapSuite.iOSEdition.WmsOverlay *ThinkGeo.MapSuite.iOSEdition.WorldMapKitOverlay

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary
Protected MethodOverlay Initializes a new instance of the class.

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Closes this instance.
Public MethodDispose Disposes this instance.
Public MethodDraw MapArguments, OverlayRefreshType This method draws the overlay by the specified arguments.
Public MethodEquals Object Object
Public MethodGetBoundingBox Gets the bounding box.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodInitialize MapArguments Initializes the specified map arguments.
Public MethodPostTransform TransformArguments, MapArguments Posts the transform for the overlay.
Public MethodRefresh Refreshes this instance.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Closes the core.
Protected MethodDispose Boolean Releases unmanaged and - optionally - managed resources.
Protected MethodDrawCore MapArguments, OverlayRefreshType This method draws the overlay by the specified arguments.
Protected MethodDrawException GeoCanvas, Exception Draws the exception.
Protected MethodDrawExceptionCore GeoCanvas, Exception Draws the exception core.
Protected MethodFinalize Object(overriden)
Protected MethodGetBoundingBoxCore Gets the bounding box core.
Protected MethodInitializeCore MapArguments Initializes the core.
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingException DrawingExceptionOverlayEventArgs Handles the event.
Protected MethodOnDrawnException DrawnExceptionOverlayEventArgs Handles the event.
Protected MethodPostTransformCore TransformArguments, MapArguments Posts the transform for the overlay.
Protected MethodRefreshCore Refreshes the core.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Gets or sets the attribution.
Public PropertyDrawingExceptionMode DrawingExceptionMode This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingQuality DrawingQuality Gets or sets the drawing quality.
Public PropertyIsEmpty Boolean Gets a value indicating whether this instance is empty.
Public PropertyIsVisible Boolean Gets or sets a value indicating whether this instance is visible.
Public PropertyMapArguments MapArguments Gets or sets the map arguments.
Public PropertyName String Gets or sets the name.
Public PropertyOpacity Double Gets or sets the opacity.
Public PropertyOverlayView UIView Gets or sets the overlay view.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary
Public EventDrawingException DrawingExceptionOverlayEventArgs This event raises when exception.
Public EventDrawnException DrawnExceptionOverlayEventArgs This event raises when exception.

Public Constructors

Protected Constructors

Overlay()

Initializes a new instance of the class.

Parameters

Name Type Description

Go Back

Public Methods

Close()

Closes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Dispose()

Disposes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Draw(MapArguments, OverlayRefreshType)

This method draws the overlay by the specified arguments.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> This parameter indicates an mapArguments to draw the overlay.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType –> This parameter indicates whether this overlay needs to be refresh or not.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetBoundingBox()

Gets the bounding box.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> A RectangleShape value for the overlay.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Initialize(MapArguments)

Initializes the specified map arguments.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map arguments.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

PostTransform(TransformArguments, MapArguments)

Posts the transform for the overlay.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.iOSEdition.TransformArguments –> The transform information.
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map arguments.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Refresh()

Refreshes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloseCore()

Closes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
isDisposing Boolean<!– System.Boolean –> true to release both managed and unmanaged resources; false to release only unmanaged resources.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawCore(MapArguments, OverlayRefreshType)

This method draws the overlay by the specified arguments.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> This parameter indicates an mapArguments to draw the overlay.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType –> This parameter indicates whether this overlay needs to be refresh or not.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawException(GeoCanvas, Exception)

Draws the exception.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The geo canvas.
exception Exception<!– System.Exception –> The exception.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawExceptionCore(GeoCanvas, Exception)

Draws the exception core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The geo canvas.
ex Exception<!– System.Exception –> The ex.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

GetBoundingBoxCore()

Gets the bounding box core.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> RectangleShape.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

InitializeCore(MapArguments)

Initializes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArgument MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map argument.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingException(DrawingExceptionOverlayEventArgs)

Handles the event.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

OnDrawnException(DrawnExceptionOverlayEventArgs)

Handles the event.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

PostTransformCore(TransformArguments, MapArguments)

Posts the transform for the overlay.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.iOSEdition.TransformArguments –> The transform information.
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map arguments.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

RefreshCore()

Refreshes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Public Properties

Attribution

Gets or sets the attribution.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

Return Value

Return Type
DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawingQuality

Gets or sets the drawing quality.

Return Value

Return Type
DrawingQuality<!– ThinkGeo.MapSuite.Core.DrawingQuality –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

IsEmpty

Gets a value indicating whether this instance is empty.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

IsVisible

Gets or sets a value indicating whether this instance is visible.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

MapArguments

Gets or sets the map arguments.

Return Value

Return Type
MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Name

Gets or sets the name.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Opacity

Gets or sets the opacity.

Return Value

Return Type
Double<!– System.Double –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

OverlayView

Gets or sets the overlay view.

Return Value

Return Type
UIView<!– MonoTouch.UIKit.UIView –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Protected Properties

Public Events

DrawingException

This event raises when exception.

Event Arguments

Event Arguments
DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawnException

This event raises when exception.

Event Arguments

Event Arguments
DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

NOTOC iOSEdition ThinkGeo.MapSuite.iOSEdition UpdateDocumentation

thinkgeo.mapsuite.iosedition.overlay.1440040131.txt.gz · Last modified: 2015/09/21 08:34 (external edit)

Page Tools