User Tools

Site Tools


thinkgeo.mapsuite.webedition.wmsoverlay

This is an old revision of the document!


ThinkGeo.MapSuite.WebEdition.WmsOverlay

<!– Class –> Represents an overlay object that gets map images from the WMS server you specify.

Remarks

The &lt;strong&gt;WmsOverlay&lt;/strong&gt; gets images from one or more WMS servers that you specify. Usually, you add a WMS server URI to the &lt;strong&gt;ServerUris&lt;/strong&gt; collection and the &lt;strong&gt;WmsOverlay&lt;/strong&gt; 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. &lt;strong&gt;Do not&lt;/strong&gt; add URIs of differently-configured WMS servers to the ServerUris collection.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodWmsOverlay Initialize an instance of the WmsOverlay class.
Public MethodWmsOverlay String Initialize an instance of the WmsOverlay class with the overlay identifier specified.
Public MethodWmsOverlay String, Uri Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified.
Public MethodWmsOverlay String, Uri, TileType Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified.
Public MethodWmsOverlay 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
Public MethodEquals Object Object
Public MethodGetBaseEpsgProjection Returns an EPSG string that indicates the projection of the LayerOverlay.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodSetBaseEpsgProjection String Sets the EPSG projection of the LayerOverlay when it is a base overlay.
Public MethodToJson Overlay Returns a JSON string which contains the information for creating an overlay at the client side.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object
Protected MethodOnTick EventArgs Overlay Raises the Tick event of the MarkerOverlay.
Protected MethodRegisterJavaScriptLibraryCore Page Overlay Registers a Javascript library URL string to the client HTML page.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Public PropertyId String Overlay Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay.
Public PropertyIsVisible Boolean Overlay Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyIsVisibleInOverlaySwitcher Boolean Overlay Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Public PropertyName String Overlay Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOpacity Single Overlay Gets or sets the opacity level of the overlay.
Public PropertyParameters Dictionary<String,String> Gets a dictionary whose items will be passed to the WMS server as parameters.
Public PropertyServerUris Collection<Uri> Gets a collection of URIs that specifies the locations of the WMS servers.
Public PropertyTileHeight Int32 Gets or sets the height of each tile, if the WmsOverlay uses tiling.
Public PropertyTileType TileType Gets or sets whether or not the WmsOverlay uses tiling.
Public PropertyTileWidth Int32 Gets or sets the width of each tile, if the WmsOverlay uses tiling.
Public PropertyTransitionEffect TransitionEffect Gets or sets the transition effect to use when the map is zoomed.
Public PropertyTransitionEffectDelayInMilliseconds Int32
Public PropertyWebImageFormat WebImageFormat Gets or sets the format of the image that is sent to the web browser.
Public PropertyWrapDateline WrapDatelineMode Gets or sets a value that indicates whether the overlay wraps at the date line.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyHasTickEvent Boolean Overlay Indicates whether the overlay supports tick event.
Protected PropertyOverlayType String Overlay(overriden) Gets a string that indicates the overlay type.
Protected PropertyProjection 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 EventTick EventArgs Overlay Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Public Constructors

WmsOverlay()

Initialize an instance of the WmsOverlay class.

Overloads

Initialize an instance of the WmsOverlay class.

Remarks

Parameters

Name Type Description

Go Back

WmsOverlay(String)

Initialize an instance of the WmsOverlay class with the overlay identifier specified.

Overloads

Initialize an instance of the WmsOverlay class.

Remarks

Parameters

Name Type Description
id String<!– System.String –> The identifier string used to find the overlay.

Go Back

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.

Remarks

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.

Go Back

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.

Remarks

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.WebEdition.TileType –> Whether or not the overlay uses tiling.

Go Back

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.

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

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.WebEdition.TileType –> Whether or not the overlay uses tiling.

Go Back

Protected Constructors

Public Methods

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetBaseEpsgProjection()

Returns an EPSG string that indicates the projection of the LayerOverlay.

Remarks

Return Value

Return Type Description
String<!– System.String –> An EPSG string that indicates the projection of the LayerOverlay.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

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.

Remarks

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.WebEdition.WmsOverlay –> Go Back

ToJson()

Returns a JSON string which contains the information for creating an overlay at the client side.

Remarks

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

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Remarks

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

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 &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

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

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

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.WmsOverlay#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#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

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

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

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.WmsOverlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#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 &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.

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

Parameters

Gets a dictionary whose items will be passed to the WMS server as parameters.

Remarks

Return Value

Return Type
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

ServerUris

Gets a collection of URIs that specifies the locations of the WMS servers.

Remarks

Return Value

Return Type
Collection<Uri><!– System.Collections.ObjectModel.Collection{System.Uri} –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

TileHeight

Gets or sets the height of each tile, if the WmsOverlay uses tiling.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

TileType

Gets or sets whether or not the WmsOverlay uses tiling.

Remarks

Return Value

Return Type
TileType<!– ThinkGeo.MapSuite.WebEdition.TileType –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

TileWidth

Gets or sets the width of each tile, if the WmsOverlay uses tiling.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

TransitionEffect

Gets or sets the transition effect to use when the map is zoomed.

Remarks

Return Value

Return Type
TransitionEffect<!– ThinkGeo.MapSuite.WebEdition.TransitionEffect –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

TransitionEffectDelayInMilliseconds

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

WebImageFormat

Gets or sets the format of the image that is sent to the web browser.

Remarks

Return Value

Return Type
WebImageFormat<!– ThinkGeo.MapSuite.WebEdition.WebImageFormat –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

WrapDateline

Gets or sets a value that indicates whether the overlay wraps at the date line.

Remarks

Return Value

Return Type
WrapDatelineMode<!– ThinkGeo.MapSuite.WebEdition.WrapDatelineMode –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> Go Back

Protected Properties

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

OverlayType

Gets a string that indicates the overlay type.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.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.

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.WmsOverlay –> 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

Event Arguments

Event Arguments
EventArgs<!– System.EventArgs –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay –> Go Back

NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation

thinkgeo.mapsuite.webedition.wmsoverlay.1440040135.txt.gz · Last modified: 2015/09/18 03:09 (external edit)