BackgroundLayer¶

Namespace: ThinkGeo.Core

This class draws the background of the map.

public class BackgroundLayer : Layer

Inheritance Object → LayerBase → Layer → BackgroundLayer

Remarks:

This class draws the background of the map.

Properties¶

BackgroundBrush¶

This property gets and sets the brush for this background layer.

public GeoBrush BackgroundBrush { get; set; }

Property Value¶

GeoBrush

Exceptions¶

ArgumentNullException
If you pass a null as the Brush, we will throw an ArgumentNullException.

Remarks:

None

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

RequestDrawingInterval¶

public TimeSpan RequestDrawingInterval { get; set; }

Property Value¶

TimeSpan

Name¶

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value¶

String

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¶

Boolean

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¶

Boolean

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¶

TimeSpan

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¶

Projection

DrawingExceptionMode¶

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

Background¶

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value¶

GeoColor

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¶

Collection<GeoColor>

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¶

Boolean

        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¶

Boolean

Remarks:

The default value is false.

ThreadSafe¶

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value¶

ThreadSafetyLevel

ColorMappings¶

ColorMapping

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value¶

Dictionary<GeoColor, GeoColor>

WrappingMode¶

public WrappingMode WrappingMode { get; set; }

Property Value¶

WrappingMode

WrappingExtent¶

public RectangleShape WrappingExtent { get; set; }

Property Value¶

RectangleShape

Constructors¶

BackgroundLayer()¶

This is the default constructor for the class.

public BackgroundLayer()

Remarks:

This is the default constructor. If you use this constructor, then you need to set the required properties manually.

BackgroundLayer(GeoBrush)¶

This is a constructor for the class.

public BackgroundLayer(GeoBrush backgroundBrush)

Parameters¶

backgroundBrush GeoBrush
This parameter is the brush that will be used draw the background layer.

Remarks:

None

Methods¶

DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶

This method will draw the background layer based on the parameters provided.

protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters¶

canvas GeoCanvas

        This parameter is the GeoCanvas used to Draw the layer.

labelsInAllLayers Collection<SimpleCandidate>
This parameter is not used for BackgroundLayers.

Exceptions¶

InvalidOperationException
In the event you attempt to call this method on a FeatureLayer that is not opened, it will throw an InvalidOperationException.

ArgumentNullException
If you pass a null as the labeledInLayers, we will throw an ArgumentNullException.

ArgumentNullException
If you pass a null as the worldExtent, we will throw an ArgumentNullException.

ArgumentNullException
If you pass a null as the image, we will throw an ArgumentNullException.

Remarks:

None

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;