This class is the base class for all types of Layers.

• System.Object
  • ThinkGeo.MapSuite.Core.Layer
    • ThinkGeo.MapSuite.Core.FeatureLayer
    • ThinkGeo.MapSuite.Core.AdornmentLayer
    • ThinkGeo.MapSuite.Core.KmlLayer
    • ThinkGeo.MapSuite.Core.RasterLayer
    • ThinkGeo.MapSuite.Core.PrinterLayer
    • ThinkGeo.MapSuite.Core.BingMapsLayer
    • ThinkGeo.MapSuite.Core.IsoLineLayer
    • ThinkGeo.MapSuite.Core.BackgroundLayer
    • ThinkGeo.MapSuite.Core.GoogleMapsLayer
    • ThinkGeo.MapSuite.Core.GroupLayer
    • ThinkGeo.MapSuite.Core.HeatLayer
    • ThinkGeo.MapSuite.Core.MapShapeLayer
    • ThinkGeo.MapSuite.Core.OpenStreetMapLayer
    • ThinkGeo.MapSuite.Core.RestrictionLayer
    • ThinkGeo.MapSuite.Core.TiledWmsLayer
    • ThinkGeo.MapSuite.Core.WmtsLayer
    • ThinkGeo.MapSuite.Core.WorldMapKitLayer

Attribution

• Return:String
• Summary:N/A

BlueTranslation

• Return:Single
• Summary:This property gets and sets the amount of blue to apply to the image.

DrawingExceptionMode

• Return:DrawingExceptionMode
• Summary:Gets or sets the DrawExcpetionMode when exception happens.

DrawingTime

• Return:TimeSpan
• Summary:This property gets the last drawing time for the layer.

GreenTranslation

• Return:Single
• Summary:This property gets and sets the amount of green to apply to the image.

HasBoundingBox

• Return:Boolean
• Summary: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.

IsGrayscale

• Return:Boolean
• Summary:This property gets and sets if the image should be converted to grayscale.

IsNegative

• Return:Boolean
• Summary:This property gets and sets whether the image should be converted to negative (inverse colors).

IsOpen

• Return:Boolean
• Summary:This property returns true if the Layer is open and false if it is not.

IsVisible

• Return:Boolean
• Summary:This property gets and set the visible state of the layer.

KeyColors

• Return:Collection<GeoColor>
• Summary:Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.

Name

• Return:String
• Summary:This property gets and sets the name for the layer.

RedTranslation

• Return:Single
• Summary:This property gets and sets the amount of red to apply to the image.

RequestDrawingInterval

• Return:TimeSpan
• Summary:N/A

Transparency

• Return:Single
• Summary:This property gets and sets the amount of transparency to apply to the image.

IsOpenCore

• Return:Boolean
• Summary:This property returns true if the Layer is open and false if it is not.

DrawingAttribution

• Event Arguments:DrawingAttributionLayerEventArgs
• Summary:N/A

DrawingException

• Event Arguments:DrawingExceptionLayerEventArgs
• Summary:N/A

DrawingProgressChanged

• Event Arguments:DrawingProgressChangedEventArgs
• Summary:N/A

DrawnAttribution

• Event Arguments:DrawnAttributionLayerEventArgs
• Summary:N/A

DrawnException

• Event Arguments:DrawnExceptionLayerEventArgs
• Summary:N/A

RequestedDrawing

• Event Arguments:RequestedDrawingLayerEventArgs
• Summary:N/A

RequestingDrawing

• Event Arguments:RequestingDrawingLayerEventArgs
• Summary:N/A

This is the default constructor for the Layer.

None

Go Back

Create a copy of Layer using the deep clone process.

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:Layer
• Description:A cloned Layer.

Go Back

This method closes the Layer and releases any resources it was using.

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:Void
• Description:None

Go Back

This method draws the Layer.

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:Void
• Description:None

canvas

• Type:GeoCanvas
• Description:This parameter is the canvas object or a GeoImage to draw on.

labelsInAllLayers

