User Tools

Site Tools


thinkgeo.mapsuite.core.restrictionlayer

This is an old revision of the document!


ThinkGeo.MapSuite.Core.RestrictionLayer

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.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.Layer
      • ThinkGeo.MapSuite.Core.RestrictionLayer

Members Summary

Public Constructors

RestrictionLayer

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:Initializes a new instance of the RestictionLayer class.

RestrictionLayer

  • Parameters:IEnumerable<AreaBaseShape>
  • DeclaringType:N/A
  • Summary:Initializes a new instance of the RestictionLayer class for the specified zones.

RestrictionLayer

  • Parameters:IEnumerable<AreaBaseShape>,RestrictionMode
  • DeclaringType:N/A
  • Summary:Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode.

RestrictionLayer

  • Parameters:IEnumerable<AreaBaseShape>,RestrictionMode,Double,Double
  • DeclaringType:N/A
  • Summary:Initializes a new instance of the RestictionLayer class for the specified zones, restriction mode, upper scale and lower scale.

Protected Constructors

Public Methods

CloneDeep

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Close

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Draw

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBox

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetThreadSafetyLevel

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Open

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:TimeSpan
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Protected Methods

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

CloseCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

DrawAttributionCore

DrawCore

DrawException

DrawExceptionCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBoxCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the bounding box of the zones.

GetThreadSafetyLevelCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OnDrawingAttribution

OnDrawingException

OnDrawingProgressChanged

OnDrawnAttribution

OnDrawnException

OnRequestedDrawing

OnRequestingDrawing

OpenCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Public Properties

Attribution

  • Return:String
  • Summary:N/A

BlueTranslation

  • Return:Single
  • Summary:N/A

CustomStyles

DrawingExceptionMode

DrawingTime

  • Return:TimeSpan
  • Summary:N/A

GreenTranslation

  • Return:Single
  • Summary:N/A

HasBoundingBox

  • Return:Boolean
  • Summary:N/A

IsGrayscale

  • Return:Boolean
  • Summary:N/A

IsNegative

  • Return:Boolean
  • Summary:N/A

IsOpen

  • Return:Boolean
  • Summary:N/A

IsVisible

  • Return:Boolean
  • Summary:N/A

KeyColors

  • Return:Collection<GeoColor>
  • Summary:N/A

LowerScale

  • Return:Double
  • Summary:Specifies the lower threshold of the layer.

Name

  • Return:String
  • Summary:N/A

RedTranslation

  • Return:Single
  • Summary:N/A

RequestDrawingInterval

  • Return:TimeSpan
  • Summary:N/A

RestrictionMode

  • Summary:Specifies whether you want to show or hide zones.

RestrictionStyle

  • Summary:Specifies the display style of the restriction zones.

Transparency

  • Return:Single
  • Summary:N/A

UpperScale

  • Return:Double
  • Summary:Specifies the upper threshold of the layer.

Zones

Protected Properties

IsOpenCore

  • Return:Boolean
  • Summary:N/A

Public Events

Public Constructors

RestrictionLayer()

Initializes a new instance of the RestictionLayer class.

Remarks

N/A

Parameters

RestrictionLayer(IEnumerable<AreaBaseShape>)

Initializes a new instance of the RestictionLayer class for the specified zones.

Remarks

N/A

Parameters

zones

  • Type:IEnumerable<AreaBaseShape>
  • Description:N/A Go Back === RestrictionLayer(IEnumerable<AreaBaseShape>,RestrictionMode) === Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode. ==== Remarks ==== N/A ==== Parameters ==== zones * Type:IEnumerable<AreaBaseShape> * Description:N/A

zonesToShowOrHide

  • Description:N/A Go Back === 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. ==== Remarks ==== N/A ==== Parameters ==== zones * Type:IEnumerable<AreaBaseShape> * Description:N/A

zonesToShowOrHide

  • Description:N/A upperScale * Type:Double * Description:N/A

