Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: SubGeographyQuery
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/geoenrichment/SubGeographyQuery"], function(SubGeographyQuery) { /* code goes here */ });
Description
(Added at v3.12)
(Currently in beta)
Represents StandardGeographyQuery parameters to search subgeographic areas that are within a parent geography. For example, you could return all the U.S. counties within a given U.S. state or you could return all the Canadian postal areas (FSAs) within a Census Metropolitan Area (city).Samples
Search for samples that use this class.Class hierarchy
esri/tasks/geoenrichment/GeographyQueryBase |_esri/tasks/geoenrichment/SubGeographyQuery
Constructors
| Name | Summary |
|---|---|
| new SubGeographyQuery(json?) | Creates a new instance of the SubGeographyQuery object. |
Properties
| Name | Type | Summary |
|---|---|---|
| countryID | String | Two-digit country code. |
| datasetID | String | Optional string that denotes the ID of a dataset associated with a particular country. |
| featureLimit | Number | Optional integer value where you can limit the number of features that are returned from the geographyQuery. |
| filterGeographyIDs | String | Parent layer geography IDs. |
| filterGeographyLayerID | String | Parent layer ID. |
| filterGeographyWhere | String | Parent layer search string. |
| generalizationLevel | Number | Optional integer that specifies the level of generalization of the geometries. |
| outSR | SpatialReference | Determines spatial reference for output geometry if returnGeometry is set to true. |
| returnCentroids | Boolean | Use this parameter to return all the geometries as points. |
| returnGeometry | Boolean | Determines whether response will also include geometries. |
| subGeographyLayerID | String | Layer ID to return features from. |
| subGeographyWhere | String | Query string for the subquery. |
| useFuzzySearch | Boolean | Optional boolean to enable fuzzy search. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts object to its JSON representation. |
Constructor Details
Creates a new instance of the SubGeographyQuery object.
Parameters:
< |
Optional | JSON object used to set the properties of the object. JSON field names should match either the property names of the class, or the property names used in the REST API. |
Sample:
Query for ZIP codes in the state of New York
require([
"esri/tasks/geoenrichment/SubGeographyQuery", ...
], function(SubGeographyQuery, ...) {
var query = new SubGeographySubQuery({
countryID: "US",
datasetID: "USA_ESRI_2013",
filterGeographyLayerID: "US.States",
filterGeographyWhere: "New York",
generalizationLevel: "6",
returnGeometry: "true"
});
...
});
Query for all towns in France containing the word "Paris" in their fields
require([
"esri/tasks/geoenrichment/SubGeographyQuery", ...
], function(SubGeographyQuery, ...) {
var query = new SubGeographyQuery({
countryID: "FR",
datasetID: "FRANCE",
generalizationLevel: "6",
filterGeographyLayerID: ["FR.Commune"],
filterGeographyWhere: "Paris",
returnGeometry: "true"
});
...
});Property Details
<String
StringTwo-digit country code. For example: "US".
<String
StringOptional string that denotes the ID of a dataset associated with a particular country.
Sample:
query.datasetID = 'US.Census2010';
<Number
NumberOptional integer value where you can limit the number of features that are returned from the geographyQuery. If
null, the server will default to 1000. <String
StringParent layer geography IDs.
<String
StringParent layer ID.
<String
StringParent layer search string. Syntax is similar to GeographyQuery.where property.
<Number
NumberOptional integer that specifies the level of generalization of the geometries. A value of 0 returns the most detailed and 6 is most generalized. Some geography layers, like 'countries', do not support returning highly detailed geometries.
Known values:
0|1|2|3|4|5|6Default value:
0<SpatialReference
SpatialReferenceDetermines spatial reference for output geometry if returnGeometry is set to true.
<Boolean
BooleanUse this parameter to return all the geometries as points. For example, you could return all U.S. ZIP Codes as centroids. Only applies if the returnGeometry property is also set to true.
Known values:
true | falseDefault value:
false<Boolean
BooleanDetermines whether response will also include geometries.
Known values:
true | falseDefault value:
false<String
StringLayer ID to return features from.
<String
StringQuery string for the subquery. Syntax is similar to GeographyQuery.where property.
<Boolean
BooleanOptional boolean to enable fuzzy search. See the REST API for details about using fuzzy logic.
Known values:
true | falseDefault value:
falseMethod Details