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

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).

*System.Object ThinkGeo.MapSuite.PortableCore.Layer *ThinkGeo.MapSuite.PortableCore.AdornmentLayer ThinkGeo.MapSuite.PortableCore.ScaleBarAdornmentLayer

Creates a new instance of the ScaleBarAdornmentLayer class.

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).

Go Back

Create a copy of Layer using the deep clone process.

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.

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

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

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.

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

This method draws the Layer.

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.

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

<!– System.Object –> Go Back

This method returns the bounding box of the Layer.

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.

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

This method returns the drawing location of the AdornmentLayer.

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

<!– System.Object –> Go Back

<!– System.Object –> Go Back

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

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.

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

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

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

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

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

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

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

<!– System.Object –> Go Back

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

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.

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

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

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.

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

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

This method draws the Layer.

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.

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

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

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

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

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

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

<!– System.Object –> Go Back

This method returns the bounding box of the Layer.

This method returns the bounding box of the Layer.

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

<!– System.Object –> Go Back

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets or sets the DrawExcpetionMode when exception happens.

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

This property gets the last drawing time for the layer.

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.

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

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.

The default value is false.

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

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

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.

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

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

This property gets and sets if the image should be converted to grayscale.

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

This property gets and sets whether the image should be converted to negative (inverse colors).

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

This property returns true if the Layer is open and false if it is not.

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.

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

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

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.

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

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

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

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

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

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

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.

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

Gets or Sets the MaxWidth of the ScaleBar.

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.

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

This property gets and sets the name for the layer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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.

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

This property returns true if the Layer is open and false if it is not.

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.

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

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

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

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

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

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

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

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

NOTOC MapSuitePortableCore ThinkGeo.MapSuite.PortableCore UpdateDocumentation