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

dojo.require("esri.tasks.geoenrichment.GeometryStudyArea");

Description

(Added at v3.6)
The study area that is based on a geometry. 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.GeometryStudyArea

Constructors

NameSummary
new esri.tasks.geoenrichment.GeometryStudyArea()Constructs a GeometryStudyArea.

Properties

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

new esri.tasks.geoenrichment.GeometryStudyArea()

Constructs a GeometryStudyArea.
Sample:
var infographics = new esri.dijit.geoenrichment.Infographic({
  ...
  studyArea: new esri.tasks.geoenrichment.GeometryStudyArea({
    geometry: new esri.geometry.Point(-120.44,34.95)
  }),
}, "infographics");
Property Details

<Object> attributes

Attributes of the study area.

<GeographyLevel[]> comparisonGeographyLevels

The identifiers for layers used to find comparison geographies.

<Geometry> geometry

The geometry for this study area.
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
Show Modal