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¶
RequestDrawingInterval¶
Gets or sets the interval between automatic draw requests. Obsolete.
public TimeSpan RequestDrawingInterval { 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.
DrawingTime¶
Gets the last recorded drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
TimeSpan
The duration of the most recent draw operation.
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¶
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).
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.
HasBoundingBox¶
Gets a value indicating whether the layer supports retrieving its bounding box.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
When this property is false, calls to or GetFullExtent throw an exception. The default implementation returns false.
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.
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¶
RestrictionLayer()¶
Initializes a new instance of the RestrictionLayer class without any zones.
public RestrictionLayer()
RestrictionLayer(IEnumerable<AreaBaseShape>)¶
Initializes a new instance of the RestrictionLayer class for the specified zones.
public RestrictionLayer(IEnumerable<AreaBaseShape> zones)
Parameters¶
zones IEnumerable<AreaBaseShape>
RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode)¶
Initializes a new instance of the RestrictionLayer 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 RestrictionLayer 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¶
GetRasterContentTypeCore()¶
Restriction zones are rendered as vector cartographic content.
protected RasterContentType GetRasterContentTypeCore()
Returns¶
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.
Returns¶
void
None
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¶
DrawingProgressChanged¶
Occurs as the layer reports drawing progress (useful for async or tiled rendering scenarios).
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
Raised after the drawing buffer elapses so consumers can handle a legacy drawing cycle. Obsolete.
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
Raised before the drawing buffer elapses so consumers can cancel a legacy drawing operation. Obsolete.
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
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;