ScaleBarPrinterLayoutAsyncLayer¶
Namespace: ThinkGeo.Core
A layout layer that draws a graphical scale bar showing ground distance for the map inside the layout.
public class ScaleBarPrinterLayoutAsyncLayer : PrinterLayoutAsyncLayer
Inheritance object → LayerBase → AsyncLayer → PrinterLayoutAsyncLayer → ScaleBarPrinterLayoutAsyncLayer
Properties¶
MapLayer¶
Gets or sets the map layout layer this scale bar measures.
public MapPrinterLayoutAsyncLayer MapLayer { get; set; }
Property Value¶
DisplayUnitString¶
This property is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.
public Dictionary<string, string> DisplayUnitString { get; }
Property Value¶
Remarks:
We will display different letters for different units of measure; for example: "m" for meters, "ft" for feet, etc.
UnitFamily¶
Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
public UnitSystem UnitFamily { get; set; }
Property Value¶
Remarks:
By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.
Thickness¶
Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
public int Thickness { get; set; }
Property Value¶
BarBrush¶
The property is the GeoBrush that will be used to draw the ScaleBar.
public GeoBrush BarBrush { get; set; }
Property Value¶
Remarks:
This BarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
BarPen¶
Gets or sets the pen used to draw the scale bar frame and tick lines.
public GeoPen BarPen { get; set; }
Property Value¶
TextStyle¶
Gets or sets the text style used to draw the scale bar's numeric labels and unit name.
public TextStyle TextStyle { get; set; }
Property Value¶
AlternateBarBrush¶
The property is the GeoBrush that will be used to draw the alternate ScaleBar.
public GeoBrush AlternateBarBrush { get; set; }
Property Value¶
Remarks:
This AlternateBarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
MaskBrush¶
Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.
public GeoBrush MaskBrush { get; set; }
Property Value¶
HasMask¶
Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.
public bool HasMask { get; set; }
Property Value¶
Remarks:
Depending upon the look of your map and your requirements, you may or may not want a mask on the ScaleBar. You can control whether or not the ScaleBar has a mask by setting this property. If you set the HasMask property to true, be sure to specify a mask color (or texture) by using the MaskBrush property.
MaskContour¶
Gets or sets the pen for the outline of the ScaleBar mask.
public GeoPen MaskContour { get; set; }
Property Value¶
Remarks:
By using this property you can control the border of the mask, if the HasMask property is set to true. If you do not want a contour or border to show, you should set the pen to transparent.
DynamicBoundingBox¶
Gets or sets whether the ScaleBar will have a dynamic bounding box or not. The default value is false. If it's true, GetBoundingBox() will return a recalculated bounding box based on rendering area instead of the bounding box from SetPosition().
public bool DynamicBoundingBox { get; set; }
Property Value¶
HasBoundingBox¶
Gets a value indicating that printer layers always expose a bounding box.
public bool HasBoundingBox { get; }
Property Value¶
BackgroundMask¶
Gets or sets the fill and outline mask drawn beneath the layer content.
public AreaStyle BackgroundMask { get; set; }
Property Value¶
ResizeMode¶
Gets or sets how the layer responds to resize operations.
public PrinterResizeMode ResizeMode { get; set; }
Property Value¶
DragMode¶
Gets or sets how the layer responds to drag operations in the layout designer.
public PrinterDragMode DragMode { get; set; }
Property Value¶
IsResizing¶
Gets or sets a value indicating whether the layer is currently being resized.
public bool IsResizing { get; set; }
Property Value¶
SelectabilityMode¶
Gets or sets whether the layer can be selected in the layout designer.
public PrinterLayerSelectabilityMode SelectabilityMode { get; set; }
Property Value¶
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.
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¶
Constructors¶
ScaleBarPrinterLayoutAsyncLayer(MapPrinterLayoutAsyncLayer)¶
Creates a new instance of the ScaleBarAdornmentLayer class.
public ScaleBarPrinterLayoutAsyncLayer(MapPrinterLayoutAsyncLayer mapLayer)
Parameters¶
mapLayer MapPrinterLayoutAsyncLayer
Remarks:
The ScaleBar will not be drawn when the CurrentExtent is outside of the world Extent(-90,180-,90,-180).
Methods¶
OpenAsyncCore(CancellationToken)¶
protected Task OpenAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken CancellationToken
Returns¶
CloseAsyncCore(CancellationToken)¶
protected Task CloseAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken CancellationToken
Returns¶
DrawAsyncCore(GeoCanvas, Collection<SimpleCandidate>)¶
This method draws the Layer.
protected Task DrawAsyncCore(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¶
Task
None
Remarks:
This abstract method is called from the concrete public method Draw. 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 to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
SetPositionCore(double, double, double, double, PrintingUnit)¶
protected RectangleShape SetPositionCore(double width, double height, double centerPointX, double centerPointY, PrintingUnit unit)
Parameters¶
width double
height double
centerPointX double
centerPointY double
unit PrintingUnit
Returns¶
GetDynamicBoundingBoxCore()¶
protected RectangleShape GetDynamicBoundingBoxCore()
Returns¶
Events¶
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;