require(["esri/smartMapping/symbology/dotDensity"], (dotDensitySchemes) => { /* code goes here */ });
import * as dotDensitySchemes from "@arcgis/core/smartMapping/symbology/dotDensity.js";
esri/smartMapping/symbology/dotDensity
Object containing helper methods for getting optimal symbol schemes used to create dot density visualizations. The getSchemes() returns color schemes best suited to the given basemap for this visualization style.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
| DotDensityScheme | Clones a dot density scheme object. | dotDensity | |
| DotDensityScheme | Returns a dot density scheme with the provided name. | dotDensity | |
| DotDensitySchemes | Returns a primary scheme and secondary schemes defining symbol properties for dot density-based data-driven visualizations in a Layer. | dotDensity | |
| DotDensityScheme[] | Returns an array of dot density schemes with the provided tags. | dotDensity |
Method Details
-
cloneScheme
MethodcloneScheme(scheme){DotDensityScheme} -
Clones a dot density scheme object.
Parameterscheme DotDensitySchemeThe dot density scheme object to clone.
ReturnsType Description DotDensityScheme Returns a clone of the given dot density scheme object. Example// clones the primary scheme returned from the getSchemes() method const dotDensityScheme = primaryScheme.clone();
-
getSchemeByName
MethodgetSchemeByName(params){DotDensityScheme} -
Returns a dot density scheme with the provided name.
ParametersSpecificationparams ObjectSee the table below for details of each parameter that may be passed to this function.
Specificationname StringThe name of the scheme to retrieve.
optional The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap.
basemapTheme StringoptionalIf you have a non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, use this parameter to indicate whether the background of the visualization is
lightordark.Possible Values:"light"|"dark"
numColors NumberThe number of colors to visualize.
ReturnsType Description DotDensityScheme Returns the dot density scheme with the given name. Example// Returns the Galaxy Berries scheme let galaxyBerriesScheme = dotDensitySchemes.getSchemeByName({ basemap: map.basemap, numColors: 3, name: "Galaxy Berries" });
-
getSchemes
MethodgetSchemes(params){DotDensitySchemes} -
Returns a primary scheme and secondary schemes defining symbol properties for dot density-based data-driven visualizations in a Layer. The
basemapparameter determines the color of the dots used to visualize each attribute. ThegeometryTypedetermines which type of symbol to return.ParametersSpecificationparams ObjectSee the table below for details of each parameter that may be passed to this function.
Specificationoptional The Esri basemap to pair with the visualization. This value indicates the best symbol colors for visualizing features against the given basemap. If you have a non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, then use the
basemapThemeparameter instead of this parameter.basemapTheme StringoptionalIf you have a non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, use this parameter to indicate whether the background of the visualization is
lightordark.Possible Values:"light"|"dark"
numColors NumberThe number of colors to visualize.
ReturnsType Description DotDensitySchemes Returns an object containing the optimal type scheme to use for the given basemap; it also contains secondary schemes. Example// gets the primary scheme for the features of the given geometry type and basemap const schemes = dotDensitySchemes.getSchemes({ basemap: map.basemap, geometryType: featureLayer.geometryType }); // the best default scheme for the layer and basemap const primaryScheme = schemes.primaryScheme;
-
getSchemesByTag
MethodgetSchemesByTag(params){DotDensityScheme[]} -
Returns an array of dot density schemes with the provided tags. These schemes define symbol properties for dot density visualizations in any layer that can be rendered with a DotDensityRenderer.
ParametersSpecificationparams ObjectSee the table below for details of each parameter that may be passed to this function.
Specificationoptional When provided, only schemes containing all the matching tags will be returned.
Known Tags: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density
optional When provided, only schemes missing all the provided tags will be returned.
Known Tags: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density
optional The basemap to pair with the visualization. This value indicates the best symbol color for visualizing features with the given basemap.
basemapTheme StringoptionalIf you have a non-Esri basemap (e.g. a VectorTileLayer basemap with a custom style) or no basemap at all, use this parameter to indicate whether the background of the visualization is
lightordark.Possible Values:"light"|"dark"
numColors NumberThe number of colors to visualize.
ReturnsType Description DotDensityScheme[] Returns an array of dot density schemes either including or excluding the provided tags. Example// Returns all the red dot density schemes let schemes = dotDensitySchemes.getSchemesByTag({ basemap: map.basemap, numColors: 2, includedTags: [ "reds", "dot-density" ] });
Type Definitions
-
Properties defining the symbology scheme used to visualize predominance for polygon features.
-
The return object of the getSchemes() method.
- Properties
-
primaryScheme DotDensityScheme
The dot density scheme best suited for the given basemap and geometry type.
secondarySchemes DotDensityScheme[]Additional dot density schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
basemapId StringThe ID of the basemap associated with the given schemes.
basemapTheme StringIndicates whether the average basemap color is
lightordark.