GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Model

QueryService Class

Executes different types of query operations on a layer. ArcGIS Maps SDK for JavaScript

public class QueryService : dymaptic.GeoBlazor.Pro.Model.ProLogicComponent

Inheritance System.Object 🡒 LogicComponent 🡒 ProLogicComponent 🡒 QueryService

Constructors

QueryService(AuthenticationManager, JsModuleManager, IAppValidator, IJSRuntime) Constructor

Constructor for use by Dependency Injection. Use AddGeoBlazorPro(this IServiceCollection, IConfiguration) in your startup code.

public QueryService(dymaptic.GeoBlazor.Core.Model.AuthenticationManager authenticationManager, dymaptic.GeoBlazor.Core.JsModuleManager jsModuleManager, dymaptic.GeoBlazor.Core.IAppValidator appValidator, Microsoft.JSInterop.IJSRuntime jsRuntime);

Parameters

authenticationManager AuthenticationManager

jsModuleManager JsModuleManager

appValidator dymaptic.GeoBlazor.Core.IAppValidator

jsRuntime Microsoft.JSInterop.IJSRuntime

Properties

QueryService.QueryResultsMaxSizeLimit Property

The maximum size of query results that will be returned in a stream. Note that setting this to a smaller value might create errors in query returns.

public long QueryResultsMaxSizeLimit { get; set; }

Property Value

System.Int64

Methods

QueryService.ExecuteAttachmentQuery(string, AttachmentQuery, RequestOptions, CancellationToken) Method

Query information about attachments associated with features from a feature layer specified in the url parameter. param attachmentQuery Specifies the attachment parameters for query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.AttachmentsQueryResult?> ExecuteAttachmentQuery(string url, dymaptic.GeoBlazor.Core.Model.AttachmentQuery attachmentQuery, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

attachmentQuery AttachmentQuery

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<AttachmentsQueryResult>

QueryService.ExecuteForCount(string, Query, RequestOptions, CancellationToken) Method

Gets a count of the number of features that satisfy the input query. param query Specifies the attributes and spatial filter of the query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<System.Nullable<int>> ExecuteForCount(string url, dymaptic.GeoBlazor.Core.Model.Query query, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

query Query

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

QueryService.ExecuteForExtent(string, Query, RequestOptions, CancellationToken) Method

Gets the extent of the features that satisfy the input query. param query Specifies the attributes and spatial filter of the query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ExtentQueryResult?> ExecuteForExtent(string url, dymaptic.GeoBlazor.Core.Model.Query query, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

query Query

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<ExtentQueryResult>

QueryService.ExecuteForIds(string, Query, RequestOptions, CancellationToken) Method

Executes a Query against the layer specified in the url parameter. param query Specifies the attributes and spatial filter of the query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<long[]?> ExecuteForIds(string url, dymaptic.GeoBlazor.Core.Model.Query query, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

query Query

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

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

QueryService.ExecuteForTopCount(string, TopFeaturesQuery, RequestOptions, CancellationToken) Method

Executes a TopFeaturesQuery against a feature service and returns the count of features or records that satisfy the query. param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<System.Nullable<int>> ExecuteForTopCount(string url, dymaptic.GeoBlazor.Core.Model.TopFeaturesQuery topFeaturesQuery, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

topFeaturesQuery TopFeaturesQuery

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

QueryService.ExecuteForTopExtents(string, TopFeaturesQuery, RequestOptions, CancellationToken) Method

Executes a TopFeaturesQuery against a feature service and returns the Extent of features that satisfy the query. param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ExtentQueryResult?> ExecuteForTopExtents(string url, dymaptic.GeoBlazor.Core.Model.TopFeaturesQuery topFeaturesQuery, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

topFeaturesQuery TopFeaturesQuery

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<ExtentQueryResult>

QueryService.ExecuteForTopIds(string, TopFeaturesQuery, RequestOptions, CancellationToken) Method

Executes a TopFeaturesQuery against a feature service and returns an array of Object IDs of features that satisfy the query. param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<long[]?> ExecuteForTopIds(string url, dymaptic.GeoBlazor.Core.Model.TopFeaturesQuery topFeaturesQuery, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

topFeaturesQuery TopFeaturesQuery

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

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

QueryService.ExecuteQueryJSON(string, Query, RequestOptions, CancellationToken) Method

Executes a Query against the layer specified in the url parameter. param query Specifies the attributes and spatial filter of the query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> ExecuteQueryJSON(string url, dymaptic.GeoBlazor.Core.Model.Query query, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

query Query

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<FeatureSet>

QueryService.ExecuteQueryPBF(string, Query, RequestOptions, CancellationToken) Method

Executes a Query against the layer specified in the url parameter. param query Specifies the attributes and spatial filter of the query. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> ExecuteQueryPBF(string url, dymaptic.GeoBlazor.Core.Model.Query query, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

query Query

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<FeatureSet>

QueryService.ExecuteRelationshipQuery(string, RelationshipQuery, RequestOptions, CancellationToken) Method

Executes a RelationshipQuery against the layer or table specified in the url parameter. param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.RelatedFeaturesQueryResult?> ExecuteRelationshipQuery(string url, dymaptic.GeoBlazor.Core.Model.RelationshipQuery relationshipQuery, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

relationshipQuery RelationshipQuery

requestOptions RequestOptions

Additional options to be used for the data request.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<RelatedFeaturesQueryResult>

QueryService.ExecuteTopFeaturesQuery(string, TopFeaturesQuery, SpatialReference, RequestOptions, CancellationToken) Method

Executes a TopFeaturesQuery against a feature service and returns a FeatureSet once the promise resolves. param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The topFilter parameter must be set. param requestOptions Additional options to be used for the data request. ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> ExecuteTopFeaturesQuery(string url, dymaptic.GeoBlazor.Core.Model.TopFeaturesQuery topFeaturesQuery, dymaptic.GeoBlazor.Core.Components.SpatialReference outSpatialReference, dymaptic.GeoBlazor.Core.Options.RequestOptions? requestOptions=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

url System.String

URL to the ArcGIS Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer).

topFeaturesQuery TopFeaturesQuery

outSpatialReference SpatialReference

The desired output spatial reference.

requestOptions RequestOptions

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<FeatureSet>

QueryService.OnExecuteForExtent(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteForExtent request.

public System.Threading.Tasks.Task OnExecuteForExtent(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

QueryService.OnExecuteForTopExtents(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteForTopExtents request.

public System.Threading.Tasks.Task OnExecuteForTopExtents(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

QueryService.OnExecuteQueryJSON(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteQueryJSON request.

public System.Threading.Tasks.Task OnExecuteQueryJSON(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

QueryService.OnExecuteQueryPBF(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteQueryPBF request.

public System.Threading.Tasks.Task OnExecuteQueryPBF(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

QueryService.OnExecuteRelationshipQuery(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteRelationshipQuery request.

public System.Threading.Tasks.Task OnExecuteRelationshipQuery(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

QueryService.OnExecuteTopFeaturesQuery(IJSStreamReference) Method

JS-Invoked response handler for the ExecuteTopFeaturesQuery request.

public System.Threading.Tasks.Task OnExecuteTopFeaturesQuery(Microsoft.JSInterop.IJSStreamReference jsStreamReference);

Parameters

jsStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task