This class represents a LineShape, which is defined as a single line with two or more points.

• System.Object
  • ThinkGeo.MapSuite.Core.BaseShape
    • ThinkGeo.MapSuite.Core.LineBaseShape
      • ThinkGeo.MapSuite.Core.LineShape

CanRotate

• Return:Boolean
• Summary:This property specifies whether the shape can be rotated.

Id

• Return:String
• Summary:N/A

Tag

• Return:Object
• Summary:N/A

Vertices

• Return:Collection<Vertex>
• Summary:This property is the collection of points that make up the LineShape.

This constructor creates the LineShape.

None

Go Back

This constructor creates the LineShape.

None

points

• Type:IEnumerable<Vertex>
• Description:N/A Go Back === LineShape(String) === This constructor creates the LineShape. ==== Remarks ==== None ==== Parameters ==== wellKnownText * Type:String * Description:This parameter is the well-known text used to build the shape.

Go Back

This constructor creates the LineShape.

None

wellKnownBinary

• Type:Byte[]
• Description:This parameter is the well-known binary used to build the shape. Go Back ===== Protected Constructors ===== ===== Public Methods ===== === Buffer(Double,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === Buffer(Double,Int32,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A quadrantSegments * Type:Int32 * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A quadrantSegments * Type:Int32 * Description:N/A bufferCapType * Type:BufferCapType * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === CloneDeep() === N/A ==== Remarks ==== N/A Return Value * Return Type:BaseShape * Description:N/A ==== Parameters ==== Go Back === Contains(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === Contains(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === ConvexHull() === N/A ==== Remarks ==== N/A Return Value * Return Type:RingShape * Description:N/A ==== Parameters ==== Go Back === Crosses(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === Crosses(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === Equals(Object) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== obj * Type:Object * Description:N/A Go Back === GetAccurateLength(Int32,DistanceUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeSrid * Type:Int32 * Description:N/A returningUnit * Type:DistanceUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetAccurateLength(String,DistanceUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeProj4ProjectionParameters * Type:String * Description:N/A returningUnit * Type:DistanceUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetBoundingBox() === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== Go Back === GetCenterPoint() === N/A ==== Remarks ==== N/A Return Value * Return Type:PointShape * Description:N/A ==== Parameters ==== Go Back === GetClosestPointTo(BaseShape,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:PointShape * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A Go Back === GetClosestPointTo(Feature,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:PointShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A Go Back === GetCrossing(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipointShape * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === GetDistanceTo(Feature,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === GetFeature(IDictionary<String,String>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Feature * Description:N/A ==== Parameters ==== columnValues * Type:IDictionary<String,String> * Description:N/A Go Back === GetFeature() === N/A ==== Remarks ==== N/A Return Value * Return Type:Feature * Description:N/A ==== Parameters ==== Go Back === GetGeoJson() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back === GetHashCode() === N/A ==== Remarks ==== N/A Return Value * Return Type:Int32 * Description:N/A ==== Parameters ==== Go Back === GetIntersection(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === GetIntersection(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetLength(GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeUnit * Type:GeographyUnit * Description:N/A returningUnit * Type:DistanceUnit * Description:N/A Go Back === GetLineOnALine(StartingPoint,Single,Single) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape, based on a starting position and other factors. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. startingPercentageOfTheLine * Type:Single * Description:This parameter defines the starting percentage into the line. Valid values must be greater than 0 and less than or equal to 100. percentageOfTheLine * Type:Single * Description:This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100. Go Back === GetLineOnALine(PointShape,PointShape) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape based on a start PointShape and an end PointShape. ==== Parameters ==== startPointShape * Type:PointShape * Description:The startPointShape defines where you will start to get the line. If it does not stand on this LineShape, the closest point on the LineShape will be the start PointShape. endPointShape * Type:PointShape * Description:The endPointShape defines where you will stop getting the line. If it does not stand on this LineShape, the closest point on the LineShape will be the end PointShape. Go Back === GetLineOnALine(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape, based on a starting position and other factors. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. startingDistance * Type:Double * Description:The starting distance from which you will start getting the line. For example, if the line is 3 units long and you have a starting distance of 1 unit, the result will be the last two units of the line. Valid values must be greater than 0. The starting distance will be in the GeographyUnit of the shape. distance * Type:Double * Description:The amount of the line you want to get after the startingDistance. Valid values must be greater than 0. shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. Go Back === GetLineOnALine(StartingPoint,PointShape) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape, based on a starting position and other factors. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. endPointShape * Type:PointShape * Description:The BaseLineShape returned will be between the startingPoint and the endPointShape specified in this parameter. Go Back === GetLineOnALine(StartingPoint,Single) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape, based on a starting position and other factors. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. percentageOfLine * Type:Single * Description:This parameter defines the percentage into the line. Valid values must be greater than 0 and less than or equal to 100. Go Back === GetPointOnALine(StartingPoint,Double,GeographyUnit,DistanceUnit) === This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. ==== Remarks ==== Passing in a 0 distance will return either the first or last point on the line, depending upon the value of the startingPoint parameter. Return Value * Return Type:PointShape * Description:This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. distance * Type:Double * Description:This parameter specifies the distance into the line you wish to move in the unit specified by the distanceUnit parameter. Valid values must be greater than or equal to 0. shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. Go Back === GetPointOnALine(StartingPoint,Single) === This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in the startingPoint parameter. ==== Remarks ==== If you pass 100 or 0 as the percentage of the line, it will return either the first or last vertex, depending on the value of the startingPoint argument. Return Value * Return Type:PointShape * Description:This method returns a PointShape on the line, based on a percentage of the length of the line from the first or last vertex defined in the startingPoint parameter. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. percentageOfLine * Type:Single * Description:This parameter defines the percentage into the line. Valid values are between 0 and 100. Go Back === GetShortestLineTo(Feature,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A Go Back === GetShortestLineTo(BaseShape,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A Go Back === GetType() === N/A ==== Remarks ==== N/A Return Value * Return Type:Type * Description:N/A ==== Parameters ==== Go Back === GetWellKnownBinary(WkbByteOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== byteOrder * Type:WkbByteOrder * Description:N/A Go Back === GetWellKnownBinary(RingOrder,WkbByteOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A byteOrder * Type:WkbByteOrder * Description:N/A Go Back === GetWellKnownBinary(RingOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A Go Back === GetWellKnownBinary() === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== Go Back === GetWellKnownText(RingOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A Go Back === GetWellKnownText() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back === GetWellKnownType() === N/A ==== Remarks ==== N/A Return Value * Return Type:WellKnownType * Description:N/A ==== Parameters ==== Go Back === Intersects(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === Intersects(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === IsClosed() === This method determines whether the line is closed, meaning that the last point and first point are the same. ==== Remarks ==== None Return Value * Return Type:Boolean * Description:The return value indicating whether the line is closed. ==== Parameters ==== Go Back === IsDisjointed(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === IsDisjointed(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === IsTopologicallyEqual(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === IsTopologicallyEqual(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === IsWithin(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === IsWithin(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === LoadFromWellKnownData(String) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== wellKnownText * Type:String * Description:N/A Go Back === LoadFromWellKnownData(Byte[]) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== wellKnownBinary * Type:Byte[] * Description:N/A Go Back === Overlaps(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === Overlaps(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === Register(PointShape,PointShape,DistanceUnit,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:BaseShape * Description:N/A ==== Parameters ==== fromPoint * Type:PointShape * Description:N/A toPoint * Type:PointShape * Description:N/A fromUnit * Type:DistanceUnit * Description:N/A toUnit * Type:GeographyUnit * Description:N/A Go Back === Register(Feature,Feature,DistanceUnit,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:BaseShape * Description:N/A ==== Parameters ==== fromPoint * Type:Feature * Description:N/A toPoint * Type:Feature * Description:N/A fromUnit * Type:DistanceUnit * Description:N/A toUnit * Type:GeographyUnit * Description:N/A Go Back === RemoveVertex(Vertex) === This method removes the selected vertex from line shape. ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:If remove sucess it will return true, otherwise return false. ==== Parameters ==== selectedVertex * Type:Vertex * Description:The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same. Go Back === RemoveVertex(Vertex,LineShape) === This method removes the selected vertex from line shape. ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:If remove sucess it will return true, otherwise return false. ==== Parameters ==== selectedVertex * Type:Vertex * Description:The selected vertex must be a vertex of line shape, otherwise it will return false and line shape will keep the same. lineShape * Type:LineShape * Description:The line shape will be removed one vertex. Go Back === ReversePoints() === This method reverses the order of the points in the line. ==== Remarks ==== None Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === Rotate(PointShape,Single) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== pivotPoint * Type:PointShape * Description:N/A degreeAngle * Type:Single * Description:N/A Go Back === ScaleDown(Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== percentage * Type:Double * Description:N/A Go Back === ScaleTo(Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== scale * Type:Double * Description:N/A Go Back === ScaleUp(Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== percentage * Type:Double * Description:N/A Go Back === Simplify(Double,SimplificationType) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== tolerance * Type:Double * Description:N/A simplificationType * Type:SimplificationType * Description:N/A Go Back === Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== shapeUnit * Type:GeographyUnit * Description:N/A tolerance * Type:Double * Description:N/A toleranceUnit * Type:DistanceUnit * Description:N/A simplificationType * Type:SimplificationType * Description:N/A Go Back === ToPolygonShape() === This method generates a PolygonShape based the vertexes of the line. ==== Remarks ==== N/A Return Value * Return Type:PolygonShape * Description:A generated polygon based on the vertexes of the line, otherwise return null. ==== Parameters ==== Go Back === ToString() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back === Touches(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === Touches(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A angleInDegrees * Type:Double * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === TranslateByDegree(Double,Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A angleInDegrees * Type:Double * Description:N/A Go Back === TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== xOffsetDistance * Type:Double * Description:N/A yOffsetDistance * Type:Double * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === TranslateByOffset(Double,Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== xOffsetDistance * Type:Double * Description:N/A yOffsetDistance * Type:Double * Description:N/A Go Back === Union(LineBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetShape * Type:LineBaseShape * Description:N/A Go Back === Union(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === Validate(ShapeValidationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:ShapeValidationResult * Description:N/A ==== Parameters ==== validationMode * Type:ShapeValidationMode * Description:N/A Go Back ===== Protected Methods ===== === BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== distance * Type:Double * Description:N/A quadrantSegments * Type:Int32 * Description:N/A bufferCapType * Type:BufferCapType * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A distanceUnit * Type:DistanceUnit * Description:N/A Go Back === CloneDeepCore() === This method returns a complete copy of the shape without any references in common. ==== Remarks ==== When you override this method, you need to ensure that there are no references in common between the original and the copy. Return Value * Return Type:BaseShape * Description:This method returns a complete copy of the shape without any references in common. ==== Parameters ==== Go Back === ContainsCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === ConvexHullCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:RingShape * Description:N/A ==== Parameters ==== Go Back === CrossesCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === Finalize() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === GetAccurateLengthCore(String,DistanceUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeProj4ProjectionParameters * Type:String * Description:N/A returningUnit * Type:DistanceUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetBoundingBoxCore() === This method calculates the smallest RectangleShape that encompasses the entire geometry. ==== Remarks ==== The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry this operation can take longer for larger objects. If the shape is a PointShape, than the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. Return Value * Return Type:RectangleShape * Description:The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry. ==== Parameters ==== Go Back === GetCenterPointCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:PointShape * Description:N/A ==== Parameters ==== Go Back === GetClosestPointToCore(BaseShape,GeographyUnit) === This method returns the point of the current shape that is closest to the target shape. ==== Remarks ==== This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line. Return Value * Return Type:PointShape * Description:A PointShape representing the closest point of the current shape to the targetShape. ==== Parameters ==== targetShape * Type:BaseShape * Description:The shape you are trying to find the closest point to. shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. Go Back === GetCrossingCore(BaseShape) === This method returns the crossing points between the current shape and the passed-in target shape. ==== Remarks ==== As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. Return Value * Return Type:MultipointShape * Description:This method returns the crossing points between the current shape and the passed-in target shape. ==== Parameters ==== targetShape * Type:BaseShape * Description:The target shape you wish to get crossing with. Go Back === GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit) === This method computes the distance between the current shape and the targetShape. ==== Remarks ==== In this method, we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.Overriding:Please ensure that you validate the parameters being passed in and raise the exceptions defined above. Return Value * Return Type:Double * Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. ==== Parameters ==== targetShape * Type:BaseShape * Description:The shape you are trying to find the distance to. shapeUnit * Type:GeographyUnit * Description:This is the GeographicUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your distanceUnit, then the distance will be returned in miles. Go Back === GetGeoJsonCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back === GetIntersectionCore(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetLengthCore(GeographyUnit,DistanceUnit) === This method returns the length of the LineShape. ==== Remarks ==== This is a useful method when you want to know the total length of a line-based shape. If the shape is a MultiLineShape, then the length is the sum of all of its lines. Return Value * Return Type:Double * Description:This overload returns the length in the unit of your choice, based on returningUnit you specify. ==== Parameters ==== shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. returningUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use as the return value. For example, if you select miles as your returningUnit, then the distance will be returned in miles. Go Back === GetLineOnALineCore(StartingPoint,Double,Double,GeographyUnit,DistanceUnit) === This method returns a BaseLineShape, based on a starting position and other factors. ==== Remarks ==== None Return Value * Return Type:LineBaseShape * Description:This method returns a BaseLineShape, based on a starting position and other factors. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. startingDistance * Type:Double * Description:The starting distance from which you will start getting the line. For example, if the line is 3 units long and you have a starting distance of 1 unit, the result will be the last two units of the line. Valid values must be greater than 0. The starting distance will be in the GeographyUnit of the shape. distance * Type:Double * Description:The amount of the line you want to get after the startingDistance. Valid values must be greater than 0. shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. Go Back === GetPointOnALineCore(StartingPoint,Double,GeographyUnit,DistanceUnit) === This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. ==== Remarks ==== Passing in a 0 distance will return either the first or last point on the line, depending on the value of the startingPoint parameter. Return Value * Return Type:PointShape * Description:This method returns a PointShape on the line, based on a distance on the line from the first or last vertex defined in the startingPoint parameter. ==== Parameters ==== startingPoint * Type:StartingPoint * Description:The startingPoint defines whether the method starts at the beginning or the end of the line. distance * Type:Double * Description:This parameter specifies the distance into the line you wish to move in the unit specified by the distanceUnit parameter. Valid values must be greater than or equal to 0. shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use for the distance parameter. For example, if you select miles as your distanceUnit, then the distance will be measured in miles. Go Back === GetShortestLineToCore(BaseShape,GeographyUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A shapeUnit * Type:GeographyUnit * Description:N/A Go Back === GetWellKnownBinaryCore(RingOrder,WkbByteOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A byteOrder * Type:WkbByteOrder * Description:N/A Go Back === GetWellKnownTextCore(RingOrder) === This method returns the well-known text representation of this shape. ==== Remarks ==== This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric figures.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON¹⁾MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING²⁾MULTIPOLYGON³⁾,⁴⁾) Return Value * Return Type:String * Description:This method returns a string that represents the shape in well-known text. ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A Go Back === GetWellKnownTypeCore() === This method returns the well-known type for the shape. ==== Remarks ==== None Return Value * Return Type:WellKnownType * Description:This method returns the well-known type for the shape. ==== Parameters ==== Go Back === IntersectsCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === IsClosedCore() === This method determines whether the line is closed, meaning that the last point and first point are the same. ==== Remarks ==== None Return Value * Return Type:Boolean * Description:The return value indicating whether the line is closed. ==== Parameters ==== Go Back === IsDisjointedCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === IsTopologicallyEqualCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === IsWithinCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === LoadFromWellKnownDataCore(String) === This method hydrates the current shape with its data from well-known text. ==== Remarks ==== None Return Value * Return Type:Void * Description:None ==== Parameters ==== wellKnownText * Type:String * Description:This parameter is the well-known text you will use to hydrate your object. Go Back === LoadFromWellKnownDataCore(Byte[]) === This method hydrates the current shape with its data from well-known binary. ==== Remarks ==== This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method. Return Value * Return Type:Void * Description:None ==== Parameters ==== wellKnownBinary * Type:Byte[] * Description:This parameter is the well-known binary used to populate the shape. Go Back === MemberwiseClone() === N/A ==== Remarks ==== N/A Return Value * Return Type:Object * Description:N/A ==== Parameters ==== Go Back === OverlapsCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit) === This method returns a BaseShape which has been registered from its original coordinate system to another, based on two anchor PointShapes. ==== Remarks ==== Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. Return Value * Return Type:BaseShape * Description:This method returns a BaseShape which has been registered from its original coordinate system to another, based on two anchor PointShapes. ==== Parameters ==== fromPoint * Type:PointShape * Description:This parameter is the anchor PointShape in the coordinate of origin. toPoint * Type:PointShape * Description:This parameter is the anchor PointShape in the coordinate of destination. fromUnit * Type:DistanceUnit * Description:This parameter is the DistanceUnit of the coordinate of origin. toUnit * Type:GeographyUnit * Description:This parameter is the GeographyUnit of the coordinate of destination. Go Back === ReversePointsCore() === This method reverses the order of the points in the line. ==== Remarks ==== None Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === RkE=(Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== factor * Type:Double * Description:N/A Go Back === RotateCore(PointShape,Single) === This method rotates the shape a number of degrees based on a pivot point. ==== Remarks ==== This method rotates the shape a number of degrees based on a pivot point. By placing the pivot point in the center of the shape, you can achieve in-place rotation. By moving the pivot point outside of the center of the shape, you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. Return Value * Return Type:Void * Description:N/A ==== Parameters ==== pivotPoint * Type:PointShape * Description:The pivotPoint represents the center of rotation. degreeAngle * Type:Single * Description:The number of degrees of rotation required from 0 to 360. Go Back === ScaleDownCore(Double) === This method decreases the size of the LineShape by the percentage given in the percentage parameter. ==== Remarks ==== This method is useful when you would like to decrease the size of the shape. Note that a larger percentage will scale the shape down faster, as you are applying the operation multiple times. There is also a ScaleUp method that will enlarge the shape. Return Value * Return Type:Void * Description:N/A ==== Parameters ==== percentage * Type:Double * Description:This is the percentage by which to decrease the shape's size. Go Back === ScaleToCore(Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== scale * Type:Double * Description:N/A Go Back === ScaleUpCore(Double) === This method increases the size of the LineShape by the percentage given in the percentage parameter. ==== Remarks ==== This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape. Return Value * Return Type:Void * Description:N/A ==== Parameters ==== percentage * Type:Double * Description:This is the percentage by which to increase the shape's size. Go Back === SimplifyCore(Double,SimplificationType) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== tolerance * Type:Double * Description:N/A simplificationType * Type:SimplificationType * Description:N/A Go Back === TouchesCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit) === This method moves the base shape from one location to another based on a distance and a direction in degrees. ==== Remarks ==== This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. Return Value * Return Type:Void * Description:N/A ==== Parameters ==== distance * Type:Double * Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the one specified in the distanceUnit parameter. The distance must be greater than or equal to 0. angleInDegrees * Type:Double * Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. shapeUnit * Type:GeographyUnit * Description:This is the GeographicUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the DistanceUnit you would like to use as the measure for the move. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles. Go Back === TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit) === This method moves the base shape from one location to another based on an X and Y offset distance. ==== Remarks ==== This method returns a shape repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. Return Value * Return Type:Void * Description:N/A ==== Parameters ==== xOffsetDistance * Type:Double * Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter. yOffsetDistance * Type:Double * Description:This is the number of vertical units of movement in the distance unit specified in the distanceUnit parameter. shapeUnit * Type:GeographyUnit * Description:This is the GeographicUnit of the shape you are performing the operation on. distanceUnit * Type:DistanceUnit * Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles. Go Back === UnionCore(IEnumerable<LineBaseShape>) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultilineShape * Description:N/A ==== Parameters ==== lineBaseShapes * Type:IEnumerable<LineBaseShape> * Description:N/A Go Back === ValidateCore(ShapeValidationMode) === This method returns a ShapeValidationResult based on a series of tests. ==== Remarks ==== We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test. Return Value * Return Type:ShapeValidationResult * Description:This method returns a ShapeValidationResult based on a series of tests. ==== Parameters ==== validationMode * Type:ShapeValidationMode * Description:This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast. Go Back ===== Public Properties ===== === CanRotate === This property specifies whether the shape can be rotated. ==== Remarks ==== If this property returns false and you attempt call the rotate method, it will throw a NotImplementedException. ==== Return Value ==== Return Type:Boolean Go Back === Id === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === Tag === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Object Go Back === Vertices === This property is the collection of points that make up the LineShape. ==== Remarks ==== None ==== Return Value ==== Return Type**:Collection<Vertex>

Go Back