require(["esri/smartMapping/symbology/relationship"], (relationshipSchemes) => { /* code goes here */ });
import * as relationshipSchemes from "@arcgis/core/smartMapping/symbology/relationship.js";
esri/smartMapping/symbology/relationship
Object containing helper methods for getting optimal symbol schemes used to create relationship (bivariate choropleth) visualizations. The getSchemes() returns color schemes best suited to the given basemap for this visualization style.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Clones a relationship (bivariate color) scheme object. | relationship | ||
Returns a relationship scheme with the provided name. | relationship | ||
Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth) data-driven visualizations in a Layer. | relationship | ||
Returns an array of relationship schemes with the provided tags. | relationship | ||
Returns metadata for the available themes. | relationship |
Method Details
-
cloneScheme
MethodcloneScheme(scheme){RelationshipScheme} -
Clones a relationship (bivariate color) scheme object.
Parameterscheme RelationshipSchemeThe relationship scheme object to clone.
ReturnsType Description RelationshipScheme Returns a clone of the given relationship scheme object. Example// clones the primary scheme returned from the getSchemes() method const relationshipScheme = primaryScheme.clone();
-
getSchemeByName
MethodgetSchemeByName(params){RelationshipScheme}Since: ArcGIS Maps SDK for JavaScript 4.12relationship since 4.9, getSchemeByName added at 4.12. -
Returns a relationship 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 colors 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"
geometryType StringThe geometry type of the features to visualize.
Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"
theme StringoptionalDefault Value: defaultDetermines which set of primary and secondary color schemes to return.
The value is always "default".
worldScale BooleanoptionalIndicates if the size units of the scheme will be in meters. This should be
truewhen the scheme is intended for 3D volumetric symbology. Aviewmust be provided if this property is set totrue.view SceneViewoptionalThe SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols.
ReturnsType Description RelationshipScheme Returns the relationship scheme with the given name. Example// Returns the Blueberry Parfait scheme let blueberryScheme = relationshipSchemes.getSchemeByName({ basemap: map.basemap, geometryType: featureLayer.geometryType, name: "Blueberry Parfait" });
-
getSchemes
MethodgetSchemes(params){RelationshipSchemes} -
Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth) data-driven visualizations in a Layer. The
basemapparameter determines the color of the symbols used to visualize each feature. 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"
geometryType StringThe geometry type of the features to visualize.
Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"
theme StringoptionalDefault Value: defaultDetermines which set of primary and secondary color schemes to return.
The value is always "default".
worldScale BooleanoptionalIndicates if the size units of the scheme will be in meters. This should be
truewhen the scheme is intended for 3D volumetric symbology. Aviewmust be provided if this property is set totrue.view SceneViewoptionalThe SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols.
ReturnsType Description RelationshipSchemes Returns an object containing the optimal relationship color 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 = relationshipSchemes.getSchemes({ basemap: map.basemap, geometryType: featureLayer.geometryType }); // the best default scheme for the layer and basemap const primaryScheme = schemes.primaryScheme;
-
getSchemesByTag
MethodgetSchemesByTag(params){RelationshipScheme[]}Since: ArcGIS Maps SDK for JavaScript 4.12relationship since 4.9, getSchemesByTag added at 4.12. -
Returns an array of relationship schemes with the provided tags. These schemes define symbol properties for relationship visualizations.
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 colors 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"
geometryType StringThe geometry type of the features to visualize. | mesh
Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"
theme StringoptionalDefault Value: defaultDetermines which set of primary and secondary color schemes to return.
The value is always "default".
worldScale BooleanoptionalIndicates if the size units of the scheme will be in meters. This should be
truewhen the scheme is intended for 3D volumetric symbology. Aviewmust be provided if this property is set totrue.view SceneViewoptionalThe SceneView instance in which the scheme will be used. This property is only applicable when the scheme will be used in conjunction with 3D symbols.
ReturnsType Description RelationshipScheme[] Returns an array of relationship schemes either including or excluding the provided tags. Examplelet schemes = relationshipSchemes.getSchemesByTag({ basemap: map.basemap, geometryType: featureLayer.geometryType, includedTags: [ "tritanopia" ], excludedTags: [ "grayscale" ] });
-
Returns metadata for the available themes. If a basemap is provided, returns themes that work best with the given basemap.
Parameteroptional The Esri basemap string or object that will be used with the returned theme(s).
Returns
Type Definitions
-
RelationshipScheme
Type DefinitionRelationshipScheme RelationshipSchemeForPoint |RelationshipSchemeForPolyline |RelationshipSchemeForPolygon |RelationshipSchemeForMesh -
Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type.
-
Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features.
- Properties
-
name String
The unique name of the scheme.
Tags associated with the scheme.
id StringThe ID uniquely identifying the color scheme.
Defines the colors to use in each bin of the relationship visualization.
noDataColor ColorThe color of the fill symbol used to indicate features with no data.
opacity NumberThe opacity of the fill symbol (0 - 1).
-
Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features.
- Properties
-
name String
The unique name of the scheme.
Tags associated with the scheme.
id StringThe ID uniquely identifying the color scheme.
Defines the colors to use in each bin of the relationship visualization.
noDataColor ColorThe color of the point symbol used to indicate features with no data.
outline ObjectProperties for defining the outline of the marker symbol.
opacity NumberThe opacity of the point symbol (0 - 1).
size NumberThe size of the point symbol in points.
-
Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features.
- Properties
-
name String
The unique name of the scheme.
Tags associated with the scheme.
id StringThe ID uniquely identifying the color scheme.
Defines the colors to use in each bin of the relationship visualization.
noDataColor ColorThe color of the fill symbol used to indicate features with no data.
outline ObjectProperties for defining the outline of the fill symbol.
opacity NumberThe opacity of the fill symbol (0 - 1).
-
Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features.
- Properties
-
name String
The unique name of the scheme.
Tags associated with the scheme.
id StringThe ID uniquely identifying the color scheme.
Defines the colors to use in each bin of the relationship visualization.
noDataColor ColorThe color of the line symbol used to indicate features with no data.
opacity NumberThe opacity of the line symbol (0 - 1).
width NumberThe width of the line symbol in points.
-
The return object of the getSchemes() method.
- Properties
-
primaryScheme RelationshipScheme
The relationship scheme best suited for the given basemap and geometry type.
secondarySchemes RelationshipScheme[]Additional relationship 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.