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: AddressStudyArea
[ AMD Module Require | Legacy Module Require ]
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
| Name | Type | Summary |
|---|---|---|
| attributes | Object | The address key value pairs to geocode to obtain this study area. |
| comparisonGeographyLevels | GeographyLevel[] | The identifiers for layers used to find comparison 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
ObjectThe address key value pairs to geocode to obtain this study area.
<GeographyLevel[]
GeographyLevel[]The identifiers for layers used to find comparison 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