User Tools

Site Tools


thinkgeo.mapsuite.portablecore.scalebaradornmentlayer

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.PortableCore.ScaleBarAdornmentLayer

<!– Class –> The ScaleBarAdornmentLayer class allows you show a bar graphic on the map that displays the distance scale for the current map extent.

Remarks

Use the <strong>ScaleBarAdornmentLayer</strong> class as a quick way to implement a <strong>ScaleBar</strong>. When using the <strong>ScaleBarAdornmentLayer</strong>, you also need to add a ScaleLineAdornmentLayer to the map control. One thing we should pay attention to is that the ScaleBar will not be drawn when the CurrentExtent is outside of Range(-90,180,90,-180).

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodScaleBarAdornmentLayer Creates a new instance of the ScaleBarAdornmentLayer class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodCloneDeep Layer Create a copy of Layer using the deep clone process.
Public MethodClose Layer This method closes the Layer and releases any resources it was using.
Public MethodDraw GeoCanvas, Collection<SimpleCandidate> Layer This method draws the Layer.
Public MethodEquals Object Object
Public MethodGetBoundingBox Layer This method returns the bounding box of the Layer.
Public MethodGetDrawingLocation GeoCanvas, Single, Single AdornmentLayer This method returns the drawing location of the AdornmentLayer.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodOpen Layer This method opens the Layer so that it is initialized and ready to use.
Public MethodRequestDrawing Layer
Public MethodRequestDrawing RectangleShape Layer
Public MethodRequestDrawing IEnumerable<RectangleShape> Layer
Public MethodRequestDrawing TimeSpan Layer
Public MethodRequestDrawing RectangleShape, TimeSpan Layer
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan Layer
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloneDeepCore Layer Create a copy of Layer using the deep clone process. The default implemenation uses serialization.
Protected MethodCloseCore Layer This method closes the Layer and releases any resources it was using.
Protected MethodDrawAttributionCore GeoCanvas, String Layer
Protected MethodDrawCore GeoCanvas, Collection<SimpleCandidate> Layer(overriden) This method draws the Layer.
Protected MethodDrawException GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawExceptionCore GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodFinalize Object
Protected MethodGetBoundingBoxCore Layer This method returns the bounding box of the Layer.
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingAttribution DrawingAttributionLayerEventArgs Layer
Protected MethodOnDrawingException DrawingExceptionLayerEventArgs Layer
Protected MethodOnDrawingProgressChanged DrawingProgressChangedEventArgs Layer
Protected MethodOnDrawnAttribution DrawnAttributionLayerEventArgs Layer
Protected MethodOnDrawnException DrawnExceptionLayerEventArgs Layer
Protected MethodOnRequestedDrawing RequestedDrawingLayerEventArgs Layer
Protected MethodOnRequestingDrawing RequestingDrawingLayerEventArgs Layer
Protected MethodOpenCore Layer This method opens the Layer so that it is initialized and ready to use.

Public Properties

Name Return DeclaringType Summary
Public PropertyAlternateBarBrush GeoBrush The property is the GeoBrush that will be used to draw the alternate ScaleBar.
Public PropertyAttribution String Layer
Public PropertyBackgroundMask AreaStyle AdornmentLayer
Public PropertyBarBrush GeoBrush The property is the GeoBrush that will be used to draw the ScaleBar.
Public PropertyBarPen GeoPen
Public PropertyDisplayUnitString Dictionary<String,String> This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.
Public PropertyDrawingExceptionMode DrawingExceptionMode Layer Gets or sets the DrawExcpetionMode when exception happens.
Public PropertyDrawingTime TimeSpan Layer This property gets the last drawing time for the layer.
Public PropertyHasBoundingBox Boolean Layer This property indicates whether 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.
Public PropertyHasMask Boolean Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.
Public PropertyHeight Single AdornmentLayer
Public PropertyIsGrayscale Boolean Layer This property gets and sets if the image should be converted to grayscale.
Public PropertyIsNegative Boolean Layer This property gets and sets whether the image should be converted to negative (inverse colors).
Public PropertyIsOpen Boolean Layer This property returns true if the Layer is open and false if it is not.
Public PropertyIsVisible Boolean Layer This property gets and set the visible state of the layer.
Public PropertyLocation AdornmentLocation AdornmentLayer This property gets and sets the drawing location of the AdornmentLayer.
Public PropertyMaskBrush GeoBrush Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.
Public PropertyMaskContour GeoPen Gets or sets the pen for the outline of the ScaleBar mask.
Public PropertyMaxWidth Int32 Gets or Sets the MaxWidth of the ScaleBar.
Public PropertyName String Layer This property gets and sets the name for the layer.
Public PropertyProjectionToDecimalDegrees Projection Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.
Public PropertyRequestDrawingInterval TimeSpan Layer
Public PropertyTextStyle TextStyle
Public PropertyThickness Int32 Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
Public PropertyTransparency Single Layer This property gets and sets the amount of transparency to apply to the image.
Public PropertyUnitFamily UnitSystem Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
Public PropertyWidth Single AdornmentLayer
Public PropertyXOffsetInPixel Single AdornmentLayer This property gets and sets the X pixel offset for the AdornmentLayer.
Public PropertyYOffsetInPixel Single AdornmentLayer This property gets and sets the Y pixel offset for the AdornmentLayer.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyIsOpenCore Boolean Layer This property returns true if the Layer is open and false if it is not.

