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

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

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 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 GeometryStudyArea()

Constructs a GeometryStudyArea.
Sample:
require([
  "esri/dijit/geoenrichment/Infographic",
  "esri/tasks/geoenrichment/GeometryStudyArea",
  "esri/geometry/Point"
] ,function(InfoGraphic, GeometryStudyArea, Point){
  var infographics = new Infographic({
    ...
    studyArea: new GeometryStudyArea({ geometry: new 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