require(["esri/renderers/smartMapping/symbology/heatmap"], function(heatmapSchemes) { /* code goes here */ });
Object: esri/renderers/smartMapping/symbology/heatmap
Since: ArcGIS API for JavaScript 4.8

Object containing helper methods for generating optimal symbols for heatmap visualizations. The getSchemes() method is used to get the heatmap color schemes best suited to the given basemap.

Method Overview

NameReturn TypeSummaryObject
HeatmapScheme

Clones a heatmap scheme object.

more details
more detailsheatmap
HeatmapSchemes

Returns a primary scheme and secondary schemes defining properties for heatmap visualizations in a point Layer.

more details
more detailsheatmap
Theme[]

Returns metadata for the available themes.

more details
more detailsheatmap

Method Details

cloneScheme(scheme){HeatmapScheme}

Clones a heatmap scheme object.

Parameter:

The heatmap scheme object to clone.

Returns:
TypeDescription
HeatmapSchemeA clone of the given heatmap scheme object.
Example:
// clones the primary scheme returned from the getSchemes() method
var heatmapScheme = primaryScheme.clone();
getSchemes(params){HeatmapSchemes}

Returns a primary scheme and secondary schemes defining properties for heatmap visualizations in a point Layer. The basemap parameter determines the color schemes of the heatmap.

Parameters:
params Object

See the table below for details of each parameter that may be passed to this function.

Specification:
basemap String|Basemap

The basemap to pair with the visualization. This value indicates the best colors for overlaying a heatmap against the given basemap.

Returns:
TypeDescription
HeatmapSchemesReturns an object containing the optimal heatmap scheme to use for the given basemap and secondary schemes that may also be used.
Example:
// gets the primary scheme for the basemap
var schemes = heatmapSchemes.getSchemes({
  basemap: map.basemap
});

// the best default scheme for the layer, basemap, and theme
var primaryScheme = schemes.primaryScheme;
getThemes(basemap){Theme[]}

Returns metadata for the available themes. If a basemap is provided, returns themes that look best with the given basemap.

Parameter:
basemap String|Basemap
optional

The Esri basemap string or object that will be used with the returned theme(s).

Returns:
TypeDescription
Theme[]Returns an array of objects that describe various themes that pair well with the given basemap.

Type Definitions

HeatmapScheme

Properties defining the symbology scheme used to visualize point features as a heatmap.

Properties:

The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

colors Color[]

A continuous color ramp used to construct a heatmap.

opacity Number

The opacity of the heatmap.

HeatmapSchemes

The return object of the getSchemes() method.

Properties:
primaryScheme HeatmapScheme

The heatmap color scheme best suited for the given basemap and geometry type.

secondarySchemes HeatmapScheme[]

Additional heatmap color schemes that may be used to visualize data overlaid on the given basemap.

basemapId String

The ID of the basemap associated with the given schemes.

Theme

Describes a theme that pairs well with the given basemaps. See the table below for more details of the properties in this object.

Properties:
name String

The name of the theme.

label String

The label identifying the theme in UI elements.

description String

Text describing the theme in the UI.

basemaps String[]

The Esri basemaps that pair well with the given theme.

API Reference search results

NameTypeModule
Loading...