====== ThinkGeo.MapSuite.MvcEdition.Overlay ======

{{section>upgrade_map_suite_to_10.0}}

Serves as the base class that defines the properties and methods shared by all types of overlays.
===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.MvcEdition.Overlay**
      *[[ThinkGeo.MapSuite.MvcEdition.WmtsOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.MarkerOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.GoogleOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.FeatureOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.LayerOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.BingMapsOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.WmsOverlay]]
      *[[ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} Overlay() **

  * //Initialize an instance of the Overlay class.//
== Remarks ==
  * //N/A//
== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Overlay(String) **

  * //Initialize an instance of the Overlay class.//
== Remarks ==
  * //N/A//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

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

  * //Initialize an instance of the Overlay class.//
== Remarks ==
  * //N/A//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

  * //isBaseOverlay//
    * Type:Boolean
    * Description:N/A

<div newline></div>
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} ToJson() **

  * //Returns a JSON string which contains the information for creating an overlay at the client side.//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:String
  * Description:A JSON string which is used to create an overlay at the client side.

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

  * //Load this object from a json string.//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //jsonString//
    * Type:String
    * Description:a json string

<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|}} EhQ=(Page) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //page//
    * Type:Page
    * Description:N/A

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

  * //Registers a Javascript library URL string to the client HTML page.//
== Remarks ==
  * //The RegisterJavaScriptLibraryCore method allows derived classes to override and register their own Javascript library URL to the HTML page.//

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

== Parameters ==
  * //page//
    * Type:Page
    * Description:The page object that is used for registering the javascript library.

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

Gets or sets a value that indicates whether the overlay is visible on the map.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

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

Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
== Remarks ==
N/A
== Return Value ==
  * Type:String

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

Gets or sets the opacity level of the overlay.
== Remarks ==
The Opacity property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent (1.00), the entire overlay is made more transparent. The lower the value, the more transparent it is.  Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible.
== Return Value ==
  * Type:Single

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

Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

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

Gets or sets a value that indicates whether the overlay is a base overlay.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

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

Gets the identifier for the overlay to be found.
== Remarks ==
N/A
== Return Value ==
  * Type:String

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

Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.
== Remarks ==
N/A
== Return Value ==
  * Type:String

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

Gets or sets the time interval in which the MarkerOverlay refreshes itself.
== Remarks ==
N/A
== Return Value ==
  * Type:TimeSpan

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

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

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} OverlayType **

Gets a string that indicates which type the overlay is.
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} ERQ= **

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

==== Public Events ====