location

AMD: require(["esri/smartMapping/symbology/location"], (locationSchemes) => { /* code goes here */ });
ESM: import * as locationSchemes from "@arcgis/core/smartMapping/symbology/location.js";
Object: esri/smartMapping/symbology/location
Since: ArcGIS Maps SDK for JavaScript 4.2

Object containing helper methods for generating optimal symbols for location-only visualizations. The getSchemes() method is used to generate symbol properties best suited to the given geometry type and basemap.

Method Overview

Name Return Type Summary Object
LocationScheme

Clones a location scheme object.

location
LocationSchemes

Returns a primary scheme and secondary schemes defining symbol properties for location-only visualizions in a FeatureLayer or SceneLayer.

location
Theme[]

Returns metadata for the available themes.

location

Method Details

cloneScheme

Method
cloneScheme(scheme){LocationScheme}

Clones a location scheme object.

Parameter

The location scheme object to clone.

Returns
Type Description
LocationScheme Returns a clone of the given location scheme object.
Example
// clones the primary scheme returned from the getSchemes() method
let locationScheme = primaryScheme.clone();

getSchemes

Method
getSchemes(params){LocationSchemes}

Returns a primary scheme and secondary schemes defining symbol properties for location-only visualizions in a FeatureLayer or SceneLayer. The basemap parameter determines the color of the graphics used to visualize each feature. The geometryType determines which type of symbol to return.

Parameters
Specification
params Object

See the table below for details of each parameter that may be passed to this function.

Specification
basemap String|Basemap
optional

The Esri basemap to pair with the visualization. This value indicates the best symbol color 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 basemapTheme parameter instead of this parameter.

basemapTheme String
optional

If 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 light or dark.

Possible Values:"light"|"dark"

geometryType String

The geometry type of the features to visualize.

Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"

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.

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.

Returns
Type Description
LocationSchemes Returns an object containing the optimal location scheme (and secondary schemes) to use for the given basemap.
Example
// gets the primary scheme for the features of the given geometry type and basemap
let schemes = locationSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

// the best default scheme for the layer, basemap, and theme
let primaryScheme = schemes.primaryScheme;

getThemes

Method
getThemes(basemap){Theme[]}

Returns metadata for the available themes. If a basemap is provided, returns themes that work best with the given basemap.

Parameter
basemap String|Basemap
optional

The Esri basemap string or object that will be used with the returned theme(s).

Returns
Type Description
Theme[] Returns an object containing information about the available themes for the given basemap.

Type Definitions

Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type.

LocationSchemeForMesh

Type Definition
LocationSchemeForMesh

Properties defining the location-only symbology scheme used to visualize mesh features.

Properties
color Color

The color of the fill symbol.

opacity Number

The opacity of the fill symbol.

LocationSchemeForPoint

Type Definition
LocationSchemeForPoint

Properties defining the location-only symbology scheme used to visualize point features.

Properties
color Color

The fill color of the marker symbol.

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 size of the marker symbol in pixels or points.

opacity Number

The opacity of the marker symbol.

LocationSchemeForPolygon

Type Definition
LocationSchemeForPolygon

Properties defining the location-only symbology scheme used to visualize polygon features.

Properties
color Color

The color of the fill symbol.

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

opacity Number

The opacity of the fill symbol.

LocationSchemeForPolyline

Type Definition
LocationSchemeForPolyline

Properties defining the location-only symbology scheme used to visualize polyline features.

Properties
color Color

The color of the line symbol.

width Number

The width of the line symbol in pixels or points.

opacity Number

The opacity of the line symbol.

LocationSchemes

Type Definition
LocationSchemes

The return object of the getSchemes() method.

Properties
primaryScheme LocationScheme

The location scheme best suited for the given basemap and geometry type.

secondarySchemes LocationScheme[]

Additional location 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.

basemapTheme String

Indicates whether the average basemap color is light or dark.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.