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: Infographic
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/geoenrichment/Infographic"], function(Infographic) { /* code goes here */ });
Description
(Added at v3.6)
Displays an Infographic of one or more variables that describe the geographic context of a location.
Note that a css stylesheet needs to be included:
<link rel="stylesheet" href="//js.arcgis.com/3.11/esri/dijit/geoenrichment/themes/common/main.css">
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new Infographic(params, srcNodeRef) | Creates a new Infographic dijit using the given DOM node. |
Properties
| Name | Type | Summary |
|---|---|---|
| cacheLimit | Number | The number of Infographic's for which data retrieved is cached for that browser session. |
| countryID | String | The ID of the country for which data is retrieved. |
| datasetID | String | The ID of the dataset to which variables used in this Infographic belong. |
| expanded | Boolean | If true, the Infographic will be displayed in its expanded state. |
| returnGeometry | Boolean | When true, output geometry will be available as the geometry property in the returned object of the "data-ready" event handler. |
| studyArea | GeometryStudyArea | The study area for this Infographic. |
| studyAreaOptions | RingBuffer | DriveBuffer | IntersectingGeographies | The options to apply to the study area. |
| subtitle | String | An HTML template string used to define the Infographic subtitle. |
| title | String | The title of the Infographic. |
| type | String | The type of the Infographic. |
| variables | String[] | The set of variables displayed in this Infographic. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setData(data, metadata?) | None | Define the infographic data. |
| startup() | None | Finalizes the creation of this dijit. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| data-error | {
error: < | Fires if an error occurs in retrieving data for the study area. |
| data-load | Fires when loading data for the study area. | |
| data-ready | {
provider: < | Fires when data for the study area is ready. |
| data-request | Fires when requesting data for the study area. | |
| resize | {
size: < | Fires when the Infographic is resized. |
Constructor Details
Creates a new
Infographic dijit using the given DOM node.Parameters:
< |
Required | Various optional parameters that can be used to configure the dijit. All properties can be passed into the constructor as options. variables, type and studyArea are required when constructing an Infographic. |
< |
Required | Reference or id of an HTML element where the Infographic should be rendered. |
Sample:
require([
"esri/dijit/geoenrichment/Infographic",
"esri/geometry/Point",
"esri/tasks/geoenrichment/GeometryStudyArea",
"dojo/domReady!"
], function(Infographic, Point, GeometryStudyArea){
var infographics = new Infographic({
studyArea: new GeometryStudyArea({ geometry: new Point(-120.44,34.95) }),
type: "AgePyramid",
variables: ["Age.*"]
}, "infographics");
infographics.startup();
});Property Details
<Number
NumberThe number of
Infographic's for which data retrieved is cached for that browser session.<String
StringThe ID of the country for which data is retrieved. Optional when constructing an
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.
Infographic. If not specified, the server will automatically determine the country. Specifying the country ID can eliminate the 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
StringThe ID of the dataset to which variables used in this
Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find available dataset. Request latest available datasets at
Infographic belong. 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"
<Boolean
BooleanIf true, the
Infographic will be displayed in its expanded state. The default value is true.Known values:
true | falseDefault value:
true<Boolean
BooleanWhen true, output geometry will be available as the
geometry property in the returned object of the "data-ready" event handler. If you do not intend to add the output geometry to the map, set it to false to improve performance.Known values:
true | falseDefault value:
false<GeometryStudyArea
GeometryStudyAreaThe study area for this
Infographic. Required when constructing an Infographic.<RingBuffer | DriveBuffer | IntersectingGeographies
RingBuffer | DriveBuffer | IntersectingGeographiesThe options to apply to the study area. Optional when constructing an
Infographic. The default value is a RingBuffer with 1-mile radius.Default value:
new RingBuffer({"radii": [ 1 ], "units": "esriMiles"})Sample:
studyAreaOptions: new DriveBuffer({radii: [ 2 ], units: "esriMiles"})<String
StringAn HTML template string used to define the Infographic subtitle. The default value is:
<div> ${address}</div><div>${name}</div>
If the study area is a point the address information is populated by performing a reverse geocode of the input study area. For other geometry types the value will be an empty string.
The name information is a string representation of the studyAreaOptions used by the infographic. For example "1-mile ring". (Added at v3.7)<String
StringThe title of the
Infographic. Optional when constructing an Infographic. If not specified, the title of the GeoEnrichment dataset will be displayed as the title.<String
StringThe type of the
Infographic. Required when constructing an Infographic.
"AgePyramid"displays an age pyramid based on the demographic data. Must specifyvariables: ["Age.*"]to get complete age data."OneVar"displays the value of a variable. If multiple variables are specified, only the first in the array will be displayed."RelatedVariables"displays values of multiple variables."Tapestry"displays Lifestyles-Esri Tapestry Segmentation data in theInfographic. Must specifyvariables: ["TapestryNEW.*"]to get complete tapestry data.
Note: Prior to version 3.16 specify "Tapestry" variables as ["Tapestry.*"] to get complete tapestry data.
Known values:
"AgePyramid" | "OneVar" | "RelatedVariables" | "TapestryNEW"<String[]
String[]The set of variables displayed in this
To return all variables in a category, specify this value as
The availability of variables varies from country to country. You may use this application to find variables available in your study area, or refer to the Data collections section in the ArcGIS GeoEnrichment Service documentation to find available variables.
Infographic. Required when constructing an Infographic.
To return all variables in a category, specify this value as
["<category_name>.*"].
The availability of variables varies from country to country. You may use this application to find variables available in your study area, or refer to the Data collections section in the ArcGIS GeoEnrichment Service documentation to find available variables.
Method Details
Define the infographic data. By default the Infographic uses online Geoenrichment services to obtain data. This method allows you to override this behavior to provide data from your own source. For example, you can use a FeatureSet returned from the GeoenrichmentTask.enrich method. (Added at v3.7)
Parameters:
< |
Required | Specify the FeatureSet containing the custom data to display in the Infographic. |
< |
Optional | Define the mappings of feature set attributes to Infographic display fields. Supported display fields are name and address. |
Finalizes the creation of this dijit. This method should be called after the constructor for this dijit is called and before letting the users interact with it.
Event Details
[ On Style Events | Connect Style Event ]
Fires if an error occurs in retrieving data for the study area. Should be used in favor of onDataRequest.
Event Object Properties:
< |
The error message returned by the GeoEnrichment service. |
Fires when data for the study area is ready. Should be used in favor of onDataReady.
Event Object Properties:
< |
A provider object containing GeoEnrichment results. When returnGeometry is set to true, you may use the provider.getGeometry() to get the returned geometry. |
Sample:
require([
"esri/graphic", "esri/symbols/SimpleFillSymbol", ...
], function(Graphic, SimpleFillSymbol, ... ){
infographics.on("data-ready", function (evt) {
map.graphics.add(new Graphic(evt.provider.geometry, new SimpleFillSymbol()));
});
});Fires when requesting data for the study area. Should be used in favor of onDataRequest.
Fires when the
Infographic is resized. Should be used in favor of onResize.Event Object Properties:
< |
The size of the Infographic.[460,106] |