ThinkGeo.MapSuite.Core.RasterLayer

This abstract class is the basis for all image-based layers in the system.

• System.Object
  • ThinkGeo.MapSuite.Core.Layer
    • ThinkGeo.MapSuite.Core.RasterLayer
      • ThinkGeo.MapSuite.Core.KmlRasterLayer
      • ThinkGeo.MapSuite.Core.NoaaRadarRasterLayer
      • ThinkGeo.MapSuite.Core.GeoTiffRasterLayer
      • ThinkGeo.MapSuite.Core.EcwRasterLayer
      • ThinkGeo.MapSuite.Core.WmsRasterLayer
      • ThinkGeo.MapSuite.Core.GdiPlusRasterLayer
      • ThinkGeo.MapSuite.Core.MrSidRasterLayer

RasterLayer()

• This is a constructor for the class. If you use this constructor, you should set the properties you need manually.

• If you use this constructor, you should set the properties you need manually.

GetProjectionText()

• This method returns the projection parameters of the current layer.

• This method returns the projection parameters of the current layer.

• Type:String
• Description:This method returns the projection parameters of the current layer.

GetHorizontalResolution()

• This method returns the horizontal resolution of the image.

• This method returns the horizontal resolution of the image.

• Type:Single
• Description:This method returns the horizontal resolution of the image.

GetVerticalResolution()

• This method returns the vertical resolution of the image.

• This method returns the vertical resolution of the image.

• Type:Single
• Description:This method returns the vertical resolution of the image.

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

• N/A

• N/A

• Type:Layer
• Description:N/A

Open()

• N/A

• N/A

• Type:Void
• Description:N/A

Close()

• N/A

• N/A

• Type:Void
• Description:N/A

GetBoundingBox()

• N/A

• N/A

• Type:RectangleShape
• Description:N/A

Draw(GeoCanvas,Collection<SimpleCandidate>)

• N/A

• N/A

• Type:Void
• Description:N/A

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

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

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

GetBoundingBoxCore()

• This method returns the bounding box of the RasterLayer.

• This method returns the bounding box of the RasterLayer.

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

OpenCore()

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

• The open method plays an important rol,e as it is responsible for initializing the RasterLayer. Most methods on the RasterLayer will throw an exception if the state of the RasterLayer is not opened. When the map draws each layer, it will open the RasterLayer 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 RasterLayer.

• Type:Void
• Description:None

CloseCore()

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

• The close method plays an important role in the life cycle of the RasterLayer. 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 RasterLayer 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

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

• This method will draw the image from the GeoImage source based on the parameters provided.

• The DrawCore method will be called when the layer is being drawn. It will determine if the image is within the extent and the threshold defined. If these parameters are met, it will query the RasterSource for an image and then apply the other various properties (such as transparency, etc.) on the image. Lastly, it will draw the image on the GeoImage or native image passed into the method.

• Type:Void
• Description:None

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the GeoCanvas used to Draw the RasterLayer.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:This parameter is not used for ImageLayers.

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

• N/A

• N/A

• Type:Layer
• Description:N/A

DrawException(GeoCanvas,Exception)

• N/A

• N/A

• Type:Void
• Description:N/A

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

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

DrawExceptionCore(GeoCanvas,Exception)

• N/A

• N/A

• Type:Void
• Description:N/A

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

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

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

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

IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit)

• This method returns whether the current extent is within the upper and lower threshold properties.

• This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.

• Type:Boolean
• Description:This method returns whether the current extent is within the upper and lower threshold properties.

• currentExtent
  • Type:RectangleShape
  • Description:This parameter is the current extent that you want determine is within the thresholds defined.

• upperThreshold
  • Type:Double
  • Description:This parameter is the upper threshold used to test the extent.

• lowerThreshold
  • Type:Double
  • Description:This parameter is the lower threshold used to test the extent.

• canvasWidth
  • Type:Int32
  • Description:This parameter is the width of the canvas.

• mapUnit
  • Type:GeographyUnit
  • Description:This parameter is the unit of the map.

IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single)

• This method returns whether the current extent is within the upper and lower threshold properties.

• This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.

• Type:Boolean
• Description:This method returns whether the current extent is within the upper and lower threshold properties.

• currentExtent
  • Type:RectangleShape
  • Description:This parameter is the current extent that you want determine is within the thresholds defined.

• upperThreshold
  • Type:Double
  • Description:This parameter is the upper threshold used to test the extent.

• lowerThreshold
  • Type:Double
  • Description:This parameter is the lower threshold used to test the extent.

• canvasWidth
  • Type:Int32
  • Description:This parameter is the width of the canvas.

• mapUnit
  • Type:GeographyUnit
  • Description:This parameter is the unit of the map.

• dpi
  • Type:Single
  • Description:This parameter is the dpi of the current extent.

ImageSource

This property gets and sets the ImageSource used by the RasterLayer.

The set for this property is protected and only intended to be used by developers who are creating their own ImageSources. This is the main property to set for developers who are creating their own RasterLayer derivatives.

• Type:RasterSource

WrappingMode

N/A

N/A

• Type:WrappingMode

WrappingExtent

N/A

N/A

• Type:RectangleShape

UpperThreshold

This property gets and sets the upper threshold in the scale at which to display the image.

Above the upper threshold in scale, the image will not be displayed. This, in conjunction with the LowerThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display.

• Type:Double

LowerThreshold

This property gets and sets the lower threshold in the scale at which to display the image.

Below the lower threshold in scale, the image will not be displayed. This, in conjunction with the UpperThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display.

• Type:Double

HasProjectionText

This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters.

N/A

• Type:Boolean

RequestDrawingInterval

N/A

N/A

• Type:TimeSpan

IsOpen

N/A

N/A

• Type:Boolean

HasBoundingBox

N/A

N/A

• Type:Boolean

DrawingTime

N/A

N/A

• Type:TimeSpan

Name

N/A

N/A

• Type:String

Attribution

N/A

N/A

• Type:String

IsVisible

N/A

N/A

• Type:Boolean

Transparency

N/A

N/A

• Type:Single

BlueTranslation

N/A

N/A

• Type:Single

RedTranslation

N/A

N/A

• Type:Single

GreenTranslation

N/A

N/A

• Type:Single

KeyColors

N/A

N/A

• Type:Collection<GeoColor>

IsNegative

N/A

N/A

• Type:Boolean

IsGrayscale

N/A

N/A

• Type:Boolean

DrawingExceptionMode

N/A

N/A

• Type:DrawingExceptionMode

IsOpenCore

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

Various methods on the RasterLayer 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 RasterLayer's Open method. The method will raise an exception if the current RasterLayer 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