thinkgeo.mapsuite.webedition.worldmapkitwmsweboverlay
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.worldmapkitwmsweboverlay [2015/09/18 03:09] admin |
thinkgeo.mapsuite.webedition.worldmapkitwmsweboverlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| Represents an overlay object that gets map images from the WMS servers. | Represents an overlay object that gets map images from the WMS servers. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay() ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay() ** | ||
| - | 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String) ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(WorldMapKitLayerType) ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(WorldMapKitLayerType) ** | ||
| - | 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28WorldMapKitLayerType.29// |
| == Parameters == | == Parameters == | ||
| * //layerType// | * //layerType// | ||
| Line 38: | Line 41: | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,WorldMapKitLayerType) ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,WorldMapKitLayerType) ** | ||
| - | 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_WorldMapKitLayerType.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 53: | Line 56: | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType) ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType) ** | ||
| - | 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 68: | Line 71: | ||
| ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType,WorldMapKitLayerType) ** | ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType,WorldMapKitLayerType) ** | ||
| - | 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.2C_WorldMapKitLayerType.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 89: | Line 92: | ||
| ** {{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.WorldMapKitWmsWebOverlay#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 101: | Line 104: | ||
| ** {{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.WorldMapKitWmsWebOverlay#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 113: | Line 116: | ||
| ** {{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.WorldMapKitWmsWebOverlay#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 129: | Line 132: | ||
| ** {{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.WorldMapKitWmsWebOverlay#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 141: | Line 144: | ||
| ** {{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.WorldMapKitWmsWebOverlay#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 154: | Line 157: | ||
| ** {{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 170: | Line 173: | ||
| ** {{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 181: | Line 184: | ||
| * //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 202: | Line 205: | ||
| ** {{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.WorldMapKitWmsWebOverlay#OnTick.28EventArgs.29// |
| == Return Value == | == Return Value == | ||
| Line 213: | Line 216: | ||
| * //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.WorldMapKitWmsWebOverlay#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 230: | Line 233: | ||
| ** {{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.WorldMapKitWmsWebOverlay#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 245: | Line 248: | ||
| Gets or sets a WorldMapKitProjection represents which projection will be used. | Gets or sets a WorldMapKitProjection represents which projection will be used. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Projection |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]] | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]] | ||
| Line 253: | Line 256: | ||
| 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28WorldMapKitLayerType.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]] | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]] | ||
| Line 261: | Line 264: | ||
| 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:[[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]] | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]] | ||
| Line 269: | Line 272: | ||
| 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.WorldMapKitWmsWebOverlay#TransitionEffect |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | ||
| Line 277: | Line 280: | ||
| 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 285: | Line 288: | ||
| 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.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.29 |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| Line 293: | Line 296: | ||
| 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.WorldMapKitWmsWebOverlay#WrapDateline |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]] | * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]] | ||
| Line 299: | Line 302: | ||
| ** {{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.WorldMapKitWmsWebOverlay#IsVisible |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 307: | Line 310: | ||
| ** {{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.WorldMapKitWmsWebOverlay#Name |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 315: | Line 318: | ||
| ** {{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 323: | Line 326: | ||
| ** {{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.WorldMapKitWmsWebOverlay#IsVisibleInOverlaySwitcher |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 331: | Line 334: | ||
| ** {{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.WorldMapKitWmsWebOverlay#IsBaseOverlay |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 339: | Line 342: | ||
| ** {{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.WorldMapKitWmsWebOverlay#Id |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 347: | Line 350: | ||
| ** {{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.WorldMapKitWmsWebOverlay#AutoRefreshInterval |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 357: | Line 360: | ||
| 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.WorldMapKitWmsWebOverlay#Attribution |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 398: | Line 401: | ||
| 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.WorldMapKitWmsWebOverlay#OverlayType |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 414: | Line 417: | ||
| Don't support auto tick event by default. | Don't support auto tick event by default. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#HasTickEvent |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 428: | Line 431: | ||
| ==== 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.WorldMapKitWmsWebOverlay#OnTick.28EventArgs.29 |
| Event Arguments:EventArgs | Event Arguments:EventArgs | ||
thinkgeo.mapsuite.webedition.worldmapkitwmsweboverlay.1442545793.txt.gz · Last modified: 2015/09/18 03:09 by admin