GeometryOperationExtensions.Within(Geometry, Geometry) Method

Definition

Determines if innerGeometry is fully contained inside outerGeometry in the Azure Cosmos DB service.

public static bool Within (this Microsoft.Azure.Documents.Spatial.Geometry inner, Microsoft.Azure.Documents.Spatial.Geometry outer);
static member Within : Microsoft.Azure.Documents.Spatial.Geometry * Microsoft.Azure.Documents.Spatial.Geometry -> bool
<Extension()>
Public Function Within (inner As Geometry, outer As Geometry) As Boolean

Parameters

inner
Geometry

Inner Geometry.

outer
Geometry

Outer Geometry.

Returns

System.Boolean

true if innerGeometry is fully contained inside outerGeometry. false otherwise.

Examples

Polygon polygon = new Polygon(
       new[]
       {
            new Position(10, 10),
            new Position(30, 10),
            new Position(30, 30),
            new Position(10, 30),
            new Position(10, 10)
       });
var withinQuery = documents.Where(document => document.Location.Within(polygon));

Remarks

Currently this function supports inner geometry of type Point and outer geometry of type Polygon.

Applies to