GeometryOperationExtensions.IsValid(Geometry) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Spatial

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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 the geometry specified is valid and can be indexed or used in queries by Azure Cosmos DB service.

If a geometry is not valid, it will not be indexed. Also during query time invalid geometries are equivalent to undefined.

public static bool IsValid (this Microsoft.Azure.Documents.Spatial.Geometry geometry);

static member IsValid : Microsoft.Azure.Documents.Spatial.Geometry -> bool

<Extension()>
Public Function IsValid (geometry As Geometry) As Boolean

Parameters

geometry: Geometry

The geometry to check for validity.

Returns

Boolean

true if geometry is valid. false otherwise.

Examples

This example select all the documents which contain invalid geometries which were not indexed.

var invalidDocuments = documents.Where(document => !document.Location.IsValid());

Remarks

Currently this function supports geometry of type Point and Polygon.

Applies to