MultipleShapeFileFeatureLayer¶
Namespace: ThinkGeo.Core
Aggregates multiple shapefiles of the same geometry type and treats them as a single layer.
public class MultipleShapeFileFeatureLayer : FeatureLayer, IFeatureLayer
Inheritance object → LayerBase → Layer → FeatureLayer → MultipleShapeFileFeatureLayer
Implements IFeatureLayer
Remarks:
Use this layer when you have several shapefiles (for example, one per state) that should draw and query as a single dataset.
Properties¶
ShapeFiles¶
Gets or sets the ShapeFiles.
public Collection<string> ShapeFiles { get; }
Property Value¶
Indexes¶
Gets or sets the Indexes.
public Collection<string> Indexes { get; }
Property Value¶
MultipleShapeFilePattern¶
This property gets and sets the Shape File pattern that makes up this layer.
public string MultipleShapeFilePattern { get; set; }
Property Value¶
string
This property gets the Shape File pattern that makes up this layer.
Remarks:
None
IndexFilePattern¶
This property gets and sets the index file pattern that makes up this layer.
public string IndexFilePattern { get; set; }
Property Value¶
string
This property gets the index file pattern that makes up this layer.
Remarks:
None
Encoding¶
This property gets and sets the encoding information for the DBF.
public Encoding Encoding { get; set; }
Property Value¶
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 MultipleShapeFeatureLayer, we override this API and mark it as true.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
The default implementation in the base class returns false.
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¶
bool
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¶
bool
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¶
float
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¶
float
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¶
float
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¶
float
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¶
bool
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¶
bool
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¶
MultipleShapeFileFeatureLayer()¶
Initializes a new instance of the MultipleShapeFileFeatureLayer class with no associated files.
public MultipleShapeFileFeatureLayer()
MultipleShapeFileFeatureLayer(string)¶
Initializes the layer using the supplied search pattern for the shapefiles.
public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern)
Parameters¶
multipleShapeFilePattern string
MultipleShapeFileFeatureLayer(string, string)¶
Initializes the layer using patterns for both shapefiles and their multiple-index files.
public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern, string indexFilePattern)
Parameters¶
multipleShapeFilePattern string
indexFilePattern string
MultipleShapeFileFeatureLayer(IEnumerable<string>)¶
Initializes a new instance of the MultipleShapeFileFeatureLayer class.
public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles)
Parameters¶
shapeFiles IEnumerable<string>
MultipleShapeFileFeatureLayer(IEnumerable<string>, IEnumerable<string>)¶
This is the constructor for the class.
public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles, IEnumerable<string> indexes)
Parameters¶
shapeFiles IEnumerable<string>
This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.
indexes IEnumerable<string>
This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.
Remarks:
This is the constructor for this class. You can pass in a group of shapes and its corresponding indexs like string[] shapeFiles = new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }; string[] indexFiles = new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }; In this way, the MultipleShapeFileFeatureLayer will construct from the passing 2 shapes.
Methods¶
BuildIndex(string)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
Returns¶
void
None
Remarks:
BuildIndex(string, BuildIndexMode)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern, BuildIndexMode buildIndexMode)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
buildIndexMode BuildIndexMode
This parameter determines whether an index file will be rebuilt if it already exists.
Returns¶
void
None
Remarks:
re-build index files that already exist. It will generate indexes for each Shape File
BuildIndex(string, string)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
indexFilePattern string
This parameter is the matching pattern of how to name the index (or indexes).
Returns¶
void
None
Remarks:
This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.
If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.
BuildIndex(string, string, BuildIndexMode)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern, BuildIndexMode buildIndexMode)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
indexFilePattern string
This parameter is the matching pattern of how to name the index (or indexes).
buildIndexMode BuildIndexMode
This parameter determines whether an index file will be rebuilt if it already exists.
Returns¶
void
None
Remarks:
This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.
If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.
BuildIndex(string, string, string, string)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
columnName string
This parameter is the column name you want to apply the regular expression towards.
regularExpression string
This parameter is the regular expression you want to use to select certain features for your index.
indexFilename string
This parameter is the name of the index file you want to generate for the features that match the regular expression.
Returns¶
void
None
Remarks:
This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.
In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.
BuildIndex(string, string, string, string, BuildIndexMode)¶
This method builds a spatial index for the layer.
public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename, BuildIndexMode buildIndexMode)
Parameters¶
multipleShapeFilePattern string
This parameter is the matching pattern that defines which Shape Files to include.
columnName string
This parameter is the column name you want to apply the regular expression towards.
regularExpression string
This parameter is the regular expression you want to use to select certain features for your index.
indexFilename string
This parameter is the name of the index file you want to generate for the features that match the regular expression.
buildIndexMode BuildIndexMode
This parameter determines whether the index file will be rebuilt if it already exists.
Returns¶
void
None
Remarks:
This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.
In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.
BuildIndex(String[], String[])¶
This method builds a spatial index for the layer.
public static void BuildIndex(String[] multipleShapeFiles, String[] multipleShapeFileIndexes)
Parameters¶
multipleShapeFiles String[]
This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.
multipleShapeFileIndexes String[]
This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.
Returns¶
BuildIndex(String[], String[], BuildIndexMode)¶
This method builds a spatial index for the layer.
public static void BuildIndex(String[] multipleShapeFiles, String[] multipleShapeFileIndexes, BuildIndexMode buildIndexMode)
Parameters¶
multipleShapeFiles String[]
This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.
multipleShapeFileIndexes String[]
buildIndexMode BuildIndexMode
Specifies the buildIndexMode.
Returns¶
GetShapePathFilenames()¶
This method returns a collection of the Shape Files and their paths that make up the layer.
public Collection<string> GetShapePathFilenames()
Returns¶
Remarks:
None
GetIndexPathFilenames()¶
This method returns a collection of the index files and their paths that make up the layer.
public Collection<string> GetIndexPathFilenames()
Returns¶
Remarks:
None
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¶
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;