thinkgeo.mapsuite.core.adornmentlayer
Differences
This shows you the differences between two versions of the page.
|
thinkgeo.mapsuite.core.adornmentlayer [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.adornmentlayer [2017/03/16 21:59] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.AdornmentLayer ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This is the base class of AdornmentLayers. The AdornmentLayer is used to place adornments on the map. Two types of AdornmentLayers are provided: ScaleLineAdornmentLayer and ScaleBarAdornmentLayer. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.Layer]] | ||
| - | ***[[ThinkGeo.MapSuite.Core.AdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.GraticuleAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.KmlAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.LegendAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.LogoAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.MagneticDeclinationAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.ScaleLineAdornmentLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.ScaleTextAdornmentLayer]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#AdornmentLayer()|AdornmentLayer]] | | | This method is the default constructor for the AdornmentLayer. | | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Create a copy of Layer using the deep clone process. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.Core.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.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.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.Core.Layer|Layer]] | This method returns the bounding box of the Layer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDrawingLocation(GeoCanvas, Single, Single)|GetDrawingLocation]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Single, Single | | This method returns the drawing location of the AdornmentLayer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Uri)|LoadLayer]] | Uri | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Stream)|LoadLayer]] | Stream | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.Core.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.Core.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.Core.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.Core.GeoCanvas|GeoCanvas]], String | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]](overriden) | This method draws the AdornmentLayer. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.Core.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.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.Core.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.Core.Layer|Layer]] | This method returns the bounding box of the Layer. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.Core.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.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BackgroundMask|BackgroundMask]] | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of blue to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets the last drawing time for the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of green to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.Core.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}}[[#Height|Height]] | Single | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]] | Boolean | [[ThinkGeo.MapSuite.Core.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.Core.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.Core.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.Core.Layer|Layer]] | This property gets and set the visible state of the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#KeyColors|KeyColors]] | Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Location|Location]] | [[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]] | | This property gets and sets the drawing location of the AdornmentLayer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the name for the layer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RedTranslation|RedTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of red to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of transparency to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Width|Width]] | Single | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#XOffsetInPixel|XOffsetInPixel]] | Single | | This property gets and sets the X pixel offset for the AdornmentLayer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#YOffsetInPixel|YOffsetInPixel]] | Single | | This property gets and sets the Y pixel offset for the AdornmentLayer. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.Core.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.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | ==== AdornmentLayer() ==== | ||
| - | This method is the default constructor for the AdornmentLayer. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ===== 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.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | A cloned Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.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.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This method returns the bounding box of the Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetDrawingLocation(GeoCanvas, Single, Single) ==== | ||
| - | This method returns the drawing location of the AdornmentLayer. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.Core.ScreenPointF --> | It returns the upper left screen point of where the AdornmentLayer will be drawn. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas used in drawing. | | ||
| - | | adornmentWidth | Single<!-- System.Single --> | This parameter is the width of the adornment. | | ||
| - | | adornmentHeight | Single<!-- System.Single --> | This parameter is the height of the adornment | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#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]] | ||
| - | ==== LoadLayer(Uri) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | layerUri | Uri<!-- System.Uri --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadLayer(Stream) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | layerStream | Stream<!-- System.IO.Stream --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#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.Core.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.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(TimeSpan, RequestDrawingBufferTimeType) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | A cloned Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawAttributionCore(GeoCanvas, String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | attribution | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ==== | ||
| - | This method draws the AdornmentLayer. | ||
| - | === Remarks === | ||
| - | This virtual method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided. | ||
| - | |||
| - | You can use the full power of the GeoCanvas to do the drawing. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object (or a GeoImage) to draw on. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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 Layer. | ||
| - | === Remarks === | ||
| - | This method returns the bounding box of the Layer. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This method returns the bounding box of the Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#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.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Attribution ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== BackgroundMask ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== BlueTranslation ==== | ||
| - | This property gets and sets the amount of blue to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingExceptionMode ==== | ||
| - | Gets or sets the DrawExcpetionMode when exception happens. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== GreenTranslation ==== | ||
| - | This property gets and sets the amount of green to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.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.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Height ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#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.Core.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.Core.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.Core.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.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== KeyColors ==== | ||
| - | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | ||
| - | === Remarks === | ||
| - | It will make these colors transparent when draw image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.GeoColor} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Location ==== | ||
| - | This property gets and sets the drawing location of the AdornmentLayer. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]]<!-- ThinkGeo.MapSuite.Core.AdornmentLocation --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#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.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RedTranslation ==== | ||
| - | This property gets and sets the amount of red to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RequestDrawingInterval ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#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.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Width ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== XOffsetInPixel ==== | ||
| - | This property gets and sets the X pixel offset for the AdornmentLayer. | ||
| - | === Remarks === | ||
| - | This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== YOffsetInPixel ==== | ||
| - | This property gets and sets the Y pixel offset for the AdornmentLayer. | ||
| - | === Remarks === | ||
| - | This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AdornmentLayer --> | ||
| - | [[#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.Core.Layer --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== DrawingAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingProgressChanged ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestedDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestingDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.adornmentlayer.txt ยท Last modified: 2017/03/16 21:59 (external edit)