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

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

Description

(Added at v3.6)
The study area that is based on an address. 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/AddressStudyArea

Properties

NameTypeSummary
attributesObjectThe address key value pairs to geocode to obtain this 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

The address key value pairs to geocode to obtain this 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