LineString Class

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos.Spatial

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

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: LineString.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.

Represents a geometry consisting of connected line segments.

[System.Runtime.Serialization.DataContract]
public sealed class LineString : Microsoft.Azure.Cosmos.Spatial.Geometry, IEquatable<Microsoft.Azure.Cosmos.Spatial.LineString>

[<System.Runtime.Serialization.DataContract>]
type LineString = class
    inherit Geometry
    interface IEquatable<LineString>

Public NotInheritable Class LineString
Inherits Geometry
Implements IEquatable(Of LineString)

Inheritance: Object

Geometry
LineString

Attributes: DataContractAttribute

Implements: IEquatable<LineString>

Constructors

LineString(IList<Position>)	Initializes a new instance of the LineString class.
LineString(IList<Position>, GeometryParams)	Initializes a new instance of the LineString class.

Properties

AdditionalProperties	Gets additional properties in the Azure Cosmos DB service. (Inherited from Geometry)
BoundingBox	Gets bounding box for this geometry in the Azure Cosmos DB service. (Inherited from Geometry)
Crs	Gets the Coordinate Reference System for this geometry in the Azure Cosmos DB service. (Inherited from Geometry)
Positions	Gets line string positions.
Type	Gets geometry type in the Azure Cosmos DB service. (Inherited from Geometry)

Methods

Distance(Geometry)	Distance in meters between two geometries in the Azure Cosmos DB service. (Inherited from Geometry)
Equals(LineString)	Determines if this LineString is equal to the `other`.
Equals(Object)	Determines whether the specified LineString is equal to the current LineString.
GetHashCode()	Serves as a hash function for the LineString type.
Intersects(Geometry)	Checks if current geometry1 intersects with geometry2. (Inherited from Geometry)
IsValid()	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`. (Inherited from Geometry)
IsValidDetailed()	Determines if the geometry specified is valid and can be indexed or used in queries by Azure Cosmos DB service and if invalid, gives the additional reason as a string value. If a geometry is not valid, it will not be indexed. Also during query time invalid geometries are equivalent to `undefined`. (Inherited from Geometry)
Within(Geometry)	Determines if current inner Geometry is fully contained inside `outer`Geometry in the Azure Cosmos DB service. (Inherited from Geometry)

Applies to

Share via