Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.webedition.overlay [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.webedition.overlay [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.WebEdition.Overlay ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 Serves as the base class that defines the properties and methods shared by all types of overlays.
-=== Remarks ===
-The &lt;strong&gt;Overlay&lt;/strong&gt; has as similar concept to the Layer. Different types of overlays stack over each other to form a map. An overlay object is responsible for getting the configuration information from the user and serializing it to a JSON string to control the client Javascript library, which creates the appropriate client layer.Usually, an overlay represents an image with a transparent background that is laid upon other overlay, such as a &lt;strong&gt;LayerOverlay&lt;/strong&gt; or &lt;strong&gt;WmsOverlay&lt;/strong&gt;. While the &lt;strong&gt;MarkerOverlay&lt;/strong&gt; will not be rendered as an image, it actually represents a &lt;strong&gt;div&lt;/strong&gt; that holds several marker images at the client side.There are basically two kinds of overlays: base overlays and non-base overlays.A base overlay has its &lt;strong&gt;IsBaseOverlay&lt;/strong&gt; property set to true. It is displayed as the background image of the map. In an &lt;strong&gt;OverlaySwitcher&lt;/strong&gt;, there is a radio button beside its name. There can be only one base overlay displayed at a time. You can click the radio button to switch the base overlay that is displayed.A non-base overlay has a false &lt;strong&gt;IsBaseOverlay&lt;/strong&gt; property. These overlays can overlap the base overlay and/or each other. They are displayed in the &lt;strong&gt;OverlaySwitcher&lt;/strong&gt; with a check box beside their name. You can click the check box to show or hide a specific overlay.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.WebEdition.Overlay]]
+    ***ThinkGeo.MapSuite.WebEdition.Overlay**
-***[[ThinkGeo.MapSuite.WebEdition.AdornmentOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.AdornmentOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.BingMapsOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.BingMapsOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.EditFeatureOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.FeatureOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.FeatureOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.MarkerOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.GoogleOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.WmtsOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.InMemoryMarkerOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.GoogleOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.LayerOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.LayerOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.MarkerOverlay]]
+      *[[ThinkGeo.MapSuite.WebEdition.WmsOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.OpenStreetMapOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.SimpleMarkerOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.WmsOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.WmtsOverlay]]
-***[[ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay]]
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:ProtectedMethod.gif|}} Overlay() **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Overlay()|Overlay]]   |    |    | Initialize an instance of the Overlay class.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Overlay(String)|Overlay]]   | String   |    | Initialize an instance of the Overlay class.   |
+Initialize an instance of the Overlay class.
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Overlay(String, Boolean)|Overlay]]   | String, Boolean   |    | 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 ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ToJson() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]]   |    |    | Returns a JSON string which contains the information for creating an overlay at the client side.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+Returns a JSON string which contains the information for creating an overlay at the client side.
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+N/A
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnTick(EventArgs)|OnTick]]   | EventArgs   |    | Raises the Tick event of the MarkerOverlay.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]]   | Page   |    | Registers a Javascript library URL string to the client HTML page.   |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]]   | String   |    |    |
+  * Description:A JSON string which is used to create an overlay at the client side.
-| {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]]   | TimeSpan   |    | Gets or sets the time interval in which the MarkerOverlay refreshes itself.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]]   | String   |    | Gets the identifier for the overlay to be found.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsBaseOverlay|IsBaseOverlay]]   | Boolean   |    | Gets or sets a value that indicates whether the overlay is a base overlay.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   |    | Gets or sets a value that indicates whether the overlay is visible on the map.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]]   | Boolean   |    | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   |    | Gets or sets the name of the overlay, which will display in the OverlaySwitcher.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]]   | Single   |    | Gets or sets the opacity level of the overlay.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#HasTickEvent|HasTickEvent]]   | Boolean   |    | Indicates whether the overlay supports tick event.   |
+** {{wiki:PublicMethod.gif|}} ToString() **
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]]   | String   |    | Gets a string that indicates which type the overlay is.   |
-==== Public Events ====
+N/A
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicEvent.gif|Public Event}}[[#Tick|Tick]]   | EventArgs   |    | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.   |
+N/A
-===== Public Constructors =====
+== Return Value ==
-===== Protected Constructors =====
+  * Type:String
-==== Overlay() ====
+  * Description:N/A
-Initialize an instance of the Overlay class.
-=== Overloads ===
-Initialize an instance of the Overlay class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Constructors|Go Back]]
+== Parameters ==
-==== Overlay(String) ====
+<div newline></div>
-Initialize an instance of the Overlay class.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-=== Overloads ===
-Initialize an instance of the Overlay class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28String.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   |    |
-[[#Protected Constructors|Go Back]]
+N/A
-==== Overlay(String, Boolean) ====
+== Remarks ==
-Initialize an instance of the Overlay class.
+N/A
-=== Overloads ===
-Initialize an instance of the Overlay class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28String.2C_Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Overlay.28String.2C_Boolean.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   |    |
-| isBaseOverlay   | Boolean<!-- System.Boolean -->   |    |
-[[#Protected Constructors|Go Back]]
+== Return Value ==
-===== Public Methods =====
+  * Type:Boolean
-==== Equals(Object) ====
+  * Description:N/A
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Equals.28Object.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //obj//
-| obj   | Object<!-- System.Object -->   |    |
+    * Type:Object
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-==== GetHashCode() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#GetHashCode.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+N/A
-^  Name ^  Type ^  Description ^
+== Remarks ==
+N/A
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Int32
-==== GetType() ====
+  * Description:N/A
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#GetType.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetType() **
-<!-- System.Object -->
+N/A
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== ToJson() ====
+N/A
-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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#ToJson.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | A JSON string which is used to create an overlay at the client side.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Type
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== ToString() ====
+==== Protected Methods ====
-=== Remarks ===
+** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) **
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#ToString.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+N/A
-^  Name ^  Type ^  Description ^
+== Remarks ==
+N/A
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-===== Protected Methods =====
+  * Description:N/A
-==== Finalize() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Finalize.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //page//
+    * Type:Page
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **
-==== MemberwiseClone() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#MemberwiseClone.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+Registers a Javascript library URL string to the client HTML page.
-^  Name ^  Type ^  Description ^
+== 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|}} 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) **
-<!-- System.Object -->
-[[#Protected Methods|Go Back]]
-==== OnTick(EventArgs) ====
 Raises the Tick event of the MarkerOverlay.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OnTick.28EventArgs.29</a>
+N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
-| e   | EventArgs<!-- System.EventArgs -->   | An System.EventArgs object that contains the event data.   |
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //e//
-==== RegisterJavaScriptLibraryCore(Page) ====
+    * Type:EventArgs
-Registers a Javascript library URL string to the client HTML page.
+    * Description:An System.EventArgs object that contains the event data.
-=== Remarks ===
-The &lt;strong&gt;RegisterJavaScriptLibraryCore&lt;/strong&gt; method allows derived classes to override and register their own Javascript library URL to the HTML page.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-| page   | Page<!-- System.Web.UI.Page -->   | The page object that is used for registering the javascript library.   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+N/A
-[[#Protected Methods|Go Back]]
+== Remarks ==
-===== Public Properties =====
+N/A
-==== Attribution ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Attribution" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Attribution</a>
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Void
-==== AutoRefreshInterval ====
+  * Description:N/A
-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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#AutoRefreshInterval" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#AutoRefreshInterval</a>
-=== Return Value ===
-^ Return Type ^
-| TimeSpan<!-- System.TimeSpan -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+<div newline></div>
-==== Id ====
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-Gets the identifier for the overlay to be found.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Id" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Id</a>
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== IsBaseOverlay ====
+N/A
-Gets or sets a value that indicates whether the overlay is a base overlay.
-=== Remarks ===
+== Return Value ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsBaseOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsBaseOverlay</a>
+  * Type:Object
-=== Return Value ===
+  * Description:N/A
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} IsVisible **
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
-[[#Public Properties|Go Back]]
-==== IsVisible ====
 Gets or sets a value that indicates whether the overlay is visible on the map.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsVisible</a>
+N/A
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Boolean
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+** {{wiki:PublicProperty.gif|}} Name **
-[[#Public Properties|Go Back]]
-==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsVisibleInOverlaySwitcher" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#IsVisibleInOverlaySwitcher</a>
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
-[[#Public Properties|Go Back]]
-==== Name ====
 Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#Name</a>
+N/A
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:String
-| String<!-- System.String -->   |
+** {{wiki:PublicProperty.gif|}} Opacity **
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
-[[#Public Properties|Go Back]]
-==== Opacity ====
 Gets or sets the opacity level of the overlay.
-=== Remarks ===
+== Remarks ==
-The &lt;strong&gt;Opacity&lt;/strong&gt; 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.
+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 ===
+== Return Value ==
-^ Return Type ^
+  * Type:Single
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher **
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
+Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
-==== HasTickEvent ====
+== Remarks ==
-Indicates whether the overlay supports tick event.
+N/A
-=== Remarks ===
+== Return Value ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#HasTickEvent" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#HasTickEvent</a>
+  * Type:Boolean
-=== Return Value ===
-^ Return Type ^
+** {{wiki:PublicProperty.gif|}} IsBaseOverlay **
-| Boolean<!-- System.Boolean -->   |
+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|}} 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 **
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
-[[#Protected Properties|Go Back]]
-==== OverlayType ====
 Gets a string that indicates which type the overlay is.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OverlayType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OverlayType</a>
+N/A
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:String
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+** {{wiki:ProtectedProperty.gif|}} HasTickEvent **
-[[#Protected Properties|Go Back]]
-===== Public Events =====
+Indicates whether the overlay supports tick event.
-==== Tick ====
+== Remarks ==
+N/A
+== 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 ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Overlay#OnTick.28EventArgs.29</a>
+N/A
-=== Event Arguments ===
-^ Event Arguments ^
-| EventArgs<!-- System.EventArgs -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay -->
+Event Arguments:EventArgs
-[[#Public Events|Go Back]]
-__NOTOC__
-[[Category:WebEdition]]
-[[Category:ThinkGeo.MapSuite.WebEdition]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools