====== ThinkGeo.MapSuite.iOSEdition.Overlay ======

{{section>upgrade_map_suite_to_10.0}}

This class is the base class of all overlays in this overlay system.
===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.iOSEdition.Overlay**
      *[[ThinkGeo.MapSuite.iOSEdition.AdornmentOverlay]]
      *[[ThinkGeo.MapSuite.iOSEdition.TileOverlay]]
      *[[ThinkGeo.MapSuite.iOSEdition.InteractiveOverlay]]
      *[[ThinkGeo.MapSuite.iOSEdition.MarkerOverlay]]
      *[[ThinkGeo.MapSuite.iOSEdition.PopupOverlay]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} Overlay() **

Initializes a new instance of the  class.
== Remarks ==
N/A
== Parameters ==
<div newline></div>
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,BufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,BufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan,BufferTimeType) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RemoveAllAnimations() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetBoundingBox() **

Gets the bounding box.
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * Description:A RectangleShape value for the overlay.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) **

Initializes the specified map arguments.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:The map arguments.

<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh() **

Refreshes this instance.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(MapArguments,OverlayRefreshType) **

This method draws the overlay by the specified arguments.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:This parameter indicates an mapArguments to draw the overlay.

  * //refreshType//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType|OverlayRefreshType]]
    * Description:This parameter indicates whether this overlay needs to be refresh or not.

<div newline></div>
** {{wiki:PublicMethod.gif|}} PostTransform(TransformArguments,MapArguments) **

Posts the transform for the overlay.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //transformInfo//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.TransformArguments|TransformArguments]]
    * Description:The transform information.

  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:The map arguments.

<div newline></div>
** {{wiki:PublicMethod.gif|}} Close() **

Closes this instance.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Dispose() **

Disposes this instance.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} RemoveAllAnimationCore() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **

Gets the bounding box core.
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * Description:RectangleShape.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RefreshCore() **

Refreshes the core.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawCore(MapArguments,OverlayRefreshType) **

This method draws the overlay by the specified arguments.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:This parameter indicates an mapArguments to draw the overlay.

  * //refreshType//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType|OverlayRefreshType]]
    * Description:This parameter indicates whether this overlay needs to be refresh or not.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} PostTransformCore(TransformArguments,MapArguments) **

Posts the transform for the overlay.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //transformInfo//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.TransformArguments|TransformArguments]]
    * Description:The transform information.

  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:The map arguments.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloseCore() **

Closes the core.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} InitializeCore(MapArguments) **

Initializes the core.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //mapArgument//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:The map argument.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **

Draws the exception.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //geoCanvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:The geo canvas.

  * //exception//
    * Type:Exception
    * Description:The exception.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **

Draws the exception core.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //geoCanvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:The geo canvas.

  * //ex//
    * Type:Exception
    * Description:The ex.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionOverlayEventArgs) **

Handles the  event.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]
    * Description:The  instance containing the event data.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionOverlayEventArgs) **

Handles the  event.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]
    * Description:The  instance containing the event data.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) **

Releases unmanaged and - optionally - managed resources.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //disposing//
    * Type:Boolean
    * Description:true to release both managed and unmanaged resources; false to release only unmanaged resources.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} PrepareInertialPanInternal(RectangleShape,RectangleShape,MapArguments) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //currentExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //velocityExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} PrepareInertialPan(RectangleShape,RectangleShape,MapArguments) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //currentExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //velocityExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //mapArguments//
    * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:TimeSpan

** {{wiki:PublicProperty.gif|}} Name **

Gets or sets the name.
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]

** {{wiki:PublicProperty.gif|}} IsVisible **

Gets or sets a value indicating whether this instance is visible.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} IsEmpty **

Gets a value indicating whether this instance is empty.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Attribution **

Gets or sets the attribution.
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} OverlayView **

Gets or sets the overlay view.
== Remarks ==
N/A
== Return Value ==
  * Type:UIView

** {{wiki:PublicProperty.gif|}} DrawingQuality **

Gets or sets the drawing quality.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]]

** {{wiki:PublicProperty.gif|}} Opacity **

Gets or sets the opacity.
== Remarks ==
N/A
== Return Value ==
  * Type:Double

** {{wiki:PublicProperty.gif|}} MapArguments **

Gets or sets the map arguments.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.iOSEdition.MapArguments|MapArguments]]

** {{wiki:PublicProperty.gif|}} CanRefreshRegion **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

==== Protected Properties ====
==== Public Events ====
** {{wiki:PublicEvent.gif|}} DrawingException **
This event raises when [drawing exception].
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} DrawnException **
This event raises when [drawn exception].
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]