User Tools

Site Tools


thinkgeo.mapsuite.portablecore.gdiplusrasterlayer

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.PortableCore.GdiPlusRasterLayer

<!– Class –> This class represents general image types to be drawn on the map, such as .BMP, .JPG, .PNG, etc.

Remarks

This type of layer is used to draw standard image types on the map. These include .BMP, .JPG, .PNG, .TIFF, and all other image types that are supported by the .NET Framework to be loaded as a Bitmap.

Each of these images will need a world file associated with it. The world file contains the geospatial information pertaining to the image. Using the world file, we know its spatial position and other required information to draw it on the map relative to other images or spatial features. World files are small text files with an extension that matches the original image's extension, but with the middle character of the extension changed to a “w”. If you have images that you want to use but do not have their world files, please contact the source of the image so that they can provide one for you. world files are fairly common in the GIS community.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodGdiPlusRasterLayer This is a constructor for the class.
Public MethodGdiPlusRasterLayer String This is a constructor for the class.
Public MethodGdiPlusRasterLayer String, String This is a constructor for the class.
Public MethodGdiPlusRasterLayer String, RectangleShape This is a constructor for the class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodCloneDeep Layer Create a copy of Layer using the deep clone process.
Public MethodClose Layer This method closes the Layer and releases any resources it was using.
Public MethodDraw GeoCanvas, Collection<SimpleCandidate> Layer This method draws the Layer.
Public MethodEquals Object Object
Public MethodGetBoundingBox Layer This method returns the bounding box of the Layer.
Public MethodGetHashCode Object
Public MethodGetHorizontalResolution RasterLayer This method returns the horizontal resolution of the image.
Public MethodGetProjectionText RasterLayer This method returns the projection parameters of the current layer.
Public MethodGetType Object
Public MethodGetVerticalResolution RasterLayer This method returns the vertical resolution of the image.
Public MethodOpen Layer This method opens the Layer so that it is initialized and ready to use.
Public MethodRequestDrawing Layer
Public MethodRequestDrawing RectangleShape Layer
Public MethodRequestDrawing IEnumerable<RectangleShape> Layer
Public MethodRequestDrawing TimeSpan Layer
Public MethodRequestDrawing RectangleShape, TimeSpan Layer
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan Layer
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloneDeepCore Layer Create a copy of Layer using the deep clone process. The default implemenation uses serialization.
Protected MethodCloseCore Layer(overriden)
Protected MethodDrawAttributionCore GeoCanvas, String Layer
Protected MethodDrawCore GeoCanvas, Collection<SimpleCandidate> Layer(overriden) This method will draw the image from the GeoImage source based on the parameters provided.
Protected MethodDrawException GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawExceptionCore GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodFinalize Object
Protected MethodGetBoundingBoxCore Layer(overriden)
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingAttribution DrawingAttributionLayerEventArgs Layer
Protected MethodOnDrawingException DrawingExceptionLayerEventArgs Layer
Protected MethodOnDrawingProgressChanged DrawingProgressChangedEventArgs Layer
Protected MethodOnDrawnAttribution DrawnAttributionLayerEventArgs Layer
Protected MethodOnDrawnException DrawnExceptionLayerEventArgs Layer
Protected MethodOnRequestedDrawing RequestedDrawingLayerEventArgs Layer
Protected MethodOnRequestingDrawing RequestingDrawingLayerEventArgs Layer
Protected MethodOpenCore Layer(overriden)

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Layer
Public PropertyBlueTranslation Single RasterLayer This property gets and sets the amount of blue to apply to the image.
Public PropertyDrawingExceptionMode DrawingExceptionMode Layer Gets or sets the DrawExcpetionMode when exception happens.
Public PropertyDrawingTime TimeSpan Layer This property gets the last drawing time for the layer.
Public PropertyGreenTranslation Single RasterLayer This property gets and sets the amount of green to apply to the image.
Public PropertyHasBoundingBox Boolean Layer(overriden) This property checks to see if 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. In GdiPlusRasterLayer, we override this API and mark it as true.
Public PropertyHasProjectionText Boolean RasterLayer This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters.
Public PropertyImageSource RasterSource RasterLayer This property gets and sets the ImageSource used by the RasterLayer.
Public PropertyIsGrayscale Boolean RasterLayer This property gets and sets if the image should be converted to grayscale.
Public PropertyIsNegative Boolean RasterLayer This property gets and sets whether the image should be converted to negative (inverse colors).
Public PropertyIsOpen Boolean Layer This property returns true if the Layer is open and false if it is not.
Public PropertyIsVisible Boolean Layer This property gets and set the visible state of the layer.
Public PropertyKeyColors Collection<GeoColor> RasterLayer Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.
Public PropertyLowerThreshold Double RasterLayer This property gets and sets the lower threshold in the scale at which to display the image.
Public PropertyName String Layer This property gets and sets the name for the layer.
Public PropertyPathFilename String This property gets and sets the path and filename of the image file you want to use.
Public PropertyRedTranslation Single RasterLayer This property gets and sets the amount of red to apply to the image.
Public PropertyRequestDrawingInterval TimeSpan Layer
Public PropertyTransparency Single Layer This property gets and sets the amount of transparency to apply to the image.
Public PropertyUpperThreshold Double RasterLayer This property gets and sets the upper threshold in the scale at which to display the image.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyIsOpenCore Boolean Layer(overriden)

