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

Layer()

• This is the default constructor for the Layer.

• None

RequestDrawing()

• N/A

• N/A

• Type:Void
• Description:N/A

RequestDrawing(RectangleShape)

• N/A

• N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>)

• N/A

• N/A

• Type:Void
• Description:N/A

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

RequestDrawing(TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

• N/A

• N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

• N/A

• N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

• N/A

• N/A

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

GetThreadSafetyLevel()

• N/A

• N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeep()

• 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.

• Type:Layer
• Description:A cloned Layer.

Open()

• 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.

• Type:Void
• Description:None

Close()

• 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.

• Type:Void
• Description:None

GetBoundingBox()

• 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.

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

Draw(GeoCanvas,Collection<SimpleCandidate>)

• 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.

• 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.

ToString()

• N/A

• N/A

• Type:String
• Description:N/A

Equals(Object)

• N/A

• N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetType()

• N/A

• N/A

• Type:Type
• Description:N/A

LoadLayer(Uri)

• N/A

• N/A

• Type:Layer
• Description:N/A

• layerUri
  • Type:Uri
  • Description:N/A

LoadLayer(Stream)

• N/A

• N/A

• Type:Layer
• Description:N/A

• layerStream
  • Type:Stream
  • Description:N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestedDrawingLayerEventArgs
  • Description:N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestingDrawingLayerEventArgs
  • Description:N/A

GetThreadSafetyLevelCore()

• N/A

• N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeepCore()

• 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.

• Type:Layer
• Description:A cloned Layer.

OpenCore()

• 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.

• Type:Void
• Description:None

CloseCore()

• 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.

• Type:Void
• Description:None

GetBoundingBoxCore()

• This method returns the bounding box of the Layer.

• This method returns the bounding box of the Layer.

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

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.

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

• 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().

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.

• N/A

• 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().

OnDrawingException(DrawingExceptionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingExceptionLayerEventArgs
  • Description:N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawnExceptionLayerEventArgs
  • Description:N/A

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

• 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.

• 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.

DrawAttributionCore(GeoCanvas,String)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• attribution
  • Type:String
  • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionLayerEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionLayerEventArgs
  • Description:N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingProgressChangedEventArgs
  • Description:N/A

Finalize()

• N/A

• N/A

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• N/A

• Type:Object
• Description:N/A

RequestDrawingInterval

N/A

N/A

• Type:TimeSpan

IsOpen

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.

• Type:Boolean

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.

The default value is false.

• Type:Boolean

DrawingTime

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.

• Type:TimeSpan

Name

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.

• Type:String

Attribution

N/A

N/A

• Type:String

IsVisible

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.

• Type:Boolean

Transparency

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

None

• Type:Single

BlueTranslation

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

None

• Type:Single

RedTranslation

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

None

• Type:Single

GreenTranslation

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

None

• Type:Single

KeyColors

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.

• Type:Collection<GeoColor>

IsNegative

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

None

• Type:Boolean

IsGrayscale

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

None

• Type:Boolean

DrawingExceptionMode

Gets or sets the DrawExcpetionMode when exception happens.

N/A

• Type:DrawingExceptionMode

IsOpenCore

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.

• Type:Boolean

RequestedDrawing N/A

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing N/A

N/A

Event Arguments:RequestingDrawingLayerEventArgs

DrawingProgressChanged N/A

N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawingException N/A

N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawnException N/A

N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution N/A

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution N/A

N/A

Event Arguments:DrawnAttributionLayerEventArgs