SpatialIndex.xml

<Type Name="SpatialIndex" FullName="Microsoft.Azure.Documents.SpatialIndex">
  <TypeSignature Language="C#" Value="public sealed class SpatialIndex : Microsoft.Azure.Documents.Index, ICloneable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SpatialIndex extends Microsoft.Azure.Documents.Index implements class System.ICloneable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.SpatialIndex" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
    <AssemblyVersion>1.14.0.0</AssemblyVersion>
    <AssemblyVersion>1.16.0.0</AssemblyVersion>
    <AssemblyVersion>1.17.0.0</AssemblyVersion>
  </AssemblyInfo>
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
    <AssemblyVersion>1.5.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Azure.Documents.Index</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.ICloneable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>
            Specifies an instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class in the Azure DocumentDB database service.
            </summary>
    <remarks>
            Can be used to serve spatial queries.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SpatialIndex (Microsoft.Azure.Documents.DataType dataType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SpatialIndex.#ctor(Microsoft.Azure.Documents.DataType)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
        <AssemblyVersion>1.16.0.0</AssemblyVersion>
        <AssemblyVersion>1.17.0.0</AssemblyVersion>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="dataType" Type="Microsoft.Azure.Documents.DataType" />
      </Parameters>
      <Docs>
        <param name="dataType">Specifies the target data type for the index path specification</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class for the Azure DocumentDB database service.
            </summary>
        <remarks>To be added.</remarks>
        <altmember cref="P:Microsoft.Azure.Documents.SpatialIndex.DataType" />
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to instantiate SpatialIndex class passing in the DataType
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="Clone">
      <MemberSignature Language="C#" Value="public object Clone ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Clone() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SpatialIndex.Clone" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
        <AssemblyVersion>1.16.0.0</AssemblyVersion>
        <AssemblyVersion>1.17.0.0</AssemblyVersion>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Creates a copy of the spatial index for the Azure DocumentDB database service.
            </summary>
        <returns>A clone of the spatial index.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DataType">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.DataType DataType { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.DataType DataType" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.SpatialIndex.DataType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
        <AssemblyVersion>1.16.0.0</AssemblyVersion>
        <AssemblyVersion>1.17.0.0</AssemblyVersion>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="dataType")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Documents.DataType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the data type for which this index should be applied in the Azure DocumentDB database service.
            </summary>
        <value>
            The data type for which this index should be applied.
            </value>
        <remarks>Refer to http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy for valid ranges of values.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>