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

require(["esri/tasks/geoenrichment/StudyArea"], function(StudyArea) { /* code goes here */ });

Description

(Added at v3.6)
The study area that is used for enrichment or for display in an Infographic widget.

Samples

Search for samples that use this class.

Subclasses

Properties

NameTypeSummary
attributesObjectAttributes of the study area.
comparisonGeographyLevelsGeographyLevel[]The identifiers for layers used to find comparison 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.
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