Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.core.magneticdeclinationprinterlayer
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer
<!– Class –>
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.Core.Layer *ThinkGeo.MapSuite.Core.PrinterLayer ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 MagneticDeclinationPrinterLayer | |||
| MagneticDeclinationPrinterLayer | MapPrinterLayer | ||
| MagneticDeclinationPrinterLayer | String, MapPrinterLayer |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Layer | |
| BackgroundMask | AreaStyle | PrinterLayer | |
| BlueTranslation | Single | Layer | This property gets and sets the amount of blue to apply to the image. |
| DragMode | PrinterDragMode | PrinterLayer | |
| DrawingExceptionMode | DrawingExceptionMode | Layer | Gets or sets the DrawExcpetionMode when exception happens. |
| DrawingTime | TimeSpan | Layer | This property gets the last drawing time for the layer. |
| Elevation | Double | ||
| ElevationUnit | DistanceUnit | ||
| GreenTranslation | Single | Layer | This property gets and sets the amount of green to apply to the image. |
| GridNorthLineStyle | LineStyle | ||
| HasBoundingBox | Boolean | Layer(overriden) | |
| IsDrawing | Boolean | PrinterLayer | |
| IsGrayscale | Boolean | Layer | This property gets and sets if the image should be converted to grayscale. |
| IsNegative | Boolean | Layer | This property gets and sets whether the image should be converted to negative (inverse colors). |
| IsOpen | Boolean | Layer | This property returns true if the Layer is open and false if it is not. |
| IsVisible | Boolean | Layer | This property gets and set the visible state of the layer. |
| KeyColors | Collection<GeoColor> | Layer | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. |
| MagneticFieldPathFilename | String | ||
| MagneticNorthLineStyle | LineStyle | ||
| MapPrinterLayer | MapPrinterLayer | ||
| Name | String | Layer | This property gets and sets the name for the layer. |
| ProjectionToDecimalDegrees | Projection | ||
| RedTranslation | Single | Layer | This property gets and sets the amount of red to apply to the image. |
| RequestDrawingInterval | TimeSpan | Layer | |
| ResizeMode | PrinterResizeMode | PrinterLayer | |
| SampleDateTime | DateTime | ||
| SelectabilityMode | SelectabilityMode | PrinterLayer | |
| TextStyle | TextStyle | ||
| Transparency | Single | Layer | This property gets and sets the amount of transparency to apply to the image. |
| TrueNorthLineStyle | LineStyle | ||
| TrueNorthPointStyle | PointStyle |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 IsOpenCore | Boolean | Layer | This property returns true if the Layer is open and false if it is not. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 DrawingAttribution | DrawingAttributionLayerEventArgs | Layer | |
| DrawingException | DrawingExceptionLayerEventArgs | Layer | |
| DrawingProgressChanged | DrawingProgressChangedEventArgs | Layer | |
| DrawnAttribution | DrawnAttributionLayerEventArgs | Layer | |
| DrawnException | DrawnExceptionLayerEventArgs | Layer | |
| RequestedDrawing | RequestedDrawingLayerEventArgs | Layer | |
| RequestingDrawing | RequestingDrawingLayerEventArgs | Layer | |
| StreamLoading | StreamLoadingEventArgs | This event allows you to pass in your own stream to represent the image. |
Public Constructors
MagneticDeclinationPrinterLayer()
Parameters
| Name | Type | Description |
|---|
MagneticDeclinationPrinterLayer(MapPrinterLayer)
Parameters
| Name | Type | Description |
|---|---|---|
| mapPrinterLayer | MapPrinterLayer<!– ThinkGeo.MapSuite.Core.MapPrinterLayer –> |
MagneticDeclinationPrinterLayer(String, MapPrinterLayer)
Parameters
| Name | Type | Description |
|---|---|---|
| magneticFieldPathFilename | String<!– System.String –> | |
| mapPrinterLayer | MapPrinterLayer<!– ThinkGeo.MapSuite.Core.MapPrinterLayer –> |
Protected Constructors
Public Methods
CloneDeep()
Create a copy of Layer using the deep clone process.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> | A cloned Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Close()
This method closes the Layer and releases any resources it was using.
Remarks
This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Draw(GeoCanvas, Collection<SimpleCandidate>)
This method draws the Layer.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | This parameter represents the labels used for collision detection and duplication checking. |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetBoundingBox()
This method returns the bounding box of the Layer.
Remarks
This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| pointFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime, String)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| pointFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldPathFilename | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime, Stream)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| pointFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldStream | Stream<!– System.IO.Stream –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| x | Double<!– System.Double –> | |
| y | Double<!– System.Double –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| point | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime, String)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| point | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldPathFilename | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime, Stream)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| x | Double<!– System.Double –> | |
| y | Double<!– System.Double –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldStream | Stream<!– System.IO.Stream –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime, String)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| x | Double<!– System.Double –> | |
| y | Double<!– System.Double –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldPathFilename | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime, Stream)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| MagneticDeclination<!– ThinkGeo.MapSuite.Core.MagneticDeclination –> |
Parameters
| Name | Type | Description |
|---|---|---|
| point | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| elevation | Double<!– System.Double –> | |
| elevationUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| sampleDateTime | DateTime<!– System.DateTime –> | |
| magneticFieldStream | Stream<!– System.IO.Stream –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
GetPosition(PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
GetPosition()
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
LoadLayer(Uri)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> |
Parameters
| Name | Type | Description |
|---|---|---|
| layerUri | Uri<!– System.Uri –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
LoadLayer(Stream)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> |
Parameters
| Name | Type | Description |
|---|---|---|
| layerStream | Stream<!– System.IO.Stream –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Open()
This method opens the Layer so that it is initialized and ready to use.
Remarks
This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.
When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> | |
| bufferTimeType | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(RectangleShape)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan<!– System.TimeSpan –> | |
| bufferTimeType | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(TimeSpan)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(RectangleShape, TimeSpan)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> | |
| bufferTimeType | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestDrawing(IEnumerable<RectangleShape>)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
SetPosition(Double, Double, LayerAnchorLocation, Double, Double, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| width | Double<!– System.Double –> | |
| height | Double<!– System.Double –> | |
| corner | LayerAnchorLocation<!– ThinkGeo.MapSuite.Core.LayerAnchorLocation –> | |
| cornerPointX | Double<!– System.Double –> | |
| cornerPointY | Double<!– System.Double –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SetPosition(Double, Double, Double, Double, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| width | Double<!– System.Double –> | |
| height | Double<!– System.Double –> | |
| centerPointX | Double<!– System.Double –> | |
| centerPointY | Double<!– System.Double –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SetPosition(Double, Double, PointShape, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| width | Double<!– System.Double –> | |
| height | Double<!– System.Double –> | |
| centerPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SetPosition(RectangleShape, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SetPosition(RectangleShape)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SetPosition(Double, Double, LayerAnchorLocation, PointShape, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| width | Double<!– System.Double –> | |
| height | Double<!– System.Double –> | |
| corner | LayerAnchorLocation<!– ThinkGeo.MapSuite.Core.LayerAnchorLocation –> | |
| cornerPoint | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
CloneDeepCore()
Create a copy of Layer using the deep clone process. The default implemenation uses serialization.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> | A cloned Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
CloseCore()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
DrawAttributionCore(GeoCanvas, String)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| attribution | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawCore(GeoCanvas, Collection<SimpleCandidate>)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> |
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
DrawException(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Remarks
This method can be overriden its logic by rewrite the DrawExceptionCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | The target canvas to draw the layer. |
| e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawExceptionCore(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | The target canvas to draw the layer. |
| e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetBoundingBoxCore()
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
GetPositionCore(PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingAttributionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnDrawingException(DrawingExceptionLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingExceptionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnAttributionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnDrawnException(DrawnExceptionLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawnExceptionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| eventArgs | RequestedDrawingLayerEventArgs<!– ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| eventArgs | RequestingDrawingLayerEventArgs<!– ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OnStreamLoading(StreamLoadingEventArgs)
This method allows you to raise the StreamLoading event.
Remarks
This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes, so we exposed a way to raise the event as necessary through this protected method.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | StreamLoadingEventArgs<!– ThinkGeo.MapSuite.Core.StreamLoadingEventArgs –> | This parameter represents the event arguments you want to raise the StreamLoading event with. |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
OpenCore()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
SetPositionCore(Double, Double, Double, Double, PrintingUnit)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| width | Double<!– System.Double –> | |
| height | Double<!– System.Double –> | |
| centerPointX | Double<!– System.Double –> | |
| centerPointY | Double<!– System.Double –> | |
| unit | PrintingUnit<!– ThinkGeo.MapSuite.Core.PrintingUnit –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer(overriden) –> Go Back
Public Properties
Attribution
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
BackgroundMask
Return Value
| Return Type |
|---|
| AreaStyle<!– ThinkGeo.MapSuite.Core.AreaStyle –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> 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.Core.Layer –> Go Back
DragMode
Return Value
| Return Type |
|---|
| PrinterDragMode<!– ThinkGeo.MapSuite.Core.PrinterDragMode –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
DrawingExceptionMode
Gets or sets the DrawExcpetionMode when exception happens.
Return Value
| Return Type |
|---|
| DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawingTime
This property gets the last drawing time for the layer.
Remarks
We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Elevation
Return Value
| Return Type |
|---|
| Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
ElevationUnit
Return Value
| Return Type |
|---|
| DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> 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.Core.Layer –> Go Back
GridNorthLineStyle
Return Value
| Return Type |
|---|
| LineStyle<!– ThinkGeo.MapSuite.Core.LineStyle –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
HasBoundingBox
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
IsDrawing
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> 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.Core.Layer –> Go Back
IsNegative
This property gets and sets whether the image should be converted to negative (inverse colors).
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
IsOpen
This property returns true if the Layer is open and false if it is not.
Remarks
This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
IsVisible
This property gets and set the visible state of the layer.
Remarks
If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
KeyColors
Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.
Remarks
It will make these colors transparent when draw image.
Return Value
| Return Type |
|---|
| Collection<GeoColor><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.GeoColor} –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
MagneticFieldPathFilename
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
MagneticNorthLineStyle
Return Value
| Return Type |
|---|
| LineStyle<!– ThinkGeo.MapSuite.Core.LineStyle –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
MapPrinterLayer
Return Value
| Return Type |
|---|
| MapPrinterLayer<!– ThinkGeo.MapSuite.Core.MapPrinterLayer –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> 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.Core.Layer –> Go Back
ProjectionToDecimalDegrees
Return Value
| Return Type |
|---|
| Projection<!– ThinkGeo.MapSuite.Core.Projection –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> 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.Core.Layer –> Go Back
RequestDrawingInterval
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
ResizeMode
Return Value
| Return Type |
|---|
| PrinterResizeMode<!– ThinkGeo.MapSuite.Core.PrinterResizeMode –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
SampleDateTime
Return Value
| Return Type |
|---|
| DateTime<!– System.DateTime –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
SelectabilityMode
Return Value
| Return Type |
|---|
| SelectabilityMode<!– ThinkGeo.MapSuite.Core.SelectabilityMode –> |
<!– ThinkGeo.MapSuite.Core.PrinterLayer –> Go Back
TextStyle
Return Value
| Return Type |
|---|
| TextStyle<!– ThinkGeo.MapSuite.Core.TextStyle –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> 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.Core.Layer –> Go Back
TrueNorthLineStyle
Return Value
| Return Type |
|---|
| LineStyle<!– ThinkGeo.MapSuite.Core.LineStyle –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
TrueNorthPointStyle
Return Value
| Return Type |
|---|
| PointStyle<!– ThinkGeo.MapSuite.Core.PointStyle –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
Protected Properties
IsOpenCore
This property returns true if the Layer is open and false if it is not.
Remarks
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.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Public Events
DrawingAttribution
Event Arguments
| Event Arguments |
|---|
| DrawingAttributionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawingException
Event Arguments
| Event Arguments |
|---|
| DrawingExceptionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawingProgressChanged
Event Arguments
| Event Arguments |
|---|
| DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawnAttribution
Event Arguments
| Event Arguments |
|---|
| DrawnAttributionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawnException
Event Arguments
| Event Arguments |
|---|
| DrawnExceptionLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestedDrawing
Event Arguments
| Event Arguments |
|---|
| RequestedDrawingLayerEventArgs<!– ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
RequestingDrawing
Event Arguments
| Event Arguments |
|---|
| RequestingDrawingLayerEventArgs<!– ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
StreamLoading
This event allows you to pass in your own stream to represent the image.
Event Arguments
| Event Arguments |
|---|
| StreamLoadingEventArgs<!– ThinkGeo.MapSuite.Core.StreamLoadingEventArgs –> |
<!– ThinkGeo.MapSuite.Core.MagneticDeclinationPrinterLayer –> Go Back
NOTOC MapSuiteCore ThinkGeo.MapSuite.Core UpdateDocumentation
thinkgeo.mapsuite.core.magneticdeclinationprinterlayer.1440040129.txt.gz · Last modified: 2015/09/17 10:34 (external edit)
