User Tools

Site Tools


api:thinkgeo.mapsuite.layers.featurelayer

ThinkGeo.MapSuite.Layers.FeatureLayer

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

FeatureLayer()

  • This is a constructor for this class.
Remarks
  • This is a constructor for this class.
Parameters

Public Methods

GetThreadSafetyLevel()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

OnDrawingFeatures(DrawingFeaturesEventArgs)

  • N/A
Remarks
  • 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.
Return Value
  • Type:Void
  • Description:None
Parameters

OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • The DrawCore will be called when the layer is being drawn. It will check if the InternalFeatures are within the extent and whether it is within a defined zoom level. If these parameters are met, then it will apply the styles of the proper zoom level to the InternalFeatures for drawing. Lastly, it will draw InternalFeatures on the GeoImage or native image passed in to the method.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the GeoCanvas used to Draw the layer.
  • labelsInAllLayers
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is not used for ImageLayers.

SetupTools()

  • N/A
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
  • Type:Void
  • Description:None
Parameters

SetupToolsCore()

  • N/A
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
  • Type:Void
  • Description:None
Parameters

OpenCore()

  • N/A
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 FeatureLayer. Most methods on the FeatureLayer will throw an exception if the state of the FeatureLayer is not opened. When the map draws each FeatureLayer, it will open the layer as one of its first steps, then after it is finished drawing with that FeatureLayer it will close it. In this way we are sure to release all resources used by the FeatureLayer.
Return Value
  • Type:Void
  • Description:None
Parameters

CloseCore()

  • N/A
Remarks
  • This protected virtual method is called from the concrete public method Close. The close method plays an important role in the life cycle of the FeatureLayer. 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 FeatureLayer 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
  • Type:Void
  • Description:None
Parameters

GetBoundingBoxCore()

  • N/A
Remarks
  • This method is called from the concrete public method GetBoundingBox. It returns the bounding box of the FeatureLayer.
Return Value
  • Description:This method returns the bounding box of the FeatureLayer.
Parameters

GetWrappingFeaturesForDrawing(WrappingWorldDirection,RectangleShape,Double,Double,IEnumerable<String>,RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • canvasWidth
    • Type:Double
    • Description:N/A
  • canvasHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetThreadSafetyLevelCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnException(DrawnExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • attribution
    • Type:String
    • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

WrappingExtent

  • N/A
Remarks
  • N/A
Return Value

WrappingMode

  • N/A
Remarks
  • N/A
Return Value

EditTools

  • N/A
Remarks
  • The EditTools are supplied as an easily accessible wrapper for the editing methods of the FeatureSource.
Return Value

FeatureIdsToExclude

  • N/A
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
  • Type:Collection<String>

QueryTools

  • N/A
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

MaxRecordsToDraw

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

FeatureSource

  • N/A
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

DrawingQuality

  • N/A
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 PlatformGeoCanvas there is a profile for HighSpeed. This profile sets specific properties, such as the smoothing mode and composing drawing mode of the PlatformGeoCanvas. 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

ZoomLevelSet

  • N/A
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

DrawingMarginInPixel

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

GeometryValidationMode

  • N/A
Remarks
  • N/A
Return Value

IsOpen

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

HasBoundingBox

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

DrawingTime

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Name

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Attribution

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

IsVisible

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Transparency

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BlueTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

RedTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

GreenTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

KeyColors

  • N/A
Remarks
  • N/A
Return Value

IsNegative

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsGrayscale

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

ColorMappings

  • N/A
Remarks
  • N/A
Return Value

DrawingExceptionMode

  • N/A
Remarks
  • N/A
Return Value

RequestDrawingInterval

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Protected Properties

FetchedCount

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int64

FetchedBytes

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int64

StyleTime

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

FetchTime

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

IsOpenCore

  • N/A
Remarks
  • Various methods on the FeatureLayer 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 FeatureLayer Open method. The method will raise an exception if the current FeatureLayer is already open.
Return Value
  • Type:Boolean

StatusChanged

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Public Events

DrawingFeatures

  • N/A
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:DrawingFeaturesEventArgs

DrawingWrappingFeatures

  • N/A
Remarks
  • N/A

Event Arguments:DrawingWrappingFeaturesFeatureLayerEventArgs

DrawingProgressChanged

  • N/A
Remarks
  • N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawingException

  • N/A
Remarks
  • N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawnException

  • N/A
Remarks
  • N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawnAttributionLayerEventArgs

RequestedDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestingDrawingLayerEventArgs

api/thinkgeo.mapsuite.layers.featurelayer.txt · Last modified: 2017/01/11 06:52 (external edit)