Skip to content

OpenStreetMapLayer

Inheritance Hierarchy

  • Object
  • Layer
    • OpenStreetMapLayer

Members Summary

Public Constructors Summary

Name
OpenStreetMapLayer()
OpenStreetMapLayer(String)
OpenStreetMapLayer(IWebProxy)
OpenStreetMapLayer(String,IWebProxy)
OpenStreetMapLayer(String,IWebProxy,String)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
Attribution String N/A
Background GeoColor N/A
BlueTranslation Single N/A
CachePictureFormat GeoImageFormat The cache for picture format
ColorMappings Dictionary<GeoColor,GeoColor> N/A
CustomServerUris Collection<Uri> N/A
DrawingExceptionMode DrawingExceptionMode N/A
DrawingTime TimeSpan N/A
GreenTranslation Single N/A
HasBoundingBox Boolean N/A
IsGrayscale Boolean N/A
IsNegative Boolean N/A
IsOpen Boolean N/A
IsVisible Boolean N/A
KeyColors Collection<GeoColor> N/A
Name String N/A
ProjectedTileCache RasterTileCache N/A
Projection Projection N/A
ProjectionFromSphericalMercator ProjectionConverter N/A
RedTranslation Single N/A
RequestDrawingInterval TimeSpan N/A
ThreadSafe ThreadSafetyLevel N/A
TileCache RasterTileCache N/A
TimeoutInSeconds Int32 Gets or sets a value represents the request timeout from the OpenStreetMap server.
Transparency Single N/A
UserAgent String N/A
WebProxy IWebProxy This property gets or sets the proxy used for requesting a Web Response.
ZoomlevelSet ZoomLevelSet N/A

Protected Properties Summary

Name Return Type Description
IsOpenCore Boolean N/A

Public Methods Summary

Name
CloneDeep()
Close()
Draw(GeoCanvas,Collection<SimpleCandidate>)
Equals(Object)
GetBoundingBox()
GetHashCode()
GetType()
Open()
RequestDrawing()
RequestDrawing(RectangleShape)
RequestDrawing(IEnumerable<RectangleShape>)
RequestDrawing(TimeSpan)
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(RectangleShape,TimeSpan)
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
ToString()

Protected Methods Summary

Name
CloneDeepCore()
CloseCore()
DrawAttributionCore(GeoCanvas,String)
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
DrawException(GeoCanvas,Exception)
DrawExceptionCore(GeoCanvas,Exception)
Finalize()
GetBoundingBoxCore()
MemberwiseClone()
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
OnDrawingException(DrawingExceptionLayerEventArgs)
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
OnDrawnException(DrawnExceptionLayerEventArgs)
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
OnSendingWebRequest(SendingWebRequestEventArgs)
OnSentWebRequest(SentWebRequestEventArgs)
OpenCore()
SendWebRequest(WebRequest)
SendWebRequestCore(WebRequest)

Public Events Summary

Name Event Arguments Description
SendingWebRequest SendingWebRequestEventArgs N/A
SentWebRequest SentWebRequestEventArgs N/A
DrawingProgressChanged DrawingProgressChangedEventArgs N/A
DrawingException DrawingExceptionLayerEventArgs N/A
DrawnException DrawnExceptionLayerEventArgs N/A
DrawingAttribution DrawingAttributionLayerEventArgs N/A
DrawnAttribution DrawnAttributionLayerEventArgs N/A
RequestedDrawing RequestedDrawingLayerEventArgs N/A
RequestingDrawing RequestingDrawingLayerEventArgs N/A

Members Detail

Public Constructors

Name
OpenStreetMapLayer()
OpenStreetMapLayer(String)
OpenStreetMapLayer(IWebProxy)
OpenStreetMapLayer(String,IWebProxy)
OpenStreetMapLayer(String,IWebProxy,String)

Protected Constructors

Public Properties

Attribution

Summary

N/A

Remarks

N/A

Return Value

String


Background

Summary

N/A

Remarks

N/A

Return Value

GeoColor


BlueTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


CachePictureFormat

Summary

The cache for picture format

Remarks

get or set a OpenStreetMapLayerPictureFormat object

Return Value

GeoImageFormat


ColorMappings

Summary

N/A

Remarks

N/A

Return Value

Dictionary<GeoColor,GeoColor>


CustomServerUris

Summary

N/A

Remarks

N/A

Return Value

Collection<Uri>


DrawingExceptionMode

Summary

N/A

