RestrictionLayer¶
Inheritance Hierarchy¶
Object
Layer
RestrictionLayer
Members Summary¶
Public Constructors Summary¶
Protected Constructors Summary¶
Name |
---|
N/A |
Public Properties Summary¶
Name | Return Type | Description |
---|---|---|
Attribution | String | N/A |
Background | GeoColor | N/A |
BlueTranslation | Single | N/A |
ColorMappings | Dictionary<GeoColor ,GeoColor > | N/A |
CustomStyles | GeoCollection<Style > | Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well. |
DrawingExceptionMode | DrawingExceptionMode | N/A |
DrawingTime | TimeSpan | N/A |
GreenTranslation | Single | N/A |
HasBoundingBox | Boolean | N/A |
IsGrayscale | Boolean | N/A |
IsNegative | Boolean | N/A |
IsOpen | Boolean | N/A |
IsVisible | Boolean | N/A |
KeyColors | Collection<GeoColor > | N/A |
LowerScale | Double | Specifies the lower threshold of the layer. |
Name | String | N/A |
Projection | Projection | N/A |
RedTranslation | Single | N/A |
RequestDrawingInterval | TimeSpan | N/A |
RestrictionMode | RestrictionMode | Specifies whether you want to show or hide zones. |
RestrictionStyle | RestrictionStyle | Specifies the display style of the restriction zones. |
ThreadSafe | ThreadSafetyLevel | N/A |
Transparency | Single | N/A |
UpperScale | Double | Specifies the upper threshold of the layer. |
Zones | GeoCollection<AreaBaseShape > | Specifies the areas you want to restrict. |
Protected Properties Summary¶
Name | Return Type | Description |
---|---|---|
IsOpenCore | Boolean | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
Members Detail¶
Public Constructors¶
Protected Constructors¶
Public Properties¶
Attribution
¶
Summary
N/A
Remarks
N/A
Return Value
String
Background
¶
Summary
N/A
Remarks
N/A
Return Value
BlueTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
ColorMappings
¶
Summary
N/A
Remarks
N/A
Return Value
CustomStyles
¶
Summary
Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well.
Remarks
N/A
Return Value
GeoCollection<Style
>
DrawingExceptionMode
¶
Summary
N/A
Remarks
N/A
Return Value
DrawingTime
¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
GreenTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
HasBoundingBox
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsGrayscale
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsNegative
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsOpen
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsVisible
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
KeyColors
¶
Summary
N/A
Remarks
N/A
Return Value
Collection<GeoColor
>
LowerScale
¶
Summary
Specifies the lower threshold of the layer.
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.
Return Value
Double
Name
¶
Summary
N/A
Remarks
N/A
Return Value
String
Projection
¶
Summary
N/A
Remarks
N/A
Return Value
RedTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
RequestDrawingInterval
¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
RestrictionMode
¶
Summary
Specifies whether you want to show or hide zones.
Remarks
N/A
Return Value
RestrictionStyle
¶
Summary
Specifies the display style of the restriction zones.
Remarks
N/A
Return Value
ThreadSafe
¶
Summary
N/A
Remarks
N/A
Return Value
Transparency
¶
Summary
N/A
Remarks
N/A
Return Value
Single
UpperScale
¶
Summary
Specifies the upper threshold of the layer.
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.
Return Value
Double
Zones
¶
Summary
Specifies the areas you want to restrict.
Remarks
N/A
Return Value
GeoCollection<AreaBaseShape
>
Protected Properties¶
IsOpenCore
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Public Methods¶
CloneDeep()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Layer | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Close()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Draw(GeoCanvas,Collection<SimpleCandidate>)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
labelsInAllLayers | Collection<SimpleCandidate > | N/A |
Equals(Object)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
obj | Object | N/A |
GetBoundingBox()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
RectangleShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetHashCode()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Int32 | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetType()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Type | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Open()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
RequestDrawing()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
RequestDrawing(RectangleShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
RequestDrawing(IEnumerable<RectangleShape>)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
RequestDrawing(TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan | N/A |
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(RectangleShape,TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
bufferTime | TimeSpan | N/A |
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
bufferTime | TimeSpan | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
ToString()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Protected Methods¶
CloneDeepCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Layer | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
CloseCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
DrawAttributionCore(GeoCanvas,String)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
attribution | String | N/A |
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
¶
Summary
This method draws the Layer.
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.
Return Value
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
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. |
DrawException(GeoCanvas,Exception)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
e | Exception | N/A |
DrawExceptionCore(GeoCanvas,Exception)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
e | Exception | N/A |
Finalize()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetBoundingBoxCore()
¶
Summary
This method returns the bounding box of the zones.
Remarks
This method returns the bounding box of the zones.
Return Value
Type | Description |
---|---|
RectangleShape | This method returns the bounding box of the zones. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
MemberwiseClone()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Object | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
args | DrawingAttributionLayerEventArgs | N/A |
OnDrawingException(DrawingExceptionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawingExceptionLayerEventArgs | N/A |
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawingProgressChangedEventArgs | N/A |
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
args | DrawnAttributionLayerEventArgs | N/A |
OnDrawnException(DrawnExceptionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawnExceptionLayerEventArgs | N/A |
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
eventArgs | RequestedDrawingLayerEventArgs | N/A |
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
eventArgs | RequestingDrawingLayerEventArgs | N/A |
OpenCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Public Events¶
DrawingProgressChanged¶
N/A
Remarks
N/A
Event Arguments
DrawingProgressChangedEventArgs
DrawingException¶
N/A
Remarks
N/A
Event Arguments
DrawingExceptionLayerEventArgs
DrawnException¶
N/A
Remarks
N/A
Event Arguments
DrawingAttribution¶
N/A
Remarks
N/A
Event Arguments
DrawingAttributionLayerEventArgs
DrawnAttribution¶
N/A
Remarks
N/A
Event Arguments
DrawnAttributionLayerEventArgs
RequestedDrawing¶
N/A
Remarks
N/A
Event Arguments
RequestedDrawingLayerEventArgs
RequestingDrawing¶
N/A
Remarks
N/A
Event Arguments