ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.webedition.overlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.WebEdition.Overlay
<!– Class –> Serves as the base class that defines the properties and methods shared by all types of overlays.
Remarks
The <strong>Overlay</strong> 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 <strong>LayerOverlay</strong> or <strong>WmsOverlay</strong>. While the <strong>MarkerOverlay</strong> will not be rendered as an image, it actually represents a <strong>div</strong> 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 <strong>IsBaseOverlay</strong> property set to true. It is displayed as the background image of the map. In an <strong>OverlaySwitcher</strong>, 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 <strong>IsBaseOverlay</strong> property. These overlays can overlap the base overlay and/or each other. They are displayed in the <strong>OverlaySwitcher</strong> with a check box beside their name. You can click the check box to show or hide a specific overlay.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.WebEdition.Overlay *ThinkGeo.MapSuite.WebEdition.AdornmentOverlay *ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay *ThinkGeo.MapSuite.WebEdition.BingMapsOverlay *ThinkGeo.MapSuite.WebEdition.EditFeatureOverlay *ThinkGeo.MapSuite.WebEdition.FeatureOverlay *ThinkGeo.MapSuite.WebEdition.FeatureSourceMarkerOverlay *ThinkGeo.MapSuite.WebEdition.GoogleOverlay *ThinkGeo.MapSuite.WebEdition.HighlightFeatureOverlay *ThinkGeo.MapSuite.WebEdition.InMemoryMarkerOverlay *ThinkGeo.MapSuite.WebEdition.LayerOverlay *ThinkGeo.MapSuite.WebEdition.MarkerOverlay *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
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| ToJson | Returns a JSON string which contains the information for creating an overlay at the client side. | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object | ||
| OnTick | EventArgs | Raises the Tick event of the MarkerOverlay. | |
| RegisterJavaScriptLibraryCore | Page | Registers a Javascript library URL string to the client HTML page. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | ||
| AutoRefreshInterval | TimeSpan | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | |
| Id | String | Gets the identifier for the overlay to be found. | |
| IsBaseOverlay | Boolean | Gets or sets a value that indicates whether the overlay is a base overlay. | |
| IsVisible | Boolean | Gets or sets a value that indicates whether the overlay is visible on the map. | |
| IsVisibleInOverlaySwitcher | Boolean | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | |
| Name | String | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | |
| Opacity | Single | Gets or sets the opacity level of the overlay. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 HasTickEvent | Boolean | Indicates whether the overlay supports tick event. | |
| OverlayType | String | Gets a string that indicates which type the overlay is. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 Tick | EventArgs | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. |
Public Constructors
Protected Constructors
Overlay()
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 |
|---|
Overlay(String)
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.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 –> |
Overlay(String, Boolean)
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.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 –> |
Public Methods
Equals(Object)
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
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
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:<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
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
ToString()
Remarks
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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnTick(EventArgs)
Raises the Tick event of the MarkerOverlay.
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>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | EventArgs<!– System.EventArgs –> | An System.EventArgs object that contains the event data. |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| page | Page<!– System.Web.UI.Page –> | The page object that is used for registering the javascript library. |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Public Properties
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 –> Go Back
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:<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 –> Go Back
Id
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 –> Go Back
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:<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>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
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:<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>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> 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 –> Go Back
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:<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>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
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
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Protected Properties
HasTickEvent
Indicates whether the overlay supports tick event.
Remarks
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>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
OverlayType
Gets a string that indicates which type the overlay is.
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>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
Public Events
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:<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>
Event Arguments
| Event Arguments |
|---|
| EventArgs<!– System.EventArgs –> |
<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back
NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation
thinkgeo.mapsuite.webedition.overlay.1440040135.txt.gz · Last modified: 2015/09/18 03:09 (external edit)