dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Model
Query Class
This class defines parameters for executing queries for features from a layer or layer view.
ArcGIS Maps SDK for JavaScript
public class Query :
dymaptic.GeoBlazor.Core.Interfaces.IQueryMixin,
System.IEquatable<dymaptic.GeoBlazor.Core.Model.Query>
Inheritance System.Object 🡒 Query
Implements IQueryMixin, System.IEquatable<Query>
Constructors
Query(IReadOnlyCollection, Nullable, Nullable, Nullable, string, Geometry, Nullable, IReadOnlyCollection, string, Nullable, Nullable, Nullable, string, Nullable, IReadOnlyCollection, IReadOnlyCollection, IReadOnlyCollection, SpatialReference, IReadOnlyCollection, Dictionary<string,object>, Point, QuantizationParameters, QueryCompositeTransformation, QuerySimpleTransformation, IReadOnlyCollection, string, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, string, TimeExtent, Nullable, string) Constructor
This class defines parameters for executing queries for features from a layer or layer view.
ArcGIS Maps SDK for JavaScript
public Query(System.Collections.Generic.IReadOnlyCollection<string>? AggregateIds=null, System.Nullable<bool> CacheHint=null, System.Nullable<double> Distance=null, System.Nullable<double> DoubleDatumTransformation=null, string? GdbVersion=null, dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry=null, System.Nullable<int> GeometryPrecision=null, System.Collections.Generic.IReadOnlyCollection<string>? GroupByFieldsForStatistics=null, string? Having=null, System.Nullable<System.DateTime> HistoricMoment=null, System.Nullable<double> MaxAllowableOffset=null, System.Nullable<int> MaxRecordCountFactor=null, string? MultipatchOption=null, System.Nullable<int> Num=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.ObjectId>? ObjectIds=null, System.Collections.Generic.IReadOnlyCollection<string>? OrderByFields=null, System.Collections.Generic.IReadOnlyCollection<string>? OutFields=null, dymaptic.GeoBlazor.Core.Components.SpatialReference? OutSpatialReference=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.StatisticDefinition>? OutStatistics=null, System.Collections.Generic.Dictionary<string,object?>? ParameterValues=null, dymaptic.GeoBlazor.Core.Components.Geometries.Point? PixelSize=null, dymaptic.GeoBlazor.Core.Model.QuantizationParameters? QuantizationParameters=null, dymaptic.GeoBlazor.Core.Model.QueryCompositeTransformation? QueryCompositeTransformationDatumTransformation=null, dymaptic.GeoBlazor.Core.Model.QuerySimpleTransformation? QuerySimpleTransformationDatumTransformation=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.QueryRangeValues>? RangeValues=null, string? RelationParameter=null, System.Nullable<bool> ReturnCentroid=null, System.Nullable<bool> ReturnDistinctValues=null, System.Nullable<bool> ReturnExceededLimitFeatures=null, System.Nullable<bool> ReturnGeometry=null, System.Nullable<bool> ReturnM=null, System.Nullable<bool> ReturnQueryGeometry=null, System.Nullable<bool> ReturnZ=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship> SpatialRelationship=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SqlFormat> SqlFormat=null, System.Nullable<int> Start=null, string? Text=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits> Units=null, string? Where=null);
Parameters
AggregateIds
System.Collections.Generic.IReadOnlyCollection<System.String>
An array of Object IDs representing aggregate (i.e.
ArcGIS Maps SDK for JavaScript
CacheHint
System.Nullable<System.Boolean>
Distance
System.Nullable<System.Double>
DoubleDatumTransformation
System.Nullable<System.Double>
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
GdbVersion
System.String
Specifies the geodatabase version to display for feature service queries.
ArcGIS Maps SDK for JavaScript
Geometry
Geometry
The geometry to apply to the spatial filter.
ArcGIS Maps SDK for JavaScript
GeometryPrecision
System.Nullable<System.Int32>
Specifies the number of decimal places for geometries returned by the JSON query operation.
ArcGIS Maps SDK for JavaScript
GroupByFieldsForStatistics
System.Collections.Generic.IReadOnlyCollection<System.String>
Used only in statistical queries.
ArcGIS Maps SDK for JavaScript
Having
System.String
A condition used with outStatistics and groupByFieldsForStatistics
to limit query results to groups that
satisfy the aggregation function(s).
ArcGIS Maps SDK for JavaScript
HistoricMoment
System.Nullable<System.DateTime>
The historic moment to query.
ArcGIS Maps SDK for JavaScript
MaxAllowableOffset
System.Nullable<System.Double>
The maximum distance in units of outSpatialReference used for
generalizing geometries returned by the query operation.
ArcGIS Maps SDK for JavaScript
MaxRecordCountFactor
System.Nullable<System.Int32>
When set, the maximum number of features returned by the query will equal the
maxRecordCount
of the service multiplied by this factor.
default 1
ArcGIS Maps SDK for JavaScript
MultipatchOption
System.String
Parameter dictates how the geometry of a multipatch feature will be returned.
ArcGIS Maps SDK for JavaScript
Num
System.Nullable<System.Int32>
The number of features to retrieve.
ArcGIS Maps SDK for JavaScript
ObjectIds
System.Collections.Generic.IReadOnlyCollection<ObjectId>
An array of ObjectIDs to be used to query for features in a layer.
ArcGIS Maps SDK for JavaScript
OrderByFields
System.Collections.Generic.IReadOnlyCollection<System.String>
One or more field names used to order the query results.
ArcGIS Maps SDK for JavaScript
OutFields
System.Collections.Generic.IReadOnlyCollection<System.String>
Attribute fields to include in the FeatureSet.
default null
ArcGIS Maps SDK for JavaScript
OutSpatialReference
SpatialReference
The spatial reference for the returned geometry.
ArcGIS Maps SDK for JavaScript
OutStatistics
System.Collections.Generic.IReadOnlyCollection<StatisticDefinition>
The definitions for one or more field-based statistics to be calculated.
ArcGIS Maps SDK for JavaScript
ParameterValues
System.Collections.Generic.Dictionary<System.String,System.Object>
Filters features from the layer based on pre-authored parameterized filters.
ArcGIS Maps SDK for JavaScript
PixelSize
Point
Specifies the pixel level to be identified on the X and Y axis.
ArcGIS Maps SDK for JavaScript
QuantizationParameters
QuantizationParameters
Used to project the geometry onto a virtual grid, likely representing
pixels on the screen.
ArcGIS Maps SDK for JavaScript
QueryCompositeTransformationDatumTransformation
QueryCompositeTransformation
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
QuerySimpleTransformationDatumTransformation
QuerySimpleTransformation
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
RangeValues
System.Collections.Generic.IReadOnlyCollection<QueryRangeValues>
Filters features from the layer that are within the specified range values.
ArcGIS Maps SDK for JavaScript
RelationParameter
System.String
The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query
the spatial relationship of the input geometry to the layer’s features.
ArcGIS Maps SDK for JavaScript
ReturnCentroid
System.Nullable<System.Boolean>
If true
, each feature in the returned FeatureSet will be returned with a centroid.
default false
ArcGIS Maps SDK for JavaScript
ReturnDistinctValues
System.Nullable<System.Boolean>
If true
then the query returns distinct values based on the field(s) specified in outFields.
default false
ArcGIS Maps SDK for JavaScript
ReturnExceededLimitFeatures
System.Nullable<System.Boolean>
If true
, then all features are returned for each tile request, even if they exceed the
maximum record limit per query indicated on the service by maxRecordCount
.
default true
ArcGIS Maps SDK for JavaScript
ReturnGeometry
System.Nullable<System.Boolean>
If true
, each feature in the returned FeatureSet includes the geometry.
default false
ArcGIS Maps SDK for JavaScript
ReturnM
System.Nullable<System.Boolean>
If true
, and returnGeometry is true
, then m-values are included in the geometry.
ArcGIS Maps SDK for JavaScript
ReturnQueryGeometry
System.Nullable<System.Boolean>
If true
, the query geometry will be returned with the query results.
default false
ArcGIS Maps SDK for JavaScript
ReturnZ
System.Nullable<System.Boolean>
If true
, and returnGeometry is true
, then z-values are included in the geometry.
ArcGIS Maps SDK for JavaScript
SpatialRelationship
System.Nullable<SpatialRelationship>
SqlFormat
System.Nullable<SqlFormat>
This parameter can be either standard SQL92 standard
or it can use the native SQL of the underlying datastore native
.
default “none”
ArcGIS Maps SDK for JavaScript
Start
System.Nullable<System.Int32>
The zero-based index indicating where to begin retrieving features.
ArcGIS Maps SDK for JavaScript
Text
System.String
Shorthand for a where clause using “like”.
default null
ArcGIS Maps SDK for JavaScript
TimeExtent
TimeExtent
A time extent for a temporal query against time-aware layers.
ArcGIS Maps SDK for JavaScript
Units
System.Nullable<QueryUnits>
Where
System.String
Properties
Query.AggregateIds Property
An array of Object IDs representing aggregate (i.e.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<string>? AggregateIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.String>
Query.CacheHint Property
public System.Nullable<bool> CacheHint { get; set; }
Implements CacheHint
Property Value
System.Nullable<System.Boolean>
Query.Distance Property
public System.Nullable<double> Distance { get; set; }
Implements Distance
Property Value
System.Nullable<System.Double>
Query.DoubleDatumTransformation Property
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> DoubleDatumTransformation { get; set; }
Property Value
System.Nullable<System.Double>
Query.GdbVersion Property
Specifies the geodatabase version to display for feature service queries.
ArcGIS Maps SDK for JavaScript
public string? GdbVersion { get; set; }
Property Value
Query.Geometry Property
The geometry to apply to the spatial filter.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry { get; set; }
Implements Geometry
Property Value
Query.GeometryPrecision Property
Specifies the number of decimal places for geometries returned by the JSON query operation.
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> GeometryPrecision { get; set; }
Property Value
Query.GroupByFieldsForStatistics Property
Used only in statistical queries.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<string>? GroupByFieldsForStatistics { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.String>
Query.Having Property
A condition used with outStatistics and groupByFieldsForStatistics
to limit query results to groups that
satisfy the aggregation function(s).
ArcGIS Maps SDK for JavaScript
public string? Having { get; set; }
Property Value
Query.HistoricMoment Property
The historic moment to query.
ArcGIS Maps SDK for JavaScript
public System.Nullable<System.DateTime> HistoricMoment { get; set; }
Property Value
System.Nullable<System.DateTime>
Query.MaxAllowableOffset Property
The maximum distance in units of outSpatialReference used for
generalizing geometries returned by the query operation.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxAllowableOffset { get; set; }
Property Value
System.Nullable<System.Double>
Query.MaxRecordCountFactor Property
When set, the maximum number of features returned by the query will equal the
maxRecordCount
of the service multiplied by this factor.
default 1
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> MaxRecordCountFactor { get; set; }
Property Value
Query.MultipatchOption Property
Parameter dictates how the geometry of a multipatch feature will be returned.
ArcGIS Maps SDK for JavaScript
public string? MultipatchOption { get; set; }
Property Value
Query.Num Property
The number of features to retrieve.
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> Num { get; set; }
Property Value
Query.ObjectIds Property
An array of ObjectIDs to be used to query for features in a layer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.ObjectId>? ObjectIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<ObjectId>
Query.OrderByFields Property
One or more field names used to order the query results.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<string>? OrderByFields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.String>
Query.OutFields Property
Attribute fields to include in the FeatureSet.
default null
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<string>? OutFields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.String>
Query.OutSpatialReference Property
The spatial reference for the returned geometry.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? OutSpatialReference { get; set; }
Implements OutSpatialReference
Property Value
Query.OutStatistics Property
The definitions for one or more field-based statistics to be calculated.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.StatisticDefinition>? OutStatistics { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<StatisticDefinition>
Query.ParameterValues Property
Filters features from the layer based on pre-authored parameterized filters.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.Dictionary<string,object?>? ParameterValues { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.Object>
Query.PixelSize Property
Specifies the pixel level to be identified on the X and Y axis.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Point? PixelSize { get; set; }
Property Value
Query.QuantizationParameters Property
Used to project the geometry onto a virtual grid, likely representing
pixels on the screen.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.QuantizationParameters? QuantizationParameters { get; set; }
Property Value
Query.QueryCompositeTransformationDatumTransformation Property
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.QueryCompositeTransformation? QueryCompositeTransformationDatumTransformation { get; set; }
Property Value
Query.QuerySimpleTransformationDatumTransformation Property
Datum transformation used for projecting geometries in the query results when
outSpatialReference is different than the layer’s spatial reference.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.QuerySimpleTransformation? QuerySimpleTransformationDatumTransformation { get; set; }
Property Value
Query.RangeValues Property
Filters features from the layer that are within the specified range values.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Model.QueryRangeValues>? RangeValues { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<QueryRangeValues>
Query.RelationParameter Property
The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query
the spatial relationship of the input geometry to the layer’s features.
ArcGIS Maps SDK for JavaScript
public string? RelationParameter { get; set; }
Property Value
Query.ReturnCentroid Property
If true
, each feature in the returned FeatureSet will be returned with a centroid.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnCentroid { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnDistinctValues Property
If true
then the query returns distinct values based on the field(s) specified in outFields.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnDistinctValues { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnExceededLimitFeatures Property
If true
, then all features are returned for each tile request, even if they exceed the
maximum record limit per query indicated on the service by maxRecordCount
.
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnExceededLimitFeatures { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnGeometry Property
If true
, each feature in the returned FeatureSet includes the geometry.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnGeometry { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnM Property
If true
, and returnGeometry is true
, then m-values are included in the geometry.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnM { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnQueryGeometry Property
If true
, the query geometry will be returned with the query results.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnQueryGeometry { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.ReturnZ Property
If true
, and returnGeometry is true
, then z-values are included in the geometry.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ReturnZ { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.SpatialRelationship Property
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SpatialRelationship> SpatialRelationship { get; set; }
Implements SpatialRelationship
Property Value
System.Nullable<SpatialRelationship>
Query.SqlFormat Property
This parameter can be either standard SQL92 standard
or it can use the native SQL of the underlying datastore native
.
default “none”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SqlFormat> SqlFormat { get; set; }
Property Value
Query.Start Property
The zero-based index indicating where to begin retrieving features.
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> Start { get; set; }
Property Value
Query.Text Property
Shorthand for a where clause using “like”.
default null
ArcGIS Maps SDK for JavaScript
public string? Text { get; set; }
Property Value
Query.TimeExtent Property
A time extent for a temporal query against time-aware layers.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent { get; set; }
Implements TimeExtent
Property Value
Query.Units Property
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.QueryUnits> Units { get; set; }
Implements Units
Property Value
Query.UseViewExtent Property
Determines whether to use the view’s extent as the query geometry
public System.Nullable<bool> UseViewExtent { get; set; }
Property Value
System.Nullable<System.Boolean>
Query.Where Property
public string? Where { get; set; }
Implements Where