SpatialIndex Class

Definition

Namespace:

Microsoft.Azure.Documents

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

Specifies an instance of the SpatialIndex class in the Azure Cosmos DB service.

public sealed class SpatialIndex : Microsoft.Azure.Documents.Index

type SpatialIndex = class
    inherit Index

Public NotInheritable Class SpatialIndex
Inherits Index

Inheritance

Object

JsonSerializable

Index

SpatialIndex

Implements

ICloneable

Remarks

Can be used to serve spatial queries.

Constructors

SpatialIndex(DataType)

Initializes a new instance of the SpatialIndex class for the Azure Cosmos DB service.

Properties

DataType	Gets or sets the data type for which this index should be applied in the Azure Cosmos DB service.
Kind	Gets or sets the kind of indexing to be applied in the Azure Cosmos DB service. (Inherited from Index)

Methods

Clone()	Creates a copy of the spatial index for the Azure Cosmos DB service.
LoadFrom(JsonReader, JsonSerializerSettings)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
LoadFrom(JsonReader)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
ToString()	Returns the string representation of the object in the Azure Cosmos DB service. (Inherited from JsonSerializable)