• Type:Collection<SimpleCandidate>
• Description:This parameter represents the labels used for collision detection and duplication checking.

Go Back

N/A

N/A

Return Value

• Return Type:Boolean
• Description:N/A

obj

• Type:Object
• Description:N/A

Go Back

This method returns the bounding box of the Layer.

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:RectangleShape
• Description:This method returns the bounding box of the Layer.

Go Back

N/A

N/A

Return Value

• Return Type:Int32
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:ThreadSafetyLevel
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Type
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Layer
• Description:N/A

layerUri

• Type:Uri
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Layer
• Description:N/A

layerStream

• Type:Stream
• Description:N/A

Go Back

This method opens the Layer so that it is initialized and ready to use.

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:Void
• Description:None

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:String
• Description:N/A

Go Back

Create a copy of Layer using the deep clone process. The default implemenation uses serialization.

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:Layer
• Description:A cloned Layer.

Go Back

This method closes the Layer and releases any resources it was using.

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:Void
• Description:None

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

attribution

• Type:String
• Description:N/A

Go Back

This method draws the Layer.

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

• Return Type:Void
• Description:None

canvas

• Type:GeoCanvas
• Description:This parameter is the canvas object or a GeoImage to draw on.

labelsInAllLayers

• Type:Collection<SimpleCandidate>
• Description:This parameter represents the labels used for collision detection and duplication checking.

Go Back

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

This method can be overriden its logic by rewrite the DrawExceptionCore.

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:The target canvas to draw the layer.

e

• Type:Exception
• Description:The exception thrown when layer.Draw().

Go Back

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:The target canvas to draw the layer.

e

• Type:Exception
• Description:The exception thrown when layer.Draw().

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

This method returns the bounding box of the Layer.

This method returns the bounding box of the Layer.

Return Value

• Return Type:RectangleShape
• Description:This method returns the bounding box of the Layer.

Go Back

N/A

N/A

Return Value

• Return Type:ThreadSafetyLevel
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Object
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

args

• Type:DrawingAttributionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawingExceptionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawingProgressChangedEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

args

• Type:DrawnAttributionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawnExceptionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

eventArgs

• Type:RequestedDrawingLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

eventArgs

• Type:RequestingDrawingLayerEventArgs
• Description:N/A

Go Back

This method opens the Layer so that it is initialized and ready to use.

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:Void
• Description:None

Go Back

N/A

N/A

Return Type:String

Go Back

This property gets and sets the amount of blue to apply to the image.

None

Return Type:Single

Go Back

Gets or sets the DrawExcpetionMode when exception happens.

N/A

Return Type:DrawingExceptionMode

Go Back

This property gets the last drawing time for the layer.

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 Type:TimeSpan

Go Back

This property gets and sets the amount of green to apply to the image.

None

Return Type:Single

Go Back

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.

The default value is false.

Return Type:Boolean

Go Back

This property gets and sets if the image should be converted to grayscale.

None

Return Type:Boolean

Go Back

This property gets and sets whether the image should be converted to negative (inverse colors).

None

Return Type:Boolean

Go Back

This property returns true if the Layer is open and false if it is not.

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 Type:Boolean

Go Back

This property gets and set the visible state of the layer.

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 Type:Boolean

Go Back

Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.

It will make these colors transparent when draw image.

Return Type:Collection<GeoColor>

Go Back

This property gets and sets the name for the layer.

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

Return Type:String

Go Back

This property gets and sets the amount of red to apply to the image.

None

Return Type:Single

Go Back

N/A

N/A

Return Type:TimeSpan

Go Back

This property gets and sets the amount of transparency to apply to the image.

None

Return Type:Single

Go Back

This property returns true if the Layer is open and false if it is not.

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 Type:Boolean

Go Back

N/A

N/A

Event Arguments:DrawingAttributionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawingExceptionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawingProgressChangedEventArgs

Go Back

N/A

N/A

Event Arguments:DrawnAttributionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawnExceptionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:RequestedDrawingLayerEventArgs

Go Back

N/A

N/A

Event Arguments:RequestingDrawingLayerEventArgs

Go Back