AdornmentLayer¶
Namespace: ThinkGeo.Core
This is the base class of AdornmentLayers. The AdornmentLayer is used to place adornments on the map. Two types of AdornmentLayers are provided: ScaleLineAdornmentLayer and ScaleBarAdornmentLayer.
public abstract class AdornmentLayer : Layer
Inheritance object → LayerBase → Layer → AdornmentLayer
Properties¶
ResizeScale¶
Gets or sets the resize scale applied to the adornment layer.
public float ResizeScale { get; set; }
Property Value¶
Remarks:
A value of 1 preserves the original size; values greater than 1 enlarge; values less than 1 shrink.
UpdateWhileTransforming¶
Whether to redraw the AdornmentLayer live while the map is being transformed (panning, zooming or rotating). Screen-fixed adornments can leave this false and be repositioned only when the transform completes; adornments whose content tracks the map (a graticule, a scale bar, magnetic declination, and so on) should return true.
public bool UpdateWhileTransforming { get; }
Property Value¶
UpdateWhilePanning¶
Whether to update the AdornmentLayer while panning the map.
public bool UpdateWhilePanning { get; }
Property Value¶
DragMode¶
Gets or sets how the adornment responds to drag operations.
public AdornmentDragMode DragMode { get; set; }
Property Value¶
ResizeMode¶
Gets or sets how the adornment is resized relative to the map view.
public AdornmentResizeMode ResizeMode { get; set; }
Property Value¶
BackgroundMask¶
Gets or sets the fill/outline style drawn behind the adornment content.
public AreaStyle BackgroundMask { get; set; }
Property Value¶
Location¶
This property gets and sets the drawing location of the AdornmentLayer.
public AdornmentLocation Location { get; set; }
Property Value¶
XOffsetInPixel¶
This property gets and sets the X pixel offset for the AdornmentLayer.
public float XOffsetInPixel { get; set; }
Property Value¶
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.
YOffsetInPixel¶
This property gets and sets the Y pixel offset for the AdornmentLayer.
public float YOffsetInPixel { get; set; }
Property Value¶
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.
Name¶
Gets or sets the display name for the layer.
public string Name { get; set; }
Property Value¶
string
The name used to identify the layer within UI components such as legends.
Remarks:
The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.
IsOpen¶
Gets a value indicating whether the layer is currently open.
public bool IsOpen { get; }
Property Value¶
bool
true if the layer has completed its open routine; otherwise, false.
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.
IsVisible¶
Gets or sets a value indicating whether the layer is visible.
public bool IsVisible { get; set; }
Property Value¶
bool
true to draw the layer; otherwise, false.
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.
Projection¶
Gets the projection of the layer.
public Projection Projection { get; set; }
Property Value¶
DrawingExceptionMode¶
Gets or sets how drawing exceptions are handled when the layer renders.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets or sets the background color used when rendering the layer.
public GeoColor Background { get; set; }
Property Value¶
GeoColor
The fill applied to areas not covered by layer content.
Transparency¶
Gets or sets the amount of transparency applied to the rendered image.
public float Transparency { get; set; }
Property Value¶
float
A value between 0 (fully transparent) and 255 (fully opaque).
Opacity¶
Gets or sets the opacity applied to the rendered image.
public float Opacity { get; set; }
Property Value¶
float
A value between 0.0 (fully transparent) and 1.0 (fully opaque).
BlueTranslation¶
Gets or sets the intensity adjustment applied to the blue channel.
public float BlueTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the blue channel translation.
RedTranslation¶
Gets or sets the intensity adjustment applied to the red channel.
public float RedTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the red channel translation.
GreenTranslation¶
Gets or sets the intensity adjustment applied to the green channel.
public float GreenTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the green channel translation.
KeyColors¶
Gets the collection of key colors that should be rendered as transparent.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.
IsNegative¶
Gets or sets a value indicating whether the image should be rendered with inverted colors.
public bool IsNegative { get; set; }
Property Value¶
bool
true to invert the color channels; otherwise, false.
IsGrayscale¶
Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.
public bool IsGrayscale { get; set; }
Property Value¶
bool
true to apply a grayscale filter; otherwise, false.
HasBoundingBox¶
Gets a value indicating whether the layer supports retrieving its bounding box.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
When this property is false, calls to or GetFullExtent throw an exception. The default implementation returns false.
ConcurrentAccess¶
Gets or sets how this layer behaves when more than one thread wants to draw it at once, and what a caller who wants concurrency should therefore do with it.
public ConcurrentAccess ConcurrentAccess { get; set; }
Property Value¶
ConcurrentAccess
unless the layer says otherwise: callers take turns on the one instance, which is what the screen renderer has done with a layer that did not say otherwise since this question was first asked.
Remarks:
A FeatureLayer that is not given a value of its own answers with its FeatureLayer.FeatureSource's, so a layer and the source it reads through cannot disagree about this.
ThreadSafe¶
Gets or sets the threading guarantees provided by the layer implementation.
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.
Remarks:
Replaced by LayerBase.ConcurrentAccess and kept only so that code written against it is told, by name, what to use instead. It does not compile, so there is never a question of which of the two a caller meant: there is one value, and it is the other one. That matters because the translation was lossy in one direction - writing ThreadSafetyLevel.Unsafe could only pick ConcurrentAccess.UnsafeLock, and would silently undo a layer or source that had said ConcurrentAccess.UnsafeClone.
ColorMappings¶
Gets the color translation map that will be applied when rendering the layer.
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
Gets or sets how the layer wraps when the map extent crosses world boundaries.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
Gets or sets the geographic extent to use when wrapping is enabled.
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Methods¶
GetRasterContentTypeCore()¶
Adornments are rendered as vector cartography.
protected RasterContentType GetRasterContentTypeCore()
Returns¶
GetWidth()¶
Gets the current adornment width, honoring overrides in derived classes.
public float GetWidth()
Returns¶
GetWidthCore()¶
When overridden in a derived class, returns the adornment width that exposes. A layer that does not override it has no width of its own.
protected float GetWidthCore()
Returns¶
GetHeight()¶
Gets the current adornment height, honoring overrides in derived classes.
public float GetHeight()
Returns¶
GetHeightCore()¶
When overridden in a derived class, returns the adornment height that exposes. A layer that does not override it has no height of its own.
protected float GetHeightCore()
Returns¶
DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶
This method draws the AdornmentLayer.
protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
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.
Returns¶
void
None
Exceptions¶
ArgumentNullException
If you pass a null as the geoCanvas, we will throw an ArgumentNullException.
ArgumentNullException
If you pass a null as the labelsInAllLayers, we will throw an ArgumentNullException.
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.
GetDrawingLocation(GeoCanvas, float, float)¶
This method returns the drawing location of the AdornmentLayer.
public ScreenPointF GetDrawingLocation(GeoCanvas canvas, float adornmentWidth, float adornmentHeight)
Parameters¶
canvas GeoCanvas
This parameter is the view used in drawing.
adornmentWidth float
This parameter is the width of the adornment.
adornmentHeight float
This parameter is the height of the adornment
Returns¶
It returns the upper left screen point of where the AdornmentLayer will be
drawn.
GetSelectionLocation(float, float, float, float)¶
Returns the screen location used for hit-testing/selection.
public ScreenPointF GetSelectionLocation(float mapWidth, float mapHeight, float adornmentWidth, float adornmentHeight)
Parameters¶
mapWidth float
Map width in screen pixels.
mapHeight float
Map height in screen pixels.
adornmentWidth float
Adornment width in pixels.
adornmentHeight float
Adornment height in pixels.
Returns¶
GetSelectionLocationCore(float, float, float, float)¶
When overridden in a derived class, returns the screen location that AdornmentLayer.GetSelectionLocation(float, float, float, float) exposes.
protected ScreenPointF GetSelectionLocationCore(float mapWidth, float mapHeight, float adornmentWidth, float adornmentHeight)
Parameters¶
mapWidth float
mapHeight float
adornmentWidth float
adornmentHeight float
Returns¶
GetAdornmentLocation(AdornmentLocation, float, float, float, float, float, float, float, bool)¶
Computes the upper-left screen location for an adornment of the given size, anchored at the specified location within the map.
public static ScreenPointF GetAdornmentLocation(AdornmentLocation location, float mapWidth, float mapHeight, float adornmentWidth, float adornmentHeight, float margin, float offsetX, float offsetY, bool centerUsesHalfSize)
Parameters¶
location AdornmentLocation
The anchor position (for example a corner or center) within the map.
mapWidth float
The map width, in pixels.
mapHeight float
The map height, in pixels.
adornmentWidth float
The adornment width, in pixels.
adornmentHeight float
The adornment height, in pixels.
margin float
The margin, in pixels, between the adornment and the map edge.
offsetX float
An additional horizontal offset, in pixels.
offsetY float
An additional vertical offset, in pixels.
centerUsesHalfSize bool
When true, centered anchors offset by half the adornment size so the adornment is centered on the anchor point.
Returns¶
ScreenPointF
The computed adornment location on screen.
Events¶
DrawingProgressChanged¶
Occurs as the layer reports drawing progress (useful for async or tiled rendering scenarios).
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
DrawingException¶
Occurs when the DrawingException event is raised.
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
Occurs when the DrawnException event is raised.
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;