Public Events

Public Constructors

ScaleBarAdornmentLayer()

Creates a new instance of the ScaleBarAdornmentLayer class.

Remarks

When displaying a <strong>ScaleBarAdornmentLayer</strong>, we need to instance a ScaleLineAdornmentLayer and add it to MapEngine. The ScaleBar will not be drawn when the <strong>CurrentExtent</strong> is outside of the world Extent(-90,180-,90,-180).

Parameters

Name Type Description

Go Back

Protected Constructors

Public Methods

CloneDeep()

Create a copy of Layer using the deep clone process.

Remarks

The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.

Return Value

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

Parameters

Name Type Description

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

Close()

This method closes the Layer and releases any resources it was using.

Remarks

This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.

If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

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

Parameters

Name Type Description

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

Draw(GeoCanvas, Collection<SimpleCandidate>)

This method draws the Layer.

Remarks

This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

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

Parameters

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

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

Equals(Object)

Return Value

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

Parameters

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

<!– System.Object –> Go Back

GetBoundingBox()

This method returns the bounding box of the Layer.

Remarks

This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

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

Parameters

Name Type Description

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

GetDrawingLocation(GeoCanvas, Single, Single)

This method returns the drawing location of the AdornmentLayer.

Return Value

Return Type Description
ScreenPointF<!– ThinkGeo.MapSuite.PortableCore.ScreenPointF –> It returns the upper left screen point of where the AdornmentLayer will be drawn.

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> This parameter is the canvas used in drawing.
adornmentWidth Single<!– System.Single –> This parameter is the width of the adornment.
adornmentHeight Single<!– System.Single –> This parameter is the height of the adornment

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

GetHashCode()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Open()

This method opens the Layer so that it is initialized and ready to use.

Remarks

This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.

When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

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

Parameters

Name Type Description

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

RequestDrawing()

Return Value

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

Parameters

Name Type Description

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

RequestDrawing(RectangleShape)

Return Value

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

Parameters

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

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

RequestDrawing(IEnumerable<RectangleShape>)

Return Value

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

Parameters

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

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

RequestDrawing(TimeSpan)

Return Value

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

Parameters

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

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

RequestDrawing(RectangleShape, TimeSpan)

Return Value

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

Parameters

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

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

RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)

Return Value

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

Parameters

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

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

ToString()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloneDeepCore()

Create a copy of Layer using the deep clone process. The default implemenation uses serialization.

Remarks

The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.

Return Value

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

Parameters

Name Type Description

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

CloseCore()

This method closes the Layer and releases any resources it was using.

Remarks

This abstract method is called from the concrete public method Close. 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.

Return Value

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

Parameters

Name Type Description

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

DrawAttributionCore(GeoCanvas, String)

Return Value

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

Parameters

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

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

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

This method draws the Layer.

Remarks

This abstract method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided.

When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.

Return Value

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

Parameters

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

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

DrawException(GeoCanvas, Exception)

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

Remarks

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

Return Value

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

Parameters

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

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

DrawExceptionCore(GeoCanvas, Exception)

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

Return Value

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

Parameters

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

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

Finalize()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetBoundingBoxCore()

This method returns the bounding box of the Layer.

Remarks

This method returns the bounding box of the Layer.

Return Value

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

Parameters

Name Type Description

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

MemberwiseClone()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Return Value

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

Parameters

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

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

OnDrawingException(DrawingExceptionLayerEventArgs)

