WmsOverlay¶
Namespace: ThinkGeo.UI.Android
Represents an overlay object that gets map images from the WMS server you specify.
public class WmsOverlay : TileOverlay, System.IDisposable
Inheritance Object → OverlayBase → 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.
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.
Uri¶
public Uri Uri { get; set; }
Property Value¶
Uri
Proxy¶
public IWebProxy Proxy { 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
LayerType¶
Gets or sets the LayerType of the Overlay.
public LayerType LayerType { get; set; }
Property Value¶
LayerType
TileSizeMode¶
public TileSizeMode TileSizeMode { get; set; }
Property Value¶
TileSizeMode
TileWidth¶
Gets or sets the width of the tile.
public int TileWidth { get; set; }
Property Value¶
Int32
The width of the tile.
TileHeight¶
Gets or sets the height of the tile.
public int TileHeight { get; set; }
Property Value¶
Int32
The height of the tile.
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.
TileCache¶
Gets or sets the tile cache.
public RasterTileCache TileCache { get; set; }
Property Value¶
RasterTileCache
The tile cache.
TileType¶
Gets and sets the overlay is formed by multiple tiles or single tile.
public TileType TileType { get; set; }
Property Value¶
TileType
The type of the tile.
TileSnappingMode¶
Gets or sets the tile snapping mode.
public TileSnappingMode TileSnappingMode { get; set; }
Property Value¶
TileSnappingMode
The tile snapping mode.
TransitionEffect¶
Gets or sets the tile transition effect.
public TransitionEffect TransitionEffect { get; set; }
Property Value¶
TransitionEffect
The tile snapping mode.
OverlayView¶
Gets or sets the overlay view.
public MapLayout OverlayView { get; set; }
Property Value¶
MapLayout
The overlay view.
IsVisible¶
public bool IsVisible { get; set; }
Property Value¶
Name¶
Gets or sets the name of this overaly.
public string Name { get; set; }
Property Value¶
DrawingExceptionMode¶
This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
DrawingExceptionMode
The drawing exception mode.
MapArguments¶
Gets or sets the map arguments.
public MapArguments MapArguments { get; set; }
Property Value¶
MapArguments
The map arguments.
Attribution¶
Gets or sets the attribution.
public string Attribution { get; set; }
Property Value¶
String
The attribution.
IsEmpty¶
Gets a value indicating whether this instance is empty.
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.
DrawingQuality¶
Gets or sets the drawingQuality for this overlay.
public DrawingQuality DrawingQuality { get; set; }
Property Value¶
DrawingQuality
Opacity¶
Gets or sets the opacity for this overlay.
public double Opacity { get; set; }
Property Value¶
Constructors¶
WmsOverlay()¶
Constructor of WmsOverlay class.
public WmsOverlay()
WmsOverlay(Uri)¶
Constructor of WmsOverlay class.
public WmsOverlay(Uri serverUri)
Parameters¶
serverUri Uri
This parameter indicates a uri for the Wms server.
WmsOverlay(Uri, IWebProxy)¶
Constructor of WmsOverlay class.
public WmsOverlay(Uri serverUri, IWebProxy proxy)
Parameters¶
serverUri Uri
This parameter indicates the uri for the Wms server.
proxy IWebProxy
This parameter indicates the web proxy of the request
Methods¶
GetTileCore(Context)¶
protected TileView GetTileCore(Context context)
Parameters¶
context Context
Returns¶
DrawTileAsyncCore(GeoCanvas, TileView)¶
protected Task DrawTileAsyncCore(GeoCanvas geoCanvas, TileView tile)
Parameters¶
geoCanvas GeoCanvas
tile TileView
Returns¶
DrawTileCore(GeoCanvas, TileView)¶
protected void DrawTileCore(GeoCanvas geoCanvas, TileView tile)
Parameters¶
geoCanvas GeoCanvas
tile TileView
OpenCore()¶
protected void OpenCore()
CloseCore()¶
protected void CloseCore()
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;
DrawingException¶
Occurs before exception is drawing on map.
public event EventHandler<DrawingExceptionOverlayEventArgs> DrawingException;
DrawnException¶
Occurs after exception is drawn on map.
public event EventHandler<DrawnExceptionOverlayEventArgs> DrawnException;
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;