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

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

Description

(Added at v3.6)
GeographicLevel works with IntersectingGeographies to define a study area of InfoGraphic with a feature from a standard geography layer. You may use this class to define your study area as a standard census unit (such as a state, county, tract, etc). To be used in favor of the levels property in the IntersectingGeographies class.

Only limited layers are available to construct a GeographicLevel object. Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "ID" column in the Standard Geography Levels table lists all the layer IDs you may use.

Samples

Search for samples that use this class.

Constructors

NameSummary
new GeographyLevel(json?)Create a GeographyLevel object.

Properties

NameTypeSummary
countryIDStringThe ID of the country for which data is retrieved.
datasetIDStringThe ID of the dataset to which variables used in this GeographyLevel belong.
layerIDStringThe ID of the layer.
Constructor Details

new GeographyLevel(json?)

Create a GeographyLevel object.
Parameters:
<Object> json Optional Various options to configure this GeographyLevel. Any property can be passed into this object.
Sample:
require([
  "esri/dijit/geoenrichment/Infographic",
  "esri/tasks/geoenrichment/IntersectingGeographies",
  "esri/tasks/geoenrichment/GeographyLevel",
  ... 
], function(Infographic, IntersectingGeographies, GeographyLevel, ... ){
  var infographics = new Infographic({
    type: "AgePyramid",
    variables: ["Age.*"],
    studyAreaOptions: new IntersectingGeographies({
      levels: [
        new GeographyLevel({
          layerID: "US.Counties",
          countryID: "US",
          datasetID: "USA_ESRI_2013"
        })
      ]
    }),
    returnGeometry: true
  }, "infographics");
});
Property Details

<String> countryID

The ID of the country for which data is retrieved. Optional when constructing a GeographyLevel. If not specified, the server will automatically determine the country. Specifying the country ID can eliminate computational cost and potentially improve the performance of your application.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "Two-Digit Country Code" column in the first table lists all the country codes you may use.
Sample:
countryID: "US"

<String> datasetID

The ID of the dataset to which variables used in this GeographyLevel belong. Optional when constructing a GeographyLevel. If not specified, the server will automatically determine the dataset. Specifying the dataset ID can eliminate computational cost and potentially improve the performance of your application.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find available dataset. Request latest available datasets at http://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer/Geoenrichment/Countries?f=pjson&token=<your_own_token>.
Sample:
datasetID: "USA_ESRI_2013"

<String> layerID

The ID of the layer. Required when constructing a GeographyLevel.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "ID" column in the Standard Geography Levels table lists all the layer IDs you may use.
Sample:
layerID: "US.Counties"