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: InfographicsOptionsItem
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/geoenrichment/InfographicsOptionsItem"], function(InfographicsOptionsItem) { /* code goes here */ });
Description
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new InfographicsOptionsItem(type, variables) | Constructs an InfographicsOptionsItem object. |
CSS
esri/dijit/geoenrichment/InfographicsOptionsItem | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| datasetID | String | The ID of the dataset to which variables used in this Infographic belong. |
| isVisible | Boolean | When true, the Infographic is configured to be visible. |
| title | String | The title or name of the Infographic. |
| type | String | The type of the Infographic. |
| variables | String[] | The set of variables displayed in this Infographic.
To return all variables in a category, specify this value as ["<category_name>.*"].
The availability of variables varies from country to country. |
Constructor Details
Constructs an
InfographicsOptionsItem object.Parameters:
< |
Required | The type of the Infographic. Required when constructing an Infographic.
|
< |
Required | The set of variables displayed in this InfographicsOptionsItem.
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. |
Sample:
require([
"esri/dijit/geoenrichment/InfographicsCarousel",
"esri/tasks/geoenrichment/GeometryStudyArea",
"esri/geometry/Point",
"esri/dijit/geoenrichment/InfographicsOptionsItem",
...
], function(InfographicsCarousel, GeometryStudyArea, Point, InfographicsOptionsItem, ... ){
var infographics = new InfographicsCarousel({
studyArea: new GeometryStudyArea({ geometry: new Point(-120.44,34.95) }),
}, "infographics");
var options = new InfographicsOptions();
options.getItems("US").then(function(items){
//make default infographics invisible
for (var i = 0; i < items.length; i++) {
items[i].isVisible = false;
};
//create a new infographic
var item = new InfographicsOptionsItem("OneVar", ["Wealth.PCI_CY"]);
item.title = "Wealth";
item.datasetID = "USA_ESRI_2013";
//push the infographic into the array and set options
items.push(item);
infographics.set("options", options);
infographics.startup();
});
});Property Details
<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>.<Boolean
BooleanWhen true, the
Infographic is configured to be visible.Known values:
true | falseDefault value:
true<String
StringThe title or name of the
Infographic.<String
StringThe type of the
Infographic. Required when constructing an Infographic.
"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."AgePyramid"displays an age pyramid based on the demographic data. Must specifyvariables: ["Age.*"]to get complete age data."Tapestry"displays Lifestyles-Esri Tapestry Segmentation data in theInfographic. Must specifyvariables: ["Tapestry.*"]to get complete tapestry data.
Known values:
"Age Pyramid" | "RelatedVariables" | "Tapestry" | "OneVar"<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.
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.