GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
OGCFeatureLayerView Class
Represents the LayerView of a OGCFeatureLayer after it has been added to a Map in either a MapView or SceneView. ArcGIS Maps SDK for JavaScript
public class OGCFeatureLayerView : dymaptic.GeoBlazor.Core.Components.LayerView, dymaptic.GeoBlazor.Core.Interfaces.IHighlightLayerViewMixin, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 LayerView 🡒 OGCFeatureLayerView
Implements IHighlightLayerViewMixin, IMapComponent
Constructors
OGCFeatureLayerView() Constructor
Parameterless constructor for use as a Razor Component.
public OGCFeatureLayerView();
OGCFeatureLayerView(FeatureEffect, FeatureFilter, HighlightOptions, Nullable, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public OGCFeatureLayerView(dymaptic.GeoBlazor.Core.Components.FeatureEffect? featureEffect=null, dymaptic.GeoBlazor.Core.Components.FeatureFilter? filter=null, dymaptic.GeoBlazor.Core.Components.HighlightOptions? highlightOptions=null, System.Nullable<double> maximumNumberOfFeatures=null, System.Nullable<bool> maximumNumberOfFeaturesExceeded=null, System.Nullable<bool> visible=null);
Parameters
featureEffect FeatureEffect
The featureEffect can be used to draw attention features of interest. ArcGIS Maps SDK for JavaScript
filter FeatureFilter
The attribute, geometry, and time extent filter. ArcGIS Maps SDK for JavaScript
highlightOptions HighlightOptions
Options for configuring the highlight. ArcGIS Maps SDK for JavaScript
maximumNumberOfFeatures System.Nullable<System.Double>
The maximum number of features that can be displayed at a time. ArcGIS Maps SDK for JavaScript
maximumNumberOfFeaturesExceeded System.Nullable<System.Boolean>
Signifies whether the maximum number of features has been exceeded. ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
When `true`, the layer is visible in the view. default true ArcGIS Maps SDK for JavaScript
Properties
OGCFeatureLayerView.AvailableFields Property
A list of attribute fields fetched for each feature including fields required for layer’s `renderer` `labelingInfo`, `elevationInfo`, and additional fields defined on the `outFields` properties. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? AvailableFields { get; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
OGCFeatureLayerView.DataUpdating Property
Indicates if the layer view is updating its data and new features are being fetched. ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> DataUpdating { get; }
Property Value
System.Nullable<System.Boolean>
OGCFeatureLayerView.FeatureEffect Property
The featureEffect can be used to draw attention features of interest. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.FeatureEffect? FeatureEffect { get; set; }
Property Value
OGCFeatureLayerView.Filter Property
The attribute, geometry, and time extent filter. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.FeatureFilter? Filter { get; set; }
Property Value
OGCFeatureLayerView.HasAllFeatures Property
Indicates whether the layer view contains all available features from the service. ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> HasAllFeatures { get; }
Property Value
System.Nullable<System.Boolean>
OGCFeatureLayerView.HasAllFeaturesInView Property
Indicates whether the layer view has all the features available in the current view. ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> HasAllFeaturesInView { get; }
Property Value
System.Nullable<System.Boolean>
OGCFeatureLayerView.HasFullGeometries Property
Indicates whether the layer view has geometries at full resolution. ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> HasFullGeometries { get; }
Property Value
System.Nullable<System.Boolean>
OGCFeatureLayerView.HighlightOptions Property
Options for configuring the highlight. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.HighlightOptions? HighlightOptions { get; set; }
Implements HighlightOptions
Property Value
OGCFeatureLayerView.MaximumNumberOfFeatures Property
The maximum number of features that can be displayed at a time. ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaximumNumberOfFeatures { get; set; }
Property Value
System.Nullable<System.Double>
OGCFeatureLayerView.MaximumNumberOfFeaturesExceeded Property
Signifies whether the maximum number of features has been exceeded. ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> MaximumNumberOfFeaturesExceeded { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
OGCFeatureLayerView.CreateAggregateQuery() Method
Creates query parameter object that can be used to fetch aggregate features as they are being displayed. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Query?> CreateAggregateQuery();
Returns
System.Threading.Tasks.Task<Query>
OGCFeatureLayerView.CreateQuery() Method
Creates a query parameter object that can be used to fetch features as they are being displayed. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Query?> CreateQuery();
Returns
System.Threading.Tasks.Task<Query>
OGCFeatureLayerView.GetAvailableFields() Method
Asynchronously retrieve the current value of the AvailableFields property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetAvailableFields();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
OGCFeatureLayerView.GetDataUpdating() Method
Asynchronously retrieve the current value of the DataUpdating property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDataUpdating();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
OGCFeatureLayerView.GetFeatureEffect() Method
Asynchronously retrieve the current value of the FeatureEffect property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.FeatureEffect?> GetFeatureEffect();
Returns
System.Threading.Tasks.Task<FeatureEffect>
OGCFeatureLayerView.GetFilter() Method
Asynchronously retrieve the current value of the Filter property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.FeatureFilter?> GetFilter();
Returns
System.Threading.Tasks.Task<FeatureFilter>
OGCFeatureLayerView.GetHasAllFeatures() Method
Asynchronously retrieve the current value of the HasAllFeatures property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetHasAllFeatures();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
OGCFeatureLayerView.GetHasAllFeaturesInView() Method
Asynchronously retrieve the current value of the HasAllFeaturesInView property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetHasAllFeaturesInView();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
OGCFeatureLayerView.GetHasFullGeometries() Method
Asynchronously retrieve the current value of the HasFullGeometries property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetHasFullGeometries();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
OGCFeatureLayerView.GetHighlightOptions() Method
Asynchronously retrieve the current value of the HighlightOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.HighlightOptions?> GetHighlightOptions();
Implements GetHighlightOptions()
Returns
System.Threading.Tasks.Task<HighlightOptions>
OGCFeatureLayerView.GetMaximumNumberOfFeatures() Method
Asynchronously retrieve the current value of the MaximumNumberOfFeatures property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaximumNumberOfFeatures();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
OGCFeatureLayerView.GetMaximumNumberOfFeaturesExceeded() Method
Asynchronously retrieve the current value of the MaximumNumberOfFeaturesExceeded property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetMaximumNumberOfFeaturesExceeded();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
OGCFeatureLayerView.Highlight(Graphic) Method
Highlights the given feature(s).
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Handle> Highlight(dymaptic.GeoBlazor.Core.Components.Graphic graphic);
Parameters
graphic Graphic
The Graphic to highlight.
Implements Highlight(Graphic)
Returns
System.Threading.Tasks.Task<Handle>
A handle that allows the highlight to be removed later.
Exceptions
System.InvalidOperationException
Throws if the graphic has no OBJECTID attribute and was not queried via GeoBlazor.
OGCFeatureLayerView.Highlight(ObjectId) Method
Highlights the given feature(s).
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Handle> Highlight(dymaptic.GeoBlazor.Core.Model.ObjectId objectId);
Parameters
objectId ObjectId
The ObjectID of the graphic to highlight.
Implements Highlight(ObjectId)
Returns
System.Threading.Tasks.Task<Handle>
A handle that allows the highlight to be removed later.
OGCFeatureLayerView.Highlight(IReadOnlyCollection) Method
Highlights the given feature(s).
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Handle> Highlight(System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Graphic> graphics);
Parameters
graphics System.Collections.Generic.IReadOnlyCollection<Graphic>
The graphics to highlight.
Implements Highlight(IReadOnlyCollection<Graphic>)
Returns
System.Threading.Tasks.Task<Handle>
A handle that allows the highlight to be removed later.
Exceptions
System.InvalidOperationException
Throws if the graphics have no OBJECTID attribute and were not queried via GeoBlazor.
OGCFeatureLayerView.Highlight(IReadOnlyCollection) Method
Highlights the given feature(s).
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Handle> Highlight(System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.ObjectId> objectIds);
Parameters
objectIds System.Collections.Generic.IReadOnlyCollection<ObjectId>
The ObjectIDs of the graphics to highlight.
Implements Highlight(IReadOnlyCollection<ObjectId>)
Returns
System.Threading.Tasks.Task<Handle>
A handle that allows the highlight to be removed later.
Exceptions
System.ArgumentException
Throws if no ObjectIDs are provided.
OGCFeatureLayerView.QueryAggregates(Query, CancellationToken) Method
Executes a Query against aggregate features (i.e. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> QueryAggregates(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<FeatureSet>
OGCFeatureLayerView.QueryAttributeBins(AttributeBinsQuery, CancellationToken) Method
Executes a AttributeBinsQuery against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an AttributeBinsFeatureSet containing the series of bins. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.AttributeBinsFeatureSet?> QueryAttributeBins(dymaptic.GeoBlazor.Pro.Model.AttributeBinsQuery binsQuery, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
binsQuery AttributeBinsQuery
Specifies the parameters of the `queryAttributeBins()` operation. The binParameters property must be set.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<AttributeBinsFeatureSet>
OGCFeatureLayerView.QueryExtent(Query, CancellationToken) Method
Executes a Query against features available for drawing in the layerView and returns the Extent of features that satisfy the query. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> QueryExtent(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view’s extent.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
OGCFeatureLayerView.QueryFeatureCount(Query, CancellationToken) Method
Executes a Query against features available for drawing in the layerView and returns the number of features that satisfy the query. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<int>> QueryFeatureCount(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view’s extent.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
OGCFeatureLayerView.QueryFeatures(Query, CancellationToken) Method
Executes a Query against features available for drawing in the layerView and returns a FeatureSet. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> QueryFeatures(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using createQuery() method and all features that pass the layer view filter are returned along with their attributes that are available on the client. To only return features visible in the view, set the `geometry` parameter in the query object to the view’s extent.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<FeatureSet>
OGCFeatureLayerView.QueryObjectIds(Query, CancellationToken) Method
Executes a Query against features available for drawing in the layerView and returns array of the ObjectIDs of features that satisfy the input query. param options An object with the following properties. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.ObjectId[]?> QueryObjectIds(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view’s extent.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<ObjectId[]>
OGCFeatureLayerView.SetFeatureEffect(FeatureEffect) Method
Asynchronously set the value of the FeatureEffect property after render.
public System.Threading.Tasks.Task SetFeatureEffect(dymaptic.GeoBlazor.Core.Components.FeatureEffect? value);
Parameters
value FeatureEffect
The value to set.
Returns
OGCFeatureLayerView.SetFilter(FeatureFilter) Method
Asynchronously set the value of the Filter property after render.
public System.Threading.Tasks.Task SetFilter(dymaptic.GeoBlazor.Core.Components.FeatureFilter? value);
Parameters
value FeatureFilter
The value to set.
Returns
OGCFeatureLayerView.SetHighlightOptions(HighlightOptions) Method
Asynchronously set the value of the HighlightOptions property after render.
public System.Threading.Tasks.Task SetHighlightOptions(dymaptic.GeoBlazor.Core.Components.HighlightOptions? value);
Parameters
value HighlightOptions
The value to set.
Implements SetHighlightOptions(HighlightOptions)
Returns
OGCFeatureLayerView.SetMaximumNumberOfFeatures(Nullable) Method
Asynchronously set the value of the MaximumNumberOfFeatures property after render.
public System.Threading.Tasks.Task SetMaximumNumberOfFeatures(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
OGCFeatureLayerView.SetMaximumNumberOfFeaturesExceeded(Nullable) Method
Asynchronously set the value of the MaximumNumberOfFeaturesExceeded property after render.
public System.Threading.Tasks.Task SetMaximumNumberOfFeaturesExceeded(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
OGCFeatureLayerView.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()