TinyGeoFeatureLayer¶
Namespace: ThinkGeo.Core
This class represents a FeatureLayer of TinyGeo File by ThinkGeo.
public class TinyGeoFeatureLayer : FeatureLayer, IFeatureLayer
Inheritance Object → LayerBase → Layer → FeatureLayer → TinyGeoFeatureLayer
Implements IFeatureLayer
Remarks:
None
Properties¶
HasBoundingBox¶
Gets or sets the HasBoundingBox.
public bool HasBoundingBox { get; }
Property Value¶
TinyGeoPathFilename¶
Gets or sets the full path to the TinyGeo file rendered by the layer.
public string TinyGeoPathFilename { get; set; }
Property Value¶
Exceptions¶
ArgumentException
Setting an invalid FilePathName structure will thrown an ArgumentException.
Remarks:
The file does not need to exist when using the stream-loading event pipeline.
Password¶
This property gets or sets the password of the TinyGeo file.
public string Password { get; set; }
Property Value¶
Projection¶
Gets the projection used by the underlying FeatureLayer.FeatureSource.
public Projection Projection { get; }
Property Value¶
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¶
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¶
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¶
Remarks:
Feature Layer. The QueryTools are supplied as an easily accessible wrapper for the query methods of the FeatureSource.
MaxRecordsToDraw¶
Gets or sets the maximum number of features that may be rendered per draw call.
public int MaxRecordsToDraw { get; set; }
Property Value¶
FeatureSource¶
This property gets the FeatureSource for the FeatureLayer.
public FeatureSource FeatureSource { get; 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¶
This property gets the general drawing quality for the FeatureLayer's
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¶
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.
LabelDisplayMode¶
Gets or sets the labeling strategy to apply when drawing this layer.
public LabelDisplayMode LabelDisplayMode { get; set; }
Property Value¶
DrawingMarginInPixel¶
Gets or sets the pixel margin applied when requesting data for this layer.
public float DrawingMarginInPixel { get; set; }
Property Value¶
RequestDrawingInterval¶
Gets or sets the interval between automatic draw requests. Obsolete.
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
Gets or sets the display name for the layer.
public string Name { get; set; }
Property Value¶
String
The name used to identify the layer within UI components such as legends.
Remarks:
The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.
IsOpen¶
Gets a value indicating whether the layer is currently open.
public bool IsOpen { get; }
Property Value¶
Boolean
true if the layer has completed its open routine; otherwise, false.
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.
IsVisible¶
Gets or sets a value indicating whether the layer is visible.
public bool IsVisible { get; set; }
Property Value¶
Boolean
true to draw the layer; otherwise, false.
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.
DrawingTime¶
Gets the last recorded drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
TimeSpan
The duration of the most recent draw operation.
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.
DrawingExceptionMode¶
Gets or sets how drawing exceptions are handled when the layer renders.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets or sets the background color used when rendering the layer.
public GeoColor Background { get; set; }
Property Value¶
GeoColor
The fill applied to areas not covered by layer content.
Transparency¶
Gets or sets the amount of transparency applied to the rendered image.
public float Transparency { get; set; }
Property Value¶
Single
A value between 0 (fully transparent) and 255 (fully opaque).
BlueTranslation¶
Gets or sets the intensity adjustment applied to the blue channel.
public float BlueTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the blue channel translation.
RedTranslation¶
Gets or sets the intensity adjustment applied to the red channel.
public float RedTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the red channel translation.
GreenTranslation¶
Gets or sets the intensity adjustment applied to the green channel.
public float GreenTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the green channel translation.
KeyColors¶
Gets the collection of key colors that should be rendered as transparent.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.
IsNegative¶
Gets or sets a value indicating whether the image should be rendered with inverted colors.
public bool IsNegative { get; set; }
Property Value¶
Boolean
true to invert the color channels; otherwise, false.
IsGrayscale¶
Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.
public bool IsGrayscale { get; set; }
Property Value¶
Boolean
true to apply a grayscale filter; otherwise, false.
ThreadSafe¶
Gets or sets the threading guarantees provided by the layer implementation.
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.
ColorMappings¶
Gets the color translation map that will be applied when rendering the layer.
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
Gets or sets how the layer wraps when the map extent crosses world boundaries.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
Gets or sets the geographic extent to use when wrapping is enabled.
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
TinyGeoFeatureLayer()¶
This is the class constructor.
public TinyGeoFeatureLayer()
Remarks:
None
TinyGeoFeatureLayer(String)¶
This is the class constructor.
public TinyGeoFeatureLayer(string tinyGeoPathFilename)
Parameters¶
tinyGeoPathFilename String
Specifies the tinyGeoPathFilename.
Remarks:
None
TinyGeoFeatureLayer(String, String)¶
This is the class constructor.
public TinyGeoFeatureLayer(string tinyGeoPathFilename, string password)
Parameters¶
tinyGeoPathFilename String
Specifies the tinyGeoPathFilename.
password String
This parameter represents the password to the .tgeo file.
Remarks:
None
Methods¶
CreateTinyGeoFile(String, String, GeographyUnit, ReturningColumnsType)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, ReturningColumnsType returningColumnType)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
returningColumnType ReturningColumnsType
This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, ReturningColumnsType, Double)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, ReturningColumnsType returningColumnType, double precisionInMeter)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
returningColumnType ReturningColumnsType
This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
precisionInMeter Double
This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, ReturningColumnsType, String)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, ReturningColumnsType returningColumnType, string password)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
returningColumnType ReturningColumnsType
This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
password String
This parameter spcifies the password of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, ReturningColumnsType, String, Double)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, ReturningColumnsType returningColumnType, string password, double precisionInMeter)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
returningColumnType ReturningColumnsType
This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
password String
This parameter spcifies the password of the target TinyGeo file.
precisionInMeter Double
This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, IEnumerable<String>)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, IEnumerable<string> columnNames)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
columnNames IEnumerable<String>
This parameter specifies the columns in shape file which will be copied to TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, IEnumerable<String>, Double)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, IEnumerable<string> columnNames, double precisionInMeter)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
columnNames IEnumerable<String>
This parameter specifies the columns in shape file which will be copied to TinyGeo file.
precisionInMeter Double
This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, IEnumerable<String>, String)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, IEnumerable<string> columnNames, string password)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
columnNames IEnumerable<String>
This parameter specifies the columns in shape file which will be copied to TinyGeo file.
password String
This parameter spcifies the password of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, IEnumerable<String>, String, Double)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, IEnumerable<string> columnNames, string password, double precisionInMeter)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
columnNames IEnumerable<String>
This parameter specifies the columns in shape file which will be copied to TinyGeo file.
password String
This parameter spcifies the password of the target TinyGeo file.
precisionInMeter Double
This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
CreateTinyGeoFile(String, String, GeographyUnit, IEnumerable<String>, String, Double, Encoding)¶
Static API to create a new TinyGeo file from an existed shape file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, string shapePathFilename, GeographyUnit unitOfData, IEnumerable<string> columnNames, string password, double precisionInMeter, Encoding shapeEncoding)
Parameters¶
tinyGeoPathFilename String
This parameter specifies the file name for the target TinyGeo file.
shapePathFilename String
This parameter specifies the file name for the existed shape file.
unitOfData GeographyUnit
This parameter specifies the Geography Unit of the data.
columnNames IEnumerable<String>
This parameter specifies the columns in shape file which will be copied to TinyGeo file.
password String
This parameter spcifies the password of the target TinyGeo file.
precisionInMeter Double
This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
shapeEncoding Encoding
This parameter specifies the encoding of the existed shape file.
CreateTinyGeoFile(String, FeatureLayer, GeographyUnit, IEnumerable<String>, String, Double, Encoding, WellKnownType)¶
Creates tiny geo file.
public static void CreateTinyGeoFile(string tinyGeoPathFilename, FeatureLayer featureLayer, GeographyUnit unitOfData, IEnumerable<string> columnNames, string password, double precisionInMeter, Encoding shapeEncoding, WellKnownType type)
Parameters¶
tinyGeoPathFilename String
The tiny geo path filename.
featureLayer FeatureLayer
The feature layer.
unitOfData GeographyUnit
The unit of data.
columnNames IEnumerable<String>
The column names.
password String
The password.
precisionInMeter Double
The precision in meter.
shapeEncoding Encoding
The shape encoding.
type WellKnownType
The type.
GetOptimalPrecision(String, GeographyUnit, DistanceUnit, TinyGeoPrecisionMode)¶
Returns optimal precision for the specified parameters.
public static double GetOptimalPrecision(string shapePathFilename, GeographyUnit unitOfData, DistanceUnit returningDistanceUnit, TinyGeoPrecisionMode precisionMode)
Parameters¶
shapePathFilename String
The shape path filename.
unitOfData GeographyUnit
The unit of data.
returningDistanceUnit DistanceUnit
The returning distance unit.
precisionMode TinyGeoPrecisionMode
The precision mode.
Returns¶
Double
The result of the operation.
GetOptimalPrecision(FeatureLayer, GeographyUnit, DistanceUnit, TinyGeoPrecisionMode)¶
Returns optimal precision for the specified parameters.
public static double GetOptimalPrecision(FeatureLayer featureLayer, GeographyUnit unitOfData, DistanceUnit returningDistanceUnit, TinyGeoPrecisionMode precisionMode)
Parameters¶
featureLayer FeatureLayer
The feature layer.
unitOfData GeographyUnit
The unit of data.
returningDistanceUnit DistanceUnit
The returning distance unit.
precisionMode TinyGeoPrecisionMode
The precision mode.
Returns¶
Double
The result of the operation.
EncryptTinyGeoFile(String, String, String)¶
Encrypt an existed TinyGeo File and save it as a new TinyGeo File.
public static void EncryptTinyGeoFile(string unencryptedTinyGeoPathFilename, string encryptedTinyGeoPathFilename, string password)
Parameters¶
unencryptedTinyGeoPathFilename String
This parameter specifies the file name for the source unencrypted TinyGeo file.
encryptedTinyGeoPathFilename String
This parameter specifies the file name for the target encrypted TinyGeo file.
password String
This parameter specified the password of the target encrypted TinyGeo file.
DecryptTinyGeoFile(String, String, String)¶
Decrypt an existed encrypted TinyGeo File and save it as a new TinyGeo File.
public static void DecryptTinyGeoFile(string encryptedTinyGeoPathFilename, string decryptedTinyGeoPathFilename, string password)
Parameters¶
encryptedTinyGeoPathFilename String
This parameter specifies the file name for the source encrypted TinyGeo file.
decryptedTinyGeoPathFilename String
This parameter specifies the file name for the target decrypted TinyGeo file.
password String
This parameter specified the password of the source encrypted TinyGeo file.
GetTinyGeoFileType()¶
Returns tiny geo file type.
public TinyGeoFileType GetTinyGeoFileType()
Returns¶
TinyGeoFileType
The result of the operation.
Events¶
StreamLoading¶
This event allows you to pass in your own stream to represent the files.
public event EventHandler<StreamLoadingEventArgs> StreamLoading;
Remarks:
If you choose you can pass in your own stream to represent the file. The stream can come from a variety of places such as isolated storage, a compressed file, and encrypted stream. When the Image is finished with the stream it will dispose of it so be sure to keep this in mind when passing the stream in. If you do not pass in a alternate stream the class will attempt to load the file from the file system using the TinyGeoPathFilename property.
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¶
Raised when wrapping features are about to be drawn. Deprecated; use FeatureLayer.DrawingFeatures instead.
public event EventHandler<DrawingWrappingFeaturesFeatureLayerEventArgs> DrawingWrappingFeatures;
DrawingProgressChanged¶
Occurs as the layer reports drawing progress (useful for async or tiled rendering scenarios).
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
Raised after the drawing buffer elapses so consumers can handle a legacy drawing cycle. Obsolete.
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
Raised before the drawing buffer elapses so consumers can cancel a legacy drawing operation. Obsolete.
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
DrawingException¶
Occurs when the DrawingException event is raised.
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
Occurs when the DrawnException event is raised.
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;