PrinterLayer¶
Namespace: ThinkGeo.Core
public abstract class PrinterLayer : Layer
Inheritance Object → LayerBase → Layer → PrinterLayer
Properties¶
IsDrawing¶
public bool IsDrawing { get; set; }
Property Value¶
HasBoundingBox¶
public bool HasBoundingBox { get; }
Property Value¶
BackgroundMask¶
public AreaStyle BackgroundMask { get; set; }
Property Value¶
ResizeMode¶
public PrinterResizeMode ResizeMode { get; set; }
Property Value¶
DragMode¶
public PrinterDragMode DragMode { get; set; }
Property Value¶
IsResizing¶
public bool IsResizing { get; set; }
Property Value¶
SelectabilityMode¶
public PrinterLayerSelectabilityMode SelectabilityMode { get; set; }
Property Value¶
Attribution¶
public string Attribution { get; set; }
Property Value¶
RequestDrawingInterval¶
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
This property gets and sets the name for the layer.
public string Name { get; set; }
Property Value¶
Remarks:
The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
IsOpen¶
This property returns true if the Layer is open and false if it is not.
public bool IsOpen { get; }
Property Value¶
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¶
This property gets and set the visible state of the layer.
public bool IsVisible { get; set; }
Property Value¶
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.
DrawingTime¶
This property gets the last drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
Remarks:
We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
Projection¶
Gets the projection of the layer.
public Projection Projection { get; set; }
Property Value¶
DrawingExceptionMode¶
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets and sets the background of the layer.
public GeoColor Background { get; set; }
Property Value¶
Transparency¶
This property gets and sets the amount of transparency to apply to the image.
public float Transparency { get; set; }
Property Value¶
Single
This property gets the amount of transparency to apply to the image.
Remarks:
None
BlueTranslation¶
This property gets and sets the amount of blue to apply to the image.
public float BlueTranslation { get; set; }
Property Value¶
Single
This property gets the amount of blue to apply to the image.
Remarks:
None
RedTranslation¶
This property gets and sets the amount of red to apply to the image.
public float RedTranslation { get; set; }
Property Value¶
Single
This property gets the amount of red to apply to the image.
Remarks:
None
GreenTranslation¶
This property gets and sets the amount of green to apply to the image.
public float GreenTranslation { get; set; }
Property Value¶
Single
This property gets the amount of green to apply to the image.
Remarks:
None
KeyColors¶
Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
It will make these colors transparent when draw image.
IsNegative¶
This property gets and sets whether the image should be converted to negative (inverse colors).
public bool IsNegative { get; set; }
Property Value¶
Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).
Remarks:
None
IsGrayscale¶
This property gets and sets if the image should be converted to grayscale.
public bool IsGrayscale { get; set; }
Property Value¶
This property gets and sets if the image should be converted to grayscale.
Remarks:
None
ThreadSafe¶
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ColorMappings¶
ColorMapping
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Methods¶
DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶
protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas GeoCanvas
labelsInAllLayers Collection<SimpleCandidate>
GetBoundingBoxCore()¶
protected RectangleShape GetBoundingBoxCore()
Returns¶
GetDynamicBoundingBox()¶
public RectangleShape GetDynamicBoundingBox()
Returns¶
GetDynamicBoundingBoxCore()¶
protected RectangleShape GetDynamicBoundingBoxCore()
Returns¶
GetPosition()¶
public RectangleShape GetPosition()
Returns¶
GetPosition(PrintingUnit)¶
public RectangleShape GetPosition(PrintingUnit unit)
Parameters¶
unit PrintingUnit
Returns¶
GetPositionCore(PrintingUnit)¶
protected RectangleShape GetPositionCore(PrintingUnit unit)
Parameters¶
unit PrintingUnit
Returns¶
SetPosition(RectangleShape)¶
public void SetPosition(RectangleShape boundingBox)
Parameters¶
boundingBox RectangleShape
SetPosition(RectangleShape, PrintingUnit)¶
public void SetPosition(RectangleShape boundingBox, PrintingUnit unit)
Parameters¶
boundingBox RectangleShape
unit PrintingUnit
SetPosition(Double, Double, PointShape, PrintingUnit)¶
public void SetPosition(double width, double height, PointShape centerPoint, PrintingUnit unit)
Parameters¶
width Double
height Double
centerPoint PointShape
unit PrintingUnit
SetPosition(Double, Double, Double, Double, PrintingUnit)¶
public void SetPosition(double width, double height, double centerPointX, double centerPointY, PrintingUnit unit)
Parameters¶
width Double
height Double
centerPointX Double
centerPointY Double
unit PrintingUnit
SetPosition(Double, Double, LayerAnchorLocation, PointShape, PrintingUnit)¶
public void SetPosition(double width, double height, LayerAnchorLocation corner, PointShape cornerPoint, PrintingUnit unit)
Parameters¶
width Double
height Double
corner LayerAnchorLocation
cornerPoint PointShape
unit PrintingUnit
SetPosition(Double, Double, LayerAnchorLocation, Double, Double, PrintingUnit)¶
public void SetPosition(double width, double height, LayerAnchorLocation corner, double cornerPointX, double cornerPointY, PrintingUnit unit)
Parameters¶
width Double
height Double
corner LayerAnchorLocation
cornerPointX Double
cornerPointY Double
unit PrintingUnit
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¶
Events¶
DrawingAttribution¶
public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;
DrawnAttribution¶
public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;
DrawingProgressChanged¶
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
DrawingException¶
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;