Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.mvcedition.wmsoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MvcEdition.WmsOverlay
<!– Class –> Represents an overlay object that gets map images from the WMS server you specify.
Remarks
The <strong>WmsOverlay</strong> gets images from one or more WMS servers that you specify. Usually, you add a WMS server URI to the <strong>ServerUris</strong> collection and the <strong>WmsOverlay</strong> will make a request to that WMS server to get its tile images.
You can also add multiple WMS server URIs to the ServerUris collection. The WmsOverlay 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. <strong>Do not</strong> add URIs of differently-configured WMS servers to the ServerUris collection.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 WmsOverlay | Initialize an instance of the WmsOverlay class. | ||
| WmsOverlay | String | Initialize an instance of the WmsOverlay class with the overlay identifier specified. | |
| WmsOverlay | String, Uri | Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified. | |
| WmsOverlay | String, Uri, TileType | Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified. | |
| WmsOverlay | IEnumerable<Uri> | Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URIs. | |
| WmsOverlay | String, IEnumerable<Uri>, TileType | Initialize an instance of the WmsOverlay class with the overlay identifier, the collection of WMS server URIs and the tile type specified. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Equals | Object | Object | |
| FromJson | String | Overlay | Load this object from a json string. |
| GetBaseEpsgProjection | Returns an EPSG string that indicates the projection of the LayerOverlay. | ||
| GetHashCode | Object | ||
| GetType | Object | ||
| SetBaseEpsgProjection | String | Sets the EPSG projection of the LayerOverlay when it is a base overlay. | |
| ToJson | Overlay | 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 | ||
| 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. |
| Name | String | Overlay | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| OnClientAutoRefreshTick | String | Overlay | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. |
| Opacity | Single | Overlay | Gets or sets the opacity level of the overlay. |
| Parameters | Dictionary<String,String> | Gets a dictionary whose items will be passed to the WMS server as parameters. | |
| ServerUris | Collection<Uri> | Gets a collection of URIs that specifies the locations of the WMS servers. | |
| TileHeight | Int32 | Gets or sets the height of each tile, if the WmsOverlay uses tiling. | |
| TileType | TileType | Gets or sets whether or not the WmsOverlay uses tiling. | |
| TileWidth | Int32 | Gets or sets the width of each tile, if the WmsOverlay uses tiling. | |
| TransitionEffect | TransitionEffect | Gets or sets the transition effect to use when the map is zoomed. | |
| TransitionEffectDelayInMilliseconds | Int32 | ||
| WebImageFormat | WebImageFormat | Gets or sets the format of the image that is sent to the web browser. | |
| 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. |
| Projection | String | Gets or sets a string that will be sent to the WMS server to get the images in the specific projection. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
WmsOverlay()
Initialize an instance of the WmsOverlay class.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|
WmsOverlay(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. |
WmsOverlay(String, Uri)
Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier used for finding the overlay. |
| serverUri | Uri<!– System.Uri –> | The URI that indicates where the WMS server is. |
WmsOverlay(String, Uri, TileType)
Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier used for finding the overlay. |
| serverUri | Uri<!– System.Uri –> | The URI that indicates where the WMS server is. |
| tileType | TileType<!– ThinkGeo.MapSuite.MvcEdition.TileType –> | Whether or not the overlay uses tiling. |
WmsOverlay(IEnumerable<Uri>)
Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URIs.
Parameters
| Name | Type | Description |
|---|---|---|
| serverUris | IEnumerable<Uri><!– System.Collections.Generic.IEnumerable{System.Uri} –> | The collection of WMS server URIs. |
WmsOverlay(String, IEnumerable<Uri>, TileType)
Initialize an instance of the WmsOverlay class with the overlay identifier, the collection of WMS server URIs and the tile type specified.
Overloads
Initialize an instance of the WmsOverlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier used for finding the overlay. |
| serverUris | IEnumerable<Uri><!– System.Collections.Generic.IEnumerable{System.Uri} –> | The collection of WMS server URIs. |
| tileType | TileType<!– ThinkGeo.MapSuite.MvcEdition.TileType –> | Whether or not the overlay uses tiling. |
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)
Load this object from a json string.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| jsonString | String<!– System.String –> | a json string |
<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back
GetBaseEpsgProjection()
Returns an EPSG string that indicates the projection of the LayerOverlay.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | An EPSG string that indicates the projection of the LayerOverlay. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> 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
SetBaseEpsgProjection(String)
Sets the EPSG projection of the LayerOverlay when it is a base overlay.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| epsgProjection | String<!– System.String –> | A string that represents the projection of the LayerOverlay. |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> 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
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
Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.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.MvcEdition.Overlay –> Go Back
Parameters
Gets a dictionary whose items will be passed to the WMS server as parameters.
Return Value
| Return Type |
|---|
| Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> Go Back
ServerUris
Gets a collection of URIs that specifies the locations of the WMS servers.
Return Value
| Return Type |
|---|
| Collection<Uri><!– System.Collections.ObjectModel.Collection{System.Uri} –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> Go Back
TileHeight
Gets or sets the height of each tile, if the WmsOverlay uses tiling.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> 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.WmsOverlay –> Go Back
TileWidth
Gets or sets the width of each tile, if the WmsOverlay uses tiling.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> 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.WmsOverlay –> Go Back
TransitionEffectDelayInMilliseconds
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> Go Back
WebImageFormat
Gets or sets the format of the image that is sent to the web browser.
Return Value
| Return Type |
|---|
| WebImageFormat<!– ThinkGeo.MapSuite.MvcEdition.WebImageFormat –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> 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.WmsOverlay –> 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
Projection
Gets or sets a string that will be sent to the WMS server to get the images in the specific projection.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.WmsOverlay –> Go Back
Public Events
thinkgeo.mapsuite.mvcedition.wmsoverlay.1440040132.txt.gz · Last modified: 2015/09/21 03:36 (external edit)
