thinkgeo.mapsuite.webedition.wmsoverlay
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.webedition.wmsoverlay [2015/09/22 08:50] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WebEdition.WmsOverlay ====== | ||
| - | Represents an overlay object that gets map images from the WMS server you specify. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.WebEdition.Overlay | ||
| - | ***ThinkGeo.MapSuite.WebEdition.WmsOverlay** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} WmsOverlay() ** | ||
| - | |||
| - | * //Initialize an instance of the WmsOverlay class.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} WmsOverlay(String) ** | ||
| - | |||
| - | * //Initialize an instance of the WmsOverlay class with the overlay identifier specified.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * //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 == | ||
| - | * //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 == | ||
| - | * //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 == | ||
| - | * //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 == | ||
| - | * //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.WebEdition.TileType|TileType]] | ||
| - | * Description:Whether or not the overlay uses tiling. | ||
| - | |||
| - | <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 == | ||
| - | * //For the most updated Info for this topic, please check it here:// | ||
| - | == 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.WebEdition.TileType|TileType]] | ||
| - | * Description:Whether or not the overlay uses tiling. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) ** | ||
| - | |||
| - | * //Sets the EPSG projection of the LayerOverlay when it is a base overlay.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //epsgProjection// | ||
| - | * Type:String | ||
| - | * Description:A string that represents the projection of the LayerOverlay. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetBaseEpsgProjection() ** | ||
| - | |||
| - | * //Returns an EPSG string that indicates the projection of the LayerOverlay.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:String | ||
| - | * Description:An EPSG string that indicates the projection of the LayerOverlay. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToJson() ** | ||
| - | |||
| - | * //Returns a JSON string which contains the information for creating an overlay at the client side.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:String | ||
| - | * Description:A JSON string which is used to create an overlay at the client side. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:The page object that is used for registering the javascript library. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
| - | |||
| - | * //Raises the Tick event of the MarkerOverlay.// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:An System.EventArgs object that contains the event data. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //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 == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} Parameters ** | ||
| - | |||
| - | Gets a dictionary whose items will be passed to the WMS server as parameters. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Parameters | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} WebImageFormat ** | ||
| - | |||
| - | Gets or sets the format of the image that is sent to the web browser. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WebImageFormat | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileWidth ** | ||
| - | |||
| - | Gets or sets the width of each tile, if the WmsOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileWidth | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileHeight ** | ||
| - | |||
| - | Gets or sets the height of each tile, if the WmsOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileHeight | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TransitionEffect ** | ||
| - | |||
| - | Gets or sets the transition effect to use when the map is zoomed. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TransitionEffect | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TransitionEffectDelayInMilliseconds ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here: | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileType ** | ||
| - | |||
| - | Gets or sets whether or not the WmsOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ServerUris ** | ||
| - | |||
| - | Gets a collection of URIs that specifies the locations of the WMS servers. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ServerUris | ||
| - | == Return Value == | ||
| - | * Type:Collection<Uri> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} WrapDateline ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay wraps at the date line. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WrapDateline | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay is visible on the map. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisible | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Name | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisibleInOverlaySwitcher | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay is a base overlay. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsBaseOverlay | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | |||
| - | Gets the identifier for the overlay to be found. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Id | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
| - | |||
| - | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#AutoRefreshInterval | ||
| - | == Return Value == | ||
| - | * Type:TimeSpan | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Attribution | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} Projection ** | ||
| - | |||
| - | Gets or sets a string that will be sent to the WMS server to get the images in the specific projection. | ||
| - | == Remarks == | ||
| - | 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} OverlayType ** | ||
| - | |||
| - | Gets a string that indicates the overlay type. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OverlayType | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
| - | |||
| - | Indicates whether the overlay supports tick event. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#HasTickEvent | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} 3hM= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
| - | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | ||
| - | == Remarks == | ||
| - | 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 | ||
| - | |||
thinkgeo.mapsuite.webedition.wmsoverlay.1442911831.txt.gz ยท Last modified: 2015/09/22 08:50 by admin
