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/heatmap
[ AMD Module Require | Legacy Module Require ]
require(["esri/styles/heatmap"], function(esriStylesHeatmap) { /* code goes here */ });
Description
(Added at v3.13)
This module contains a collection of themes suitable for visualizing features using a heatmap.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: default. |
Sample:
var map;
require([
"esri/map",
"esri/styles/heatmap", "dojo/domReady!"], function(Map, esriStylesHeatmap) {
map = new Map("map", {
basemap: "topo-vector",
center: [-122.45, 37.75], // longitude, latitude
zoom: 12
});
map.on("load", function(){
themes = esriStylesHeatmap.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 | Name of the theme. Example: default. |
<
Object>< |
Required | Primary scheme is an object with a colors property. The first color is recommended for the coldest pixels of the heatmap, and the last color is recommended for the hottest pixels. Colors in between are interpolated along the heat intensity scale. |
< |
Required | Secondary schemes. It is an array of objects with properties identical to the primaryScheme. |
Sample:
var map;
require([
"esri/map",
"esri/styles/heatmap", "dojo/domReady!"
], function (Map, esriStylesHeatmap){
map = new Map("map", {
basemap: "topo-vector",
center: [-122.45, 37.75], // longitude, latitude
zoom: 12
});
map.on("load", function (){
schemes = esriStylesHeatmap.getSchemes({theme: "default", basemap: map.getBasemap());
console.log(JSON.stringify(schemes));
});
});