Geometry Functions
The following functions allow you to create and evaluate geometry objects. Please note that if your input has more than one geometry, they must have the same spatial reference.
Since Arcade expressions execute for each feature, using multiple geometry operations within the context of the labeling and visualization profiles can be expensive and severely impact the performance of the application. Also note that geometries fetched from feature services, especially polylines and polygons, are generalized according to the view's scale resolution. Be aware that using a feature's geometry (i.e. $feature
) as input to any geometry function will yield results only as precise as the view scale. Therefore, results returned from geometry operations in the visualization and labeling profiles may be different at each scale level. Use these functions at your discretion within these contexts.
Geometry functions are not supported in the Dashboard formatting profile.
Units reference
If a function references units, then any of the values described in the table below may be used. Units can either be identified as a number or a string. If the value is a number, it will be based on the standard referenced here. Where appropriate, linear and areal units may be used interchangeably. For example, if calculating an area and meters
is specified as the unit, then the unit will be treated as squaremeters
and vice versa.
Unit value  Alternate values 

acres * 
acre , ac 
feet 
foot , ft , squarefeet , squarefoot , squarefeet , squarefoot 
hectares * 
hectare , ha 
kilometers 
kilometer , km , squarekilometers , squarekilometer , squarekilometers , squarekilometer 
miles 
mile , squaremiles , squaremile , squaremiles , squaremile 
nauticalmiles 
nauticalmile , squarenauticalmiles , squarenauticalmile , squarenauticalmiles , squarenauticalmile 
meters 
meter , m , squaremeters , squaremeter , squaremeters , squaremeter 
yards 
yard , yd , squareyards , squareyard , squareyards , squareyard 
* Indicates the unit may only be used for calculating areas.
Angle
This function has 2 signatures:
Angle(pointA, pointB) > Number
Returns the arithmetic angle of a line between two points in degrees (0  360). The angle is measured in a counterclockwise direction relative to east. For example, an angle of 90 degrees points due north.
Only the xy plane is considered for the measurement. Any zcoordinates are ignored. Point features can be used instead of any or both Point geometries. If the points are identical, then an angle of 0 degrees is returned.
See bearing.
Parameters
 pointA: Point  Feature  The first Point or Feature used to calculate the angle.
 pointB: Point  Feature  The second Point or Feature used to calculate the angle.
Return value: Number
Example
Returns the angle from a Point to a Feature, in degrees
var pointA = Point({ "x":976259, "y":8066511, "spatialReference": { "wkid": 3857 } });
Angle(pointA, $feature)
Angle(pointA, pointB, pointC) > Number
Returns the arithmetic angle of a line between three points in degrees (0  360). The angle is measured around pointB
in a counterclockwise direction, from pointA
to pointC
.
Only the xy plane is considered for the measurement. Any zcoordinates are ignored. Point features can be used instead of either or all Point geometries. If the points are identical, then an angle of 0 or 180 degrees is returned (depending internal arithmetic).
See bearing.
Parameters
 pointA: Point  Feature  The first Point or Feature used to calculate the angle.
 pointB: Point  Feature  The second Point or Feature used to calculate the angle.
 pointC: Point  Feature  The third Point or Feature used to calculate the angle.
Return value: Number
Example
Returns the angle between two points around the feature, in degrees
var pointA = Point({ "x":976259, "y":8066511, "spatialReference": { "wkid": 3857 } });
var pointC = Point({ "x":308654, "y":9005421, "spatialReference": { "wkid": 3857 } });
Angle(pointA, $feature, pointC)
Area
This function has 2 signatures:
Area(polygon, unit?) > Number
Returns the area of the input geometry or Feature in the given units. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 polygon: Polygon  Feature  Array<Point>  The Polygon or Feature for which to calculate the planar area.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the area of the feature in square meters
Area($feature, 'squaremeters')
Area(features, unit?) > Number
Returns the area of the input FeatureSet in the given units. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet for which to calculate the planar area.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the area of the layer in square kilometers
Area($layer, 'squarekilometers')
AreaGeodetic
This function has 2 signatures:
AreaGeodetic(polygon, unit?) > Number
Returns the geodetic area of the input geometry or Feature in the given units. This is more reliable measurement of area than Area() because it takes into account the Earth's curvature. Support is limited to geometries with a Web Mercator (wkid 3857) or a WGS 84 (wkid 4326) spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 polygon: Polygon  Feature  Array<Point>  The Polygon or Feature for which to calculate the geodetic area.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the geodetic area of the feature in square meters
AreaGeodetic($feature, 'squaremeters')
AreaGeodetic(features, unit?) > Number
Returns the geodetic area of the input FeatureSet in the given units. This is more reliable measurement of area than Area() because it takes into account the Earth's curvature. Support is limited to geometries with a Web Mercator (wkid 3857) or a WGS 84 (wkid 4326) spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet for which to calculate the geodetic area.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the geodetic area of the layer in square kilometers
AreaGeodetic($layer, 'squarekilometers')
Bearing
This function has 2 signatures:
Bearing(pointA, pointB) > Number
Returns the geographic angle of a line between two points in degrees (0  360). The bearing is measured in a clockwise direction relative to north. For example, a bearing of 225 degrees represents a southwest orientation.
Only the xy plane is considered for the measurement. Any zcoordinates are ignored. Point features can be used instead of either or both Point geometries. If the points are identical, then an angle of 0 is returned.
See also angle.
Parameters
 pointA: Point  Feature  The first point used to calculate the bearing.
 pointB: Point  Feature  The second point used to calculate the bearing.
