此类定义用于执行对来自层的相关记录的查询的参数。一旦定义了关系查询对象的属性,就可以将其传递给 query.executeRelationshipQuery()和 FeatureLayer.queryRelatedFeatures() 方法,这将返回按源层/表 objectIds 分组的FeatureSet 。
- 示例:
构造函数
属性列表
属性 | 类型 | 描述 | 类 | |
---|---|---|---|---|
String | 更多信息 类名。 | 更多信息 | Accessor | |
String | 更多信息 指定要查询的地理数据库版本。 | 更多信息 | RelationshipQuery | |
Number | 更多信息 指定查询操作返回的几何图形的小数位数。 | 更多信息 | RelationshipQuery | |
Date | 更多信息 历史性时刻查询。 | 更多信息 | RelationshipQuery | |
Number | 更多信息 用于概括查询操作返回的几何的最大允许偏移量。 | 更多信息 | RelationshipQuery | |
Number | 更多信息 要检索的特征数。 | 更多信息 | RelationshipQuery | |
Number[] | 更多信息 正在查询的图层/表中的要素的 objectId 数组。 | 更多信息 | RelationshipQuery | |
String[] | 更多信息 用于对查询结果进行排序的一个或多个字段名称。 | 更多信息 | RelationshipQuery | |
String[] | 更多信息 要包含在 FeatureSet 中的属性字段。 | 更多信息 | RelationshipQuery | |
SpatialReference | 更多信息 返回几何的空间参考。 | 更多信息 | RelationshipQuery | |
Number | 更多信息 要查询的关系ID。 | 更多信息 | RelationshipQuery | |
Boolean | 更多信息 如果为 | 更多信息 | RelationshipQuery | |
Boolean | 更多信息 如果该参数和 returnGeometry 都为 | 更多信息 | RelationshipQuery | |
Boolean | 更多信息 如果该参数和 returnGeometry 都为 | 更多信息 | RelationshipQuery | |
Number | 更多信息 从零开始的索引,指示从何处开始检索要素。 | 更多信息 | RelationshipQuery | |
String | 更多信息 要应用于相关表或图层的定义表达式。 | 更多信息 | RelationshipQuery |
属性详细说明
-
类名。类的名称声明格式为
geoscene.folder.className
。
-
gdbVersion String
-
指定要查询的地理数据库版本。
-
geometryPrecision Number
-
指定查询操作返回的几何图形的小数位数。
-
historicMoment Date
-
历史时刻查询。 仅当 FeatureLayer 的
supportsHistoricMoment
属性设置为true
时,此参数才适用。
-
maxAllowableOffset Number
-
用于概括查询操作返回的几何的最大允许偏移量。偏移量的单位为
outSpatialReference
。如果outSpatialReference
未定义,则使用视图的 spatialReference。
-
num Number
-
要检索的特征数。此选项应与start 属性结合使用。使用它来实现分页(即在查询时检索结果的“页面”)。
如果未提供,但 Query 的实例有
start
属性,则num
默认值为10。如果未提供num
或start
属性,则num
默认值等于服务的maxRecordCount
,可在 REST 端点找到要素层。
-
正在查询的图层/表中的要素的 objectId 数组。
-
用于对查询结果进行排序的一个或多个字段名称。 在字段名称后指定
ASC
(升序)或DESC
(降序)以控制顺序。默认顺序是ASC
.已知限制
- 如果查询MapImageLayer,则
supportsAdvancedQueries
必须true
在服务上。 - 对于FeatureLayer,
FeatureLayer.capabilities.queryRelated.supportsOrderBy
必须是true
.
示例代码:query.orderByFields = ["STATE_NAME DESC"];
- 如果查询MapImageLayer,则
-
要包含在 FeatureSet 中的属性字段。字段必须存在于地图图层中。您必须列出实际的字段名称而不是别名。但是,您可以在显示结果时使用别名。
指定输出字段时,应将字段限制为仅希望在查询或结果中使用的字段。您包含的字段越少,响应速度就越快。
每个查询都必须有权访问图层的 Shape 和 ObjectId 字段。但是,您的字段列表不需要包括这两个字段。
示例代码:query.outFields = [ "NAME", "STATE_ABBR", "POP04" ];
-
outSpatialReference SpatialReferenceautocast
-
返回几何的空间参考。如果
outSpatialReference
未定义,则使用视图的 spatialReference。
-
relationshipId Number
-
要查询的关系ID。表或图层参与的关系的 ID 列在 GeoScene 服务目录中。要查询的关系ID。此图层/表参与的关系包含在要素服务图层资源响应中。查询关系的相关表/层对应的表/层中的记录。
-
returnGeometry Boolean
-
如果为
true
, 则返回的FeatureSet中的每个特征都包含几何。- 默认值:false
-
returnM Boolean
-
如果该值和 returnGeometry 都为
true
, 则 m 值包含在几何中。
-
returnZ Boolean
-
如果该值和 returnGeometry 都为
true
, 则 z 值包含在几何中。
方法列表
属性 | 返回值类型 | 描述 | 类 | |
---|---|---|---|---|
RelationshipQuery | 更多信息 创建RelationshipQuery 对象的深拷贝。 | 更多信息 | RelationshipQuery | |
* | 更多信息 创建此类的新实例并使用从 GeoScene产品生成的 JSON 对象的值对其进行初始化。 | 更多信息 | RelationshipQuery | |
Object | 更多信息 将此类的实例转换为其 GeoScene portal JSON 格式。 | 更多信息 | RelationshipQuery |
方法详细说明
-
clone(){RelationshipQuery}
-
创建RelationshipQuery 对象的深拷贝。
返回值:类型 描述 RelationshipQuery RelationshipQuery对象的新实例等于用于调用 .clone()
的对象。
-
fromJSON(json){*}static
-
创建此类的新实例,并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入
json
参数的对象通常来自对 REST API 中的查询操作的响应,或者来自另一个 GeoScene产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例,请参阅指南中的 使用 fromJSON() 主题。参数:json Object实例的 json 表达式,以geoscene 格式显示。
返回值:类型 描述 * 返回一个该类的新实例。
-
toJSON(){Object}
-
将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息,请参阅 使用 fromJSON() 指南。
返回值:类型 描述 Object 此类实例的 GeoScene portal JSON 格式。