thinkgeo.mapsuite.webedition.wmsoverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.wmsoverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WebEdition.WmsOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | 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 ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.WebEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.WebEdition.WmsOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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.WebEdition.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(String, IEnumerable<Uri>, TileType)|WmsOverlay]] | String, IEnumerable<Uri>, [[ThinkGeo.MapSuite.WebEdition.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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{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.WebEdition.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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnTick(EventArgs)|OnTick]] | EventArgs | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Raises the Tick event of the MarkerOverlay. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] | Page | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Registers a Javascript library URL string to the client HTML page. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]] | TimeSpan | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Gets the identifier for the overlay to be found. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsBaseOverlay|IsBaseOverlay]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.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.WebEdition.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.WebEdition.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.WebEdition.Overlay|Overlay]] | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]] | Single | [[ThinkGeo.MapSuite.WebEdition.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.WebEdition.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.WebEdition.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.WebEdition.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.WebEdition.WrapDatelineMode|WrapDatelineMode]] | | Gets or sets a value that indicates whether the overlay wraps at the date line. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#HasTickEvent|HasTickEvent]] | Boolean | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Indicates whether the overlay supports tick event. | | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]] | String | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]](overriden) | Gets a string that indicates the overlay type. | | ||
| - | | {{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. | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#Tick|Tick]] | EventArgs | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== WmsOverlay() ==== | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WmsOverlay(String) ==== | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier string used to find the overlay. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WmsOverlay(String, Uri) ==== | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier and a WMS server URI specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.29</a> | ||
| - | === 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]] | ||
| - | ==== WmsOverlay(String, Uri, TileType) ==== | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier, the WMS server URI and the tile type specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29</a> | ||
| - | === 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.WebEdition.TileType|TileType]]<!-- ThinkGeo.MapSuite.WebEdition.TileType --> | Whether or not the overlay uses tiling. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WmsOverlay(String, IEnumerable<Uri>, TileType) ==== | ||
| - | Initialize an instance of the WmsOverlay class with the overlay identifier, the collection of WMS server URIs and the tile type specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the WmsOverlay class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier used for finding the overlay. | | ||
| - | | serverUris | IEnumerable<Uri><!-- System.Collections.Generic.IEnumerable{System.Uri} --> | The collection of WMS server URIs. | | ||
| - | | tileType | [[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]<!-- ThinkGeo.MapSuite.WebEdition.TileType --> | Whether or not the overlay uses tiling. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | An EPSG string that indicates the projection of the LayerOverlay. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#SetBaseEpsgProjection.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#SetBaseEpsgProjection.28String.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | epsgProjection | String<!-- System.String --> | A string that represents the projection of the LayerOverlay. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToJson.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | A JSON string which is used to create an overlay at the client side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnTick(EventArgs) ==== | ||
| - | Raises the Tick event of the MarkerOverlay. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | EventArgs<!-- System.EventArgs --> | An System.EventArgs object that contains the event data. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | page | Page<!-- System.Web.UI.Page --> | The page object that is used for registering the javascript library. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Attribution ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Attribution" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Attribution</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#AutoRefreshInterval" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#AutoRefreshInterval</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | Gets the identifier for the overlay to be found. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Id" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Id</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsBaseOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsBaseOverlay</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisible</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisibleInOverlaySwitcher" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#IsVisibleInOverlaySwitcher</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Name ==== | ||
| - | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Name</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Parameters" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#Parameters</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ServerUris" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#ServerUris</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<Uri><!-- System.Collections.ObjectModel.Collection{System.Uri} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileHeight" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileHeight</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileType ==== | ||
| - | Gets or sets whether or not the WmsOverlay uses tiling. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WmsOverlay.28String.2C_Uri.2C_TileType.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]<!-- ThinkGeo.MapSuite.WebEdition.TileType --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileWidth" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TileWidth</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TransitionEffect" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#TransitionEffect</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]]<!-- ThinkGeo.MapSuite.WebEdition.TransitionEffect --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TransitionEffectDelayInMilliseconds ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WebImageFormat" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WebImageFormat</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]]<!-- ThinkGeo.MapSuite.WebEdition.WebImageFormat --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WrapDateline" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#WrapDateline</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]]<!-- ThinkGeo.MapSuite.WebEdition.WrapDatelineMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== HasTickEvent ==== | ||
| - | Indicates whether the overlay supports tick event. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#HasTickEvent" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#HasTickEvent</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ==== OverlayType ==== | ||
| - | Gets a string that indicates the overlay type. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OverlayType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OverlayType</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.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. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#GetBaseEpsgProjection.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.WmsOverlay --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== Tick ==== | ||
| - | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WmsOverlay#OnTick.28EventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | EventArgs<!-- System.EventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Overlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:WebEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.webedition.wmsoverlay.1440040135.txt.gz ยท Last modified: 2015/09/18 03:09 (external edit)
