GraticuleFeatureLayer¶

Namespace: ThinkGeo.Core

GraticuleFeatureLayer shows Meridians and Parallels displaying through the map. Meridians are lines of longitude and they have a North South orientation. Parallels are lines of latitude and they have an East West orientation. Showing graticule for latitude and longitude is a standard way in cartography to give spatial references to the users.

public class GraticuleFeatureLayer : FeatureLayer

Inheritance Object → Layer → FeatureLayer → GraticuleFeatureLayer

Properties¶

GraticuleLineStyle¶

Gets or Sets the LineStyle of the Meridians and Parallels.

public LineStyle GraticuleLineStyle { get; set; }

Property Value¶

LineStyle

GraticuleTextFont¶

Gets or Sets the GeoFont of the Meridians and Parallels.

public GeoFont GraticuleTextFont { get; set; }

Property Value¶

GeoFont

GraticuleTextBrush¶

Gets or Sets the GeoBrush of the Meridians and Parallels.

public GeoBrush GraticuleTextBrush { get; set; }

Property Value¶

GeoBrush

WrappingMode¶

Thie property gets or sets whether allow wrap date line.

public WrappingMode WrappingMode { get; set; }

Property Value¶

WrappingMode

WrappingExtent¶

Gets or sets the wrapping extent.

public RectangleShape WrappingExtent { get; set; }

Property Value¶

RectangleShape

        The wrapping extent.

GraticuleTextHaloPen¶

public GeoPen GraticuleTextHaloPen { get; set; }

Property Value¶

GeoPen

Projection¶

public Projection Projection { get; }

Property Value¶

Projection

EditTools¶

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

public EditTools EditTools { get; protected set; }

Property Value¶

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.

FeatureIdsToExclude¶

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

public Collection<string> FeatureIdsToExclude { get; }

Property Value¶

Collection<String>

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.

QueryTools¶

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

public QueryTools QueryTools { get; protected set; }

Property Value¶

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.

MaxRecordsToDraw¶

public int MaxRecordsToDraw { get; set; }

Property Value¶

Int32

FeatureSource¶

This property gets the FeatureSource for the FeatureLayer.

public FeatureSource FeatureSource { get; protected set; }

Property Value¶

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.

DrawingQuality¶

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

public DrawingQuality DrawingQuality { get; set; }

Property Value¶

DrawingQuality

        This property gets the general drawing quality for the FeatureLayer's
        view.

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.

ZoomLevelSet¶

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

public ZoomLevelSet ZoomLevelSet { get; set; }

Property Value¶

ZoomLevelSet

        This property gets 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.

DrawingMarginInPixel¶

public float DrawingMarginInPixel { get; set; }

Property Value¶

Single

IsOpen¶

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

public bool IsOpen { get; }

Property Value¶

Boolean

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.

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.

public bool HasBoundingBox { get; }

Property Value¶

Boolean

Remarks:

The default value is false.

DrawingTime¶

This property gets the last drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value¶

TimeSpan

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.

Name¶

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value¶

String

Remarks:

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

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

IsVisible¶

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

public bool IsVisible { get; set; }

Property Value¶

Boolean

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.

Transparency¶

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

public float Transparency { get; set; }

Property Value¶

Single
This property gets the amount of transparency to apply to the image.

Remarks:

None

BlueTranslation¶

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

public float BlueTranslation { get; set; }

Property Value¶

Single
This property gets the amount of blue to apply to the image.

Remarks:

None

RedTranslation¶

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

public float RedTranslation { get; set; }

Property Value¶

Single
This property gets the amount of red to apply to the image.

Remarks:

None

GreenTranslation¶

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

public float GreenTranslation { get; set; }

Property Value¶

Single
This property gets the amount of green to apply to the image.

Remarks:

None

KeyColors¶

Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.

public Collection<GeoColor> KeyColors { get; }

Property Value¶

Collection<GeoColor>

Remarks:

It will make these colors transparent when draw image.

IsNegative¶

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

public bool IsNegative { get; set; }

Property Value¶

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

Remarks:

None

IsGrayscale¶

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

public bool IsGrayscale { get; set; }

Property Value¶

Boolean

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

Remarks:

None

ColorMappings¶

ColorMapping

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value¶

Dictionary<GeoColor, GeoColor>

DrawingExceptionMode¶

Gets or sets the DrawExceptionMode when exception happens.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

ThreadSafe¶

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value¶

ThreadSafetyLevel

Background¶

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value¶

GeoColor

RequestDrawingInterval¶

public TimeSpan RequestDrawingInterval { get; set; }

Property Value¶

TimeSpan

Constructors¶

GraticuleFeatureLayer()¶

This is the default constructor of the class.

public GraticuleFeatureLayer()

Remarks:

If use this constructor, the projection is null.

GraticuleFeatureLayer(Int32)¶

This constructor creates GraticuleFeatureLayer with custom graticuleDensity

public GraticuleFeatureLayer(int graticuleDensity)

Parameters¶

graticuleDensity Int32

Methods¶

DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶

This method draws the AdornmentLayer.

protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters¶

canvas GeoCanvas
This parameter is the view object (or a NativeImage) to draw on.

labelsInAllLayers Collection<SimpleCandidate>
This parameter represents the labels used for collision detection and duplication checking.

Exceptions¶

ArgumentNullException
If you pass a null as the geoCanvas, we will throw an ArgumentNullException.

ArgumentNullException
If you pass a null as the labelsInAllLayers, we will throw an ArgumentNullException.

ArgumentOutOfRangeException
If you pass in a mapUnit that is not defined in the enumeration, it will throw a ArgumentOutOfRangeException.

Remarks:

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

You can use the full power of the GeoCanvas to do the drawing.

Events¶

DrawingFeatures¶

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

public event EventHandler<DrawingFeaturesEventArgs> DrawingFeatures;

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.

DrawingWrappingFeatures¶

public event EventHandler<DrawingWrappingFeaturesFeatureLayerEventArgs> DrawingWrappingFeatures;

DrawingProgressChanged¶

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

DrawingException¶

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException¶

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;

DrawingAttribution¶

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution¶

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

RequestedDrawing¶

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing¶

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;