Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: StandardGeographyStudyArea

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

NameTypeSummary
attributesObjectAttributes of the study area.
comparisonGeographyLevelsGeographyLevel[]The identifiers for layers used to find comparison geographies.
countryIDStringThe country to which this geography belongs.
geographyLayerIDStringThe ID of the standard geography layer.
idsString[]The IDs of the standard geographies.
optionsRingBuffer | DriveBuffer | IntersectingGeographiesThe options to apply to the study area.
returnGeometryBooleanIf true, geometry will be returned.

Methods

NameReturn typeSummary
toJson()ObjectConverts object to its JSON representation.
Property Details

<Object> attributes

Attributes of the study area.

<GeographyLevel[]> comparisonGeographyLevels

The identifiers for layers used to find comparison geographies.

<String> countryID

The country to which this geography belongs.

<String> geographyLayerID

The ID of the standard geography layer.

<String[]> ids

The IDs of the standard geographies.
The options to apply to the study area.

<Boolean> returnGeometry

If true, geometry will be returned.
Known values: true | false
Default value: false
Method Details

toJson()

Converts object to its JSON representation.
Return type: Object