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

Object containing helper methods for getting optimal symbol themes used to create data-driven visualizations of unique values or types. The getSchemes() method is used to generate symbol properties best suited to the given basemap.

Method Overview

NameReturn TypeSummaryObject
Object

Clones a type scheme object.

more details
more detailstype
Object

Returns a primary scheme and secondary schemes defining symbol properties for type-based data-driven visualizions in a Layer.

more details
more detailstype

Method Details

cloneScheme(scheme){Object}

Clones a type scheme object.

Parameter:

The type scheme object to clone.

Returns:
TypeDescription
ObjectReturns a clone of the given type scheme object.
Example:
// clones the primary scheme returned from the getSchemes() method
var typeScheme = primaryScheme.clone();

getSchemes(params){Object}

Returns a primary scheme and secondary schemes defining symbol properties for type-based data-driven visualizions in a Layer. The basemap parameter determines the color of the graphics 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 against the given basemap.

geometryType String

The geometry type of the features to visualize.

Known Values: point | multipoint | polyline | polygon | mesh

theme String
optional

Determines whether to return a standardized unique value scheme for point cloud class renderers (i.e. when the CLASS_CODE field is driving the visualization in a PointCloudLayer), or to return the other default primary schemes used in other unique value renderers generated for non-point cloud layer types.

Known Values: point-cloud-class | default

Default Value: 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.

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:
TypeDescription
ObjectReturns an object containing the optimal type scheme to use for the given basemap; it also contains secondary schemes. See the table below for more details of this object.
PropertyTypeDescription
primarySchemePointTypeScheme | PolylineTypeScheme | PolygonTypeScheme | MeshTypeSchemeThe type scheme best suited for the given basemap and geometry type.
secondarySchemesObject[]Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
Example:
// gets the primary scheme for the features of the given geometry type and basemap
var schemes = sizeSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

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

Type Definitions

MeshTypeScheme

Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data.

Properties:
colors Color[]

The fill colors of the symbols comprising the theme.

noDataColor Color

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

opacity Number

The opacity of the symbol (0 - 1).

PointTypeScheme

Properties defining the symbology scheme used to visualize point features driven by type-based attribute data.

Properties:
colors Color[]

The fill colors of the point symbols comprising the theme.

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 pixels or points.

size Number

The default size of the point symbol in pixels, points, or real-world units.

opacity Number

The opacity of the point symbol.

PolygonTypeScheme

Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data.

Properties:
colors Color[]

The fill colors of the symbols comprising the theme.

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).

PolylineTypeScheme

Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data.

Properties:
colors Color[]

The colors of the line symbols comprising the theme.

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).

API Reference search results

NameTypeModule

There were no match results from your search criteria.