RestrictionLayer¶
Namespace: ThinkGeo.Core
This layer can show or hide one or many zones that you want to restrict from being displayed. You can use the specified style to decorate the zones and set the lower/upper scale to control at which zoom levels you want to show or hide the zones. The default decoration style is a hatch pattern. You can change this to a circle with slash image, or, if you want a different look, you can use custom styles.
public class RestrictionLayer : Layer
Inheritance Object → LayerBase → Layer → RestrictionLayer
Properties¶
UpperScale¶
Specifies the upper threshold of the layer.
public double UpperScale { get; set; }
Property Value¶
Remarks:
If Restriction mode is ShowZones:
If currentScale is greater than UpperScale, it will hide the whole map; otherwise, it will show the specified zones.
If Restriction mode is HideZones:
If currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, it will hide the specified zones; otherwise, it will do nothing.
LowerScale¶
Specifies the lower threshold of the layer.
public double LowerScale { get; set; }
Property Value¶
Remarks:
If Restriction mode is ShowZones:
If currentScale is less than LowerScale, it will hide the whole map; otherwise, it will show the specified zones.
If Restriction mode is HideZones:
if currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, it will hide the specified zones; otherwise it will do nothing.
CustomStyles¶
Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well.
public GeoCollection<Style> CustomStyles { get; }
Property Value¶
RestrictionMode¶
Specifies whether you want to show or hide zones.
public RestrictionMode RestrictionMode { get; set; }
Property Value¶
Zones¶
Specifies the areas you want to restrict.
public GeoCollection<AreaBaseShape> Zones { get; }
Property Value¶
RestrictionStyle¶
Specifies the display style of the restriction zones.
public RestrictionStyle RestrictionStyle { 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
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¶
Constructors¶
RestrictionLayer()¶
Initializes a new instance of the RestictionLayer class.
public RestrictionLayer()
RestrictionLayer(IEnumerable<AreaBaseShape>)¶
Initializes a new instance of the RestictionLayer class for the specified zones.
public RestrictionLayer(IEnumerable<AreaBaseShape> zones)
Parameters¶
zones IEnumerable<AreaBaseShape>
RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode)¶
Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode.
public RestrictionLayer(IEnumerable<AreaBaseShape> zones, RestrictionMode zonesToShowOrHide)
Parameters¶
zones IEnumerable<AreaBaseShape>
zonesToShowOrHide RestrictionMode
RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode, Double, Double)¶
Initializes a new instance of the RestictionLayer class for the specified zones, restriction mode, upper scale and lower scale.
public RestrictionLayer(IEnumerable<AreaBaseShape> zones, RestrictionMode zonesToShowOrHide, double upperScale, double lowerScale)
Parameters¶
zones IEnumerable<AreaBaseShape>
zonesToShowOrHide RestrictionMode
upperScale Double
lowerScale Double
Methods¶
GetBoundingBoxCore()¶
This method returns the bounding box of the zones.
protected RectangleShape GetBoundingBoxCore()
Returns¶
RectangleShape
This method returns the bounding box of the zones.
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 zones.
DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶
This method draws the Layer.
protected void DrawCore(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.
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.
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;