User Tools

Site Tools

Trace:
thinkgeo.mapsuite.mvcedition.wmsoverlay

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.mvcedition.wmsoverlay [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.mvcedition.wmsoverlay [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.MvcEdition.WmsOverlay ====== ====== ThinkGeo.MapSuite.MvcEdition.WmsOverlay ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Represents an overlay object that gets map images from the WMS server you specify. 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 ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.Overlay]] +    *ThinkGeo.MapSuite.MvcEdition.Overlay 
-***[[ThinkGeo.MapSuite.MvcEdition.WmsOverlay]]+      ***ThinkGeo.MapSuite.MvcEdition.WmsOverlay**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} WmsOverlay() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#WmsOverlay()|WmsOverlay]] ​  ​| ​   |    | Initialize an instance of the WmsOverlay class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WmsOverlay(String)|WmsOverlay]] ​  | String ​  ​| ​   | Initialize an instance of the WmsOverlay class with the overlay identifier specified. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WmsOverlay(String,​ Uri)|WmsOverlay]] ​  | String, Uri   ​| ​   | Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WmsOverlay(String,​ Uri, TileType)|WmsOverlay]] ​  | String, Uri, [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] ​  ​| ​   | Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WmsOverlay(IEnumerable<​Uri>​)|WmsOverlay]] ​  | IEnumerable<​Uri> ​  ​| ​   | Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URIs.   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​WmsOverlay(String,​ IEnumerable<​Uri>,​ TileType)|WmsOverlay]] ​  | String, IEnumerable<​Uri>,​ [[ThinkGeo.MapSuite.MvcEdition.TileType|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 ​==== +  * //​Initialize an instance of the WmsOverlay class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A// 
 +== Parameters ​== 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} WmsOverlay(String) **
  
 +  * //​Initialize an instance of the WmsOverlay class with the overlay identifier specified.//​
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //id//
 +    * Type:String
 +    * Description:​The identifier string used to find the overlay.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} WmsOverlay(String,​Uri) **
 +
 +  * //​Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified.//​
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //id//
 +    * Type:String
 +    * Description:​The identifier used for finding the overlay.
 +
 +  * //​serverUri//​
 +    * Type:Uri
 +    * Description:​The URI that indicates where the WMS server is.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} WmsOverlay(String,​Uri,​TileType) **
 +
 +  * //​Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified.//​
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //id//
 +    * Type:String
 +    * Description:​The identifier used for finding the overlay.
 +
 +  * //​serverUri//​
 +    * Type:Uri
 +    * Description:​The URI that indicates where the WMS server is.
 +
 +  * //​tileType//​
 +    * Type:​[[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]
 +    * Description:​Whether or not the overlay uses tiling.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} WmsOverlay(IEnumerable<​Uri>​) **
 +
 +  * //​Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URIs.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //​serverUris//​
 +    * Type:​IEnumerable<​Uri>​
 +    * Description:​The collection of WMS server URIs.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} 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.//​
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //id//
 +    * Type:String
 +    * Description:​The identifier used for finding the overlay.
 +
 +  * //​serverUris//​
 +    * Type:​IEnumerable<​Uri>​
 +    * Description:​The collection of WMS server URIs.
 +
 +  * //​tileType//​
 +    * Type:​[[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]
 +    * Description:​Whether or not the overlay uses tiling.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} SetBaseEpsgProjection(String) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Load this object from a json string. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetBaseEpsgProjection()|GetBaseEpsgProjection]] ​  ​| ​   |    | Returns an EPSG string that indicates the projection of the LayerOverlay. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#SetBaseEpsgProjection(String)|SetBaseEpsgProjection]] ​  | String ​  ​| ​   | Sets the EPSG projection of the LayerOverlay when it is a base overlay. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToJson()|ToJson]] ​  ​| ​   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | 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 ==== +  * //Sets the EPSG projection of the LayerOverlay when it is a base overlay.//​ 