Remarks

N/A

Return Value

DrawingExceptionMode


DrawingTime

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


GreenTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


HasBoundingBox

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsGrayscale

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsNegative

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsOpen

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsVisible

Summary

N/A

Remarks

N/A

Return Value

Boolean


KeyColors

Summary

N/A

Remarks

N/A

Return Value

Collection<GeoColor>


Name

Summary

N/A

Remarks

N/A

Return Value

String


ProjectedTileCache

Summary

N/A

Remarks

N/A

Return Value

RasterTileCache


Projection

Summary

N/A

Remarks

N/A

Return Value

Projection


ProjectionFromSphericalMercator

Summary

N/A

Remarks

N/A

Return Value

ProjectionConverter


RedTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


RequestDrawingInterval

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


ThreadSafe

Summary

N/A

Remarks

N/A

Return Value

ThreadSafetyLevel


TileCache

Summary

N/A

Remarks

N/A

Return Value

RasterTileCache


TimeoutInSeconds

Summary

Gets or sets a value represents the request timeout from the OpenStreetMap server.

Remarks

N/A

Return Value

Int32


Transparency

Summary

N/A

Remarks

N/A

Return Value

Single


UserAgent

Summary

N/A

Remarks

N/A

Return Value

String


WebProxy

Summary

This property gets or sets the proxy used for requesting a Web Response.

Remarks

N/A

Return Value

IWebProxy


ZoomlevelSet

Summary

N/A

Remarks

N/A

Return Value

ZoomLevelSet


Protected Properties

IsOpenCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


Public Methods

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

Close()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Draw(GeoCanvas,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetBoundingBox()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RequestDrawing()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RequestDrawing(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A

RequestDrawing(IEnumerable<RectangleShape>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A

RequestDrawing(TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(RectangleShape,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

CloseCore()

Summary

This method closes the Layer and releases any resources it was using.

Remarks

This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.

Return Value

Type Description
Void None

Parameters

Name Type Description
N/A N/A N/A

DrawAttributionCore(GeoCanvas,String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
attribution String N/A

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

Summary

This method draws the Layer.

Remarks

This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.

Return Value

Type Description
Void None

Parameters

Name Type Description
canvas GeoCanvas This parameter is the view object or a NativeImage to draw on.
labelsInAllLayers Collection<SimpleCandidate> This parameter represents the labels used for collision detection and duplication checking.

DrawException(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

DrawExceptionCore(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetBoundingBoxCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingAttributionLayerEventArgs N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingExceptionLayerEventArgs N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingProgressChangedEventArgs N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnAttributionLayerEventArgs N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawnExceptionLayerEventArgs N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestedDrawingLayerEventArgs N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestingDrawingLayerEventArgs N/A

OnSendingWebRequest(SendingWebRequestEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e SendingWebRequestEventArgs N/A

OnSentWebRequest(SentWebRequestEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e SentWebRequestEventArgs N/A

OpenCore()

Summary

This method opens the Layer so that it is initialized and ready to use.

Remarks

This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.

Return Value

Type Description
Void None

Parameters

Name Type Description
N/A N/A N/A

SendWebRequest(WebRequest)

Summary

N/A

Remarks

N/A

Return Value

Type Description
WebResponse N/A

Parameters

Name Type Description
webRequest WebRequest N/A

SendWebRequestCore(WebRequest)

Summary

N/A

Remarks

N/A

Return Value

Type Description
WebResponse N/A

Parameters

Name Type Description
webRequest WebRequest N/A

Public Events

SendingWebRequest

N/A

Remarks

N/A

Event Arguments

SendingWebRequestEventArgs

SentWebRequest

N/A

Remarks

N/A

Event Arguments

SentWebRequestEventArgs

DrawingProgressChanged

N/A

Remarks

N/A

Event Arguments

DrawingProgressChangedEventArgs

DrawingException

N/A

Remarks

N/A

Event Arguments

DrawingExceptionLayerEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments

DrawnExceptionLayerEventArgs

DrawingAttribution

N/A

Remarks

N/A

Event Arguments

DrawingAttributionLayerEventArgs

DrawnAttribution

N/A

Remarks

N/A

Event Arguments

DrawnAttributionLayerEventArgs

RequestedDrawing

N/A

Remarks

N/A

Event Arguments

RequestedDrawingLayerEventArgs

RequestingDrawing

N/A

Remarks

N/A

Event Arguments

RequestingDrawingLayerEventArgs