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: StandardGeographyStudyArea
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/geoenrichment/StandardGeographyStudyArea"], function(StandardGeographyStudyArea) { /* code goes here */ });
Description
(Added at v3.6)
The study area that is based on a standard geography. May be used when constructing an Infographic or an InfographicsCarousel.Samples
Search for samples that use this class.Class hierarchy
esri/tasks/geoenrichment/StudyArea |_esri/tasks/geoenrichment/StandardGeographyStudyArea
Properties
| Name | Type | Summary |
|---|---|---|
| attributes | Object | Attributes of the study area. |
| comparisonGeographyLevels | GeographyLevel[] | The identifiers for layers used to find comparison geographies. |
| countryID | String | The country to which this geography belongs. |
| geographyLayerID | String | The ID of the standard geography layer. |
| ids | String[] | The IDs of the standard geographies. |
| options | RingBuffer | DriveBuffer | IntersectingGeographies | The options to apply to the study area. |
| returnGeometry | Boolean | If true, geometry will be returned. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts object to its JSON representation. |
Property Details
<Object
ObjectAttributes of the study area.
<GeographyLevel[]
GeographyLevel[]The identifiers for layers used to find comparison geographies.
<String
StringThe country to which this geography belongs.
<String
StringThe ID of the standard geography layer.
<String[]
String[]The IDs of the standard geographies.
<RingBuffer | DriveBuffer | IntersectingGeographies
RingBuffer | DriveBuffer | IntersectingGeographiesThe options to apply to the study area.
<Boolean
BooleanIf true, geometry will be returned.
Known values:
true | falseDefault value:
falseMethod Details