SpatialSpec Class

Reference

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

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.

Spatial index specification

public sealed class SpatialSpec : Microsoft.Azure.Documents.JsonSerializable

type SpatialSpec = class
    inherit JsonSerializable

Public NotInheritable Class SpatialSpec
Inherits JsonSerializable

Inheritance: Object

JsonSerializable
SpatialSpec

Examples

"spatialIndexes": [ {
"path":"/'region'/?", "types":["Polygon"], "boundingBox": { "xmin":0, "ymin":0, "xmax":10, "ymax":10 } } ]

Constructors

SpatialSpec()

Properties

BoundingBox	Gets or sets the bounding box
Path	Path in JSON document to index
SpatialTypes	Path's spatial type

Methods

LoadFrom(JsonReader)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Loads the object from the specified JSON reader 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)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	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)

Applies to