OpenStreetMapLayer¶

Namespace: ThinkGeo.Core

This class is use for Open Street Map Layer, and you also can get map from open street map server.

public class OpenStreetMapLayer : XyzTileLayer

Inheritance Object → Layer → WebBasedLayer → XyzTileLayer → OpenStreetMapLayer

Properties¶

UserAgent¶

public string UserAgent { get; set; }

Property Value¶

String

CustomServerUris¶

public Collection<Uri> CustomServerUris { get; }

Property Value¶

Collection<Uri>

TileWidth¶

public int TileWidth { get; protected set; }

Property Value¶

Int32

TileHeight¶

public int TileHeight { get; protected set; }

Property Value¶

Int32

MapUnit¶

public GeographyUnit MapUnit { get; protected set; }

Property Value¶

GeographyUnit

MaxExtent¶

public RectangleShape MaxExtent { get; protected set; }

Property Value¶

RectangleShape

TileCache¶

public RasterTileCache TileCache { get; set; }

Property Value¶

RasterTileCache

ProjectedTileCache¶

public RasterTileCache ProjectedTileCache { get; set; }

Property Value¶

RasterTileCache

ProjectionConverterFromServerProjection¶

public ProjectionConverter ProjectionConverterFromServerProjection { get; set; }

Property Value¶

ProjectionConverter

WebProxy¶

public IWebProxy WebProxy { get; set; }

Property Value¶

IWebProxy

TimeoutInSeconds¶

public int TimeoutInSeconds { get; set; }

Property Value¶

Int32

IsOpen¶

This property returns true if the Layer is open and false if it is not.

public bool IsOpen { get; }

Property Value¶

Boolean

Remarks:

This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

HasBoundingBox¶

This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.

public bool HasBoundingBox { get; }

Property Value¶

Boolean

Remarks:

The default value is false.

DrawingTime¶

This property gets the last drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value¶

TimeSpan

Remarks:

We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.

Name¶

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value¶

String

Remarks:

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

IsVisible¶

This property gets and set the visible state of the layer.

public bool IsVisible { get; set; }

Property Value¶

Boolean

Remarks:

If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.

Transparency¶

This property gets and sets the amount of transparency to apply to the image.

public float Transparency { get; set; }

Property Value¶

Single
This property gets the amount of transparency to apply to the image.

Remarks:

None

BlueTranslation¶

This property gets and sets the amount of blue to apply to the image.

public float BlueTranslation { get; set; }

Property Value¶

Single
This property gets the amount of blue to apply to the image.

Remarks:

None

RedTranslation¶

This property gets and sets the amount of red to apply to the image.

public float RedTranslation { get; set; }

Property Value¶

Single
This property gets the amount of red to apply to the image.

Remarks:

None

GreenTranslation¶

This property gets and sets the amount of green to apply to the image.

public float GreenTranslation { get; set; }

Property Value¶

Single
This property gets the amount of green to apply to the image.

Remarks:

None

KeyColors¶

Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.

public Collection<GeoColor> KeyColors { get; }

Property Value¶

Collection<GeoColor>

Remarks:

It will make these colors transparent when draw image.

IsNegative¶

This property gets and sets whether the image should be converted to negative (inverse colors).

public bool IsNegative { get; set; }

Property Value¶

Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).

Remarks:

None

IsGrayscale¶

This property gets and sets if the image should be converted to grayscale.

public bool IsGrayscale { get; set; }

Property Value¶

Boolean

        This property gets and sets if the image should be converted to grayscale.

Remarks:

None

ColorMappings¶

ColorMapping

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value¶

Dictionary<GeoColor, GeoColor>

DrawingExceptionMode¶

Gets or sets the DrawExceptionMode when exception happens.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

ThreadSafe¶

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value¶

ThreadSafetyLevel

Projection¶

Gets the projection of the layer.

public Projection Projection { get; set; }

Property Value¶

Projection

Background¶

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value¶

GeoColor

RequestDrawingInterval¶

public TimeSpan RequestDrawingInterval { get; set; }

Property Value¶

TimeSpan

Constructors¶

OpenStreetMapLayer()¶

The default constructor

public OpenStreetMapLayer()

Remarks:

The constructor initilizes the properties. WebProxy is set to null.

OpenStreetMapLayer(String)¶

This is constructore of OpenStreetMapLayer.

public OpenStreetMapLayer(string userAgent)

Parameters¶

userAgent String
The valid HTTP user-agent is required for OpenStreetMap Server.

OpenStreetMapLayer(IWebProxy)¶

This is constructore of OpenStreetMapLayer.

public OpenStreetMapLayer(IWebProxy webProxy)

Parameters¶

webProxy IWebProxy
This parameter indicates a WebProxy for requesting image from OpenStreet imagery service.

OpenStreetMapLayer(String, IWebProxy)¶

public OpenStreetMapLayer(string userAgent, IWebProxy webProxy)

Parameters¶

userAgent String

webProxy IWebProxy

Methods¶

GetImageUriCore(Int32, Int64, Int64, Single)¶

protected Uri GetImageUriCore(int zoomLevel, long x, long y, float resolutionFactor)

Parameters¶

zoomLevel Int32

x Int64

y Int64

resolutionFactor Single

Returns¶

Uri

Events¶

SendingWebRequest¶

public event EventHandler<SendingWebRequestEventArgs> SendingWebRequest;

SentWebRequest¶

public event EventHandler<SentWebRequestEventArgs> SentWebRequest;

DrawingProgressChanged¶

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

DrawingException¶

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException¶

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;

DrawingAttribution¶

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution¶

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

RequestedDrawing¶

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing¶

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;