====== ThinkGeo.MapSuite.WebEdition.LayerOverlay ======

{{section>upgrade_map_suite_to_10.0}}

Represents an Overlay that contains layers.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.WebEdition.Overlay
      ***ThinkGeo.MapSuite.WebEdition.LayerOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} LayerOverlay() **

  * //Initialize an instance of the LayerOverlay class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} LayerOverlay(String) **

  * //Initialize an instance of the LayerOverlay class with the overlay identifier specified.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28String.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used to retrieve the overlay for collection.

<div newline></div>
** {{wiki:PublicMethod.gif|}} LayerOverlay(String,Boolean,TileType) **

  * //Initialize an instance of the LayerOverlay class with the overlay identifier, IsBaseOverlay boolean value and the value indicating whether to use tiling.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28String.2C_Boolean.2C_TileType.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used to retrieve the overlay for collection.

  * //isBaseOverlay//
    * Type:Boolean
    * Description:A boolean value that indicates whether this overlay is a base overlay.

  * //tileType//
    * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]
    * Description:The TileType that indicates whether this overlay uses tiling.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) **

  * //Sets the EPSG projection of the LayerOverlay when it is a base overlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#SetBaseEpsgProjection.28String.29//

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

== Parameters ==
  * //epsgProjection//
    * Type:String
    * Description:A string that represents the projection of the LayerOverlay.

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

  * //Returns an EPSG string that indicates the projection of the LayerOverlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetBaseEpsgProjection.28.29//

== Return Value ==
  * Type:String
  * Description:An EPSG string that indicates the projection of the LayerOverlay.

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

  * //Gets the smallest extent that includes all of the features of all layers in the LayerOverlay.//
== Remarks ==
  * //If you have several layers, with one justified up and to the right and another justified down and to the left, this method will combine all of the current extents to make one composite extent.//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * Description:The smallest extent that includes all of the features of all layers in the LayerOverlay.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Object,RectangleShape,GeographyUnit) **

  * //Draw all of the layers to the image object using the parameters specified.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Draw.28GeoCanvas.2C_Object.2C_RectangleShape.2C_GeographyUnit.29//

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

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:The GeoCanvas object that the layers will draw on.

  * //nativeImage//
    * Type:Object
    * Description:The image object to which all of the layers will be drawn. Usually it is a bitmap.

  * //canvasExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent in which the features of the layers will be drawn.

  * //mapUnit//
    * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
    * Description:The geographic unit that the map will use to draw.

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

  * //Redraw this overlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Redraw.28.29//

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

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GenerateCacheImages(ZoomLevel,RectangleShape,GeographyUnit) **

  * //Generates images to the server cache by zoomLevel.//
== Remarks ==
  * //This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.//

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

== Parameters ==
  * //zoomLevel//
    * Type:[[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]
    * Description:The zoomlevel at which the images will be generated.

  * //cacheExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent of the region for which the cached images will be generated.

  * //mapUnit//
    * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
    * Description:The unit of map.

<div newline></div>
** {{wiki:PublicMethod.gif|}} GenerateCacheImages(Double,RectangleShape,GeographyUnit) **

  * //Generates the images to the server cache by scale.//
== Remarks ==
  * //This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.//

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

== Parameters ==
  * //scale//
    * Type:Double
    * Description:The scale that is used to calculate the coordinates of the images.

  * //cacheExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent of the region for which the cache images will be generated.

  * //mapUnit//
    * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
    * Description:The unit of map.

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

  * //Returns a JSON string which contains the information for creating an overlay at the client side.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ToJson.28.29//

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ToString.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Equals.28Object.29//

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetHashCode.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetType.28.29//

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

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Object,RectangleShape,GeographyUnit) **

  * //Draw all of the layers to the image object using the parameters specified.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#DrawCore.28GeoCanvas.2C_Object.2C_RectangleShape.2C_GeographyUnit.29//

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

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:The GeoCanvas object that the layers will draw on.

  * //nativeImage//
    * Type:Object
    * Description:The image object to which all of the layers will be drawn. Usually it is a bitmap.

  * //canvasExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The extent in which the features of the layers will be drawn.

  * //mapUnit//
    * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
    * Description:The geographic unit that the map will use to draw.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 3xM=(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 <strong>RegisterJavaScriptLibraryCore</strong> 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|}} RaiseTickEvent(EventArgs) **

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

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

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:N/A

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

  * //Raises the Tick event of the MarkerOverlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OnTick.28EventArgs.29//

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

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:An System.EventArgs object that contains the event data.

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Finalize.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#MemberwiseClone.28.29//

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

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

