LayerBase¶
Namespace: ThinkGeo.Core
This class is the base class for all types of Layers.
public abstract class LayerBase
Inheritance Object → LayerBase
Remarks:
The LayerBase class is where all other types of layers are inherited from. It provides the base set of functionality. Though all Layers inherit from this class, we strongly suggest if you decide to create your own LayerBase type that you consider inheriting from the higher level RasterLayer for image-based layers and FeatureLayer for feature-based layers. They provide a rich set of default operations for the various types of layers and are simple to inherit from.
Properties¶
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
HasBoundingBox¶
This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
The default value is false.
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¶
IsDrawingNeeded(Double)¶
public bool IsDrawingNeeded(double currentScale)
Parameters¶
currentScale Double
Returns¶
IsDrawingNeededCore(Double)¶
protected bool IsDrawingNeededCore(double currentScale)
Parameters¶
currentScale Double
Returns¶
DrawException(GeoCanvas, Exception)¶
This method will draw on the view when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
protected void DrawException(GeoCanvas canvas, Exception e)
Parameters¶
canvas GeoCanvas
The target view to draw the layer.
e Exception
The exception thrown when layer.Draw().
Remarks:
This method can be overriden its logic by rewrite the DrawExceptionCore.
DrawExceptionCore(GeoCanvas, Exception)¶
This method will draw on the view when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
protected void DrawExceptionCore(GeoCanvas canvas, Exception e)
Parameters¶
canvas GeoCanvas
The target view to draw the layer.
e Exception
The exception thrown when layer.Draw().
OnDrawingException(DrawingExceptionLayerEventArgs)¶
protected void OnDrawingException(DrawingExceptionLayerEventArgs e)
Parameters¶
e DrawingExceptionLayerEventArgs
GetBoundingBox()¶
This method returns the bounding box of the Layer.
public RectangleShape GetBoundingBox()
Returns¶
RectangleShape
This method returns the bounding box of the Layer.
Remarks:
This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.
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.
GetBoundingBoxCore()¶
This method returns the bounding box of the Layer.
protected RectangleShape GetBoundingBoxCore()
Returns¶
RectangleShape
This method returns the bounding box of the Layer.
Exceptions¶
InvalidOperationException
In the event you attempt to call this method on a layer which has not been opened, it will throw an InvalidOperationException.
Remarks:
This method returns the bounding box of the Layer.
OnDrawnException(DrawnExceptionLayerEventArgs)¶
protected void OnDrawnException(DrawnExceptionLayerEventArgs e)
Parameters¶
e DrawnExceptionLayerEventArgs
CloneDeep()¶
Create a copy of LayerBase using the deep clone process.
public LayerBase CloneDeep()
Returns¶
LayerBase
A cloned LayerBase.
Remarks:
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
CloneDeepCore()¶
Create a copy of LayerBase using the deep clone process. The default implemenation uses serialization.
protected LayerBase CloneDeepCore()
Returns¶
LayerBase
A cloned LayerBase.
Remarks:
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Events¶
DrawingException¶
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;