WmsOverlay¶
Namespace: ThinkGeo.Core
Represents an overlay object that gets map images from the WMS server you specify.
public class WmsOverlay : TileOverlay, System.IDisposable
Inheritance Object → Overlay → TileOverlay → WmsOverlay
Implements IDisposable
Remarks:
The WmsOverlay gets images from one or more WMS servers that you specify. Usually, you add a WMS server URI to the ServerUris collection and the WmsOverlay 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. Do not add URIs of differently-configured WMS servers to the ServerUris collection.
Fields¶
credentials¶
public ICredentials credentials;
Properties¶
Parameters¶
Gets a dictionary whose items will be passed to the WMS server as parameters.
public Dictionary<string, string> Parameters { get; }
Property Value¶
Dictionary<String, String>
A dictionary whose items will be passed to the WMS server as parameters.
ServerUri¶
Gets or Set a URI that specifies the location of the WMS server.
public Uri ServerUri { get; set; }
Property Value¶
Uri
WebProxy¶
This property gets or sets the proxy used for requesting a Web Response.
public IWebProxy WebProxy { get; set; }
Property Value¶
IWebProxy
TimeoutInSeconds¶
Gets or sets the length of time, in seconds, before the request times out.
public int TimeoutInSeconds { get; set; }
Property Value¶
AxisOrder¶
public WmsAxisOrder AxisOrder { get; set; }
Property Value¶
WmsAxisOrder
Projection¶
Gets or sets a string that will be sent to the WMS server to get the images in the specific projection.
public string Projection { get; set; }
Property Value¶
String
A string that represents the projection that the images use.
Credentials¶
This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.
public ICredentials Credentials { get; set; }
Property Value¶
ICredentials
Crs¶
public string Crs { get; set; }
Property Value¶
ImageFormat¶
Gets and sets drawing format for the tiles.
public RasterTileFormat ImageFormat { get; set; }
Property Value¶
RasterTileFormat
JpegQuality¶
Gets or sets the image quality when the TileImageFormat is Jpeg; otherwise this property has no effects. Its default value is 80.
public int JpegQuality { get; set; }
Property Value¶
IsCacheOnly¶
Gets or sets a value indicating whether this instance is cache only.
public bool IsCacheOnly { get; set; }
Property Value¶
Boolean
true if this instance is cache only; otherwise, false.
IsVisible¶
Gets or sets if this overlay is visible.
public bool IsVisible { get; set; }
Property Value¶
TileSizeMode¶
Gets or sets the tile size mode.
public TileSizeMode TileSizeMode { get; set; }
Property Value¶
TileSizeMode
The tile size mode.
TileResolution¶
Gets or sets the tile resolution.
public TileResolution TileResolution { get; set; }
Property Value¶
TileResolution
The tile resolution.
TileType¶
Gets and sets the overlay is formed by multiple tiles or single tile.
public TileType TileType { get; set; }
Property Value¶
TileWidth¶
Gets and sets the width of the tile.
public int TileWidth { get; set; }
Property Value¶
TileHeight¶
Gets and sets the height of the tile.
public int TileHeight { get; set; }
Property Value¶
RenderMode¶
This property gets and sets the render mode for drawing this overlay.
public RenderMode RenderMode { get; set; }
Property Value¶
Remarks:
Set Skia to render map image with Skia. We recommend use this value with large data.
Set DrawingVisual to render map image with DrawingVisual feature in WPF. Use it when the spatial data is small to get better responding.
TileCache¶
Gets and sets a tile cache object for saving the tiles.
public RasterTileCache TileCache { get; set; }
Property Value¶
RasterTileCache
TileSnappingMode¶
Gets or sets the tileView snapping mode.
public TileSnappingMode TileSnappingMode { get; set; }
Property Value¶
TileSnappingMode
TileBuffer¶
This property gets and sets the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.
public int TileBuffer { get; set; }
Property Value¶
MaxExtent¶
This property gets or sets the max extent of matrix to calculate the tiles.
public RectangleShape MaxExtent { get; set; }
Property Value¶
RectangleShape
Remarks:
By default, MaxExtent is null; the matrix is created depending on the GeographyUnit of current map. When it's DecimalDegree, the matrix' is calculated as (-180, 90, 180, -90) as MaxExtent. While it's not DecimalDegree, the matrix is (-20037508.2314698, 20037508.2314698, 20037508.2314698, -20037508.2314698); It's allowed to modify it to customize the matrix.
WrappingMode¶
Thie property gets or sets whether allow wrap date line.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingMode
WrappingExtent¶
public RectangleShape WrappingExtent { get; set; }
Property Value¶
RectangleShape
CanRefreshRegion¶
public bool CanRefreshRegion { get; protected set; }
Property Value¶
IsBase¶
public bool IsBase { get; set; }
Property Value¶
Name¶
Gets or sets the name of this overaly.
public string Name { get; set; }
Property Value¶
MapArguments¶
Gets or sets current map information which will be used for calculating mechanism.
public MapArguments MapArguments { get; set; }
Property Value¶
MapArguments
OverlayCanvas¶
Gets or sets the actual canvas which maintains all the visual elements on the overlay.
public Canvas OverlayCanvas { get; set; }
Property Value¶
Canvas
DrawingExceptionMode¶
This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
DrawingExceptionMode
RefreshTypeOnResize¶
public OverlayRefreshType RefreshTypeOnResize { get; set; }
Property Value¶
Attribution¶
public string Attribution { get; set; }
Property Value¶
IsEmpty¶
This property gets if this overlay is empty or not.
public bool IsEmpty { get; }
Property Value¶
Remarks:
This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.
AutoRefreshInterval¶
public TimeSpan AutoRefreshInterval { get; set; }
Property Value¶
Constructors¶
WmsOverlay()¶
Constructore of WmsOverlay class.
public WmsOverlay()
WmsOverlay(Uri)¶
Constructore of WmsOverlay class.
public WmsOverlay(Uri serverUri)
Parameters¶
serverUri Uri
This parameter indicates a uri for the Wms server.
WmsOverlay(Uri, IWebProxy)¶
Constructore of WmsOverlay class.
public WmsOverlay(Uri serverUri, IWebProxy webProxy)
Parameters¶
serverUri Uri
webProxy IWebProxy
This parameter indicates the web proxy of the request
Methods¶
OpenCore()¶
protected void OpenCore()
GetTileCore()¶
This method gets a specific tile object to form an overlay.
protected TileView GetTileCore()
Returns¶
TileView
A TileView object to form an overlay.
DrawTileAsyncCore(GeoCanvas, TileView)¶
This method redraws a tile by an extent and geography unit.
protected Task DrawTileAsyncCore(GeoCanvas geoCanvas, TileView tile)
Parameters¶
geoCanvas GeoCanvas
tile TileView
A tile which needs to be redrawn.
Returns¶
SaveStateCore()¶
This method saves overlay state to a byte array.
protected Byte[] SaveStateCore()
Returns¶
Byte[]
A byte array indicates current overlay state.
LoadStateCore(Byte[])¶
This method restore the overlay state back from the specified state.
protected void LoadStateCore(Byte[] state)
Parameters¶
state Byte[]
This parameter indicates the state for restore the overlay.
OnSendingWebRequest(SendingWebRequestEventArgs)¶
protected void OnSendingWebRequest(SendingWebRequestEventArgs e)
Parameters¶
e SendingWebRequestEventArgs
OnSentWebRequest(SentWebRequestEventArgs)¶
protected void OnSentWebRequest(SentWebRequestEventArgs e)
Parameters¶
e SentWebRequestEventArgs
Events¶
SendingWebRequest¶
public event EventHandler<SendingWebRequestEventArgs> SendingWebRequest;
SentWebRequest¶
public event EventHandler<SentWebRequestEventArgs> SentWebRequest;
DrawTilesProgressChanged¶
This event raises when download progress is changed.
public event EventHandler<DrawTilesProgressChangedTileOverlayEventArgs> DrawTilesProgressChanged;
DrawingTile¶
This event raises before the tile is drawing.
public event EventHandler<DrawingTileTileOverlayEventArgs> DrawingTile;
DrawnTile¶
This event raises after the tile is drawn.
public event EventHandler<DrawnTileTileOverlayEventArgs> DrawnTile;
DrawingException¶
public event EventHandler<DrawingExceptionTileOverlayEventArgs> DrawingException;
DrawnException¶
public event EventHandler<DrawnExceptionTileOverlayEventArgs> DrawnException;
TileTypeChanged¶
public event EventHandler<TileTypeChangedTileOverlayEventArgs> TileTypeChanged;
TileTypeChanging¶
public event EventHandler<TileTypeChangingTileOverlayEventArgs> TileTypeChanging;
Drawing¶
This event raises before the overlay is drawing.
public event EventHandler<DrawingOverlayEventArgs> Drawing;
Drawn¶
This event raises after the overlay is drawn.
public event EventHandler<DrawnOverlayEventArgs> Drawn;
DrawingAttribution¶
public event EventHandler<DrawingAttributionOverlayEventArgs> DrawingAttribution;
DrawnAttribution¶
public event EventHandler<DrawnAttributionOverlayEventArgs> DrawnAttribution;