dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

FeatureLayerView Class

Represents the LayerView of a FeatureLayer
after it has been added to a Map in either a MapView or
SceneView.
ArcGIS Maps SDK for JavaScript

public class FeatureLayerView : dymaptic.GeoBlazor.Core.Components.LayerView,
dymaptic.GeoBlazor.Core.Interfaces.IHighlightLayerViewMixin,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 LayerView 🡒 FeatureLayerView

Implements IHighlightLayerViewMixin, IMapComponent

Constructors

FeatureLayerView() Constructor

Parameterless constructor for use as a Razor Component.

public FeatureLayerView();

Properties

FeatureLayerView.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; set; }

Property Value

System.Collections.Generic.IReadOnlyList<System.String>

FeatureLayerView.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; set; }

Property Value

System.Nullable<System.Boolean>

FeatureLayerView.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

FeatureEffect

FeatureLayerView.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

FeatureFilter

FeatureLayerView.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; set; }

Property Value

System.Nullable<System.Boolean>

FeatureLayerView.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; set; }

Property Value

System.Nullable<System.Boolean>

FeatureLayerView.HasFullGeometries Property

Indicates whether the layer view has geometries at full resolution.
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> HasFullGeometries { get; set; }

Property Value

System.Nullable<System.Boolean>

FeatureLayerView.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

HighlightOptions

FeatureLayerView.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>

FeatureLayerView.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>

FeatureLayerView.Type Property

Identifies the layer view type.

public override System.Nullable<dymaptic.GeoBlazor.Core.Enums.LayerType> Type { get; }

Property Value

System.Nullable<LayerType>

Methods

FeatureLayerView.CreateQuery() Method

Creates query parameter object that can be used to fetch features as they are being displayed. It sets the query parameter’s outFields property to [“*”] and returnGeometry to true. The output spatial reference outSpatialReference is set to the spatial reference of the view. Parameters of the filter currently applied to the layerview are also incorporated in the returned query object. The results will include geometries of features and values for availableFields.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Query> CreateQuery();

Returns

System.Threading.Tasks.Task<Query>

FeatureLayerView.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>>

FeatureLayerView.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>>

FeatureLayerView.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>

FeatureLayerView.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>

FeatureLayerView.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>>

FeatureLayerView.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>>

FeatureLayerView.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>>

FeatureLayerView.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>

FeatureLayerView.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>>

FeatureLayerView.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>>

FeatureLayerView.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.

FeatureLayerView.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.

FeatureLayerView.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.

FeatureLayerView.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.

FeatureLayerView.OnQueryFeaturesStreamCallback(IJSStreamReference, Guid) Method

Internal use callback from JavaScript

public System.Threading.Tasks.Task OnQueryFeaturesStreamCallback(Microsoft.JSInterop.IJSStreamReference streamReference, System.Guid queryId);

Parameters

streamReference Microsoft.JSInterop.IJSStreamReference

queryId System.Guid

Returns

System.Threading.Tasks.Task

FeatureLayerView.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. Valid only for hosted feature services on arcgis.com and for ArcGIS Server 10.3.1 and later. If query parameters are not provided, the extent and count of all features available for drawing are returned. To query for the extent of features directly from a Feature Service rather than those visible in the view, you must use the QueryExtent(Query, CancellationToken) method.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ExtentQueryResult?> 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

A cancellation token that can be used to cancel the query operation.

Returns

System.Threading.Tasks.Task<ExtentQueryResult>

Remarks

Spatial queries are executed against quantized geometries in the layerView. The resolution of layerView geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layerView query will likewise be at the same scale resolution of the view. Spatial queries have the same limitations as those listed in the projection engine documentation. Spatial queries are not currently supported if the FeatureLayerView has any of the following SpatialReferences:
GDM 2000 (4742) – Malaysia,
Gusterberg (Ferro) (8042) – Austria/Czech Republic,
ISN2016 (8086) - Iceland,
SVY21 (4757) - Singapore

FeatureLayerView.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. If query parameters are not provided, the count of all features available for drawing is returned. To query for the count of features directly from a Feature Service rather than those visible in the view, you must use the QueryFeatureCount(Query, CancellationToken) method.

public System.Threading.Tasks.Task<System.Nullable<int>> QueryFeatureCount(dymaptic.GeoBlazor.Core.Model.Query? query=null, 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

A cancellation token that can be used to cancel the query operation.

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>
The number of features that satisfy the query.

Remarks

Spatial queries are executed against quantized geometries in the layerView. The resolution of layerView geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layerView query will likewise be at the same scale resolution of the view. Spatial queries have the same limitations as those listed in the projection engine documentation. Spatial queries are not currently supported if the FeatureLayerView has any of the following SpatialReferences:
GDM 2000 (4742) – Malaysia,
Gusterberg (Ferro) (8042) – Austria/Czech Republic,
ISN2016 (8086) - Iceland,
SVY21 (4757) - Singapore

FeatureLayerView.QueryFeatures(Query, CancellationToken) Method

Executes a Query against features available for drawing in the layerView and returns a FeatureSet. If query parameters are not provided, all features available for drawing are returned along with their attributes that are available on the client. For client-side attribute queries, relevant fields should exist in availableFields list for the query to be successful. To execute a query against all the features in a feature service rather than only those in the client, you must use the QueryFeatures(Query, CancellationToken) method.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> QueryFeatures(dymaptic.GeoBlazor.Core.Model.Query? query=null, 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, all features available for drawing 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

A cancellation token that can be used to cancel the query operation.

Returns

System.Threading.Tasks.Task<FeatureSet>
A FeatureSet containing the features that satisfy the query.

Remarks

Attribute values used in attribute queries executed against layerViews are case sensitive. Spatial queries are executed against quantized geometries in the layerView. The resolution of layerView geometries, is only as precise as the scale resolution of the view. Therefore, the results of the same query could be different when executed at different scales. This also means that geometries returned from any layerView query will likewise be at the same scale resolution of the view. Spatial queries have the same limitations as those listed in the projection engine documentation. Spatial queries are not currently supported if the FeatureLayerView has any of the following SpatialReferences:
GDM 2000 (4742) – Malaysia,
Gsterberg (Ferro) (8042) – Austria/Czech Republic,
ISN2016 (8086) - Iceland,
SVY21 (4757) - Singapore

FeatureLayerView.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. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned. To query for ObjectIDs of features directly from a Feature Service rather than those visible in the view, you must use the QueryObjectIds(Query, CancellationToken) method.

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

A cancellation token that can be used to cancel the query operation.

Returns

System.Threading.Tasks.Task<ObjectId[]>

FeatureLayerView.SetFeatureEffect(FeatureEffect) Method

Sets the FeatureEffect for this view.

public System.Threading.Tasks.Task SetFeatureEffect(dymaptic.GeoBlazor.Core.Components.FeatureEffect? featureEffect);

Parameters

featureEffect FeatureEffect

The new effect (or null to clear) to apply to this view.

Returns

System.Threading.Tasks.Task

FeatureLayerView.SetFilter(FeatureFilter) Method

Sets the FeatureFilter for this view.

public System.Threading.Tasks.Task SetFilter(dymaptic.GeoBlazor.Core.Components.FeatureFilter? filter);

Parameters

filter FeatureFilter

The new filter (or null to clear) to apply to this view.

Returns

System.Threading.Tasks.Task

FeatureLayerView.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

System.Threading.Tasks.Task

FeatureLayerView.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

System.Threading.Tasks.Task

FeatureLayerView.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

System.Threading.Tasks.Task

FeatureLayerView.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()