Return value: Number
Example
Returns the bearing from a point to the feature, in degrees
var pointA = Point({ "x":976259, "y":8066511, "spatialReference": { "wkid": 3857 } });
Bearing(pointA,$feature)
Bearing(pointA, pointB, pointC) > Number
Returns the geographic angle of a line between three points in degrees (0  360). The bearing is measured around pointB
in a clockwise direction, from pointA
to pointC
.
Only the xy plane is considered for the measurement. Any zcoordinates are ignored. Point features can be used instead of any or all Point geometries. If the points are identical, then an angle of 0 or 180 degrees is returned (depending internal arithmetic).
See also angle.
Parameters
 pointA: Point  Feature  The first point used to calculate the bearing.
 pointB: Point  Feature  The second point used to calculate the bearing.
 pointC: Point  Feature  The third point used to calculate the bearing.
Return value: Number
Example
Returns the bearing between two points around the feature, in degrees
var pointA = Point({ "x":976259, "y":8066511, "spatialReference": { "wkid": 3857 } });
var pointC = Point({ "x":308654, "y":9005421, "spatialReference": { "wkid": 3857 } });
Bearing(pointA,$feature,pointC)
Buffer
Buffer(inputGeometry, distance, unit?) > Polygon
Returns the planar (or Euclidean) buffer at a specified distance around the input geometry. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The geometry to buffer.
 distance: Number  The distance to buffer from the geometry.
 unit (Optional): Text  Number  Measurement unit of the buffer
distance
. Use one of the string values listed in the Units reference.
Return value: Polygon
Example
Returns a polygon representing a 1/2mile buffer around the input geometry
Buffer($feature, 0.5, 'miles')
BufferGeodetic
BufferGeodetic(inputGeometry, distance, unit?) > Polygon
Returns the geodetic buffer at a specified distance around the input geometry. This is a geodesic measurement, which calculates distances on an ellipsoid. Support is limited to geometries with a Web Mercator (wkid 3857) or a WGS 84 (wkid 4326) spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The geometry to buffer.
 distance: Number  The distance to buffer from the geometry.
 unit (Optional): Text  Number  Measurement unit of the buffer
distance
. Use one of the string values listed in the Units reference.
Return value: Polygon
Example
Returns a polygon representing a 1/2mile buffer around the input geometry
BufferGeodetic($feature, 0.5, 'miles')
Centroid
Centroid(polygon) > Point
Returns the centroid of the input geometry.
Parameter
Return value: Point
Examples
Returns the centroid of the given polygon
Centroid($feature)
Returns the centroid of the given polygon ring
var ringPoints = Geometry($feature).rings[0];
Centroid(ringPoints);
Clip
Clip(inputGeometry, envelope) > Geometry
Calculates the clipped geometry from a target geometry by an envelope.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The geometry to be clipped.
 envelope: Extent  The envelope used to clip the
geometry
.
Return value: Geometry
Example
Returns the area of the clipped geometry
var envelope = Extent({ ... });
Area(Clip($feature, envelope), 'squaremiles');
Contains
This function has 2 signatures:
 Contains(containerGeometry, insideGeometry) > Boolean
 Contains(containerGeometry, insideFeatures) > FeatureSet
Contains(containerGeometry, insideGeometry) > Boolean
Indicates if one geometry contains another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 containerGeometry: Geometry  Feature  The geometry that is tested for the 'contains' relationship to
insideGeometry
. Think of this geometry as the potential 'container' of theinsideGeometry
.  insideGeometry: Geometry  Feature  The geometry that is tested for the 'within' relationship to the
containerGeometry
.
Return value: Boolean
Example
Returns true if the feature is contained within the given polygon
var container = Polygon({ ... });
Contains(containerGeometry, $feature);
Contains(containerGeometry, insideFeatures) > FeatureSet
Returns features from a FeatureSet that are contained within the input geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 containerGeometry: Geometry  Feature  The geometry that is tested for the 'contains' relationship to
insideFeatures
. Think of this geometry as the potential 'container' of theinsideFeatures
.  insideFeatures: FeatureSet  The FeatureSet that is tested for the 'within' relationship to the
containerGeometry
.
Return value: FeatureSet
Example
Returns the number of features that are within the given polygon
var parcels = FeatureSetByName($map, 'parcels')
var projectArea = $feature;
Count(Contains(projectArea, parcels));
ConvertDirection
ConvertDirection(input, inputSpec, outputSpec) > Array<Number  Text>  Number  Text
Angles can have several interpretations and can be represented as a number, a text, or a well formed array. This function takes one input representation and converts it to another.
The input value is described by a dictionary that specified the type of angle and the type of direction. Examples:
input  angle type  direction type 