-^ 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}}[[#​RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] ​  | Page   | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Registers a Javascript library URL string to the client HTML page.   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:Void 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Attribution|Attribution]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  ​| ​   | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​AutoRefreshInterval|AutoRefreshInterval]] ​  | TimeSpan ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the time interval in which the MarkerOverlay refreshes itself. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets the identifier for the overlay to be found. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsBaseOverlay|IsBaseOverlay]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is a base overlay. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisible|IsVisible]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is visible on the map.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OnClientAutoRefreshTick|OnClientAutoRefreshTick]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Opacity|Opacity]] ​  | Single ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | Gets or sets the opacity level of the overlay. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Parameters|Parameters]] ​  | Dictionary<​String,​String> ​  ​| ​   | Gets a dictionary whose items will be passed to the WMS server as parameters. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ServerUris|ServerUris]] ​  | Collection<​Uri> ​  ​| ​   | Gets a collection of URIs that specifies the locations of the WMS servers. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileHeight|TileHeight]] ​  | Int32   ​| ​   | Gets or sets the height of each tile, if the WmsOverlay uses tiling. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileType|TileType]] ​  | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] ​  ​| ​   | Gets or sets whether or not the WmsOverlay uses tiling. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileWidth|TileWidth]] ​  | Int32   ​| ​   | Gets or sets the width of each tile, if the WmsOverlay uses tiling. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TransitionEffect|TransitionEffect]] ​  | [[ThinkGeo.MapSuite.MvcEdition.TransitionEffect|TransitionEffect]] ​  ​| ​   | Gets or sets the transition effect to use when the map is zoomed. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TransitionEffectDelayInMilliseconds|TransitionEffectDelayInMilliseconds]] ​  | Int32   ​| ​   |    | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​WebImageFormat|WebImageFormat]] ​  | [[ThinkGeo.MapSuite.MvcEdition.WebImageFormat|WebImageFormat]] ​  ​| ​   | Gets or sets the format of the image that is sent to the web browser. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​WrapDateline|WrapDateline]] ​  | [[ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode|WrapDatelineMode]] ​  ​| ​   | Gets or sets a value that indicates whether the overlay wraps at the date line.   |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * //​epsgProjection//​ 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​OverlayType|OverlayType]] ​  ​| ​String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | Gets a string that indicates the overlay type.   | +    * Type:String 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​Projection|Projection]] ​  | String ​  ​| ​   | Gets or sets a string that will be sent to the WMS server to get the images in the specific projection.   |+    * Description:A string that represents ​the projection of the LayerOverlay.
  
-==== Public Events ==== +<div newline></​div>​ 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+** {{wiki:​PublicMethod.gif|}} GetBaseEpsgProjection() **
  
-===== Public Constructors ===== +  * //​Returns ​an EPSG string that indicates ​the projection ​of the LayerOverlay.// 
-==== WmsOverlay() ==== +== Remarks ​== 
-Initialize ​an instance of the WmsOverlay class. +  ​* //N/A//
-=== Overloads === +
-Initialize an instance ​of the WmsOverlay class. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-==== WmsOverlay(String) ==== +  ​* Type:String 
-Initialize an instance of the WmsOverlay class with the overlay identifier specified. +  * Description:An EPSG string ​that indicates the projection of the LayerOverlay.
-=== Overloads === +
-Initialize an instance of the WmsOverlay class. +
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| id   | String<​!-- System.String --> ​  | The identifier ​string ​used to find the overlay.   |+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== WmsOverlay(String,​ Uri) ==== +<div newline></div> 
-Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified. +** {{wiki:​PublicMethod.gif|}} ToJson() **
-=== 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.   ​|+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-==== WmsOverlay(String,​ Uri, TileType) ==== +== Remarks ​== 
-Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified. +  ​* //N/A//
-=== 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 ​  | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<​!-- ThinkGeo.MapSuite.MvcEdition.TileType --> ​  | Whether or not the overlay uses tiling. ​  |+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-==== WmsOverlay(IEnumerable<​Uri>​) ​==== +  ​* Type:String 
-Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URIs. +  * Description:N/A
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| serverUris ​  | IEnumerable<​Uri><​!-- System.Collections.Generic.IEnumerable{System.Uri} --> ​  | The collection of WMS server URIs.   |+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== WmsOverlay(String,​ IEnumerable<​Uri>,​ TileType) ==== +<div newline></div> 
-Initialize an instance of the WmsOverlay class with the overlay identifier, the collection of WMS server URIs and the tile type specified. +** {{wiki:​PublicMethod.gif|}} FromJson(String) **
-=== 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 ​  | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<​!-- ThinkGeo.MapSuite.MvcEdition.TileType --> ​  | Whether or not the overlay uses tiling. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks ​== 
-===== Public Methods ===== +  * //N/A//
-==== Equals(Object) ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* Type:Void 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //​jsonString//​ 
-==== FromJson(String) ​==== +    ​* ​Type:String 
-Load this object from a json string. +    ​* Description:​N/​A
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} ToString() **
-| jsonString ​  | String<​!-- System.String --> ​  | a json string ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetBaseEpsgProjection() ==== +  * //N/A//
-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 === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:String 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== 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:Boolean 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== SetBaseEpsgProjection(String) ==== +
-Sets the EPSG projection of the LayerOverlay when it is a base overlay. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| epsgProjection ​  | String<​!-- System.String --> ​  ​| ​A string that represents the projection of the LayerOverlay. ​  |+  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== ToJson() ==== +  * Description:N/A
-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 === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Type 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters == 
-[[#Public Methods|Go Back]] +<div newline></​div> 
-===== Protected Methods ​===== +==== Protected Methods ==== 
-==== Finalize() ==== +** {{wiki:​ProtectedMethod.gif|}} EhQ=(Page) **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== 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) ​**
-==== 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 === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| page   | Page<!-- System.Web.UI.Page --> ​  | The page object that is used for registering the javascript library. ​  |+  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-===== Public Properties ===== +  * Description:​N/​A
-==== Attribution ==== +
-=== Return Value === +
-^ Return ​Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +== Parameters ​== 
-[[#Public Properties|Go Back]] +  * //page// 
-==== AutoRefreshInterval ​==== +    ​* ​Type:Page 
-Gets or sets the time interval in which the MarkerOverlay refreshes itself. +    * Description:​N/​A
-=== Return Value === +
-^ Return ​Type ^ +
-| TimeSpan<​!-- System.TimeSpan --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +<div newline></​div> 
-[[#Public Properties|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
-==== Id ==== +
-Gets the identifier for the overlay to be found. +
-=== Return Value === +
-^ Return Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.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. +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> +== Return Value == 
-[[#Public Properties|Go Back]] +  ​* ​Type:Void 
-==== IsVisible ==== +  * Description:​N/​A
-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 --> +== Parameters ​== 
-[[#Public Properties|Go Back]] +<div newline></​div>​ 
-==== IsVisibleInOverlaySwitcher ​==== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-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 --> +  * //N/A// 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== Name ==== +  * //N/A//
-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 --> +== Return Value == 
-[[#Public Properties|Go Back]] +  ​* ​Type:Object 
-==== OnClientAutoRefreshTick ==== +  * Description:​N/​A
-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 --> +== Parameters ​== 
-[[#Public Properties|Go Back]] +<div newline></div> 
-==== Opacity ==== +==== Public Properties ==== 
-Gets or sets the opacity level of the overlay. +** {{wiki:​PublicProperty.gif|}} Parameters **
-=== 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 --> 
-[[#Public Properties|Go Back]] 
-==== Parameters ==== 
 Gets a dictionary whose items will be passed to the WMS server as parameters. Gets a dictionary whose items will be passed to the WMS server as parameters.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| Dictionary<​String,​String>​<!-- System.Collections.Generic.Dictionary{System.String,​System.String} --> ​  |+== Return Value == 
 +  ​* ​Type:Dictionary<​String,​String>​
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +** {{wiki:​PublicProperty.gif|}} WebImageFormat **
-[[#Public Properties|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 --> +Gets or sets the format ​of the image that is sent to the web browser. 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== TileHeight ==== +N/A 
-Gets or sets the height ​of each tile, if the WmsOverlay uses tiling. +== Return Value == 
-=== Return Value === +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.WebImageFormat|WebImageFormat]]
-^ Return ​Type ^ +
-| Int32<​!-- System.Int32 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +** {{wiki:​PublicProperty.gif|}} TileWidth **
-[[#Public Properties|Go Back]] +
-==== TileType ==== +
-Gets or sets whether or not the WmsOverlay uses tiling. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<​!-- ThinkGeo.MapSuite.MvcEdition.TileType --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TileWidth ==== 
 Gets or sets the width of each tile, if the WmsOverlay uses tiling. Gets or sets the width of each tile, if the WmsOverlay uses tiling.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| Int32<​!-- System.Int32 ​--> ​  |+== Return Value == 
 +  ​* ​Type:Int32 
 + 
 +** {{wiki:​PublicProperty.gif|}} TileHeight ** 
 + 
 +Gets or sets the height of each tile, if the WmsOverlay uses tiling. 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:Int32 
 + 
 +** {{wiki:​PublicProperty.gif|}} TransitionEffect **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TransitionEffect ==== 
 Gets or sets the transition effect to use when the map is zoomed. Gets or sets the transition effect to use when the map is zoomed.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.MvcEdition.TransitionEffect|TransitionEffect]]<!-- ThinkGeo.MapSuite.MvcEdition.TransitionEffect --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.TransitionEffect|TransitionEffect]]
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +** {{wiki:​PublicProperty.gif|}} TransitionEffectDelayInMilliseconds ​**
-[[#Public Properties|Go Back]] +
-==== TransitionEffectDelayInMilliseconds ​==== +
-=== Return Value === +
-^ Return Type ^ +
-| Int32<​!-- System.Int32 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +N/A 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== WebImageFormat ​==== +N/A 
-Gets or sets the format of the image that is sent to the web browser. +== Return Value == 
-=== Return Value === +  * Type:​Int32 
-^ Return ​Type ^ + 
-| [[ThinkGeo.MapSuite.MvcEdition.WebImageFormat|WebImageFormat]]<!-- ThinkGeo.MapSuite.MvcEdition.WebImageFormat -->   ​|+** {{wiki:​PublicProperty.gif|}} TileType ** 
 + 
 +Gets or sets whether or not the WmsOverlay uses tiling. 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] 
 + 
 +** {{wiki:​PublicProperty.gif|}} ServerUris ** 
 + 
 +Gets a collection of URIs that specifies the locations of the WMS servers. 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:​Collection<​Uri> 
 + 
 +** {{wiki:​PublicProperty.gif|}} WrapDateline **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> 
-[[#Public Properties|Go Back]] 
-==== WrapDateline ==== 
 Gets or sets a value that indicates whether the overlay wraps at the date line. Gets or sets a value that indicates whether the overlay wraps at the date line.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode|WrapDatelineMode]]<!-- ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode|WrapDatelineMode]]
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +** {{wiki:​PublicProperty.gif|}} IsVisible ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +N/A 
-==== OverlayType ​==== +== Remarks == 
-Gets a string that indicates the overlay type. +N/A 
-=== Return Value === +== Return Value == 
-^ Return Type ^ +  * Type:​Boolean 
-| String<!-- System.String --> ​  |+ 
 +** {{wiki:​PublicProperty.gif|}} Name ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:​String 
 + 
 +** {{wiki:​PublicProperty.gif|}} Opacity ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:​Single 
 + 
 +** {{wiki:​PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:​Boolean 
 + 
 +** {{wiki:​PublicProperty.gif|}} IsBaseOverlay ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:​Boolean 
 + 
 +** {{wiki:​PublicProperty.gif|}} Id ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:​String 
 + 
 +** {{wiki:​PublicProperty.gif|}} OnClientAutoRefreshTick ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:​String 
 + 
 +** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval ** 
 + 
 +N/A 
 +== 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|}} Projection **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> 
-[[#​Protected Properties|Go Back]] 
-==== Projection ==== 
 Gets or sets a string that will be sent to the WMS server to get the images in the specific projection. Gets or sets a string that will be sent to the WMS server to get the images in the specific projection.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| String<​!-- System.String ​--> ​  |+== Return Value == 
 +  ​* ​Type:String
  
-<!-- ThinkGeo.MapSuite.MvcEdition.WmsOverlay --> +** {{wiki:​ProtectedProperty.gif|}} OverlayType ** 
-[[#​Protected Properties|Go Back]] + 
-===== Public Events ​===== +Gets a string that indicates the overlay type. 
-__NOTOC__ +== Remarks ​== 
-[[Category:MvcEdition]] +N/A 
-[[Category:ThinkGeo.MapSuite.MvcEdition]] +== Return Value == 
-[[Category:UpdateDocumentation]]+  * Type:String 
 + 
 +** {{wiki:ProtectedProperty.gif|}} ERQ= ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:Double 
 + 
 +==== Public Events ====
  
thinkgeo.mapsuite.mvcedition.wmsoverlay.1440040132.txt.gz · Last modified: 2015/09/21 03:36 (external edit)

Page Tools