thinkgeo.mapsuite.portablecore.rasterlayer
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.rasterlayer [2015/09/21 08:16] admin |
thinkgeo.mapsuite.portablecore.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.KmlRasterLayer]] | + | *[[ThinkGeo.MapSuite.Core.GdiPlusRasterLayer]] |
| - | *[[ThinkGeo.MapSuite.Core.NoaaRadarRasterLayer]] | + | |
| *[[ThinkGeo.MapSuite.Core.GeoTiffRasterLayer]] | *[[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 17: | Line 16: | ||
| ** {{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 25: | Line 24: | ||
| ** {{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 37: | Line 36: | ||
| ** {{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 49: | Line 48: | ||
| ** {{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 59: | Line 58: | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | + | ** {{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 == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] |
| * 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|}} RequestDrawing(IEnumerable<RectangleShape>) ** | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 98: | Line 93: | ||
| == Parameters == | == Parameters == | ||
| - | * //extentsToRefresh// | ||
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 114: | Line 105: | ||
| == Parameters == | == Parameters == | ||
| - | * //bufferTime// | ||
| - | * Type:TimeSpan | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| * 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|}} RequestDrawing(RectangleShape,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 150: | Line 129: | ||
| == Parameters == | == Parameters == | ||
| - | * //extentToRefresh// | + | * //canvas// |
| - | * Type:[[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 | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 170: | Line 149: | ||
| == 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(IEnumerable<RectangleShape>,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 194: | Line 161: | ||
| == Parameters == | == Parameters == | ||
| - | * //extentsToRefresh// | + | * //extentToRefresh// |
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | + | * Type:[[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>,TimeSpan,RequestDrawingBufferTimeType) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 216: | Line 179: | ||
| * //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|}} GetThreadSafetyLevel() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** |
| - | 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> | + | * //bufferTime// |
| - | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | + | * Type:TimeSpan |
| + | * 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|}} Open() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 262: | Line 209: | ||
| == Parameters == | == Parameters == | ||
| - | <div newline></div> | + | * //extentToRefresh// |
| - | ** {{wiki:PublicMethod.gif|}} Close() ** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:N/A | ||
| - | N/A | + | * //bufferTime// |
| - | == Remarks == | + | * Type:TimeSpan |
| - | N/A | + | * Description:N/A |
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** |
| - | 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 298: | Line 229: | ||
| == Parameters == | == Parameters == | ||
| - | * //canvas// | + | * //extentsToRefresh// |
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:IEnumerable<[[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 | ||
| Line 309: | Line 240: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 321: | Line 252: | ||
| ** {{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 337: | Line 268: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 349: | Line 280: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 362: | Line 293: | ||
| ** {{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 374: | Line 305: | ||
| ** {{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 386: | Line 317: | ||
| ** {{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 398: | Line 329: | ||
| ** {{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 414: | Line 345: | ||
| * 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> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 450: | Line 365: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 462: | Line 377: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 474: | Line 389: | ||
| ** {{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 494: | Line 409: | ||
| ** {{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 514: | Line 429: | ||
| ** {{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 530: | Line 445: | ||
| ** {{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 546: | Line 461: | ||
| ** {{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 566: | Line 481: | ||
| ** {{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 582: | Line 497: | ||
| ** {{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 598: | Line 513: | ||
| ** {{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 609: | Line 524: | ||
| * //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 | * Description:N/A | ||
| Line 614: | Line 545: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 626: | Line 557: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 638: | Line 569: | ||
| ** {{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 670: | Line 601: | ||
| ** {{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 705: | Line 636: | ||
| <div newline></div> | <div newline></div> | ||
| ==== Public Properties ==== | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} ImageSource ** | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
| - | This property gets and sets the ImageSource used by the RasterLayer. | + | * //This property gets and sets the amount of blue to apply to the image.// |
| == Remarks == | == 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. | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
| - | This property gets and sets the upper threshold in the scale at which to display the image. | + | * //This property gets and sets the amount of red to apply to the image.// |
| == Remarks == | == 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. | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:Double | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} LowerThreshold ** | + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** |
| - | This property gets and sets the lower threshold in the scale at which to display the image. | + | * //This property gets and sets the amount of green to apply to the image.// |
| == Remarks == | == 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. | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:Double | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** | + | ** {{wiki:PublicProperty.gif|}} IsNegative ** |
| - | This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters. | + | * //This property gets and sets whether the image should be converted to negative (inverse colors).// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| - | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | + | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** |
| - | N/A | + | * //This property gets and sets if the image should be converted to grayscale.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:TimeSpan | + | * Type:Boolean |
| - | ** {{wiki:PublicProperty.gif|}} IsOpen ** | + | ** {{wiki:PublicProperty.gif|}} ImageSource ** |
| - | N/A | + | * //This property gets and sets the ImageSource used by the RasterLayer.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| - | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** | + | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** |
| - | N/A | + | * //This property gets and sets the upper threshold in the scale at which to display the image.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 Value == | ||
| - | * Type:Boolean | + | * Type:Double |
| - | ** {{wiki:PublicProperty.gif|}} DrawingTime ** | + | ** {{wiki:PublicProperty.gif|}} LowerThreshold ** |
| - | N/A | + | * //This property gets and sets the lower threshold in the scale at which to display the image.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 Value == | ||
| - | * Type:TimeSpan | + | * Type:Double |
| - | ** {{wiki:PublicProperty.gif|}} Name ** | + | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** |
| - | N/A | + | * //This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:Boolean |
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | + | ** {{wiki:PublicProperty.gif|}} KeyColors ** |
| - | N/A | + | * //Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //It will make these colors transparent when draw image.// |
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> |
| - | ** {{wiki:PublicProperty.gif|}} IsVisible ** | + | ** {{wiki:PublicProperty.gif|}} IsOpen ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| - | ** {{wiki:PublicProperty.gif|}} Transparency ** | + | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:Boolean |
| - | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** | + | ** {{wiki:PublicProperty.gif|}} DrawingTime ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:TimeSpan |
| - | ** {{wiki:PublicProperty.gif|}} RedTranslation ** | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:String |
| - | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | + | ** {{wiki:PublicProperty.gif|}} IsVisible ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:Boolean |
| - | ** {{wiki:PublicProperty.gif|}} KeyColors ** | + | ** {{wiki:PublicProperty.gif|}} Transparency ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} IsNegative ** | + | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] |
| - | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | + | ** {{wiki:PublicProperty.gif|}} Attribution ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:String |
| - | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | + | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | + | * Type:TimeSpan |
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
| - | This property returns true if the RasterLayer is open and false if it is not. | + | * //This property returns true if the RasterLayer is open and false if it is not.// |
| == Remarks == | == 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. | + | * //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 == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | + | ** {{wiki:PublicEvent.gif|}} DrawingException ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
| - | + | ||
| - | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | + | |
| - | N/A | + | |
| - | == Remarks == | + | |
| - | N/A | + | |
| - | + | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | + | |
| ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} DrawingException ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} DrawnException ** | ** {{wiki:PublicEvent.gif|}} DrawnException ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | ||
| + | |||
| + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | ||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
| + | |||
| + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | ||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
thinkgeo.mapsuite.portablecore.rasterlayer.1442823407.txt.gz · Last modified: 2015/09/21 08:16 by admin