dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
FeatureFilter Class
This class defines parameters for setting a client-side filter on a featureEffect or layer view.
ArcGIS Maps SDK for JavaScript
public class FeatureFilter : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 FeatureFilter
Constructors
FeatureFilter() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureFilter();
FeatureFilter(Nullable, Geometry, IReadOnlyList, Nullable, TimeExtent, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public FeatureFilter(System.Nullable<double> distance=null, dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? geometry=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ObjectId>? objectIds=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship> spatialRelationship=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? timeExtent=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits> units=null, string? where=null);
Parameters
distance System.Nullable<System.Double>
Specifies a search distance from a given geometry in a spatial filter.
ArcGIS Maps SDK for JavaScript
geometry Geometry
The geometry to apply to the spatial filter.
ArcGIS Maps SDK for JavaScript
objectIds System.Collections.Generic.IReadOnlyList<ObjectId>
An array of objectIds of the features to be filtered.
ArcGIS Maps SDK for JavaScript
spatialRelationship System.Nullable<SpatialRelationship>
For spatial filters, this parameter defines the spatial relationship to filter features in the layer view
against the filter geometry.
default “intersects”
ArcGIS Maps SDK for JavaScript
timeExtent TimeExtent
A range of time with start and end date.
default null
ArcGIS Maps SDK for JavaScript
units System.Nullable<QueryUnits>
The unit for calculating the buffer distance when distance is specified in a spatial filter.
default null
ArcGIS Maps SDK for JavaScript
where System.String
A where clause for the feature filter.
ArcGIS Maps SDK for JavaScript
Properties
FeatureFilter.Distance Property
Specifies a search distance from a given geometry in a spatial filter. The units property indicates the unit of measurement. In essence, setting this property creates a buffer at the specified size around the input geometry. The filter will use that buffer to display features in the layer or layer view that adhere to the to the indicated spatial relationship.
public System.Nullable<double> Distance { get; set; }
Property Value
System.Nullable<System.Double>
FeatureFilter.Geometry Property
The geometry to apply to the spatial filter. The spatial relationship as specified by spatialRelationship will indicate how the geometry should be used to filter features.
public dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry { get; set; }
Property Value
Remarks
Known Limitations: Mesh geometry types are currently not supported.
FeatureFilter.ObjectIds Property
An array of objectIds of the features to be filtered.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ObjectId>? ObjectIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ObjectId>
FeatureFilter.SpatialRelationship Property
For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter geometry. The spatial relationships discover how features are spatially related to each other. For example, you may want to know if a polygon representing a county completely contains points representing settlements.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship> SpatialRelationship { get; set; }
Property Value
System.Nullable<SpatialRelationship>
FeatureFilter.TimeExtent Property
A range of time with start and end date. Only the features that fall within this time extent will be displayed. The Date field to be used for timeExtent should be added to outFields list when the layer is initialized. This ensures the best user experience when switching or updating fields for time filters.
public dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent { get; set; }
Property Value
FeatureFilter.Units Property
The unit for calculating the buffer distance when distance is specified in a spatial filter.
default null
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits> Units { get; set; }
Property Value
FeatureFilter.Where Property
A where clause for the feature filter. Any legal SQL92 where clause operating on the fields in the layer is allowed. Be sure to have the correct sequence of single and double quotes when writing the where clause in JavaScript. For apps where users can interactively change fields used for attribute filter, we suggest you include all possible fields in the outFields of the layer. This ensures the best user experience when switching or updating fields for attribute filters.
public string? Where { get; set; }
Property Value
Methods
FeatureFilter.AddToObjectIds(ObjectId[]) Method
Asynchronously adds elements to the ObjectIds property.
public System.Threading.Tasks.Task AddToObjectIds(params dymaptic.GeoBlazor.Core.Model.ObjectId[] values);
Parameters
The elements to add.
Returns
FeatureFilter.CreateQuery() Method
Creates query parameters that can be used to fetch features that
satisfy the layer’s current filters and definitions.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Query?> CreateQuery();
Returns
System.Threading.Tasks.Task<Query>
FeatureFilter.GetDistance() Method
Asynchronously retrieve the current value of the Distance property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetDistance();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
FeatureFilter.GetGeometry() Method
Asynchronously retrieve the current value of the Geometry property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Geometry?> GetGeometry();
Returns
System.Threading.Tasks.Task<Geometry>
FeatureFilter.GetObjectIds() Method
Asynchronously retrieve the current value of the ObjectIds property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ObjectId>?> GetObjectIds();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ObjectId>>
FeatureFilter.GetSpatialRelationship() Method
Asynchronously retrieve the current value of the SpatialRelationship property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship>> GetSpatialRelationship();
Returns
System.Threading.Tasks.Task<System.Nullable<SpatialRelationship>>
FeatureFilter.GetTimeExtent() Method
Asynchronously retrieve the current value of the TimeExtent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent?> GetTimeExtent();
Returns
System.Threading.Tasks.Task<TimeExtent>
FeatureFilter.GetUnits() Method
Asynchronously retrieve the current value of the Units property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits>> GetUnits();
Returns
System.Threading.Tasks.Task<System.Nullable<QueryUnits>>
FeatureFilter.GetWhere() Method
Asynchronously retrieve the current value of the Where property.
public System.Threading.Tasks.Task<string?> GetWhere();
Returns
System.Threading.Tasks.Task<System.String>
FeatureFilter.RemoveFromObjectIds(ObjectId[]) Method
Asynchronously remove an element from the ObjectIds property.
public System.Threading.Tasks.Task RemoveFromObjectIds(params dymaptic.GeoBlazor.Core.Model.ObjectId[] values);
Parameters
The elements to remove.
Returns
FeatureFilter.SetDistance(Nullable) Method
Asynchronously set the value of the Distance property after render.
public System.Threading.Tasks.Task SetDistance(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
FeatureFilter.SetGeometry(Geometry) Method
Asynchronously set the value of the Geometry property after render.
public System.Threading.Tasks.Task SetGeometry(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? value);
Parameters
value Geometry
The value to set.
Returns
FeatureFilter.SetObjectIds(IReadOnlyList) Method
Asynchronously set the value of the ObjectIds property after render.
public System.Threading.Tasks.Task SetObjectIds(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.ObjectId>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<ObjectId>
The value to set.
Returns
FeatureFilter.SetSpatialRelationship(Nullable) Method
Asynchronously set the value of the SpatialRelationship property after render.
public System.Threading.Tasks.Task SetSpatialRelationship(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship> value);
Parameters
value System.Nullable<SpatialRelationship>
The value to set.
Returns
FeatureFilter.SetTimeExtent(TimeExtent) Method
Asynchronously set the value of the TimeExtent property after render.
public System.Threading.Tasks.Task SetTimeExtent(dymaptic.GeoBlazor.Core.Components.TimeExtent? value);
Parameters
value TimeExtent
The value to set.
Returns
FeatureFilter.SetUnits(Nullable) Method
Asynchronously set the value of the Units property after render.
public System.Threading.Tasks.Task SetUnits(System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits> value);
Parameters
value System.Nullable<QueryUnits>
The value to set.
Returns
FeatureFilter.SetWhere(string) Method
Asynchronously set the value of the Where property after render.
public System.Threading.Tasks.Task SetWhere(string? value);
Parameters
value System.String
The value to set.