Learn how to determine the spatial relationship between geometries.
Move the graphics to view their spatial relationships. Use the sketch component to create new graphics.
A spatial relationship, also known as a spatial relation, is how one
In this tutorial, you will use geometry operators to determine spatial relationships between two intersectsOperator, disjointOperator, and withinOperator are used. If the operation is successful, then true is returned.
Prerequisites
Steps
Create a new pen
- To get started, either complete the Display a map tutorial or
.
Get an access token
You need an
- Go to the Create an API key tutorial and create an
API key with the followingprivilege(s) :
- Privileges
- Location services > Basemaps
- Privileges
- In CodePen, set the
apiKeyproperty on the globalesriConfigvariable to your access token.var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};
To learn about other ways to get an access token, go to Types of authentication.
Add HTML elements
Add an arcgis-sketch component to interactively draw geometries and graphics. We will also add a calcite list to display the spatial relationships between the drawn graphics.
-
In the
body, create a newarcgis-sketchcomponent. Hide some of the tools that are not needed for this tutorial using attributes. Also, disable the default graphics layer as we will be creating our own graphics layer.28 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch></arcgis-map></body>3 collapsed lines</html> -
Add a
calcite-listthat will display the spatial relationships between graphics in thetop-rightslot of the map.28 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map></body>3 collapsed lines</html> -
Add some CSS to format the results list. This class will set the list item’s background color to the calcite color for success. See the Calcite colors and theming documentation for more information.
16 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style>34 collapsed lines</head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map></body></html>
Add modules
- In a new
<script>at the bottom of the<body>, use$arcgis.import()to add theGraphic,GraphicsLayer, and geometry operator modules.The
ArcGIS Maps SDK for JavaScript is available via CDN and npm, but this tutorial is based on CDN. The$arcgis.importglobal function accepts a module path or array of module paths, and returns a promise that resolves with the requested modules. This function can only be used when working with the CDN; otherwise, use the standard import syntax. To learn more about the SDK’s different modules, visit the References page.60 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);</script>5 collapsed lines</body></html>
Create graphics
You need two geometries to execute a spatial relationship operation. Create a
-
Get references to the HTML elements in our app.
60 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");</script>5 collapsed lines</body></html> -
First, create a new
GraphicsLayer. Next, assign a newMapinstance to the viewElement’s map property, specifying “arcgis/topographic” as the basemap and adding the newly created graphics layer to the layers collection.60 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});</script>5 collapsed lines</body></html> -
Create a polyline graphic and add it to the
graphicsLayer.99 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);8 collapsed lines</script></body></html> -
Create a polygon graphic and add it to the
graphicsLayer.122 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);8 collapsed lines</script></body></html> -
Run the code to verify that the graphics appear in the view.
Set sketch component properties
Use the arcgis-sketch component and GraphicsLayer classes to interactively create a graphic and add it to the arcgis-map. An event handler will listen for a change from the sketch component and update the spatial relationship accordingly.
-
Set the
snappingOptionsandlayerproperties on the sketch component. This will allow you to move and update the line and polyline graphics created in the last step.145 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;8 collapsed lines</script></body></html> -
Run the code to verify that you can use the sketch component to move/update the line and polygon geometries created in the last step.
Determine spatial relationships
Spatial relationships are determined based on the interiors, boundaries, and exteriors of two geometries. Use geometry operators such as the containsOperator and the intersectsOperator to find the spatial relationship between the sketched geometries.
-
To format the results, create a
showSpatialRelationshipfunction. This function takes two parameters: a string representing the spatial relationship type and a value representing whether that relationship is true or false. Find the list item for the spatial relationship by querying the list for the proper id. If the value of the spatial relationship istrue, then apply thetrueCSS class to the appropriate list item. If it’sfalse, remove the CSS class.155 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}8 collapsed lines</script></body></html> -
Create a function called
onGraphicUpdate. If there are less than two graphics in thegraphicsLayerremove thetruecss class from all the calcite list items and return out of the function.164 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}}8 collapsed lines</script></body></html> -
If there are two graphics in the graphics layer, get the geometries to find the spatial relationships.
164 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}const geometry1 = graphicsLayer.graphics.getItemAt(0).geometry;const geometry2 = graphicsLayer.graphics.getItemAt(1).geometry;}8 collapsed lines</script></body></html> -
Test each spatial relationship on the two geometries and display the results in the list. Call the
showSpatialRelationshipfunction to display the results.164 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}const geometry1 = graphicsLayer.graphics.getItemAt(0).geometry;const geometry2 = graphicsLayer.graphics.getItemAt(1).geometry;const contains = containsOperator.execute(geometry1, geometry2);showSpatialRelationship("contains", contains);const crosses = crossesOperator.execute(geometry1, geometry2);showSpatialRelationship("crosses", crosses);const disjoint = disjointOperator.execute(geometry1, geometry2);showSpatialRelationship("disjoint", disjoint);const equals = equalsOperator.execute(geometry1, geometry2);showSpatialRelationship("equals", equals);const intersects = intersectsOperator.execute(geometry1, geometry2);showSpatialRelationship("intersects", intersects);const overlaps = overlapsOperator.execute(geometry1, geometry2);showSpatialRelationship("overlaps", overlaps);const touches = touchesOperator.execute(geometry1, geometry2);showSpatialRelationship("touches", touches);const within = withinOperator.execute(geometry1, geometry2);showSpatialRelationship("within", within);}8 collapsed lines</script></body></html>
Add event listeners
Create an event listener to register a change when a new graphic is drawn or updated. If you draw a new graphic, the last graphic from the graphics layer is removed. The onGraphicUpdate function is called to determine the spatial relationships between the remaining geometries.
-
Listen for events on the Sketch component. Watch for the
arcgisUpdate,arcgisUndo, orarcgisRedoevents, and call theonGraphicUpdatemethod to determine the spatial relationships when these events occur.201 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}const geometry1 = graphicsLayer.graphics.getItemAt(0).geometry;const geometry2 = graphicsLayer.graphics.getItemAt(1).geometry;const contains = containsOperator.execute(geometry1, geometry2);showSpatialRelationship("contains", contains);const crosses = crossesOperator.execute(geometry1, geometry2);showSpatialRelationship("crosses", crosses);const disjoint = disjointOperator.execute(geometry1, geometry2);showSpatialRelationship("disjoint", disjoint);const equals = equalsOperator.execute(geometry1, geometry2);showSpatialRelationship("equals", equals);const intersects = intersectsOperator.execute(geometry1, geometry2);showSpatialRelationship("intersects", intersects);const overlaps = overlapsOperator.execute(geometry1, geometry2);showSpatialRelationship("overlaps", overlaps);const touches = touchesOperator.execute(geometry1, geometry2);showSpatialRelationship("touches", touches);const within = withinOperator.execute(geometry1, geometry2);showSpatialRelationship("within", within);}["arcgisUpdate", "arcgisUndo", "arcgisRedo"].forEach((eventName) => {arcgisSketch.addEventListener(eventName, () => {onGraphicUpdate();});});7 collapsed lines</script></body></html> -
Listen for the
arcgisCreateevent on the Sketch component. When theevent.detail.stateis equal to"start", remove all but the first graphic in thegraphicsLayer. This will ensure there can only be two graphics in thegraphicsLayerat one time. Call theonGraphicUpdatefunction after the new graphic has been created to determine the spatial relationship between the geometries.201 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}const geometry1 = graphicsLayer.graphics.getItemAt(0).geometry;const geometry2 = graphicsLayer.graphics.getItemAt(1).geometry;const contains = containsOperator.execute(geometry1, geometry2);showSpatialRelationship("contains", contains);const crosses = crossesOperator.execute(geometry1, geometry2);showSpatialRelationship("crosses", crosses);const disjoint = disjointOperator.execute(geometry1, geometry2);showSpatialRelationship("disjoint", disjoint);const equals = equalsOperator.execute(geometry1, geometry2);showSpatialRelationship("equals", equals);const intersects = intersectsOperator.execute(geometry1, geometry2);showSpatialRelationship("intersects", intersects);const overlaps = overlapsOperator.execute(geometry1, geometry2);showSpatialRelationship("overlaps", overlaps);const touches = touchesOperator.execute(geometry1, geometry2);showSpatialRelationship("touches", touches);const within = withinOperator.execute(geometry1, geometry2);showSpatialRelationship("within", within);}["arcgisUpdate", "arcgisUndo", "arcgisRedo"].forEach((eventName) => {arcgisSketch.addEventListener(eventName, () => {onGraphicUpdate();});});arcgisSketch.addEventListener("arcgisCreate", async (event) => {if (event.detail.state === "start") {graphicsLayer.graphics = [graphicsLayer.graphics.shift()];}if (event.detail.state === "complete") {onGraphicUpdate();}});7 collapsed lines</script></body></html>
Initial load
-
Wait for the Sketch component to be ready with the
componentOnReadymethod, then use the sketch components’striggerUpdatemethod to select the polyline graphic so that the user knows they can move that graphic around. Call theonGraphicUpdateto calculate the spatial relationships on initial load.201 collapsed lines<html><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" /><title>ArcGIS Maps SDK for JavaScript Tutorials: Find spatial relationships</title><script>var esriConfig = {apiKey: "YOUR_ACCESS_TOKEN",};</script><!-- Load the ArcGIS Maps SDK for JavaScript from CDN --><script type="module" src="https://js.arcgis.com/5.0/"></script><style>html,body {height: 100%;margin: 0;}.true {--calcite-color-foreground-1: var(--calcite-color-status-success);}</style></head><body><arcgis-map center="-118.805, 34.020" zoom="13"><arcgis-zoom slot="top-left"></arcgis-zoom><arcgis-sketch creation-mode="continuous" default-graphics-layer-disabled hide-create-tools-pointhide-duplicate-button hide-selection-tools-lasso-selection hide-selection-tools-rectangle-selectionhide-settings-menu layout="horizontal" slot="bottom-right"></arcgis-sketch><calcite-list scale="s" slot="top-right" id="list" selection-mode="none"><calcite-list-item-group heading="Spatial relationships"><calcite-list-item id="contains" label="Contains"> </calcite-list-item><calcite-list-item id="crosses" label="Crosses"> </calcite-list-item><calcite-list-item id="disjoint" label="Disjoint"> </calcite-list-item><calcite-list-item id="equals" label="Equals"> </calcite-list-item><calcite-list-item id="intersects" label="Intersects"> </calcite-list-item><calcite-list-item id="overlaps" label="Overlaps"> </calcite-list-item><calcite-list-item id="touches" label="Touches"> </calcite-list-item><calcite-list-item id="within" label="Within"> </calcite-list-item></calcite-list-item-group></calcite-list></arcgis-map><script type="module">const [Graphic,Map,containsOperator,crossesOperator,disjointOperator,equalsOperator,intersectsOperator,overlapsOperator,touchesOperator,withinOperator,GraphicsLayer,] = await $arcgis.import(["@arcgis/core/Graphic.js","@arcgis/core/Map.js","@arcgis/core/geometry/operators/containsOperator.js","@arcgis/core/geometry/operators/crossesOperator.js","@arcgis/core/geometry/operators/disjointOperator.js","@arcgis/core/geometry/operators/equalsOperator.js","@arcgis/core/geometry/operators/intersectsOperator.js","@arcgis/core/geometry/operators/overlapsOperator.js","@arcgis/core/geometry/operators/touchesOperator.js","@arcgis/core/geometry/operators/withinOperator.js","@arcgis/core/layers/GraphicsLayer.js",]);const viewElement = document.querySelector("arcgis-map");const arcgisSketch = document.querySelector("arcgis-sketch");const list = document.querySelector("#list");const graphicsLayer = new GraphicsLayer();viewElement.map = new Map({basemap: "arcgis/topographic",layers: [graphicsLayer],});const polyline = {type: "polyline",paths: [[-13227000.704542402, 4032506.197638312],[-13223540.698857695, 4034443.92109266],[-13222135.94452635, 4032506.197638312],[-13221470.479577951, 4033494.9524006792],[-13221470.404932415, 4033494.9524006792],],spatialReference: {wkid: 102100,},};const simpleLineSymbol = {type: "simple-line",width: 2,};const polylineGraphic = new Graphic({geometry: polyline,symbol: simpleLineSymbol,});graphicsLayer.add(polylineGraphic);// Create a polygon geometryconst polygon = {type: "polygon",rings: [[-13228098.704542402, 4035365.9427463487],[-13226362.225451587, 4035365.9427463487],[-13226362.225451587, 4032059.2948176656],[-13228098.704542402, 4032059.2948176656],[-13228098.704542402, 4035365.9427463487],],spatialReference: {wkid: 102100,},};const simpleFillSymbol = {type: "simple-fill",};const polygonGraphic = new Graphic({geometry: polygon,symbol: simpleFillSymbol,});graphicsLayer.add(polygonGraphic);arcgisSketch.snappingOptions = {enabled: true,featureSources: [{layer: graphicsLayer,},],};arcgisSketch.layer = graphicsLayer;function showSpatialRelationship(string, value) {const listItem = list.querySelector(`#${string}`);if (value) {listItem.classList.add("true");} else {listItem.classList.remove("true");}}function onGraphicUpdate() {if (graphicsLayer.graphics.length < 2) {list.querySelectorAll("calcite-list-item").forEach((listItem) => {listItem.classList.remove("true");});return;}const geometry1 = graphicsLayer.graphics.getItemAt(0).geometry;const geometry2 = graphicsLayer.graphics.getItemAt(1).geometry;const contains = containsOperator.execute(geometry1, geometry2);showSpatialRelationship("contains", contains);const crosses = crossesOperator.execute(geometry1, geometry2);showSpatialRelationship("crosses", crosses);const disjoint = disjointOperator.execute(geometry1, geometry2);showSpatialRelationship("disjoint", disjoint);const equals = equalsOperator.execute(geometry1, geometry2);showSpatialRelationship("equals", equals);const intersects = intersectsOperator.execute(geometry1, geometry2);showSpatialRelationship("intersects", intersects);const overlaps = overlapsOperator.execute(geometry1, geometry2);showSpatialRelationship("overlaps", overlaps);const touches = touchesOperator.execute(geometry1, geometry2);showSpatialRelationship("touches", touches);const within = withinOperator.execute(geometry1, geometry2);showSpatialRelationship("within", within);}["arcgisUpdate", "arcgisUndo", "arcgisRedo"].forEach((eventName) => {arcgisSketch.addEventListener(eventName, () => {onGraphicUpdate();});});arcgisSketch.addEventListener("arcgisCreate", async (event) => {if (event.detail.state === "start") {graphicsLayer.graphics = [graphicsLayer.graphics.shift()];}if (event.detail.state === "complete") {onGraphicUpdate();}});await arcgisSketch.componentOnReady();arcgisSketch.triggerUpdate(polylineGraphic).then(onGraphicUpdate);8 collapsed lines</script></body></html>
Run the app
In CodePen, run your code to display the map.
The map loads and displays a line and polygon graphic. In the top right, the spatial relationships between the graphics are displayed. Move the graphics to see how the spatial relationships change. Create new graphics using the Sketch component to explore the spatial relationships between different geometry types.
What’s next?
Learn how to use additional SDK features and ArcGIS services in these tutorials: