Method Overview

Method Details

cloneScheme(scheme){PredominanceScheme}

Clones a predominance scheme object.

Parameter:

scheme PredominanceScheme The predominance scheme object to clone.

Returns:

Type	Description
PredominanceScheme	Returns a clone of the given predominance scheme object.

Example:

// clones the primary scheme returned from the getSchemes() method
const predominanceScheme = primaryScheme.clone();

getSchemes(params){PredominanceSchemes}

Returns a primary scheme and secondary schemes defining symbol properties for predominance-based data-driven visualizations in a Layer. The basemap parameter determines the color of the symbols used to visualize each feature. The geometryType determines which type of symbol to return.

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 symbol color for visualizing features with the given basemap. geometryType String The geometry type of the features to visualize. Possible Values: point | multipoint | polyline | polygon | mesh numColors Number The number of unique values to include in the predominance visualization. theme String optional Default Value: default Determines which set of primary and secondary color schemes to return Possible Values: default worldScale Boolean optional Indicates if the size units of the scheme will be in meters. This should be true when the scheme is intended for 3D volumetric symbology. A view must be provided if this property is set to true. view SceneView optional The 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.

Returns:

Type	Description
PredominanceSchemes	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 = predominanceSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

// the best default scheme for the layer and basemap
const primaryScheme = schemes.primaryScheme;

Type Definitions

PredominanceSchemePredominanceSchemeForPoint|PredominanceSchemeForPolyline|PredominanceSchemeForPolygon|PredominanceSchemeForMesh

Defines the symbology scheme used to visualize predominance based on the layer's geometry type.

PredominanceSchemeForMesh

Properties defining the symbology scheme used to visualize predominance for mesh features.

Properties:

colors Color[] The fill colors of the mesh symbols used for each category.

noDataColor Color The color of the fill symbol used to indicate features with no data.

opacity Number The opacity of the symbol (0 - 1).

PredominanceSchemeForPoint

Properties defining the symbology scheme used to visualize predominance for point features.

Properties:

colors Color[] The fill colors of the point symbols used for each category.

noDataColor Color The color of the point symbol used to indicate features with no data.

outline Object Properties for defining the outline of the marker symbol. Specification: color Color The outline color of the marker symbol. width Number The width of the marker symbol in points.

opacity Number The opacity of the point symbol (0 - 1).

sizeScheme SizeSchemeForPoint The scheme defining the size visual variable if included in a predominance visualization.

PredominanceSchemeForPolygon

Properties defining the symbology scheme used to visualize predominance for polygon features.

Properties:

colors Color[] The fill colors of the polygon symbols used for each category.

noDataColor Color The color of the fill symbol used to indicate features with no data.

outline Object Properties for defining the outline of the fill symbol. Specification: color Color The outline color of the fill symbol. width Number The width of the fill symbol's outline in pixels or points.

opacity Number The opacity of the symbol (0 - 1).

sizeScheme SizeSchemeForPolygon The scheme defining the size visual variable if included in a predominance visualization.

PredominanceSchemeForPolyline

Properties defining the symbology scheme used to visualize predominance for polyline features.

Properties:

colors Color[] The colors of the line symbols used for each category.

noDataColor Color The color of the line symbol used to indicate features with no data and features that are out of range.

width Number The default width of the line symbol in pixels or points.

opacity Number The opacity of the line symbol (0 - 1).

sizeScheme SizeSchemeForPolyline The scheme defining the size visual variable if included in a predominance visualization.

PredominanceSchemes

The return object of the getSchemes() method.

Properties:

primaryScheme PredominanceScheme The predominance scheme best suited for the given basemap and geometry type.

secondarySchemes PredominanceScheme[] Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId String The ID of the basemap associated with the given schemes.