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/relationship
[ AMD Module Require | Legacy Module Require ]
require(["esri/styles/relationship"], function(esriStylesRelationship) { /* code goes here */ });
Description
(Added at v3.25)
This module contains a collection of color schemes suitable for creating relationship (or bivariate choropleth) visualizations.Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| getAvailableThemes(basemap) | Object[] | Returns themes available for the given basemap. |
| getSchemes(params) | Object | Returns the primary and secondary color schemes for the given theme, basemap, and geometry type. |
Method Details
Returns themes available for the given basemap. The theme is required for getting the relevant color schemes from the
getSchemes() method.Return type:
Object[]Parameters:
< |
Required | Specifies the basemap name if you only want themes applicable to a specific basemap, for example: streets, gray, topo, terrain, national-geographic, oceans, osm, satellite, hybrid, dark-gray. |
Sample:
// returns an array of themes pertaining to the streets basemap
esriStylesRelationship.getAvailableThemes("streets");Returns the primary and secondary color schemes for the given theme, basemap, and geometry type. One of the returned schemes may be used as a parameter to the smartMapping.createRelationshipRenderer() method. See esriStylesChoropleth.getSchemes() for details about the return object.
Return type:
ObjectParameters:
< |
Required | See the params Object Specifications table below for a description of the method parameters. |
Object Specifications:
<
params>< |
Required | Name of the basemap. Some example values include: streets, gray, topo, terrain, national-geographic, oceans, osm, satellite, hybrid, dark-gray. |
< |
Required | Geometry type of features in the relevant dataset. Supported types: "point", "line", "polygon". |
< |
Required | Name of the theme. The only supported value is "default". |