This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.rasterlayer [2015/09/21 01:09] admin |
thinkgeo.mapsuite.core.rasterlayer [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.RasterLayer ====== | ====== ThinkGeo.MapSuite.Core.RasterLayer ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This abstract class is the basis for all image-based layers in the system. | This abstract class is the basis for all image-based layers in the system. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 5: | Line 8: | ||
*ThinkGeo.MapSuite.Core.Layer | *ThinkGeo.MapSuite.Core.Layer | ||
***ThinkGeo.MapSuite.Core.RasterLayer** | ***ThinkGeo.MapSuite.Core.RasterLayer** | ||
- | *[[ThinkGeo.MapSuite.Core.GdiPlusRasterLayer]] | ||
- | *[[ThinkGeo.MapSuite.Core.GeoTiffRasterLayer]] | ||
*[[ThinkGeo.MapSuite.Core.KmlRasterLayer]] | *[[ThinkGeo.MapSuite.Core.KmlRasterLayer]] | ||
+ | *[[ThinkGeo.MapSuite.Core.NoaaRadarRasterLayer]] | ||
+ | *[[ThinkGeo.MapSuite.Core.GeoTiffRasterLayer]] | ||
+ | *[[ThinkGeo.MapSuite.Core.EcwRasterLayer]] | ||
*[[ThinkGeo.MapSuite.Core.WmsRasterLayer]] | *[[ThinkGeo.MapSuite.Core.WmsRasterLayer]] | ||
+ | *[[ThinkGeo.MapSuite.Core.GdiPlusRasterLayer]] | ||
+ | *[[ThinkGeo.MapSuite.Core.MrSidRasterLayer]] | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
Line 14: | Line 20: | ||
** {{wiki:ProtectedMethod.gif|}} RasterLayer() ** | ** {{wiki:ProtectedMethod.gif|}} RasterLayer() ** | ||
- | This is a constructor for the class. If you use this constructor, you should set the properties you need manually. | + | * //This is a constructor for the class. If you use this constructor, you should set the properties you need manually.// |
== Remarks == | == Remarks == | ||
- | 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.// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
Line 22: | Line 28: | ||
** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
- | This method returns the projection parameters of the current layer. | + | * //This method returns the projection parameters of the current layer.// |
== Remarks == | == Remarks == | ||
- | This method returns the projection parameters of the current layer. | + | * //This method returns the projection parameters of the current layer.// |
== Return Value == | == Return Value == | ||
Line 34: | Line 40: | ||
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
- | This method returns the horizontal resolution of the image. | + | * //This method returns the horizontal resolution of the image.// |
== Remarks == | == Remarks == | ||
- | This method returns the horizontal resolution of the image. | + | * //This method returns the horizontal resolution of the image.// |
== Return Value == | == Return Value == | ||
Line 46: | Line 52: | ||
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
- | This method returns the vertical resolution of the image. | + | * //This method returns the vertical resolution of the image.// |
== Remarks == | == Remarks == | ||
- | This method returns the vertical resolution of the image. | + | * //This method returns the vertical resolution of the image.// |
== Return Value == | == Return Value == | ||
Line 56: | Line 62: | ||
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
+ | * //extentToRefresh// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Open() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 91: | Line 101: | ||
== Parameters == | == Parameters == | ||
+ | * //extentsToRefresh// | ||
+ | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Close() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 103: | Line 117: | ||
== Parameters == | == Parameters == | ||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 127: | Line 153: | ||
== Parameters == | == Parameters == | ||
- | * //canvas// | + | * //extentToRefresh// |
- | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
* Description:N/A | * Description:N/A | ||
- | * //labelsInAllLayers// | + | * //bufferTime// |
- | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Type:TimeSpan |
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 147: | Line 173: | ||
== Parameters == | == Parameters == | ||
+ | * //extentToRefresh// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 159: | Line 197: | ||
== Parameters == | == Parameters == | ||
- | * //extentToRefresh// | + | * //extentsToRefresh// |
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 177: | Line 219: | ||
* //extentsToRefresh// | * //extentsToRefresh// | ||
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
- | * //bufferTime// | + | <div newline></div> |
- | * Type:TimeSpan | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
- | * Description:N/A | + | |
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 207: | Line 265: | ||
== Parameters == | == Parameters == | ||
- | * //extentToRefresh// | + | <div newline></div> |
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
- | * Description:N/A | + | |
- | * //bufferTime// | + | * //N/A// |
- | * Type:TimeSpan | + | == Remarks == |
- | * Description:N/A | + | * //N/A// |
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
== Return Value == | == Return Value == | ||
Line 227: | Line 301: | ||
== Parameters == | == Parameters == | ||
- | * //extentsToRefresh// | + | * //canvas// |
- | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
* Description:N/A | * Description:N/A | ||
- | * //bufferTime// | + | * //labelsInAllLayers// |
- | * Type:TimeSpan | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
* Description:N/A | * Description:N/A | ||
Line 238: | Line 312: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 250: | Line 324: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 266: | Line 340: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 278: | Line 352: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 291: | Line 365: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | This method returns the bounding box of the RasterLayer. | + | * //This method returns the bounding box of the RasterLayer.// |
== Remarks == | == Remarks == | ||
- | This method returns the bounding box of the RasterLayer. | + | * //This method returns the bounding box of the RasterLayer.// |
== Return Value == | == Return Value == | ||
Line 303: | Line 377: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | This method opens the RasterLayer so that it is initialized and ready to use. | + | * //This method opens the RasterLayer so that it is initialized and ready to use.// |
== Remarks == | == 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. | + | * //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 == | == Return Value == | ||
Line 315: | Line 389: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | This method opens the RasterLayer so that it is initialized and ready to use. | + | * //This method opens the RasterLayer so that it is initialized and ready to use.// |
== Remarks == | == 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. | + | * //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 == | == Return Value == | ||
Line 327: | Line 401: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | This method will draw the image from the GeoImage source based on the parameters provided. | + | * //This method will draw the image from the GeoImage source based on the parameters provided.// |
== Remarks == | == 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. | + | * //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 Value == | ||
Line 343: | Line 417: | ||
* Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | ||
* Description:This parameter is not used for ImageLayers. | * Description:This parameter is not used for ImageLayers. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //eventArgs// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //eventArgs// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 359: | Line 465: | ||
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 371: | Line 477: | ||
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 391: | Line 497: | ||
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 411: | Line 517: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 427: | Line 533: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 443: | Line 549: | ||
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 463: | Line 569: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 479: | Line 585: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 495: | Line 601: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 506: | Line 612: | ||
* //e// | * //e// | ||
* Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //eventArgs// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //eventArgs// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
* Description:N/A | * Description:N/A | ||
Line 543: | Line 617: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 555: | Line 629: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 567: | Line 641: | ||
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit) ** | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit) ** | ||
- | This method returns whether the current extent is within the upper and lower threshold properties. | + | * //This method returns whether the current extent is within the upper and lower threshold properties.// |
== Remarks == | == Remarks == | ||
- | This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided. | + | * //This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.// |
== Return Value == | == Return Value == | ||
Line 599: | Line 673: | ||
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single) ** | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single) ** | ||
- | This method returns whether the current extent is within the upper and lower threshold properties. | + | * //This method returns whether the current extent is within the upper and lower threshold properties.// |
== Remarks == | == Remarks == | ||
- | This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided. | + | * //This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.// |
== Return Value == | == Return Value == | ||
Line 634: | Line 708: | ||
<div newline></div> | <div newline></div> | ||
==== Public Properties ==== | ==== Public Properties ==== | ||
- | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** | + | ** {{wiki:PublicProperty.gif|}} ImageSource ** |
- | This property gets and sets the amount of blue to apply to the image. | + | This property gets and sets the ImageSource used by the RasterLayer. |
== Remarks == | == Remarks == | ||
- | None | + | 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 Value == | ||
- | * Type:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
- | ** {{wiki:PublicProperty.gif|}} RedTranslation ** | + | ** {{wiki:PublicProperty.gif|}} WrappingMode ** |
- | This property gets and sets the amount of red to apply to the image. | + | N/A |
== Remarks == | == Remarks == | ||
- | None | + | N/A |
== Return Value == | == Return Value == | ||
- | * Type:Single | + | * Type:[[ThinkGeo.MapSuite.Core.WrappingMode|WrappingMode]] |
- | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | + | ** {{wiki:PublicProperty.gif|}} WrappingExtent ** |
- | This property gets and sets the amount of green to apply to the image. | + | N/A |
== Remarks == | == Remarks == | ||
- | None | + | N/A |
== Return Value == | == Return Value == | ||
- | * Type:Single | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | + | ||
- | ** {{wiki:PublicProperty.gif|}} IsNegative ** | + | |
- | + | ||
- | This property gets and sets whether the image should be converted to negative (inverse colors). | + | |
- | == Remarks == | + | |
- | None | + | |
- | == Return Value == | + | |
- | * Type:Boolean | + | |
- | + | ||
- | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | + | |
- | + | ||
- | This property gets and sets if the image should be converted to grayscale. | + | |
- | == Remarks == | + | |
- | None | + | |
- | == Return Value == | + | |
- | * Type:Boolean | + | |
- | + | ||
- | ** {{wiki:PublicProperty.gif|}} 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 == | + | |
- | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
** {{wiki:PublicProperty.gif|}} UpperThreshold ** | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** | ||
Line 706: | Line 756: | ||
* Type:Boolean | * Type:Boolean | ||
- | ** {{wiki:PublicProperty.gif|}} KeyColors ** | + | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** |
- | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | + | N/A |
== Remarks == | == Remarks == | ||
- | It will make these colors transparent when draw image. | + | N/A |
== Return Value == | == Return Value == | ||
- | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | + | * Type:TimeSpan |
** {{wiki:PublicProperty.gif|}} IsOpen ** | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
Line 739: | Line 789: | ||
** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
N/A | N/A | ||
Line 762: | Line 820: | ||
* Type:Single | * Type:Single | ||
- | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
N/A | N/A | ||
Line 768: | Line 826: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | + | * Type:Single |
- | ** {{wiki:PublicProperty.gif|}} Attribution ** | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
N/A | N/A | ||
Line 776: | Line 834: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:String | + | * Type:Single |
- | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** |
N/A | N/A | ||
Line 784: | Line 842: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:TimeSpan | + | * Type:Single |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} KeyColors ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsNegative ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
==== Protected Properties ==== | ==== Protected Properties ==== | ||
Line 796: | Line 886: | ||
==== Public Events ==== | ==== Public Events ==== | ||
- | ** {{wiki:PublicEvent.gif|}} DrawingException ** | + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** | + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawnException ** | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | + | ** {{wiki:PublicEvent.gif|}} DrawingException ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | + | ** {{wiki:PublicEvent.gif|}} DrawnException ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | + | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | + | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |