User Tools

Site Tools


thinkgeo.mapsuite.core.multiplefeaturelayer

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.MultipleFeatureLayer

<!– Class –> This class represents a Layer backed by multiple Shape Files.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodMultipleFeatureLayer This is the default constructor for the class.
Public MethodMultipleFeatureLayer IEnumerable<FeatureSource> This is a constructor for the 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 MethodGetHashCode Object
Public MethodGetType Object
Public MethodStatic MemberLoadLayer Uri Layer
Public MethodStatic MemberLoadLayer Stream Layer
Public MethodOpen Layer This method opens the Layer so that it is initialized and ready to use.
Public MethodRequestDrawing IEnumerable<RectangleShape> Layer
Public MethodRequestDrawing RectangleShape Layer
Public MethodRequestDrawing TimeSpan, RequestDrawingBufferTimeType Layer
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType Layer
Public MethodRequestDrawing Layer
Public MethodRequestDrawing RectangleShape, TimeSpan Layer
Public MethodRequestDrawing RectangleShape, TimeSpan, RequestDrawingBufferTimeType Layer
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan Layer
Public MethodRequestDrawing 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(overriden)
Protected MethodDrawAttributionCore GeoCanvas, String Layer
Protected MethodDrawCore GeoCanvas, Collection<SimpleCandidate> Layer(overriden)
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(overriden)
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingAttribution DrawingAttributionLayerEventArgs Layer
Protected MethodOnDrawingException DrawingExceptionLayerEventArgs Layer
Protected MethodOnDrawingFeatures DrawingFeaturesEventArgs FeatureLayer This method raises the DrawingFeatures event.
Protected MethodOnDrawingProgressChanged DrawingProgressChangedEventArgs Layer
Protected MethodOnDrawingWrappingFeatures DrawingWrappingFeaturesFeatureLayerEventArgs FeatureLayer
Protected MethodOnDrawnAttribution DrawnAttributionLayerEventArgs Layer
Protected MethodOnDrawnException DrawnExceptionLayerEventArgs Layer
Protected MethodOnRequestedDrawing RequestedDrawingLayerEventArgs Layer
Protected MethodOnRequestingDrawing RequestingDrawingLayerEventArgs Layer
Protected MethodOpenCore Layer(overriden)
Protected MethodSetupTools FeatureLayer This method sets up the EditTools and QueryTools objects.
Protected MethodSetupToolsCore FeatureLayer This method sets up the EditTools and QueryTools objects.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Layer
Public PropertyBlueTranslation Single Layer This property gets and sets the amount of blue to apply to the image.
Public PropertyDrawingExceptionMode DrawingExceptionMode Layer Gets or sets the DrawExcpetionMode when exception happens.
Public PropertyDrawingMarginInPixel Single FeatureLayer
Public PropertyDrawingQuality DrawingQuality FeatureLayer This property gets and sets the general drawing quality for the FeatureLayer's canvas.
Public PropertyDrawingTime TimeSpan Layer This property gets the last drawing time for the layer.
Public PropertyEditTools EditTools FeatureLayer This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer.
Public PropertyFeatureIdsToExclude Collection<String> FeatureLayer A collection of strings representing record id of features not to get in the Layer.
Public PropertyFeatureSource FeatureSource FeatureLayer This property gets the FeatureSource for the FeatureLayer.
Public PropertyFeatureSources Collection<FeatureSource> This property gets the FeatureSources you want to use.
Public PropertyGeometryValidationMode GeometryValidationMode FeatureLayer
Public PropertyGreenTranslation Single Layer This property gets and sets the amount of green to apply to the image.
Public PropertyHasBoundingBox Boolean 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 MultipleFeatureLayer, we override this API and mark it as true.
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 PropertyKeyColors 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.
Public PropertyMaxRecordsToDraw Int32 FeatureLayer
Public PropertyName String Layer This property gets and sets the name for the layer.
Public PropertyQueryTools QueryTools FeatureLayer This property gets the QueryTools that allow you to easily query Features from the Feature Layer.
Public PropertyRedTranslation Single Layer This property gets and sets the amount of red to apply to the image.
Public PropertyRequestDrawingInterval TimeSpan Layer
Public PropertyTransparency Single Layer This property gets and sets the amount of transparency to apply to the image.
Public PropertyWrappingExtent RectangleShape FeatureLayer
Public PropertyWrappingMode WrappingMode FeatureLayer Thie property gets or sets whether allow wrap date line.
Public PropertyZoomLevelSet ZoomLevelSet FeatureLayer This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyIsOpenCore Boolean Layer(overriden)

Public Events

Public Constructors

MultipleFeatureLayer()

This is the default constructor for the class.

Overloads

This is the default constructor. If you use this constructor, then you need to set the required properties manually.

Remarks

This is the default constructor. If you use this constructor, then you need to set the required properties manually.

Parameters

Name Type Description

Go Back

MultipleFeatureLayer(IEnumerable<FeatureSource>)

This is a constructor for the class.

Overloads

This constructor allows you to provide information about the FeatureSources for the MultipleFeatureLayer.

Remarks

This constructor gets the layer ready to use.

Parameters

Name Type Description
featureSources IEnumerable<FeatureSource><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.FeatureSource} –> This parameter represents the FeatureSources in this class that you want to use.

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

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

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

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(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, 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(TimeSpan)

Return Value

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

Parameters

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

<!– ThinkGeo.MapSuite.Core.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.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

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

OnDrawingFeatures(DrawingFeaturesEventArgs)

This method raises the DrawingFeatures event.

Remarks

<list type=“bullet”> <item>You can call this method from a derived class to enable it to raise the event. This may be useful if you plan to extend the FeatureLayer and you need access to the event.

This event is meant to allow you to add or remove the features to be drawn.</item> </list>

Return Value

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

Parameters

Name Type Description
e DrawingFeaturesEventArgs<!– ThinkGeo.MapSuite.Core.DrawingFeaturesEventArgs –> This parameter represents the event arguments for the event.

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)

Return Value

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

Parameters

Name Type Description
e DrawingWrappingFeaturesFeatureLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingWrappingFeaturesFeatureLayerEventArgs –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

OpenCore()

Return Value

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

Parameters

Name Type Description

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

SetupTools()

This method sets up the EditTools and QueryTools objects.

Remarks

This method is the concrete wrapper for the abstract method SetupToolsCore. The SetupTools method allows you to create the QueryTool, EditTools and other tools you may need on your object. We created this method so that if you want to extend one of the tool classes, you can override the SetupToolsCore and create any class you want.

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.FeatureLayer –> Go Back

SetupToolsCore()

This method sets up the EditTools and QueryTools objects.

Remarks

This method is the concrete wrapper for the abstract method SetupTools. The SetupTools method allows you to create the QueryTool, EditTools and other tools you may need on your object. We created this method so that if you want to extend one of the tool classes, you can override the SetupToolsCore and create any class you want.

Return Value

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

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

Public Properties

Attribution

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.Core.Layer –> 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

DrawingExceptionMode

Gets or sets the DrawExcpetionMode when exception happens.

Return Value

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

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

DrawingMarginInPixel

Return Value

Return Type
Single<!– System.Single –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

DrawingQuality

This property gets and sets the general drawing quality for the FeatureLayer's canvas.

Remarks

The DrawingQuality enumeration allows you to control, in a macro sense, the drawing quality that will be used in the GeoCanvas. Each GeoCanvas, which is responsible for drawing of the features, may have its own specialized drawing quality properties. What the DrawingQuality enumeration does is define some general guidelines for each GeoCanvas. For example, if you set the DrawingQuality to HighSpeed, then inside of the GdiPlusGeoCanvas there is a profile for HighSpeed. This profile sets specific properties, such as the smoothing mode and composing drawing mode of the GdiPlusGeoCanvas. As each GeoCanvas may have different drawing quality properties, this offers a general way to control drawing quality and speed.

If you need complete control over how a specific GeoCanvas will draw, then you can set the DrawingQuality to Custom. This will tell the specific GeoCanvas to use the properties on its own object instead of one of the pre-defined profiles. If one of the profiles – such as HighSpeed or HighQuality – is set, then the specific GeoCanvas ignores its own properties for drawing quality.

Return Value

Return Type
DrawingQuality<!– ThinkGeo.MapSuite.Core.DrawingQuality –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

EditTools

This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer.

Remarks

The EditTools are supplied as an easily accessible wrapper for the editing methods of the FeatureSource.

Return Value

Return Type
EditTools<!– ThinkGeo.MapSuite.Core.EditTools –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

FeatureIdsToExclude

A collection of strings representing record id of features not to get in the Layer.

Remarks

This string collection is a handy place to specify what records not to get from the source. Suppose you have a shape file of roads and you want to hide the roads within a particular rectangle, simply execute GetFeaturesInsideBoundingBox() and add the id of the return features to the collection and forget about them. Since you can set this by Layer it makes is easy to determine what to and what not to.

Return Value

Return Type
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

FeatureSource

This property gets the FeatureSource for the FeatureLayer.

Remarks

The FeatureSource is the provider of data to the FeatureLayer. There are different FeatureSource classes to match the various ways that feature data is stored. It is important that, when you inherit from the FeatureLayer, in the constructor you set the FeatureSource you want to use.

Return Value

Return Type
FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

FeatureSources

This property gets the FeatureSources you want to use.

Remarks

This property gets the FeatureSources you want to use.

Return Value

Return Type
Collection<FeatureSource><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSource} –>

<!– ThinkGeo.MapSuite.Core.MultipleFeatureLayer –> Go Back

GeometryValidationMode

Return Value

Return Type
GeometryValidationMode<!– ThinkGeo.MapSuite.Core.GeometryValidationMode –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

HasBoundingBox

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 MultipleFeatureLayer, we override this API and mark it as true.

Remarks

The default implementation in the base class returns false.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> 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

MaxRecordsToDraw

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

QueryTools

This property gets the QueryTools that allow you to easily query Features from the Feature Layer.

Remarks

This property gets the QueryTools that allow you to easily query Features from the Feature Layer. The QueryTools are supplied as an easily accessible wrapper for the query methods of the FeatureSource.

Return Value

Return Type
QueryTools<!– ThinkGeo.MapSuite.Core.QueryTools –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

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

WrappingExtent

Return Value

Return Type
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

WrappingMode

Thie property gets or sets whether allow wrap date line.

Return Value

Return Type
WrappingMode<!– ThinkGeo.MapSuite.Core.WrappingMode –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

ZoomLevelSet

This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer.

Remarks

The ZoomLevelSet is a class that contains all of the ZoomLevels for the FeatureLayer. Each ZoomLevel contains the styles that are used to determine how to draw the InternalFeatures.

Return Value

Return Type
ZoomLevelSet<!– ThinkGeo.MapSuite.Core.ZoomLevelSet –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

Protected Properties

IsOpenCore

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> 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

DrawingFeatures

This event is raised when features are about to be drawn in the layer.

Remarks

This event is raised when features are about to be drawn in the layer. In the event arguments, there is a collection of features to be drawn. You can easily add or remove items from this collection so that extra items will draw or not draw.

Event Arguments

Event Arguments
DrawingFeaturesEventArgs<!– ThinkGeo.MapSuite.Core.DrawingFeaturesEventArgs –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> Go Back

DrawingProgressChanged

Event Arguments

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

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

DrawingWrappingFeatures

Event Arguments

Event Arguments
DrawingWrappingFeaturesFeatureLayerEventArgs<!– ThinkGeo.MapSuite.Core.DrawingWrappingFeaturesFeatureLayerEventArgs –>

<!– ThinkGeo.MapSuite.Core.FeatureLayer –> 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

NOTOC MapSuiteCore ThinkGeo.MapSuite.Core UpdateDocumentation

thinkgeo.mapsuite.core.multiplefeaturelayer.1440040129.txt.gz · Last modified: 2015/09/17 10:35 (external edit)