12.34  dms, degrees, radians, gradians  north, south, polar 
12.3456  dms, degrees, radians, gradians  north, south, polar 
[12,34,56]  dms  north, south, polar 
['N',12.34,'W']  dms, degrees, radians, gradians  quadrant 
['N',12,34,56,'W']  dms  quadrant 
'12.34'  dms, degrees, radians, gradians  north, south, polar 
'12 34 56'  dms  north, south, polar 
'N 12.34 W'  dms, degrees, radians, gradians  quadrant 
'N 12 34 56 W'  dms  quadrant 
If the angleType
and directionType
are not appropriate for the input, then the conversion will fail.
The desired output value is as well described by a dictionary that specidies output type, angle type, direction type, and an optional format for text ouput.
If the output type is value
:
 an array will be returned for angle type
dms
or for direction typequadrant
 a number will be returned for all the other cases
If the output type is text
, then default padding and delimeters will be used unless the optionalformat
property is provided.
format
controls order, spacing, padding, and delimeters in the output text.
Strings of format specifier characters before a decimal point indicate minimum padding (e.g. DDD > 000
).
Strings of format characters after a decimal point indicate precision (e.g. D.DD > 0.00
).
Supported format
characters:
Code  Meaning 

D 
Decimal Degrees 
R 
Radians 
G 
Gradians 
d 
DMS Degrees 
m 
DMS Minutes 
s 
DMS Seconds 
P 
Long Meridian (e.g. North vs. South ) 
p 
Short Meridian (e.g. N vs. S ) 
B 
Long direction (e.g. East vs. West ) 
b 
Short direction (e.g. E vs. W ) 
[ ] 
Escape characters 
For dms
formatting, if the s
is not used then m
will round to the nearest minute. Similarly, if m
is not used then d
will round.
Parameters

input: Array<Number  Text>  Number  Text  A raw representation of the bearing. The type of
input
and the values of theinputSpec
dictate how the input is parsed. 
inputSpec: Dictionary  Contains information about how to interpret input.
 angleType: Text  Describes the input angle unit.
Supported Values: DEGREES
, DMS
, RADIANS
, GONS
, GRADIANS
 directionType: Text  Describes the input bearing's meridian and direction.
Supported Values: NORTH
, SOUTH
, POLAR
, QUADRANT

outputSpec: Dictionary  Contains information about how to format the output. See the properties of the outputSpec here.
 outputType: Text  Controls output type.
Supported Values: value
, text
 angleType: Text  Describes the output angle unit.
Supported Values: DEGREES
, DMS
, RADIANS
, GONS
, GRADIANS
 directionType: Text  Describes the output bearing's meridian and direction.
Supported Values: NORTH
, SOUTH
, POLAR
, QUADRANT
 format (Optional): Text  Controls text formatting. Only applicable if
outputType
istext
.
Return value: Array<Number  Text>  Number  Text
Examples
Examples where the outputType
is value
.
ConvertDirection( 30, {directionType:'North', angleType: 'Degrees'}, {directionType:'Quadrant', angleType: 'DMS', outputType: 'value'})
// returns ['N', 30, 0, 0, 'E']
ConvertDirection( 25.99, {directionType:'North', angleType : 'Gradians'}, {directionType:'North', outputType: 'value', angleType : 'Gradians'})
// returns 25.99
ConvertDirection( 1, {directionType:'North', angleType: 'DEGREES'}, {directionType: 'Quadrant', angleType: 'Degrees', outputType: 'value'})
// returns ['N',1,'E']
ConvertDirection( 0.9, {directionType: 'North', angleType: 'degrees'}, {directionType:'North', angleType: 'gradians', outputType: 'value'})
// returns 1.0
ConvertDirection( 180.0, {directionType:'North', angleType: 'degrees'}, {directionType:'North', angleType: 'radians', outputType : 'value'})
// returns PI
Examples where outputType
is text
.
ConvertDirection( 25.34, {directionType: 'North', angleType: 'DEGREES'}, {directionType:'North', outputType: 'text', format: 'DDDD.D'})
// returns '0025.3'
ConvertDirection( 25.34, {directionType: 'North', angleType: 'DEGREES'}, {directionType:'North', outputType: 'text', format: 'R'})
// returns '0'
ConvertDirection( 25.34, {directionType: 'North', angleType: 'DEGREES'}, {directionType:'North', outputType: 'text', format: '[DD.DD]'})
// returns 'DD.DD'
ConvertDirection( 25.34, {directionType:'North', angleType: 'DEGREES'}, {directionType:'quadrant', outputType: 'text', format: 'P B'})
// returns 'North East'
ConvertDirection( [001,01,59.99], {directionType:'North', angleType: 'DMS'}, {directionType:'North', angleType: 'DMS', outputType: 'text', format: 'dddA mm[B] ssC'})
// returns '001A 02B 00C'
Crosses
This function has 2 signatures:
Crosses(geometry1, geometry2) > Boolean
Indicates if one geometry crosses another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The geometry to cross.
 geometry2: Geometry  Feature  The geometry being crossed.
