RasterLayer¶
Inheritance Hierarchy¶
Object
Layer
Members Summary¶
Public Constructors Summary¶
Name |
---|
N/A |
Protected Constructors Summary¶
Name |
---|
RasterLayer() |
Public Properties Summary¶
Name | Return Type | Description |
---|---|---|
Attribution | String | N/A |
Background | GeoColor | N/A |
BlueTranslation | Single | N/A |
ColorMappings | Dictionary<GeoColor ,GeoColor > | N/A |
DrawingExceptionMode | DrawingExceptionMode | N/A |
DrawingTime | TimeSpan | N/A |
GreenTranslation | Single | N/A |
HasBoundingBox | Boolean | N/A |
ImageSource | RasterSource | This property gets and sets the Image used by the RasterLayer. |
IsGrayscale | Boolean | N/A |
IsNegative | Boolean | N/A |
IsOpen | Boolean | N/A |
IsVisible | Boolean | N/A |
KeyColors | Collection<GeoColor > | N/A |
LowerThreshold | Double | This property gets and sets the lower threshold in the scale at which to display the image. |
Name | String | N/A |
Projection | Projection | N/A |
RedTranslation | Single | N/A |
RequestDrawingInterval | TimeSpan | N/A |
ScaleFactor | Double | The scale factor when drawing the primitive image. For example I am looking for an image with 100100px, If the ScaleFactor is set to 2, it means the component will get the image with 200200px. We want to keep it as 1 (by default) for most cases. |
ThreadSafe | ThreadSafetyLevel | N/A |
Transparency | Single | N/A |
UpperThreshold | Double | This property gets and sets the upper threshold in the scale at which to display the image. |
WrappingExtent | RectangleShape | N/A |
WrappingMode | WrappingMode | N/A |
Protected Properties Summary¶
Name | Return Type | Description |
---|---|---|
IsOpenCore | Boolean | This property returns true if the RasterLayer is open and false if it is not. |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
Members Detail¶
Public Constructors¶
Name |
---|
N/A |
Protected Constructors¶
RasterLayer()
¶
Summary
This is a constructor for the class. If you use this constructor, you should set the properties you need manually.
Remarks
If you use this constructor, you should set the properties you need manually.
Return Value
Type | Description |
---|---|
N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Public Properties¶
Attribution
¶
Summary
N/A
Remarks
N/A
Return Value
String
Background
¶
Summary
N/A
Remarks
N/A
Return Value
BlueTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
ColorMappings
¶
Summary
N/A
Remarks
N/A
Return Value
DrawingExceptionMode
¶
Summary
N/A
Remarks
N/A
Return Value
DrawingTime
¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
GreenTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
HasBoundingBox
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
ImageSource
¶
Summary
This property gets and sets the Image used by the RasterLayer.
Remarks
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.
Return Value
IsGrayscale
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsNegative
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsOpen
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsVisible
¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
KeyColors
¶
Summary
N/A
Remarks
N/A
Return Value
Collection<GeoColor
>
LowerThreshold
¶
Summary
This property gets and sets the lower threshold in the scale at which to display the image.
Remarks
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.
Return Value
Double
Name
¶
Summary
N/A
Remarks
N/A
Return Value
String
Projection
¶
Summary
N/A
Remarks
N/A
Return Value
RedTranslation
¶
Summary
N/A
Remarks
N/A
Return Value
Single
RequestDrawingInterval
¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
ScaleFactor
¶
Summary
The scale factor when drawing the primitive image. For example I am looking for an image with 100100px, If the ScaleFactor is set to 2, it means the component will get the image with 200200px. We want to keep it as 1 (by default) for most cases.
Remarks
N/A
Return Value
Double
ThreadSafe
¶
Summary
N/A
Remarks
N/A
Return Value
Transparency
¶
Summary
N/A
Remarks
N/A
Return Value
Single
UpperThreshold
¶
Summary
This property gets and sets the upper threshold in the scale at which to display the image.
Remarks
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.
Return Value
Double
WrappingExtent
¶
Summary
N/A
Remarks
N/A
Return Value
WrappingMode
¶
Summary
N/A
Remarks
N/A
Return Value
Protected Properties¶
IsOpenCore
¶
Summary
This property returns true if the RasterLayer is open and false if it is not.
Remarks
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.
Return Value
Boolean
Public Methods¶
CloneDeep()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Layer | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Close()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Draw(GeoCanvas,Collection<SimpleCandidate>)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
labelsInAllLayers | Collection<SimpleCandidate > | N/A |
Equals(Object)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
obj | Object | N/A |
GetBoundingBox()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
RectangleShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetHashCode()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Int32 | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetHorizontalResolution()
¶
Summary
This method returns the horizontal resolution of the image.
Remarks
This method returns the horizontal resolution of the image.
Return Value
Type | Description |
---|---|
Single | This method returns the horizontal resolution of the image. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetType()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Type | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetVerticalResolution()
¶
Summary
This method returns the vertical resolution of the image.
Remarks
This method returns the vertical resolution of the image.
Return Value
Type | Description |
---|---|
Single | This method returns the vertical resolution of the image. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Open()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
RequestDrawing()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
RequestDrawing(RectangleShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
RequestDrawing(IEnumerable<RectangleShape>)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
RequestDrawing(TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan | N/A |
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(RectangleShape,TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
bufferTime | TimeSpan | N/A |
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | N/A |
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
bufferTime | TimeSpan | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape > | N/A |
bufferTime | TimeSpan | N/A |
bufferTimeType | RequestDrawingBufferTimeType | N/A |
ToString()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Protected Methods¶
CloneDeepCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Layer | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
CloseCore()
¶
Summary
This method opens the RasterLayer so that it is initialized and ready to use.
Remarks
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.
Return Value
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
DrawAttributionCore(GeoCanvas,String)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
attribution | String | N/A |
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
¶
Summary
This method will draw the image from the NativeImage source based on the parameters provided.
Remarks
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 NativeImage or native image passed into the method.
Return Value
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | This parameter is the GeoCanvas used to Draw the RasterLayer. |
labelsInAllLayers | Collection<SimpleCandidate > | This parameter is not used for ImageLayers. |
DrawException(GeoCanvas,Exception)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
e | Exception | N/A |
DrawExceptionCore(GeoCanvas,Exception)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
canvas | GeoCanvas | N/A |
e | Exception | N/A |
Finalize()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetBoundingBoxCore()
¶
Summary
This method returns the bounding box of the RasterLayer.
Remarks
This method returns the bounding box of the RasterLayer.
Return Value
Type | Description |
---|---|
RectangleShape | This method returns the bounding box of the RasterLayer. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
MemberwiseClone()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Object | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
args | DrawingAttributionLayerEventArgs | N/A |
OnDrawingException(DrawingExceptionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawingExceptionLayerEventArgs | N/A |
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawingProgressChangedEventArgs | N/A |
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
args | DrawnAttributionLayerEventArgs | N/A |
OnDrawnException(DrawnExceptionLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
e | DrawnExceptionLayerEventArgs | N/A |
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
eventArgs | RequestedDrawingLayerEventArgs | N/A |
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
eventArgs | RequestingDrawingLayerEventArgs | N/A |
OpenCore()
¶
Summary
This method opens the RasterLayer so that it is initialized and ready to use.
Remarks
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.
Return Value
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
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
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