Return Value

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

Parameters

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

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

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Return Value

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

Parameters

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

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

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Return Value

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

Parameters

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

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

OnDrawnException(DrawnExceptionLayerEventArgs)

Return Value

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

Parameters

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

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

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Return Value

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

Parameters

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

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

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Return Value

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

Parameters

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

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

OpenCore()

This method opens the Layer so that it is initialized and ready to use.

Remarks

This abstract method is called from the concrete public method Open. 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.

Return Value

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

Parameters

Name Type Description

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

Public Properties

AlternateBarBrush

The property is the GeoBrush that will be used to draw the alternate ScaleBar.

Remarks

This <strong>AlternateBarBrush</strong> property will give you full control over the appearance of the <strong>ScaleBarAdornmentLayer</strong>.

Return Value

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

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

Attribution

Return Value

Return Type
String<!– System.String –>

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

BackgroundMask

Return Value

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

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

BarBrush

The property is the GeoBrush that will be used to draw the ScaleBar.

Remarks

This <strong>BarBrush</strong> property will give you full control over the appearance of the <strong>ScaleBarAdornmentLayer</strong>.

Return Value

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

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

BarPen

Return Value

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

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

DisplayUnitString

This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.

Remarks

We will display different letters for different units of measure; for example: “m” for meters, “ft” for feet, etc.

Return Value

Return Type
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –>

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

DrawingExceptionMode

Gets or sets the DrawExcpetionMode when exception happens.

Return Value

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

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

DrawingTime

This property gets the last drawing time for the layer.

Remarks

We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

HasBoundingBox

This property indicates whether 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.

Remarks

The default value is false.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

HasMask

Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.

Remarks

Depending upon the look of your map and your requirements, you may or may not want a mask on the ScaleBar. You can control whether or not the ScaleBar has a mask by setting this property. If you set the <strong>HasMask</strong> property to true, be sure to specify a mask color (or texture) by using the <strong>MaskBrush</strong> property.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

Height

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.AdornmentLayer –> 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.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.PortableCore.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.PortableCore.Layer –> Go Back

IsVisible

This property gets and set the visible state of the layer.

Remarks

If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

Location

This property gets and sets the drawing location of the AdornmentLayer.

Return Value

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

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

MaskBrush

Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.

Return Value

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

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

MaskContour

Gets or sets the pen for the outline of the ScaleBar mask.

Remarks

By using this property you can control the border of the mask, if the <strong>HasMask</strong> property is set to true. If you do not want a contour or border to show, you should set the pen to transparent.

Return Value

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

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

MaxWidth

Gets or Sets the MaxWidth of the ScaleBar.

Remarks

You can use this property to set the maximum width that you want the ScaleBar to occupy on the map. The <strong>ScaleBarAdornmentLayer</strong> will automatically adjust its size based upon the current extent of the map. By setting this property, you can control the maximum width the ScaleBar will occupy on the map.

Return Value

Return Type
Int32<!– System.Int32 –>

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

Name

This property gets and sets the name for the layer.

Remarks

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

Return Value

Return Type
String<!– System.String –>

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

ProjectionToDecimalDegrees

Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.

Return Value

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

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

RequestDrawingInterval

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

TextStyle

Return Value

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

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

Thickness

Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.

Return Value

Return Type
Int32<!– System.Int32 –>

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

Transparency

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

Return Value

Return Type
Single<!– System.Single –>

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

UnitFamily

Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.

Remarks

By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.

Return Value

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

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

Width

Return Value

Return Type
Single<!– System.Single –>

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

XOffsetInPixel

This property gets and sets the X pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment.

Return Value

Return Type
Single<!– System.Single –>

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

YOffsetInPixel

This property gets and sets the Y pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment.

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.PortableCore.AdornmentLayer –> 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.PortableCore.Layer –> Go Back

Public Events

DrawingAttribution

Event Arguments

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

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

DrawingException

Event Arguments

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

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

DrawingProgressChanged

Event Arguments

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

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

DrawnAttribution

Event Arguments

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

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

DrawnException

Event Arguments

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

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

RequestedDrawing

Event Arguments

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

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

RequestingDrawing

Event Arguments

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

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

NOTOC MapSuitePortableCore ThinkGeo.MapSuite.PortableCore UpdateDocumentation

thinkgeo.mapsuite.portablecore.scalebaradornmentlayer.1440040133.txt.gz · Last modified: 2015/09/23 01:40 (external edit)