Return value: Boolean
Example
Returns true if the feature crosses the given polygon
var geom2 = Polygon({ ... });
Crosses($feature, geom2);
Crosses(features, crossingGeometry) > FeatureSet
Returns features from a FeatureSet that cross the input geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The features to test the crosses relationship with the input
crossingGeometry
.  crossingGeometry: Geometry  Feature  The geometry being crossed.
Return value: FeatureSet
Example
Returns the number of features in the FeatureSet that cross the given polygon
var geom2 = Polygon({ ... });
Count( Crosses($layer, geom2) );
Cut
Cut(polylineOrPolygon, cutter) > Array<Geometry>
Splits the input Polyline or Polygon where it crosses a cutting Polyline. For Polylines, all resulting left cuts are grouped together in the first Geometry. Right cuts and coincident cuts are grouped in the second Geometry. Each undefined cut, along with any uncut parts, are output as separate Polylines.
For Polygons, all resulting left cuts are grouped in the first Polygon, all right cuts are grouped in the second Polygon, and each undefined cut, along with any leftover parts after cutting, are output as a separate Polygon. If no cuts are returned then the array will be empty. An undefined cut will only be produced if a left cut or right cut was produced and there was a part left over after cutting, or a cut is bounded to the left and right of the cutter.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 polylineOrPolygon: Polyline  Polygon  Feature  The geometry to cut.
 cutter: Polyline  Feature  The Polyline used to cut the
geometry
.
Example
Cuts the feature's geometry with the given polyline
var cutter = Polyline({ ... });
Cut($feature, cutter));
Densify
Densify(inputGeometry, maxSegmentLength, unit?) > Geometry
Densifies geometries by inserting vertices to create segments no longer than the specified interval.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The input geometry to be densified.
 maxSegmentLength: Number  The maximum segment length allowed. Must be a positive value.
 unit (Optional): Text  Number  Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. Use one of the string values listed in the Units reference.
Return value: Geometry
Example
Returns the densified geometry with a maximum segment length of 10 m
var maxLength = 10;
Densify($feature, maxLength, 'meters');
DensifyGeodetic
DensifyGeodetic(inputGeometry, maxSegmentLength, unit?) > Geometry
Geodesically densifies geometries by inserting vertices to create segments no longer than the specified interval.
**Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. ** Read more here.
Parameters
 inputGeometry: Geometry  Feature  The input geometry to be densified.
 maxSegmentLength: Number  The maximum segment length allowed. Must be a positive value.
 unit (Optional): Text  Number  Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. Use one of the string values listed in the Units reference.
Return value: Geometry
Example
Returns the densified geometry with a maximum segment length of 10000
DensifyGeodetic($feature, 10000, 'meters');
Difference
Difference(inputGeometry, subtractor) > Geometry
Performs the topological difference operation for the two geometries. The resultant geometry comes from inputGeometry
, not the subtractor
. The dimension of subtractor
has to be equal to or greater than that of inputGeometry
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The input geometry from which to subtract.
 subtractor: Geometry  Feature  The geometry to subtract from
