thinkgeo.mapsuite.portablecore.restrictionlayer
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.restrictionlayer [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.RestrictionLayer ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | 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.PortableCore.Layer]] | ||
| - | ***[[ThinkGeo.MapSuite.PortableCore.RestrictionLayer]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RestrictionLayer()|RestrictionLayer]] | | | Initializes a new instance of the RestictionLayer class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RestrictionLayer(IEnumerable<AreaBaseShape>)|RestrictionLayer]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]> | | Initializes a new instance of the RestictionLayer class for the specified zones. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode)|RestrictionLayer]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]>, [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]] | | Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode, Double, Double)|RestrictionLayer]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]>, [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]], Double, Double | | Initializes a new instance of the RestictionLayer class for the specified zones, restriction mode, upper scale and lower scale. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Create a copy of Layer using the deep clone process. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method closes the Layer and releases any resources it was using. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Collection<SimpleCandidate>)|Draw]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method draws the Layer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method returns the bounding box of the Layer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method closes the Layer and releases any resources it was using. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas, String)|DrawAttributionCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This method draws the Layer. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This method returns the bounding box of the zones. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomStyles|CustomStyles]] | [[ThinkGeo.MapSuite.PortableCore.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.PortableCore.Style|Style]]> | | Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets the last drawing time for the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | 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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets if the image should be converted to grayscale. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets whether the image should be converted to negative (inverse colors). | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and set the visible state of the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LowerScale|LowerScale]] | Double | | Specifies the lower threshold of the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the name for the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RestrictionMode|RestrictionMode]] | [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]] | | Specifies whether you want to show or hide zones. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RestrictionStyle|RestrictionStyle]] | [[ThinkGeo.MapSuite.PortableCore.RestrictionStyle|RestrictionStyle]] | | Specifies the display style of the restriction zones. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]] | Single | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the amount of transparency to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#UpperScale|UpperScale]] | Double | | Specifies the upper threshold of the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Zones|Zones]] | [[ThinkGeo.MapSuite.PortableCore.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]> | | Specifies the areas you want to restrict. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== RestrictionLayer() ==== | ||
| - | Initializes a new instance of the RestictionLayer class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RestrictionLayer(IEnumerable<AreaBaseShape>) ==== | ||
| - | Initializes a new instance of the RestictionLayer class for the specified zones. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | zones | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.AreaBaseShape} --> | | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RestrictionLayer(IEnumerable<AreaBaseShape>, RestrictionMode) ==== | ||
| - | Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | zones | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.AreaBaseShape} --> | | | ||
| - | | zonesToShowOrHide | [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]]<!-- ThinkGeo.MapSuite.PortableCore.RestrictionMode --> | | | ||
| - | |||
| - | [[#Public Constructors|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. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | zones | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.AreaBaseShape} --> | | | ||
| - | | zonesToShowOrHide | [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]]<!-- ThinkGeo.MapSuite.PortableCore.RestrictionMode --> | | | ||
| - | | upperScale | Double<!-- System.Double --> | | | ||
| - | | lowerScale | Double<!-- System.Double --> | | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== CloneDeep() ==== | ||
| - | Create a copy of Layer using the deep clone process. | ||
| - | === Remarks === | ||
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Close() ==== | ||
| - | This method closes the Layer and releases any resources it was using. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. | ||
| - | |||
| - | If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | ||
| - | |||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(GeoCanvas, Collection<SimpleCandidate>) ==== | ||
| - | This method draws the Layer. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. | ||
| - | |||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetBoundingBox() ==== | ||
| - | This method returns the bounding box of the Layer. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer. | ||
| - | |||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Open() ==== | ||
| - | This method opens the Layer so that it is initialized and ready to use. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. | ||
| - | |||
| - | When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer. | ||
| - | |||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== CloneDeepCore() ==== | ||
| - | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | ||
| - | === Remarks === | ||
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== CloseCore() ==== | ||
| - | This method closes the Layer and releases any resources it was using. | ||
| - | === Remarks === | ||
| - | This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. | ||
| - | |||
| - | If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawAttributionCore(GeoCanvas, String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
| - | | attribution | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|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 ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawException(GeoCanvas, Exception) ==== | ||
| - | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | ||
| - | === Remarks === | ||
| - | This method can be overriden its logic by rewrite the DrawExceptionCore. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawExceptionCore(GeoCanvas, Exception) ==== | ||
| - | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|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 ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the zones. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OpenCore() ==== | ||
| - | This method opens the Layer so that it is initialized and ready to use. | ||
| - | === Remarks === | ||
| - | This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. | ||
| - | |||
| - | When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Attribution ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== CustomStyles ==== | ||
| - | Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.PortableCore.Style|Style]]><!-- ThinkGeo.MapSuite.PortableCore.GeoCollection{ThinkGeo.MapSuite.PortableCore.Style} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingExceptionMode ==== | ||
| - | Gets or sets the DrawExcpetionMode when exception happens. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingTime ==== | ||
| - | This property gets the last drawing time for the layer. | ||
| - | === 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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. | ||
| - | === Remarks === | ||
| - | The default value is false. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsGrayscale ==== | ||
| - | This property gets and sets if the image should be converted to grayscale. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsNegative ==== | ||
| - | This property gets and sets whether the image should be converted to negative (inverse colors). | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsOpen ==== | ||
| - | This property returns true if the Layer is open and false if it is not. | ||
| - | === 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| - | This property gets and set the visible state of the layer. | ||
| - | === 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== LowerScale ==== | ||
| - | Specifies the lower threshold of the layer. | ||
| - | === Remarks === | ||
| - | If Restriction mode is ShowZones: | ||
| - | |||
| - | If currentScale is less than <strong>LowerScale</strong>, 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 <strong>LowerScale</strong>, it will hide the specified zones; otherwise it will do nothing. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Double<!-- System.Double --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Name ==== | ||
| - | This property gets and sets the name for the layer. | ||
| - | === Remarks === | ||
| - | The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RequestDrawingInterval ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RestrictionMode ==== | ||
| - | Specifies whether you want to show or hide zones. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RestrictionMode|RestrictionMode]]<!-- ThinkGeo.MapSuite.PortableCore.RestrictionMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RestrictionStyle ==== | ||
| - | Specifies the display style of the restriction zones. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RestrictionStyle|RestrictionStyle]]<!-- ThinkGeo.MapSuite.PortableCore.RestrictionStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Transparency ==== | ||
| - | This property gets and sets the amount of transparency to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== UpperScale ==== | ||
| - | Specifies the upper threshold of the layer. | ||
| - | === Remarks === | ||
| - | <strong>If Restriction mode is ShowZones:</strong> | ||
| - | |||
| - | If currentScale is greater than <strong>UpperScale</strong>, it will hide the whole map; otherwise, it will show the specified zones. | ||
| - | |||
| - | <strong>If Restriction mode is HideZones:</strong> | ||
| - | |||
| - | If currentScale is less than or equal to <strong>UpperScale</strong> and greater than or equal to LowerScale, it will hide the specified zones; otherwise, it will do nothing. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Double<!-- System.Double --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Zones ==== | ||
| - | Specifies the areas you want to restrict. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.PortableCore.AreaBaseShape|AreaBaseShape]]><!-- ThinkGeo.MapSuite.PortableCore.GeoCollection{ThinkGeo.MapSuite.PortableCore.AreaBaseShape} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RestrictionLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== IsOpenCore ==== | ||
| - | This property returns true if the Layer is open and false if it is not. | ||
| - | === Remarks === | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== DrawingAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingProgressChanged ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestedDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestingDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.restrictionlayer.1440040133.txt.gz ยท Last modified: 2015/09/21 08:17 (external edit)