Public Events

Public Constructors

GdiPlusRasterLayer()

This is a constructor for the class.

Overloads

This is the default constructor. If you use this constructor, then you need to set the PathFileName property manually before using the layer.

Remarks

If you use this constructor, then you need to set the PathFileName property manually before using the layer.

Parameters

Name Type Description

Go Back

GdiPlusRasterLayer(String)

This is a constructor for the class.

Overloads

This constructor allows you to provide the path and filename information for the GDI+ image file.

Remarks

This constructor gets the layer ready to use.

Parameters

Name Type Description
pathFilename String<!– System.String –> This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance.

Go Back

GdiPlusRasterLayer(String, String)

This is a constructor for the class.

Overloads

This constructor allows you to provide the path and filename information for both the GDI+ image file and its world file.

Remarks

This constructor gets the layer ready to use.

Parameters

Name Type Description
pathFilename String<!– System.String –> This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance.
worldfilePathFilename String<!– System.String –> This parameter is the world file path and filename for the GDI+ image you want to use.

Go Back

GdiPlusRasterLayer(String, RectangleShape)

This is a constructor for the class.

Overloads

This constructor allows you to provide the path and filename for the GDI+ image file and the image extent to use.

Remarks

This constructor gets the layer ready to use.

Parameters

Name Type Description
pathFilename String<!– System.String –> This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance.
imageExtent RectangleShape<!– ThinkGeo.MapSuite.PortableCore.RectangleShape –> This parameter is the image extent of GDI+ image file you want to use.

Go Back

Protected Constructors

Public Methods

CloneDeep()

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

Return Type Description
Layer<!– ThinkGeo.MapSuite.PortableCore.Layer –> A cloned Layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

Close()

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

Draw(GeoCanvas, Collection<SimpleCandidate>)

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> This parameter is the canvas object or a GeoImage to draw on.
labelsInAllLayers Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> This parameter represents the labels used for collision detection and duplication checking.

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetBoundingBox()

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

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.PortableCore.RectangleShape –> This method returns the bounding box of the Layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetHorizontalResolution()

This method returns the horizontal resolution of the image.

Remarks

This method returns the horizontal resolution of the image.

Return Value

Return Type Description
Single<!– System.Single –> This method returns the horizontal resolution of the image.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

GetProjectionText()

This method returns the projection parameters of the current layer.

Remarks

This method returns the projection parameters of the current layer.

Return Value

Return Type Description
String<!– System.String –> This method returns the projection parameters of the current layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetVerticalResolution()

This method returns the vertical resolution of the image.

Remarks

This method returns the vertical resolution of the image.

Return Value

Return Type Description
Single<!– System.Single –> This method returns the vertical resolution of the image.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