lowerScale

  • Type:Double
  • Description:N/A Go Back ===== Protected Constructors ===== ===== Public Methods ===== === CloneDeep() === N/A ==== Remarks ==== N/A Return Value * Return Type:Layer * Description:N/A ==== Parameters ==== Go Back === Close() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === Draw(GeoCanvas,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A labelsInAllLayers * Type:Collection<SimpleCandidate> * Description:N/A Go Back === Equals(Object) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== obj * Type:Object * Description:N/A Go Back === GetBoundingBox() === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== Go Back === GetHashCode() === N/A ==== Remarks ==== N/A Return Value * Return Type:Int32 * Description:N/A ==== Parameters ==== Go Back === GetThreadSafetyLevel() === N/A ==== Remarks ==== N/A Return Value * Return Type:ThreadSafetyLevel * Description:N/A ==== Parameters ==== Go Back === GetType() === N/A ==== Remarks ==== N/A Return Value * Return Type:Type * Description:N/A ==== Parameters ==== Go Back === Open() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === RequestDrawing(RectangleShape,TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === RequestDrawing(TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing(IEnumerable<RectangleShape>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A Go Back === RequestDrawing(RectangleShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A Go Back === RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === ToString() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back ===== Protected Methods ===== === CloneDeepCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Layer * Description:N/A ==== Parameters ==== Go Back === CloseCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === DrawAttributionCore(GeoCanvas,String) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A attribution * Type:String * Description:N/A Go Back === DrawCore(GeoCanvas,Collection<SimpleCandidate>) === 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 * Return Type:Void * Description:None ==== Parameters ==== canvas * Type:GeoCanvas * Description:This parameter is the canvas object or a GeoImage to draw on. labelsInAllLayers * Type:Collection<SimpleCandidate> * Description:This parameter represents the labels used for collision detection and duplication checking. Go Back === DrawException(GeoCanvas,Exception) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A e * Type:Exception * Description:N/A Go Back === DrawExceptionCore(GeoCanvas,Exception) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A e * Type:Exception * Description:N/A Go Back === Finalize() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === GetBoundingBoxCore() === This method returns the bounding box of the zones. ==== Remarks ==== This method returns the bounding box of the zones. Return Value * Return Type:RectangleShape * Description:This method returns the bounding box of the zones. ==== Parameters ==== Go Back === GetThreadSafetyLevelCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:ThreadSafetyLevel * Description:N/A ==== Parameters ==== Go Back === MemberwiseClone() === N/A ==== Remarks ==== N/A Return Value * Return Type:Object * Description:N/A ==== Parameters ==== Go Back === OnDrawingAttribution(DrawingAttributionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== args * Type:DrawingAttributionLayerEventArgs * Description:N/A Go Back === OnDrawingException(DrawingExceptionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawingExceptionLayerEventArgs * Description:N/A Go Back === OnDrawingProgressChanged(DrawingProgressChangedEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawingProgressChangedEventArgs * Description:N/A Go Back === OnDrawnAttribution(DrawnAttributionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== args * Type:DrawnAttributionLayerEventArgs * Description:N/A Go Back === OnDrawnException(DrawnExceptionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawnExceptionLayerEventArgs * Description:N/A Go Back === OnRequestedDrawing(RequestedDrawingLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== eventArgs * Type:RequestedDrawingLayerEventArgs * Description:N/A Go Back === OnRequestingDrawing(RequestingDrawingLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== eventArgs * Type:RequestingDrawingLayerEventArgs * Description:N/A Go Back === OpenCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back ===== Public Properties ===== === Attribution === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === BlueTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === CustomStyles === 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 ==== Return Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Style, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]] Go Back === DrawingExceptionMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:DrawingExceptionMode Go Back === DrawingTime === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:TimeSpan Go Back === GreenTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === HasBoundingBox === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsGrayscale === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsNegative === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsOpen === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsVisible === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === KeyColors === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Collection<GeoColor> Go Back === LowerScale === 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 ==== Return Type:Double Go Back === Name === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === RedTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === RequestDrawingInterval === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:TimeSpan Go Back === RestrictionMode === Specifies whether you want to show or hide zones. ==== Remarks ==== N/A ==== Return Value ==== Return Type:RestrictionMode Go Back === RestrictionStyle === Specifies the display style of the restriction zones. ==== Remarks ==== N/A ==== Return Value ==== Return Type:RestrictionStyle Go Back === Transparency === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === UpperScale === 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 ==== Return Type:Double Go Back === Zones === Specifies the areas you want to restrict. ==== Remarks ==== N/A ==== Return Value ==== Return Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AreaBaseShape, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]] Go Back ===== Protected Properties ===== === IsOpenCore === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back ===== Public Events ===== === DrawingAttribution === N/A ==== Remarks ==== N/A Event Arguments:DrawingAttributionLayerEventArgs Go Back === DrawingException === N/A ==== Remarks ==== N/A Event Arguments:DrawingExceptionLayerEventArgs Go Back === DrawingProgressChanged === N/A ==== Remarks ==== N/A Event Arguments:DrawingProgressChangedEventArgs Go Back === DrawnAttribution === N/A ==== Remarks ==== N/A Event Arguments:DrawnAttributionLayerEventArgs Go Back === DrawnException === N/A ==== Remarks ==== N/A Event Arguments:DrawnExceptionLayerEventArgs Go Back === RequestedDrawing === N/A ==== Remarks ==== N/A Event Arguments:RequestedDrawingLayerEventArgs Go Back === RequestingDrawing === N/A ==== Remarks ==== N/A Event Arguments**:RequestingDrawingLayerEventArgs

Go Back

thinkgeo.mapsuite.core.restrictionlayer.1442486321.txt.gz · Last modified: 2015/09/17 10:38 by admin