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
Object: esri/styles/choropleth
[ AMD Module Require | Legacy Module Require ]
require(["esri/styles/choropleth"], function(esriStylesChoropleth) { /* code goes here */ });
Description
(Added at v3.13)
This module contains a collection of themes suitable for unclassed and classed choropleth mapping.Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| getAvailableThemes(basemap?) | Object[] | Returns available themes. |
| getSchemes(params) | Object | Returns schemes matching the given parameters. |
Method Details
Returns available themes. See the Object Specifications table below for the returned
Object[] properties.Return type:
Object[]Parameters:
< |
Optional | Specify the basemap name if you only want themes applicable to a specific basemap, for example: Example: streets, gray, topo, terrain, national-geographic, oceans, osm, satellite, hybrid, dark-gray. |
Object Specifications:
<
Object[]>< |
Required | Basemaps that this theme has schemes for. Example: ["streets","gray","topo","terrain","national-geographic","oceans","osm","satellite","hybrid","dark-gray"]. |
< |
Required | Theme description. Example: "Default theme for basic visualization of features." |
< |
Required | Display label for theme. |
< |
Required | Name of the theme. The following themes are available: high-to-low, above-and-below, centered-on, or extremes. |
Sample:
var map;
require([
"esri/map",
"esri/styles/choropleth", "dojo/domReady!"], function(Map, esriStylesChoropleth) {
map = new Map("map", {
basemap: "topo",
center: [-122.45, 37.75], // longitude, latitude
zoom: 13
});
map.on("load", function(){
themes = esriStylesChoropleth.getAvailableThemes(map.getBasemap());
console.log(JSON.stringify(themes[0]["basemaps"]));
});
});
Returns schemes matching the given parameters. See the Object Specifications table below for the returned
Object properties.Return type:
ObjectParameters:
< |
Required | Parameters used to determine the returned scheme type. |
Object Specifications:
<
params>< |
Required | Name of the basemap. Example: streets, gray, topo, terrain, national-geographic, oceans, osm, satellite, hybrid, dark-gray. |
< |
Required | Geometry type of features in your dataset. Supported types: point, line, polygon. |
< |
Required | Name of the theme. Example: high-to-low, above-and-below, centered-on, or extremes. |
<
Object>< |
Required | Primary scheme is an object with properties based on the feature geometry type.
colorsForClassBreaks: These are colors suitable for classed choropleth mapping, categorized based on the number of classes. It is an array of objects with the following properties:
|
|||||||||
< |
Required | Secondary schemes. It is an array of objects with properties identical to the primaryScheme. |
Sample:
var map;
require([
"esri/map",
"esri/styles/choropleth", "dojo/domReady!"
], function (Map, esriStylesChoropleth){
map = new Map("map", {
basemap: "topo",
center: [-122.45, 37.75], // longitude, latitude
zoom: 13
});
map.on("load", function (){
schemes = esriStylesChoropleth.getSchemes({theme: "high-to-low", basemap: map.getBasemap(), geometryType: "point"});
console.log(JSON.stringify(schemes));
});
});