Open()

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing(RectangleShape)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.PortableCore.RectangleShape –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing(IEnumerable<RectangleShape>)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing(TimeSpan)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing(RectangleShape, TimeSpan)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.PortableCore.RectangleShape –>
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} –>
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloneDeepCore()

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

Return Type Description
Layer<!– ThinkGeo.MapSuite.PortableCore.Layer –> A cloned Layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

CloseCore()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

DrawAttributionCore(GeoCanvas, String)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –>
attribution String<!– System.String –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

This method will draw the image from the GeoImage 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 GeoImage or native image passed into the method.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> This parameter is the GeoCanvas used to Draw the RasterLayer.
labelsInAllLayers Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> This parameter is not used for ImageLayers.

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

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.

Remarks

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

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> The target canvas to draw the layer.
e Exception<!– System.Exception –> The exception thrown when layer.Draw().

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

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.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> The target canvas to draw the layer.
e Exception<!– System.Exception –> The exception thrown when layer.Draw().

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetBoundingBoxCore()

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.PortableCore.RectangleShape –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawingAttributionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnDrawingException(DrawingExceptionLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawingExceptionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawnAttributionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnDrawnException(DrawnExceptionLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawnExceptionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
eventArgs RequestedDrawingLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
eventArgs RequestingDrawingLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

OpenCore()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

Public Properties

Attribution

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

BlueTranslation

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

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

DrawingExceptionMode

Gets or sets the DrawExcpetionMode when exception happens.

Return Value

Return Type
DrawingExceptionMode<!– ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawingTime

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

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

GreenTranslation

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

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

HasBoundingBox

This property checks to see if 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. In GdiPlusRasterLayer, we override this API and mark it as true.

Remarks

The default implementation in the base class returns false.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

HasProjectionText

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

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

ImageSource

This property gets and sets the ImageSource 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

Return Type
RasterSource<!– ThinkGeo.MapSuite.PortableCore.RasterSource –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

IsGrayscale

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

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

IsNegative

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

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

IsOpen

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

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

IsVisible

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

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

KeyColors

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

Remarks

It will make these colors transparent when draw image.

Return Value

Return Type
Collection<GeoColor><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

LowerThreshold

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

Return Type
Double<!– System.Double –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

Name

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

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

PathFilename

This property gets and sets the path and filename of the image file you want to use.

Remarks

This should be a complete path and filename for the image file.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.PortableCore.GdiPlusRasterLayer –> Go Back

RedTranslation

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

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

RequestDrawingInterval

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

Transparency

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

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

UpperThreshold

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

Return Type
Double<!– System.Double –>

<!– ThinkGeo.MapSuite.PortableCore.RasterLayer –> Go Back

Protected Properties

IsOpenCore

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.PortableCore.Layer(overriden) –> Go Back

Public Events

DrawingAttribution

Event Arguments

Event Arguments
DrawingAttributionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawingException

Event Arguments

Event Arguments
DrawingExceptionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawingProgressChanged

Event Arguments

Event Arguments
DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawnAttribution

Event Arguments

Event Arguments
DrawnAttributionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

DrawnException

Event Arguments

Event Arguments
DrawnExceptionLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestedDrawing

Event Arguments

Event Arguments
RequestedDrawingLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

RequestingDrawing

Event Arguments

Event Arguments
RequestingDrawingLayerEventArgs<!– ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.Layer –> Go Back

StreamLoading

This event allows you to pass in your own stream to represent the image.

Remarks

If you wish, you can pass in your own stream to represent the image. The stream can come from a variety of places, including isolated storage, a compressed file, or an encrypted stream. When the image is finished with the stream it will dispose of it, so be sure to keep this in mind when passing the stream in. If you do not pass in an alternate stream, the class will attempt to load the file from the file system using the PathFileName property.

Event Arguments

Event Arguments
StreamLoadingEventArgs<!– ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs –>

<!– ThinkGeo.MapSuite.PortableCore.GdiPlusRasterLayer –> Go Back

NOTOC MapSuitePortableCore ThinkGeo.MapSuite.PortableCore UpdateDocumentation

thinkgeo.mapsuite.portablecore.gdiplusrasterlayer.1440040132.txt.gz · Last modified: 2015/09/21 08:08 (external edit)