Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.mvcedition.worldmapkitwmsweboverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay
<!– Class –> Represents an overlay object that gets map images from the WMS servers.
Remarks
The <strong>WorldMapKitWmsWebOverlay</strong> gets images from four WMS servers that we specify by default. Usually, you add a WMS server URI to the <strong>ServerUris</strong> collection and the <strong>WorldMapKitWmsWebOverlay</strong> will make requests to that WMS servers to get its tile images.
The WorldMapKitWmsWebOverlay will randomly send requests to those WMS servers in a concurrent fashion. This means that the tile images can come from different WMS servers, thus greatly enhancing performance.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.MvcEdition.Overlay *ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 WorldMapKitWmsWebOverlay | Initialize an instance of the WmsOverlay class. | ||
| WorldMapKitWmsWebOverlay | String | Initialize an instance of the WmsOverlay class with the overlay identifier specified. | |
| WorldMapKitWmsWebOverlay | WorldMapKitLayerType | ||
| WorldMapKitWmsWebOverlay | String, WorldMapKitLayerType | ||
| WorldMapKitWmsWebOverlay | String, TileType | Initialize an instance of the WmsOverlay class with the overlay identifier specified. | |
| WorldMapKitWmsWebOverlay | String, TileType, WorldMapKitLayerType |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object | ||
| RegisterJavaScriptLibraryCore | Page | Overlay | Registers a Javascript library URL string to the client HTML page. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Overlay | |
| AutoRefreshInterval | TimeSpan | Overlay | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| Id | String | Overlay | Gets the identifier for the overlay to be found. |
| IsBaseOverlay | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is a base overlay. |
| IsVisible | Boolean | Overlay | Gets or sets a value that indicates whether the overlay is visible on the map. |
| IsVisibleInOverlaySwitcher | Boolean | Overlay | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
| LayerType | WorldMapKitLayerType | ||
| MapType | WorldMapKitMapType | ||
| Name | String | Overlay | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| OnClientAutoRefreshTick | String | Overlay(overriden) | Don't support auto tick event by default. |
| Opacity | Single | Overlay | Gets or sets the opacity level of the overlay. |
| Projection | WorldMapKitProjection | Gets or sets a WorldMapKitProjection represents which projection will be used. | |
| TileType | TileType | Gets or sets whether or not the WmsOverlay uses tiling. | |
| TransitionEffect | TransitionEffect | Gets or sets the transition effect to use when the map is zoomed. | |
| TransitionEffectDelayInMilliseconds | Int32 | ||
| WrapDateline | WrapDatelineMode | Gets or sets a value that indicates whether the overlay wraps at the date line. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 OverlayType | String | Overlay(overriden) | Gets a string that indicates the overlay type. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
WorldMapKitWmsWebOverlay()
Initialize an instance of the WmsOverlay class.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|
WorldMapKitWmsWebOverlay(String)
Initialize an instance of the WmsOverlay class with the overlay identifier specified.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier string used to find the overlay. |
WorldMapKitWmsWebOverlay(WorldMapKitLayerType)
Parameters
| Name | Type | Description |
|---|---|---|
| layerType | WorldMapKitLayerType<!– ThinkGeo.MapSuite.Core.WorldMapKitLayerType –> |
WorldMapKitWmsWebOverlay(String, WorldMapKitLayerType)
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| layerType | WorldMapKitLayerType<!– ThinkGeo.MapSuite.Core.WorldMapKitLayerType –> |
WorldMapKitWmsWebOverlay(String, TileType)
Initialize an instance of the WmsOverlay class with the overlay identifier specified.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier string used to find the overlay. |
| tileType | TileType<!– ThinkGeo.MapSuite.MvcEdition.TileType –> | Whether or not the overlay uses tiling. |
WorldMapKitWmsWebOverlay(String, TileType, WorldMapKitLayerType)
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| tileType | TileType<!– ThinkGeo.MapSuite.MvcEdition.TileType –> | |
| layerType | WorldMapKitLayerType<!– ThinkGeo.MapSuite.Core.WorldMapKitLayerType –> |
Protected Constructors
Public Methods
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
FromJson(String)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| jsonString | String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
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.
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.MvcEdition.Overlay –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.MvcEdition.Overlay –> Go Back
Public Properties
Attribution
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
AutoRefreshInterval
Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
Id
Gets the identifier for the overlay to be found.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
IsBaseOverlay
Gets or sets a value that indicates whether the overlay is a base overlay.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
IsVisible
Gets or sets a value that indicates whether the overlay is visible on the map.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
IsVisibleInOverlaySwitcher
Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
LayerType
Return Value
| Return Type |
|---|
| WorldMapKitLayerType<!– ThinkGeo.MapSuite.Core.WorldMapKitLayerType –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
MapType
Return Value
| Return Type |
|---|
| WorldMapKitMapType<!– ThinkGeo.MapSuite.Core.WorldMapKitMapType –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
Name
Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
OnClientAutoRefreshTick
Don't support auto tick event by default.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> 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.MvcEdition.Overlay –> Go Back
Projection
Gets or sets a WorldMapKitProjection represents which projection will be used.
Return Value
| Return Type |
|---|
| WorldMapKitProjection<!– ThinkGeo.MapSuite.Core.WorldMapKitProjection –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
TileType
Gets or sets whether or not the WmsOverlay uses tiling.
Return Value
| Return Type |
|---|
| TileType<!– ThinkGeo.MapSuite.MvcEdition.TileType –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
TransitionEffect
Gets or sets the transition effect to use when the map is zoomed.
Return Value
| Return Type |
|---|
| TransitionEffect<!– ThinkGeo.MapSuite.MvcEdition.TransitionEffect –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
TransitionEffectDelayInMilliseconds
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
WrapDateline
Gets or sets a value that indicates whether the overlay wraps at the date line.
Return Value
| Return Type |
|---|
| WrapDatelineMode<!– ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode –> |
<!– ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay –> Go Back
Protected Properties
OverlayType
Gets a string that indicates the overlay type.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) –> Go Back
Public Events
thinkgeo.mapsuite.mvcedition.worldmapkitwmsweboverlay.1440040132.txt.gz · Last modified: 2015/09/21 03:36 (external edit)
