thinkgeo.mapsuite.webedition.wmsoverlay
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.wmsoverlay [2015/09/18 03:09] admin |
thinkgeo.mapsuite.webedition.wmsoverlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.WmsOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.WmsOverlay ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| 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. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} WmsOverlay() ** | ** {{wiki:PublicMethod.gif|}} WmsOverlay() ** | ||
| - | Initialize an instance of the WmsOverlay class. | + | * //Initialize an instance of the WmsOverlay class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} WmsOverlay(String) ** | ** {{wiki:PublicMethod.gif|}} WmsOverlay(String) ** | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier specified. | + | * //Initialize an instance of the WmsOverlay class with the overlay identifier specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} WmsOverlay(String,Uri) ** | ** {{wiki:PublicMethod.gif|}} WmsOverlay(String,Uri) ** | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified. | + | * //Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 42: | Line 45: | ||
| ** {{wiki:PublicMethod.gif|}} WmsOverlay(String,Uri,TileType) ** | ** {{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. | + | * //Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 61: | Line 64: | ||
| ** {{wiki:PublicMethod.gif|}} WmsOverlay(String,IEnumerable<Uri>,TileType) ** | ** {{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. | + | * //Initialize an instance of the WmsOverlay class with the overlay identifier, the collection of WMS server URIs and the tile type specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 82: | Line 85: | ||
| ** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) ** | ** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) ** | ||
| - | Sets the EPSG projection of the LayerOverlay when it is a base overlay. | + | * //Sets the EPSG projection of the LayerOverlay when it is a base overlay.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#SetBaseEpsgProjection.28String.29// |
| == Return Value == | == Return Value == | ||
| Line 98: | Line 101: | ||
| ** {{wiki:PublicMethod.gif|}} GetBaseEpsgProjection() ** | ** {{wiki:PublicMethod.gif|}} GetBaseEpsgProjection() ** | ||
| - | Returns an EPSG string that indicates the projection of the LayerOverlay. | + | * //Returns an EPSG string that indicates the projection of the LayerOverlay.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29// |
| == Return Value == | == Return Value == | ||
| Line 110: | Line 113: | ||
| ** {{wiki:PublicMethod.gif|}} ToJson() ** | ** {{wiki:PublicMethod.gif|}} ToJson() ** | ||
| - | N/A | + | * //Returns a JSON string which contains the information for creating an overlay at the client side.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToJson.28.29// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| - | * Description:N/A | + | * Description:A JSON string which is used to create an overlay at the client side. |
| == Parameters == | == Parameters == | ||
| Line 122: | Line 125: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 134: | Line 137: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 150: | Line 153: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 162: | Line 165: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 175: | Line 178: | ||
| ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 191: | Line 194: | ||
| ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ||
| - | N/A | + | * //Registers a Javascript library URL string to the client HTML page.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.// |
| == Return Value == | == Return Value == | ||
| Line 202: | Line 205: | ||
| * //page// | * //page// | ||
| * Type:Page | * Type:Page | ||
| - | * Description:N/A | + | * Description:The page object that is used for registering the javascript library. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 223: | Line 226: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
| - | N/A | + | * //Raises the Tick event of the MarkerOverlay.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29// |
| == Return Value == | == Return Value == | ||
| Line 234: | Line 237: | ||
| * //e// | * //e// | ||
| * Type:EventArgs | * Type:EventArgs | ||
| - | * Description:N/A | + | * Description:An System.EventArgs object that contains the event data. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 251: | Line 254: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 266: | Line 269: | ||
| 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. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Parameters |
| == Return Value == | == Return Value == | ||
| * Type:Dictionary<String,String> | * Type:Dictionary<String,String> | ||
| Line 274: | Line 277: | ||
| Gets or sets the format of the image that is sent to the web browser. | Gets or sets the format of the image that is sent to the web browser. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WebImageFormat |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]] | * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]] | ||
| Line 282: | Line 285: | ||
| 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. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileWidth |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 290: | Line 293: | ||
| Gets or sets the height of each tile, if the WmsOverlay uses tiling. | Gets or sets the height of each tile, if the WmsOverlay uses tiling. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileHeight |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 298: | Line 301: | ||
| 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. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TransitionEffect |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | ||
| Line 306: | Line 309: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here: |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 314: | Line 317: | ||
| Gets or sets whether or not the WmsOverlay uses tiling. | Gets or sets whether or not the WmsOverlay uses tiling. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| Line 322: | Line 325: | ||
| Gets a collection of URIs that specifies the locations of the WMS servers. | Gets a collection of URIs that specifies the locations of the WMS servers. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ServerUris |
| == Return Value == | == Return Value == | ||
| * Type:Collection<Uri> | * Type:Collection<Uri> | ||
| Line 330: | Line 333: | ||
| 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. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WrapDateline |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]] | * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]] | ||
| Line 336: | Line 339: | ||
| ** {{wiki:PublicProperty.gif|}} IsVisible ** | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay is visible on the map. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisible |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 344: | Line 347: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | N/A | + | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Name |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 352: | Line 355: | ||
| ** {{wiki:PublicProperty.gif|}} Opacity ** | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
| - | N/A | + | Gets or sets the opacity level of the overlay. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | 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 Value == | ||
| * Type:Single | * Type:Single | ||
| Line 360: | Line 363: | ||
| ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisibleInOverlaySwitcher |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 368: | Line 371: | ||
| ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay is a base overlay. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsBaseOverlay |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 376: | Line 379: | ||
| ** {{wiki:PublicProperty.gif|}} Id ** | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | N/A | + | Gets the identifier for the overlay to be found. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Id |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 384: | Line 387: | ||
| ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
| - | N/A | + | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#AutoRefreshInterval |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 394: | Line 397: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Attribution |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 403: | Line 406: | ||
| 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. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29 |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 411: | Line 414: | ||
| Gets a string that indicates the overlay type. | Gets a string that indicates the overlay type. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OverlayType |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 417: | Line 420: | ||
| ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
| - | N/A | + | Indicates whether the overlay supports tick event. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#HasTickEvent |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 433: | Line 436: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} Tick ** | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
| - | N/A | + | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29 |
| Event Arguments:EventArgs | Event Arguments:EventArgs | ||
thinkgeo.mapsuite.webedition.wmsoverlay.1442545787.txt.gz · Last modified: 2015/09/18 03:09 by admin