Layer¶

Inheritance Hierarchy¶

• Object
• Layer
  • AdornmentLayer
  • FeatureLayer
  • RasterLayer
  • PrinterLayer
  • ArcGISServerRestLayer
  • BackgroundLayer
  • BingMapsLayer
  • GoogleMapsLayer
  • GroupLayer
  • IsoLineLayer
  • MapShapeLayer
  • OpenStreetMapLayer
  • RestrictionLayer
  • ThinkGeoCloudRasterMapsLayer
  • ThinkGeoCloudVectorMapsLayer
  • ThinkGeoMBTilesLayer
  • WmtsLayer

Members Summary¶

Public Constructors Summary¶

Protected Constructors Summary¶

Public Properties Summary¶

Protected Properties Summary¶

Public Methods Summary¶

Protected Methods Summary¶

Public Events Summary¶

Members Detail¶

Public Constructors¶

Protected Constructors¶

Layer()¶

Summary

This is the default constructor for the Layer.

Remarks

None

Return Value

Parameters

Public Properties¶

Attribution¶

Summary

N/A

Remarks

N/A

Return Value

String

Background¶

Summary

Gets and sets the background of the layer.

Remarks

N/A

Return Value

GeoColor

BlueTranslation¶

Summary

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

Remarks

None

Return Value

Single

ColorMappings¶

Summary

ColorMapping

Remarks

N/A

Return Value

Dictionary<GeoColor,GeoColor>

DrawingExceptionMode¶

Summary

Gets or sets the DrawExcpetionMode when exception happens.

Remarks

N/A

Return Value

DrawingExceptionMode

DrawingTime¶

Summary

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

TimeSpan

GreenTranslation¶

Summary

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

Remarks

None

Return Value

Single

HasBoundingBox¶

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.

Remarks

The default value is false.

Return Value

Boolean

IsGrayscale¶

Summary

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

Remarks

None

Return Value

Boolean

IsNegative¶

Summary

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

Remarks

None

Return Value

Boolean

IsOpen¶

Summary

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

Boolean

IsVisible¶

Summary

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

Boolean

KeyColors¶

Summary

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

Remarks

It will make these colors transparent when draw image.

Return Value

Collection<GeoColor>

Name¶

Summary

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

String

Projection¶

Summary

Gets the projection of the layer.

Remarks

N/A

Return Value

Projection

RedTranslation¶

Summary

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

Remarks

None

Return Value

Single

RequestDrawingInterval¶

Summary

N/A

Remarks

N/A

Return Value

TimeSpan

ThreadSafe¶

Summary

N/A

Remarks

N/A

Return Value

ThreadSafetyLevel

Transparency¶

Summary

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

Remarks

None

Return Value

Single

Protected Properties¶

IsOpenCore¶

Summary

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

Boolean

Public Methods¶

CloneDeep()¶

Summary

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

Parameters

Close()¶

Summary

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

Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)¶

Summary

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

Parameters

Equals(Object)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetBoundingBox()¶

Summary

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

Parameters

GetHashCode()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetType()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadLayer(Uri)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadLayer(Stream)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Open()¶

Summary

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

Parameters

RequestDrawing()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(RectangleShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(IEnumerable<RectangleShape>)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(TimeSpan)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(RectangleShape,TimeSpan)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ToString()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Protected Methods¶

CloneDeepCore()¶

Summary

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

Parameters

CloseCore()¶

Summary

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

Parameters

DrawAttributionCore(GeoCanvas,String)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)¶

Summary

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

Parameters

DrawException(GeoCanvas,Exception)¶

Summary

This method will draw on the view 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

Parameters

DrawExceptionCore(GeoCanvas,Exception)¶

Summary

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

Remarks

N/A

Return Value

Parameters

Finalize()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetBoundingBoxCore()¶

Summary

This method returns the bounding box of the Layer.

Remarks

This method returns the bounding box of the Layer.

Return Value

Parameters

MemberwiseClone()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnDrawingAttribution(DrawingAttributionLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnDrawingException(DrawingExceptionLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnDrawnException(DrawnExceptionLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnRequestedDrawing(RequestedDrawingLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnRequestingDrawing(RequestingDrawingLayerEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OpenCore()¶

Summary

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

Parameters

Public Events¶

DrawingProgressChanged¶

N/A

Remarks

N/A

Event Arguments

DrawingProgressChangedEventArgs

DrawingException¶

N/A

Remarks

N/A

Event Arguments

DrawingExceptionLayerEventArgs

DrawnException¶

N/A

Remarks

N/A

Event Arguments

DrawnExceptionLayerEventArgs

DrawingAttribution¶

N/A

Remarks

N/A

Event Arguments

DrawingAttributionLayerEventArgs

DrawnAttribution¶

N/A

Remarks

N/A

Event Arguments

DrawnAttributionLayerEventArgs

RequestedDrawing¶

N/A

Remarks

N/A

Event Arguments

RequestedDrawingLayerEventArgs

RequestingDrawing¶

N/A

Remarks

N/A

Event Arguments

RequestingDrawingLayerEventArgs