Skip to content

AdornmentLayer

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
N/A

Protected Constructors Summary

Name
AdornmentLayer()

Public Properties Summary

Name Return Type Description
Attribution String N/A
Background GeoColor N/A
BackgroundMask AreaStyle N/A
BlueTranslation Single N/A
ColorMappings Dictionary<GeoColor,GeoColor> N/A
DrawingExceptionMode DrawingExceptionMode N/A
DrawingTime TimeSpan N/A
GreenTranslation Single N/A
HasBoundingBox Boolean N/A
Height Single N/A
IsGrayscale Boolean N/A
IsNegative Boolean N/A
IsOpen Boolean N/A
IsVisible Boolean N/A
KeyColors Collection<GeoColor> N/A
Location AdornmentLocation This property gets and sets the drawing location of the AdornmentLayer.
Name String N/A
Projection Projection N/A
RedTranslation Single N/A
RequestDrawingInterval TimeSpan N/A
ThreadSafe ThreadSafetyLevel N/A
Transparency Single N/A
Width Single N/A
XOffsetInPixel Single This property gets and sets the X pixel offset for the AdornmentLayer.
YOffsetInPixel Single This property gets and sets the Y pixel offset for the AdornmentLayer.

Protected Properties Summary

Name Return Type Description
ActualWidth Single N/A
IsOpenCore Boolean N/A

Public Methods Summary

Name
CloneDeep()
Close()
Draw(GeoCanvas,Collection<SimpleCandidate>)
Equals(Object)
GetBoundingBox()
GetDrawingLocation(GeoCanvas,Single,Single)
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)
OpenCore()

Public Events Summary

Name Event Arguments Description
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
N/A

Protected Constructors

AdornmentLayer()

Summary

This method is the default constructor for the AdornmentLayer.

Remarks

None

Return Value

Type Description
N/A

Parameters

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

Public Properties

Attribution

Summary

N/A

Remarks

N/A

Return Value

String


Background

Summary

N/A

Remarks

N/A

Return Value

GeoColor


BackgroundMask

Summary

N/A

Remarks

N/A

Return Value

AreaStyle


BlueTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


ColorMappings

Summary

N/A

Remarks

N/A

Return Value

Dictionary<GeoColor,GeoColor>


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


Height

Summary

N/A

Remarks

N/A

Return Value

Single


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>


Location

Summary

This property gets and sets the drawing location of the AdornmentLayer.

Remarks

N/A

Return Value

AdornmentLocation


Name

Summary

N/A

Remarks

N/A

Return Value

String


Projection

Summary

N/A

Remarks

N/A

Return Value

Projection


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


Transparency

Summary

N/A

Remarks

N/A

Return Value

Single


Width

Summary

N/A

Remarks

N/A

Return Value

Single


XOffsetInPixel

Summary

This property gets and sets the X pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment.

Return Value

Single


YOffsetInPixel

Summary

This property gets and sets the Y pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment.

Return Value

Single


Protected Properties

ActualWidth

Summary

N/A

Remarks

N/A

Return Value

Single


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

GetDrawingLocation(GeoCanvas,Single,Single)

Summary

This method returns the drawing location of the AdornmentLayer.

Remarks

N/A

Return Value

Type Description
ScreenPointF It returns the upper left screen point of where the AdornmentLayer will be drawn.

Parameters

Name Type Description
canvas GeoCanvas This parameter is the view used in drawing.
adornmentWidth Single This parameter is the width of the adornment.
adornmentHeight Single This parameter is the height of the adornment

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

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

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 AdornmentLayer.

Remarks

This virtual method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided. You can use the full power of the GeoCanvas to do the drawing.

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

OpenCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

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

Public Events

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