Geometry.Within(Geometry) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos.Spatial

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Geometry.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines if current inner Geometry is fully contained inside outerGeometry in the Azure Cosmos DB service.

public bool Within (Microsoft.Azure.Cosmos.Spatial.Geometry outer);

member this.Within : Microsoft.Azure.Cosmos.Spatial.Geometry -> bool

Public Function Within (outer As Geometry) As Boolean

Parameters

outer: Geometry

Outer Geometry.

Returns

Boolean

true if current inner Geometry 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 current geometry of type Point and outer geometry of type Polygon.

Applies to