geometry
.
Return value: Geometry
Example
Subtracts the given polygon area from the feature.
var subtractor = Polygon({ ... });
Difference($feature, subtractor);
Disjoint
Disjoint(geometry1, geometry2) > Boolean
Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. In the table below, the red highlight indicates that the function would return true
with the specified geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The base geometry that is tested for the 'disjoint' relationship to
geometry2
.  geometry2: Geometry  Feature  The comparison geometry that is tested for the 'disjoint' relationship to
geometry1
.
Return value: Boolean
Example
Returns true if the geometries don't intersect
var geom2 = Polygon({ ... });
Disjoint($feature, geom2);
Distance
Distance(geometry1, geometry2, unit?) > Number
Returns the planar distance between two geometries in the given units. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  Array<Point>  The geometry used to measure the distance from
geometry2
.  geometry2: Geometry  Feature  Array<Point>  The geometry used to measure the distance from
geometry1
.  unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the distance between two geometries in meters
var geom2 = Point({ ... });
Distance($feature, geom2, 'meters')
DistanceGeodetic
DistanceGeodetic(point1, point2, units?) > Number
Calculates the shortest distance between two points along a great circle. Applies only to points with a Geographic Coordinate System (GCS) or the Web Mercator spatial reference. If the input points have a Projected Coordinate System (other than Web Mercator), you should use the distance method.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 point1: Point  Feature  The point used to measure the distance from
point2
. This point must have a GCS or Web Mercator spatial reference.  point2: Point  Feature  The point used to measure the distance from
point1
. This point must have a GCS or Web Mercator spatial reference.  units (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the distance from a bus in a stream layer to the central station in kilometers
var unionStation = Point({"x": 118.15, "y": 33.80, "spatialReference": { "wkid": 3857 }});
distanceGeodetic($feature, unionStation, 'kilometers');
EnvelopeIntersects
This function has 2 signatures:
 EnvelopeIntersects(geometry1, geometry2) > Boolean
 EnvelopeIntersects(features, envelope) > FeatureSet
EnvelopeIntersects(geometry1, geometry2) > Boolean
Indicates if the envelope (or extent) of one geometry intersects the envelope of another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The geometry that is tested for the intersects relationship to the other geometry.
 geometry2: Geometry  Feature  The geometry being intersected.
Return value: Boolean
Example
Returns true if the geometries intersect
var geom2 = Polygon({ ... });
EnvelopeIntersects($feature, geom2);
EnvelopeIntersects(features, envelope) > FeatureSet
Returns features from a FeatureSet where the envelopes (or extent) of a set of features intersect the envelope of another geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet that is tested for the intersects relationship to the input
envelope
.  envelope: Geometry  Feature  The envelope being intersected.
Return value: FeatureSet
Example
Returns the number of features that intersect the envelope of geom2
var geom2 = Polygon({ ... });
Count( EnvelopeIntersects($layer, geom2) );
Equals
Equals(geometry1, geometry2) > Boolean
Indicates if two geometries are equal, or geographically equivalent given the spatial reference and tolerance of the data. The two input geometries don't have to be clones to be considered equal.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The first input geometry.
 geometry2: Geometry  Feature  The second input geometry.
Return value: Boolean
Example
Returns true if the geometries are equal
var geom2 = Point({ ... });
Equals($feature, geom2);
Extent
Extent(inputGeometry) > Extent
Constructs an Extent object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for Envelope geometries. This function may also return the extent of an input Polygon, Point, Polyline or Multipoint.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 inputGeometry: Dictionary  Geometry  Feature  The JSON or Geometry from which to construct the extent geometry object.
Return value: Extent
Examples
// Creates an Extent object
var extentJSON = {
"xmin": 109.55, "ymin": 25.76, "xmax": 86.39, "ymax": 49.94,
"spatialReference": { "wkid": 3857 }
};
Extent(extentJSON);
// Returns the Extent of the given feature
Extent($feature)
Generalize
Generalize(inputGeometry, maxDeviation, removeDegenerateParts?, maxDeviationUnit?) > Geometry
Reduces the number of vertices in the input geometry based on a given deviation value. Point and Multipoint geometries are left unchanged. Envelopes are converted to Polygons and then generalized.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The input geometry to be generalized.
 maxDeviation: Number  The maximum allowed deviation from the generalized geometry to the original geometry.
 removeDegenerateParts (Optional): Boolean  When
true
the degenerate parts of the geometry will be removed from the output (may be undesired for drawing).  maxDeviationUnit (Optional): Text  Number  Measurement unit for maxDeviation. Defaults to the units of the input geometry. Use one of the string values listed in the Units reference.
Return value: Geometry
Example
Returns a generalized version of the input geometry
// Removes vertices so segments are no more than 100 meters from the original geometry
Generalize($feature, 100, true, 'meters')
Geometry
Geometry(inputFeature) > Geometry
Constructs a Geometry object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for geometries. This function may also return the Geometry of an input feature.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 inputFeature: Feature  Dictionary  The Feature or JSON from which to construct the geometry object.
Return value: Geometry
Examples
Returns the geometry of the feature
Geometry($feature)
Constructs a point geometry. This can be done with any geometry type.
var pointJSON = {"x": 118.15, "y": 33.80, "spatialReference": { "wkid": 4326 } };
Geometry(pointJSON);
Intersection
Intersection(geometry1, geometry2) > Geometry
Constructs the settheoretic intersection between two geometries and returns a new geometry.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The geometry to intersect with
geometry2
.  geometry2: Geometry  Feature  The geometry to intersect with
geometry1
.
Return value: Geometry
Example
Returns the area common to both polygons
var geom2 = Polygon({ ... });
Area(Intersection($feature, geom2), 'squaremiles');
Intersects
This function has 2 signatures:
Intersects(geometry1, geometry2) > Boolean
Indicates if one geometry intersects another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The geometry that is tested for the intersects relationship to
geometry2
.  geometry2: Geometry  Feature  The geometry being intersected.
Return value: Boolean
Example
Returns true if the geometries intersect
var geom2 = Polygon({ ... });
Intersects($feature, geom2);
Intersects(features, inputGeometry) > FeatureSet
Returns features from a FeatureSet that intersect another geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet that is tested for the intersects relationship to
geometry
.  inputGeometry: Geometry  Feature  The geometry being intersected.
Return value: FeatureSet
Example
Returns the number of features that intersect the polygon
var geom2 = Polygon({ ... });
Count( Intersects($layer, geom2) );
IsSelfIntersecting
IsSelfIntersecting(inputGeometry) > Boolean
Indicates whether the input geometry has rings, paths, or points that intersect or cross other parts of the geometry. For example, a single polyline feature whose paths intersect each other or a polygon with rings that self intersect would return true
.
Parameter
 inputGeometry: Geometry  Feature  The polygon, polyline, or multipoint geometry to test for the self intersection.
Return value: Boolean
Example
Returns true if the polyline's paths intersect each other
var polyline = Polyline({ ... });
IsSelfIntersecting(polyline);
IsSimple
IsSimple(inputGeometry) > Boolean
Indicates if the given geometry is topologically simple.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
Return value: Boolean
Example
Returns true if the geometry is topologically simple
IsSimple($feature);
Length
This function has 2 signatures:
Length(inputGeometry, unit?) > Number
Returns the length of the input geometry or Feature in the given units. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  Array<Point>  The geometry or geometries for which to calculate the planar length.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the planar length of the feature in kilometers
Length($feature, 'kilometers')
Length(features, unit?) > Number
Returns the length of the input FeatureSet in the given units. This is a planar measurement using Cartesian mathematics.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet for which to calculate the planar length.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the planar length of the layer in meters
Length($layer, 'meters')
Length3D
This function has 2 signatures:
Length3D(inputGeometry, unit?) > Number
Profiles: Attribute Rules  Popups  Field Calculation  Form Calculation  Tasks
Returns the planar (i.e. Cartesian) length of the input geometry or Feature taking height or Z information into account. The geometry provided to this function must be assigned a projected coordinate system. If the spatial reference does not provide a value for Z units, then the result will be returned in meters. Keep in mind that not all clients (such as the 3.x series of the ArcGIS API for JavaScript) support requesting Z values even when the data contains Z information.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  Array<Point>  The geometry or Feature for which to calculate the planar length in 3D space.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Examples
Returns the 3D planar length of the feature in the unit of the spatial reference of the context executing the expression.
Length3D($feature)
Returns the 3D planar length of the feature in feet.
Length3D($feature, 'feet')
Length3D(features, unit?) > Number
Profiles: Attribute Rules  Popups  Field Calculation  Form Calculation  Tasks
Returns the planar (i.e. Cartesian) length of the input FeatureSet taking height or Z information into account. The geometry provided to this function must be assigned a projected coordinate system. If the spatial reference does not provide a value for Z units, then the result will be returned in meters. Keep in mind that not all clients (such as the 3.x series of the ArcGIS API for JavaScript) support requesting Z values even when the data contains Z information.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet for which to calculate the planar length in 3D space.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the 3D length of the layer's features in meters
Length($layer, 'meters')
LengthGeodetic
This function has 2 signatures:
LengthGeodetic(inputGeometry, unit?) > Number
Returns the geodetic length of the input geometry or Feature in the given units. This is more reliable measurement of length than Length() because it takes into account the Earth's curvature. Support is limited to geometries with a Web Mercator (wkid 3857) or a WGS 84 (wkid 4326) spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  Array<Point>  The geometry for which to calculate the geodetic length.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the geodetic length of the feature in kilometers
LengthGeodetic($feature, 'kilometers')
LengthGeodetic(features, unit?) > Number
Returns the geodetic length of the input FeatureSet in the given units. This is more reliable measurement of length than Length() because it takes into account the Earth's curvature. Support is limited to geometries with a Web Mercator (wkid 3857) or a WGS 84 (wkid 4326) spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 features: FeatureSet  The FeatureSet for which to calculate the geodetic length.
 unit (Optional): Text  Number  Measurement unit of the return value. Use one of the string values listed in the Units reference.
Return value: Number
Example
Returns the geodetic length of the layer in meters
LengthGeodetic($layer, 'meters')
MultiPartToSinglePart
MultiPartToSinglePart(inputGeometry) > Array<Geometry>
Converts a multipart geometry into separate geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
Example
Returns an array of singlepart geometries from a multipart geometry
var allParts = MultiPartToSinglePart($feature)
Multipoint
Multipoint(definition) > Multipoint
Constructs a Multipoint object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for multipoint geometries
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 definition: Dictionary  The JSON from which to construct the multipoint geometry object.
Return value: Multipoint
Example
// Creates a Multipoint object
var multipointJSON = {
"points": [[97.06138,32.837],[97.06133,32.836],[97.06124,32.834],[97.06127,32.832]],
"spatialReference" : { "wkid": 3857 }
};
Multipoint(multipointJSON);
Offset
Offset(inputGeometry, offsetDistance, offsetUnit?, joinType?, bevelRatio?, flattenError?) > Geometry
Creates a geometry that is a constant planar distance from an input geometry. It is similar to buffering, but produces a onesided result.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The geometry to offset. Point geometries are not supported.
 offsetDistance: Number  The planar distance to offset from the input geometry. If
offsetDistance > 0
, then the offset geometry is constructed to the right of the input geometry, ifoffsetDistance = 0
, then there is no change in the geometries, otherwise it is constructed to the left. The direction of the paths or rings of the input geometry determines which side of the geometry is considered right, and which side is considered left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the right side of a simple polygon is always its inside.  offsetUnit (Optional): Text  Number  Measurement unit for
offsetDistance
. Defaults to the units of the input geometry. Use one of the string values listed in the Units reference.  joinType (Optional): Text  The join type. Possible values are
round
,bevel
,miter
, orsquare
.  bevelRatio (Optional): Number  Applicable when
joinType = 'miter'
;bevelRatio
is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled.  flattenError (Optional): Number  Applicable when
joinType = 'round'
;flattenError
determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join.
Return value: Geometry
Example
Returns the offset geometry
Offset($feature, 10, 'meters', 'square');
Overlaps
This function has 2 signatures:
 Overlaps(geometry1, geometry2) > Boolean
 Overlaps(overlappingFeatures, inputGeometry) > FeatureSet
Overlaps(geometry1, geometry2) > Boolean
Indicates if one geometry overlaps another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The base geometry that is tested for the 'overlaps' relationship with
geometry2
.  geometry2: Geometry  Feature  The comparison geometry that is tested for the 'overlaps' relationship with
geometry1
.
Return value: Boolean
Example
Returns true if the geometries overlap
var geom2 = Polygon({ ... });
Overlaps($feature, geom2);
Overlaps(overlappingFeatures, inputGeometry) > FeatureSet
Returns features from a FeatureSet that overlap another geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 overlappingFeatures: FeatureSet  The features that are tested for the 'overlaps' relationship with
geometry
.  inputGeometry: Geometry  Feature  The comparison geometry that is tested for the 'overlaps' relationship with
overlappingFeatures
.
Return value: FeatureSet
Example
Returns the number of features that overlap the polygon
var geom2 = Polygon({ ... });
Count( Overlaps($layer, geom2) );
Point
Point(definition) > Point
Constructs a Point object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for Point geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 definition: Dictionary  The JSON from which to construct the point geometry object.
Return value: Point
Example
// Creates a Point object
var pointJSON = { "x": 118.15, "y": 33.80, "spatialReference": { "wkid": 4326 }};
Point(pointJSON)
Polygon
Polygon(definition) > Polygon
Constructs a Polygon object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for Polygon geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 definition: Dictionary  The JSON from which to construct the polygon geometry object.
Return value: Polygon
Example
// Creates a Polygon object
var polygonJSON = {
"rings": [
[[97.06138,32.837],[97.06133,32.836],[97.06124,32.834],[97.06127,32.832], [97.06138,32.837]],
[[97.06326,32.759],[97.06298,32.755],[97.06153,32.749], [97.06326,32.759]]
],
"spatialReference": { "wkid": 3857 }
};
Polygon(polygonJSON);
Polyline
Polyline(definition) > Polyline
Constructs a Polyline object from a JSON string or an object literal. The JSON schema must follow the ArcGIS REST API format for Polyline geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 definition: Dictionary  The JSON from which to construct the polyline geometry object.
Return value: Polyline
Example
// Creates a Polyline object
var polylineJSON = {
"paths": [
[[97.06138,32.837],[97.06133,32.836],[97.06124,32.834],[97.06127,32.832]],
[[97.06326,32.759],[97.06298,32.755]]
],
"spatialReference": { "wkid": 4326 }
};
Polyline(polylineJSON);
Relate
Relate(geometry1, geometry2, relation) > Boolean
Indicates if the given DE9IM relation is true
for the two geometries.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The first geometry for the relation.
 geometry2: Geometry  Feature  The second geometry for the relation.
 relation: Text  The Dimensionally Extended 9 Intersection Model (DE9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: 0,1,2), a Boolean value (T or F), or a mask character (for ignoring results: '*').
Example: Each of the following DE9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry: TTTFFTFFT (Boolean), 'T******FF*' (ignore irrelevant intersections), or '102FF*FF*' (dimension form). Each returns the same result.
Return value: Boolean
Example
Returns true if the relation of the input geometries matches
Relate($feature, geometry2, 'TTTFFTFFT')
RingIsClockwise
RingIsClockwise(points) > Boolean
Indicates whether the points in a polygon ring are ordered in a clockwise direction.
Parameter
Return value: Boolean
Example
// $feature is a polygon feature
var polygonRings = Geometry($feature).rings;
IIf(RingIsClockwise(polygonRings[0]), 'correct polygon', 'incorrect direction')
Rotate
Rotate(inputGeometry, angle, rotationOrigin?) > Geometry
Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputGeometry: Geometry  Feature  The geometry to rotate.
 angle: Number  The rotation angle in degrees.
 rotationOrigin (Optional): Point  Point to rotate the geometry around. Defaults to the centroid of the geometry.
Return value: Geometry
Example
Returns the input feature rotated about the centroid by 90 degrees
Rotate($feature, 90)
SetGeometry
SetGeometry(inputFeature, inputGeometry) > Null
Sets or replaces a geometry on a userdefined Feature. Note that features referenced as global variables are immutable; their geometries cannot be changed.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 inputFeature: Feature  A feature whose geometry will be updated.
 inputGeometry: Geometry  The geometry to set on the input feature.
Return value: Null
Example
Sets a new geometry on the feature
var pointFeature = Feature(Point( ... ), 'name', 'buffer centroid');
var mileBuffer = BufferGeodetic(Geometry(pointFeature), 1, 'mile');
SetGeometry(pointFeature, mileBuffer);
Simplify
Simplify(inputGeometry) > Geometry
Performs the simplify operation on the geometry. This alters the given geometry to make it topologically legal.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
Return value: Geometry
Example
Returns the simplified geometry of the feature
Simplify($feature);
SymmetricDifference
SymmetricDifference(leftGeometry, rightGeometry) > Geometry
Performs the Symmetric difference operation on the two geometries. The symmetric difference includes the parts of both geometries that are not common with each other.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 leftGeometry: Geometry  Feature  The geometry instance to compare to
rightGeometry
in the XOR operation.  rightGeometry: Geometry  Feature  The geometry instance to compare to
leftGeometry
in the XOR operation.
Return value: Geometry
Example
Returns a polygon representing areas where both inputs do not overlap
var geom2 = Polygon({ ... });
SymmetricDifference($feature, geom2);
Touches
This function has 2 signatures:
Touches(geometry1, geometry2) > Boolean
Indicates if one geometry touches another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 geometry1: Geometry  Feature  The geometry to test the 'touches' relationship with
geometry2
.  geometry2: Geometry  Feature  The geometry to test the 'touches' relationship with
geometry1
.
Return value: Boolean
Example
Returns true if the geometries touch
var geom2 = Polygon({ ... });
Touches($feature, geom2);
Touches(touchingFeatures, inputGeometry) > FeatureSet
Returns features from a FeatureSet that touch another geometry. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 touchingFeatures: FeatureSet  The features to test the 'touches' relationship with
geometry
.  inputGeometry: Geometry  Feature  The geometry to test the 'touches' relationship with
touchingFeatures
.
Return value: FeatureSet
Example
Returns the number of features in the layer that touch the geometry.
var geom = Polygon({ ... });
Count( Touches($layer, geom) );
Union
Union(geometries) > Geometry
Constructs the settheoretic union of the geometries in an input array, or list, and returns a single Geometry. All inputs must have the same geometry type and share the same spatial reference.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameter
 geometries: Array<Geometry>  Array<Feature>  An array, or list, of geometries to union into a single geometry. This can be any number of geometries.
Return value: Geometry
Examples
Unions geometries passed as an array
var geom2 = Polygon({ ... });
Union([ $feature, geom2 ]);
Unions geometries passed as a list
var geom2 = Polygon({ ... });
var geom3 = Polygon({ ... });
var geom4 = Polygon({ ... });
Union(Geometry($feature), geom2, geom3, geom4);
Within
This function has 2 signatures:
Within(innerGeometry, outerGeometry) > Boolean
Indicates if one geometry is within another geometry. In the graphic below, the red highlight indicates the scenarios where the function will return true
.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 innerGeometry: Geometry  Feature  The base geometry that is tested for the 'within' relationship to
outerGeometry
.  outerGeometry: Geometry  Feature  The comparison geometry that is tested for the 'contains' relationship to
innerGeometry
.
Return value: Boolean
Example
Returns true if the feature is within the given polygon
var outerGeom = Polygon({ ... });
Within($feature, outerGeom);
Within(innerGeometry, outerFeatures) > FeatureSet
Returns features from a FeatureSet that contain the innerGeometry
. In the graphic below, the red highlight illustrates the spatial relationships where the function will return features.
Be aware that using $feature
as input to this function will yield results only as precise as the view's scale resolution. Therefore values returned from expressions using this function may change after zooming between scales. Read more here.
Parameters
 innerGeometry: Geometry  Feature  The base geometry that is tested for the 'within' relationship to
outerFeatures
.  outerFeatures: FeatureSet  The comparison features that are tested for the 'contains' relationship to
innerGeometry
.
Return value: FeatureSet
Example
Returns the number of features in the layer within the polygon
var outerGeom = Polygon({ ... });
Count( Within(outerGeom, $layer) );