MapPrinterLayoutAsyncLayer¶
Namespace: ThinkGeo.Core
A layout layer that renders a map (a set of layers over a map extent) into a print or export layout, with optional interactive inner pan and zoom navigation inside the printer frame.
public class MapPrinterLayoutAsyncLayer : PrinterLayoutAsyncLayer, IInnerNavigationPrinterLayer
Inheritance object → LayerBase → AsyncLayer → PrinterLayoutAsyncLayer → MapPrinterLayoutAsyncLayer
Implements IInnerNavigationPrinterLayer
Properties¶
MapExtent¶
Gets or sets the world extent of the map displayed inside the frame.
public RectangleShape MapExtent { get; set; }
Property Value¶
Layers¶
Gets the collection of layers whose content is drawn inside the map frame.
public GeoCollection<LayerBase> Layers { get; }
Property Value¶
MapUnit¶
Gets or sets the geographic unit the map is measured in.
public GeographyUnit MapUnit { get; set; }
Property Value¶
DrawingMode¶
Gets or sets how the map is drawn (default, raster, or vector).
public MapPrinterDrawingMode DrawingMode { get; set; }
Property Value¶
PreviewDrawingMode¶
Gets or sets how the map is drawn while previewing (use cache or redraw).
public MapPrinterPreviewDrawingMode PreviewDrawingMode { get; set; }
Property Value¶
EnableInnerNavigation¶
Gets or sets whether interactive overlays may pan and zoom the map content inside this printer frame.
public bool EnableInnerNavigation { 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¶
MapPrinterLayoutAsyncLayer()¶
Initializes a new, empty instance of the MapPrinterLayoutAsyncLayer class.
public MapPrinterLayoutAsyncLayer()
MapPrinterLayoutAsyncLayer(IEnumerable<LayerBase>, RectangleShape, GeographyUnit)¶
Initializes a new instance of the MapPrinterLayoutAsyncLayer class with the supplied layers, map extent, and map unit.
public MapPrinterLayoutAsyncLayer(IEnumerable<LayerBase> layers, RectangleShape mapExtent, GeographyUnit mapUnit)
Parameters¶
layers IEnumerable<LayerBase>
The layers whose content is drawn inside the map frame.
mapExtent RectangleShape
The world extent of the map to display.
mapUnit GeographyUnit
The geographic unit the map is measured in.
Methods¶
InvalidateInnerContentCache()¶
Invalidates the cached map image so the next draw regenerates the map content.
public void InvalidateInnerContentCache()
Returns¶
BeginInnerPanSession()¶
Begins a pan-preview session so move updates can stay on cache only.
public bool BeginInnerPanSession()
Returns¶
TryPreviewInnerPan(double, double)¶
Updates pan-preview offsets without committing map extent.
public bool TryPreviewInnerPan(double horizontalPanRatio, double verticalPanRatio)
Parameters¶
horizontalPanRatio double
verticalPanRatio double
Returns¶
EndInnerPanSession(bool)¶
Ends pan-preview and optionally commits the accumulated pan to map extent.
public bool EndInnerPanSession(bool commitPreviewPan)
Parameters¶
commitPreviewPan bool
Returns¶
TryZoomInnerContentAt(double, double, double)¶
Zooms inner map content around an anchor in the printer frame.
public bool TryZoomInnerContentAt(double zoomFactor, double anchorXRatio, double anchorYRatio)
Parameters¶
zoomFactor double
anchorXRatio double
anchorYRatio double
Returns¶
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>)¶
protected Task DrawAsyncCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas GeoCanvas
labelsInAllLayers Collection<SimpleCandidate>
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;