ThinkGeo.MapSuite.Layers.Layer
Inheritance Hierarchy
Members Summary
Public Constructors
Protected Constructors
Layer()
Parameters
Public Methods
GetThreadSafetyLevel()
Return Value
Parameters
CloneDeep()
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
Parameters
Open()
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
Type:Void
Description:None
Parameters
Close()
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
Type:Void
Description:None
Parameters
GetBoundingBox()
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
Parameters
Draw(GeoCanvas,Collection<SimpleCandidate>)
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
Type:Void
Description:None
Parameters
RequestDrawing()
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(RectangleShape)
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(IEnumerable<RectangleShape>)
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
ToString()
Return Value
Type:String
Description:N/A
Parameters
Equals(Object)
Return Value
Type:Boolean
Description:N/A
Parameters
obj
Type:Object
Description:N/A
GetHashCode()
Return Value
Type:Int32
Description:N/A
Parameters
GetType()
Return Value
Type:Type
Description:N/A
Parameters
LoadLayer(Uri)
Return Value
Parameters
LoadLayer(Stream)
Return Value
Parameters
layerStream
Type:Stream
Description:N/A
Protected Methods
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
GetThreadSafetyLevelCore()
Return Value
Parameters
CloneDeepCore()
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
Parameters
OpenCore()
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
Type:Void
Description:None
Parameters
CloseCore()
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
Type:Void
Description:None
Parameters
GetBoundingBoxCore()
Return Value
Parameters
DrawException(GeoCanvas,Exception)
Return Value
Type:Void
Description:N/A
Parameters
DrawExceptionCore(GeoCanvas,Exception)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawingException(DrawingExceptionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnException(DrawnExceptionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
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. 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 that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
Type:Void
Description:None
Parameters
DrawAttributionCore(GeoCanvas,String)
Return Value
Type:Void
Description:N/A
Parameters
attribution
Type:String
Description:N/A
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
Finalize()
Return Value
Type:Void
Description:N/A
Parameters
MemberwiseClone()
Return Value
Type:Object
Description:N/A
Parameters
Public Properties
IsOpen
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
HasBoundingBox
Return Value
DrawingTime
Return Value
Name
Return Value
Attribution
Return Value
IsVisible
Return Value
Transparency
Return Value
BlueTranslation
Return Value
RedTranslation
Return Value
GreenTranslation
Return Value
KeyColors
Return Value
IsNegative
Return Value
IsGrayscale
Return Value
ColorMappings
Return Value
DrawingExceptionMode
Return Value
RequestDrawingInterval
Return Value
Protected Properties
StatusChanged
Return Value
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.
Return Value
Public Events
DrawingProgressChanged