OpenStreetMapOverlay¶
Namespace: ThinkGeo.Core
This class represents an overlay that requesting images from OpenStreet Map Service.
public class OpenStreetMapOverlay : XyzTileOverlay`1, System.IDisposable
Inheritance Object → Overlay → TileOverlay → WebBasedTileOverlay<OpenStreetMapAsyncLayer> → XyzTileOverlay<OpenStreetMapAsyncLayer> → OpenStreetMapOverlay
Implements IDisposable
Properties¶
CustomServerUris¶
public Collection<Uri> CustomServerUris { get; }
Property Value¶
UserAgent¶
public string UserAgent { get; set; }
Property Value¶
TileCache¶
public RasterTileCache TileCache { get; set; }
Property Value¶
RasterTileCache
ProjectionConverterFromServerProjection¶
public ProjectionConverter ProjectionConverterFromServerProjection { get; set; }
Property Value¶
ProjectionConverter
ProjectedTileCache¶
public RasterTileCache ProjectedTileCache { get; set; }
Property Value¶
RasterTileCache
WebProxy¶
Gets or sets the Web Proxy for web service.
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¶
ImageFormat¶
Gets and sets drawing format for the tiles.
public GeoImageFormat ImageFormat { get; set; }
Property Value¶
GeoImageFormat
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.
Opacity¶
public double Opacity { get; set; }
Property Value¶
IsVisible¶
Gets or sets if this overlay is visible.
public bool IsVisible { get; set; }
Property Value¶
DrawingQuality¶
public DrawingQuality DrawingQuality { get; set; }
Property Value¶
DrawingQuality
TileSizeMode¶
Gets or sets the tile size mode.
public TileSizeMode TileSizeMode { get; set; }
Property Value¶
TileSizeMode
The tile size mode.
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¶
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
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¶
OpenStreetMapOverlay()¶
This is constructor of OpenStreetMapOverlay.
public OpenStreetMapOverlay()
OpenStreetMapOverlay(String)¶
This is constructor of OpenStreetMapOverlay.
public OpenStreetMapOverlay(string userAgent)
Parameters¶
userAgent String
The valid HTTP user-agent is required for OpenStreetMap Server.
OpenStreetMapOverlay(IWebProxy)¶
This is constructor of OpenStreetMapOverlay.
public OpenStreetMapOverlay(IWebProxy webProxy)
Parameters¶
webProxy IWebProxy
This parameter indicates a WebProxy for requesting image from OpenStreet imagery service.
OpenStreetMapOverlay(String, IWebProxy)¶
public OpenStreetMapOverlay(string userAgent, IWebProxy webProxy)
Parameters¶
userAgent String
The valid HTTP user-agent is required for OpenStreetMap Server.
webProxy IWebProxy
This parameter indicates a WebProxy for requesting image from OpenStreet imagery service.
Methods¶
GetBoundingBoxCore()¶
protected RectangleShape GetBoundingBoxCore()
Returns¶
RectangleShape
GetTileMatrixCore(Double)¶
protected TileMatrix GetTileMatrixCore(double scale)
Parameters¶
scale Double
Returns¶
TileMatrix
GetDrawingCellsCore(RectangleShape, Int32)¶
protected Dictionary<string, MatrixCell> GetDrawingCellsCore(RectangleShape targetExtent, int tileBuffer)
Parameters¶
targetExtent RectangleShape
tileBuffer Int32
Returns¶
Dictionary<String, MatrixCell>
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.
Events¶
SendingHttpRequest¶
public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;
ReceivedHttpResponse¶
public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;
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;
ThrowingException¶
public event EventHandler<ThrowingExceptionOverlayEventArgs> ThrowingException;