thinkgeo.mapsuite.portablecore.geotiffrasterlayer
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.geotiffrasterlayer [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.geotiffrasterlayer [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.GeoTiffRasterLayer ====== | + | ====== ThinkGeo.MapSuite.Core.GeoTiffRasterLayer ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class represents a TIFF image to be drawn on the map. | This class represents a TIFF image to be drawn on the map. | ||
| - | === Remarks === | ||
| - | The TiffRasterLayer represents a TIFF file for drawing on the map. Simply provide the path and filename for the TIFF file, add the layer to the MapEngine class and start drawing. You can also draw the layer manually outside of the MapEngine. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.PortableCore.Layer]] | + | *ThinkGeo.MapSuite.Core.Layer |
| - | ***[[ThinkGeo.MapSuite.PortableCore.RasterLayer]] | + | *ThinkGeo.MapSuite.Core.RasterLayer |
| - | ****[[ThinkGeo.MapSuite.PortableCore.GeoTiffRasterLayer]] | + | ***ThinkGeo.MapSuite.Core.GeoTiffRasterLayer** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GeoTiffRasterLayer() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoTiffRasterLayer()|GeoTiffRasterLayer]] | | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoTiffRasterLayer(String)|GeoTiffRasterLayer]] | String | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoTiffRasterLayer(String, String)|GeoTiffRasterLayer]] | String, String | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoTiffRasterLayer(String, RectangleShape)|GeoTiffRasterLayer]] | String, [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | | This is a constructor for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //If you use this constructor then, you need to set the PathFileName property manually before using the layer.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GeoTiffRasterLayer(String) ** | ||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //This constructor gets the layer ready to use.// | ||
| + | == Parameters == | ||
| + | * //imagePathFilename// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the path and filename of the TIFF file you want to use. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GeoTiffRasterLayer(String,String) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //This constructor gets the layer ready to use.// | ||
| + | == Parameters == | ||
| + | * //imagePathFilename// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the path and filename of the TIFF file you want to use. | ||
| + | |||
| + | * //worldfilePathFilename// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the world file path and filename for the TIFF file you want to use. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GeoTiffRasterLayer(String,RectangleShape) ** | ||
| + | |||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //This constructor gets the layer ready to use.// | ||
| + | == Parameters == | ||
| + | * //imagePathFilename// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the path and filename of the TIFF file you want to use. | ||
| + | |||
| + | * //imageExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:This parameter is the image extent of the TIFF file you want to use. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Create a copy of Layer using the deep clone process. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method closes the Layer and releases any resources it was using. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Collection<SimpleCandidate>)|Draw]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method draws the Layer. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method returns the bounding box of the Layer. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHorizontalResolution()|GetHorizontalResolution]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the horizontal resolution of the image. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectionText()|GetProjectionText]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the projection parameters of the current layer. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetVerticalResolution()|GetVerticalResolution]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the vertical resolution of the image. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //canvas// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //labelsInAllLayers// | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentToRefresh// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentsToRefresh// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentToRefresh// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentsToRefresh// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas, String)|DrawAttributionCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | |
| - | ==== Public Properties ==== | + | * //N/A// |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | * //N/A// |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of blue to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingQuality|DrawingQuality]] | [[ThinkGeo.MapSuite.PortableCore.DrawingQuality|DrawingQuality]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets the last drawing time for the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of green to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|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 GeoTiffRasterLayer, we override this API and mark it as true. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasProjectionText|HasProjectionText]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ImageSource|ImageSource]] | [[ThinkGeo.MapSuite.PortableCore.RasterSource|RasterSource]] | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the ImageSource used by the RasterLayer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets if the image should be converted to grayscale. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets whether the image should be converted to negative (inverse colors). | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and set the visible state of the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#KeyColors|KeyColors]] | Collection<[[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]> | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LibraryType|LibraryType]] | [[ThinkGeo.MapSuite.PortableCore.GeoTiffLibraryType|GeoTiffLibraryType]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LowerThreshold|LowerThreshold]] | Double | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the lower threshold in the scale at which to display the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the name for the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PathFilename|PathFilename]] | String | | This property gets and sets the path and filename of the TIFF file you want to use. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RedTranslation|RedTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of red to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]] | Single | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the amount of transparency to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#UpperThreshold|UpperThreshold]] | Double | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the upper threshold in the scale at which to display the image. | | + | |
| - | ==== Protected Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | * Description:N/A |
| - | ==== Public Events ==== | + | == Parameters == |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | * //canvas// |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | * Description:N/A |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
| - | ===== Public Constructors ===== | + | * //labelsInAllLayers// |
| - | ==== GeoTiffRasterLayer() ==== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | === 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 ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ==== GeoTiffRasterLayer(String) ==== | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** |
| - | This is a constructor for the class. | + | |
| - | === Overloads === | + | |
| - | This constructor allows you to provide the path and filename information for the TIFF file. | + | |
| - | === Remarks === | + | |
| - | This constructor gets the layer ready to use. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | imagePathFilename | String<!-- System.String --> | This parameter is the path and filename of the TIFF file you want to use. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ==== GeoTiffRasterLayer(String, String) ==== | + | == Remarks == |
| - | This is a constructor for the class. | + | * //N/A// |
| - | === Overloads === | + | |
| - | This constructor allows you to provide the path and filename information for both the TIFF file and its world file. | + | |
| - | === Remarks === | + | |
| - | This constructor gets the layer ready to use. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | imagePathFilename | String<!-- System.String --> | This parameter is the path and filename of the TIFF file you want to use. | | + | |
| - | | worldfilePathFilename | String<!-- System.String --> | This parameter is the world file path and filename for the TIFF file you want to use. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== GeoTiffRasterLayer(String, RectangleShape) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This constructor allows you to provide the path and filename for the TIFF file and the image extent to use. | + | |
| - | === Remarks === | + | |
| - | This constructor gets the layer ready to use. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | imagePathFilename | String<!-- System.String --> | This parameter is the path and filename of the TIFF file you want to use. | | + | |
| - | | imageExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter is the image extent of the TIFF file you want to use. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | <div newline></div> |
| - | ===== Public Methods ===== | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | ==== 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 ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== Close() ==== | + | * Description:N/A |
| - | 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. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | 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. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== Draw(GeoCanvas, Collection<SimpleCandidate>) ==== | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** |
| - | 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. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | + | * Description:N/A |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|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 --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //eventArgs// |
| - | ==== Equals(Object) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** |
| - | | obj | Object<!-- System.Object --> | | | + | |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetBoundingBox() ==== | + | * //N/A// |
| - | 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 Value === | + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the Layer. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetHashCode() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetHorizontalResolution() ==== | + | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** |
| - | 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 === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== GetProjectionText() ==== | + | * Description:N/A |
| - | 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 === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //canvas// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | * //e// |
| - | [[#Public Methods|Go Back]] | + | * Type:Exception |
| - | ==== GetType() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetVerticalResolution() ==== | + | * //N/A// |
| - | 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //canvas// |
| - | ==== Open() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | This method opens the Layer so that it is initialized and ready to use. | + | * Description:N/A |
| - | === 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. | + | * //e// |
| + | * Type:Exception | ||
| + | * Description:N/A | ||
| - | 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. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== RequestDrawing() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //e// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** |
| - | ==== RequestDrawing(RectangleShape) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //e// |
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** |
| - | ==== RequestDrawing(TimeSpan) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //canvas// |
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //attribution// |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** |
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | + | |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToString() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //args// |
| - | ===== Protected Methods ===== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
| - | ==== CloneDeepCore() ==== | + | * Description:N/A |
| - | 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 ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== CloseCore() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //args// |
| - | ==== DrawAttributionCore(GeoCanvas, String) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** |
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | + | |
| - | | attribution | String<!-- System.String --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | + | * Description:N/A |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | ==== DrawException(GeoCanvas, Exception) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| - | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method can be overriden its logic by rewrite the DrawExceptionCore. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** |
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|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 --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawExceptionCore(GeoCanvas, Exception) ==== | + | * //N/A// |
| - | 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | + | * Description:N/A |
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //eventArgs// |
| - | ==== Finalize() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetBoundingBoxCore() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== MemberwiseClone() ==== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Object |
| - | ==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} LibraryType ** | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoTiffLibraryType|GeoTiffLibraryType]] |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //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 GeoTiffRasterLayer, we override this API and mark it as true.// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | + | * //The default implementation in the base class returns false.// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:Boolean |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} DrawingQuality ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]] |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} PathFilename ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //This property gets and sets the path and filename of the TIFF file you want to use.// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | + | * //This should be the complete path and filename for a TIFF file.// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:String |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:Single |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:Single |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OpenCore() ==== | + | * //N/A// |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:Single |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} IsNegative ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | * //N/A// |
| - | ==== Attribution ==== | + | == Return Value == |
| - | === Return Value === | + | * Type:Boolean |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== DrawingExceptionMode ==== | + | * //N/A// |
| - | Gets or sets the DrawExcpetionMode when exception happens. | + | == Return Value == |
| - | === Return Value === | + | * Type:Boolean |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} ImageSource ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== DrawingQuality ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingQuality|DrawingQuality]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingQuality --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoTiffRasterLayer --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== DrawingTime ==== | + | * //N/A// |
| - | This property gets the last drawing time for the layer. | + | == Return Value == |
| - | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| - | 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 --> | + | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== HasBoundingBox ==== | + | * //N/A// |
| - | 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 GeoTiffRasterLayer, we override this API and mark it as true. | + | == Return Value == |
| - | === Remarks === | + | * Type:Double |
| - | The default implementation in the base class returns false. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | ** {{wiki:PublicProperty.gif|}} LowerThreshold ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== ImageSource ==== | + | * //N/A// |
| - | This property gets and sets the ImageSource used by the RasterLayer. | + | == Return Value == |
| - | === Remarks === | + | * Type:Double |
| - | 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 ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RasterSource|RasterSource]]<!-- ThinkGeo.MapSuite.PortableCore.RasterSource --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== IsNegative ==== | + | * //N/A// |
| - | This property gets and sets whether the image should be converted to negative (inverse colors). | + | == Return Value == |
| - | === Return Value === | + | * Type:Boolean |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | ** {{wiki:PublicProperty.gif|}} KeyColors ** |
| - | [[#Public Properties|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. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | * //N/A// |
| - | | Boolean<!-- System.Boolean --> | | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} IsOpen ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== 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. | + | == Return Value == |
| - | === Remarks === | + | * Type:Boolean |
| - | It will make these colors transparent when draw image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | + | ** {{wiki:PublicProperty.gif|}} DrawingTime ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== LibraryType ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoTiffLibraryType|GeoTiffLibraryType]]<!-- ThinkGeo.MapSuite.PortableCore.GeoTiffLibraryType --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoTiffRasterLayer --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== LowerThreshold ==== | + | * //N/A// |
| - | This property gets and sets the lower threshold in the scale at which to display the image. | + | == Return Value == |
| - | === Remarks === | + | * Type:TimeSpan |
| - | 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 --> | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | [[#Public Properties|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 --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== PathFilename ==== | + | * //N/A// |
| - | This property gets and sets the path and filename of the TIFF file you want to use. | + | == Return Value == |
| - | === Remarks === | + | * Type:String |
| - | This should be the complete path and filename for a TIFF file. | + | |
| - | === Return Value === | + | ** {{wiki:PublicProperty.gif|}} IsVisible ** |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Transparency ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:TimeSpan | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} DrawingException ** | ||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoTiffRasterLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
| - | [[#Public Properties|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 --> | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
| - | [[#Public Properties|Go Back]] | + | * //N/A// |
| - | ==== RequestDrawingInterval ==== | + | == Remarks == |
| - | === Return Value === | + | * //N/A// |
| - | ^ Return Type ^ | + | |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| - | [[#Public Properties|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 --> | + | ** {{wiki:PublicEvent.gif|}} DrawnException ** |
| - | [[#Public Properties|Go Back]] | + | * //N/A// |
| - | ==== UpperThreshold ==== | + | == Remarks == |
| - | This property gets and sets the upper threshold in the scale at which to display the image. | + | * //N/A// |
| - | === 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 --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | |
| - | ==== IsOpenCore ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** |
| - | [[#Protected Properties|Go Back]] | + | * //N/A// |
| - | ===== Public Events ===== | + | == Remarks == |
| - | ==== DrawingAttribution ==== | + | * //N/A// |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== DrawingException ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== DrawingProgressChanged ==== | + | == Remarks == |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== DrawnAttribution ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== DrawnException ==== | + | == Remarks == |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== RequestedDrawing ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== RequestingDrawing ==== | + | == Remarks == |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.geotiffrasterlayer.1440040132.txt.gz · Last modified: 2015/09/21 08:09 (external edit)