Gets or sets the width of each tile if the layer is in MultipleTile mode.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileWidth
== Return Value ==
  * Type:Int32

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

Gets or sets the height of each tile if the layer is in MultipleTile mode.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileHeight
== Return Value ==
  * Type:Int32

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

Gets or sets the transition effect to use when the map is zoomed.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TransitionEffect
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]]

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

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:
== Return Value ==
  * Type:Int32

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

Gets or sets whether or not the LayerOverlay uses tiling.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#LayerOverlay.28String.2C_Boolean.2C_TileType.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]

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

Gets or sets the number of extra rows and colums of tiles on each side that will surround the minimum grid tiles to cover the map. Used only when in MultipleTile mode.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#TileMargin
== Return Value ==
  * Type:Int32

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

Gets or sets the server cache in the overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ServerCache
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.ServerCache|ServerCache]]

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

Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ClientCache
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.ClientCache|ClientCache]]

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

Gets or sets the format of the image that is sent to the web browser.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WebImageFormat
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]]

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

Gets or sets the quality of the JPEG image that is sent to the web browser. Valid values are between 1 - 100, inclusive.
== Remarks ==
The <strong>JpegQuality</strong> property determines the quality of the JPEG image that is sent to the browser if the WebImageFormat is Jpeg. Setting this property to a lower value will reduce the image filesize. The value must be between 1 - 100. The default is 100.
== Return Value ==
  * Type:Int32

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

Gets or sets whether the multi-thread is disabled or not.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsMultiThreadDisabled
== Return Value ==
  * Type:Boolean

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

Gets a GeoCollection that contains the layers that will draw on the image that is sent to the browser.
== Remarks ==
The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw with specified styles to the image that will be sent to the browser.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]]

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

Gets or sets a value that indicates whether the overlay is visible on the map.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsVisible
== Return Value ==
  * Type:Boolean

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

Gets or sets a value that indicates whether the overlay wraps at the date line.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#WrapDateline
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]]

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

Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Name
== Return Value ==
  * Type:String

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

Gets or sets the opacity level of the overlay.
== Remarks ==
The <strong>Opacity</strong> 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 ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsVisibleInOverlaySwitcher
== Return Value ==
  * Type:Boolean

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

Gets or sets a value that indicates whether the overlay is a base overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#IsBaseOverlay
== Return Value ==
  * Type:Boolean

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

Gets the identifier for the overlay to be found.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Id
== Return Value ==
  * Type:String

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

Gets or sets the time interval in which the MarkerOverlay refreshes itself.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#AutoRefreshInterval
== Return Value ==
  * Type:TimeSpan

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

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#Attribution
== Return Value ==
  * Type:String

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

Gets a string that indicates the overlay type.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OverlayType
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} ExtraParameter **

Gets or sets extra parameters for current overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#ExtraParameter
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} Projection **

Gets or sets projection of current overlay for requesting images.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#GetBaseEpsgProjection.28.29
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} HasTickEvent **

Indicates whether the overlay supports tick event.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#HasTickEvent
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} 3hM= **

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

==== Public Events ====
** {{wiki:PublicEvent.gif|}} Tick **
Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.LayerOverlay#OnTick.28EventArgs.29

Event Arguments:EventArgs