This class represents a closed ring of points.

• System.Object
  • ThinkGeo.MapSuite.Core.BaseShape
    • ThinkGeo.MapSuite.Core.AreaBaseShape
      • ThinkGeo.MapSuite.Core.RingShape

CanRotate

• Return:Boolean
• Summary:N/A

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 RingShape.

This constructor creates a RingShape.

None

Go Back

N/A

N/A

points

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

Go Back

This constructor creates a RingShape.

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 === Crosses(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A 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 === Equals(Object) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== obj * Type:Object * Description:N/A Go Back === GetAccurateArea(Int32,AreaUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeSrid * Type:Int32 * Description:N/A returningUnit * Type:AreaUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetAccurateArea(String,AreaUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeProj4ProjectionParameters * Type:String * Description:N/A returningUnit * Type:AreaUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetAccuratePerimeter(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 === GetAccuratePerimeter(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 === GetArea(GeographyUnit,AreaUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeUnit * Type:GeographyUnit * Description:N/A returningUnit * Type:AreaUnit * 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 === GetConvexHull() === N/A ==== Remarks ==== N/A Return Value * Return Type:RingShape * Description:N/A ==== Parameters ==== 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 === GetDifference(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === GetDifference(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * 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 === 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 === 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:MultipolygonShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === GetIntersection(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetPerimeter(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 === 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 === GetSymmetricalDifference(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === GetSymmetricalDifference(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetType() === N/A ==== Remarks ==== N/A Return Value * Return Type:Type * Description:N/A ==== Parameters ==== 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(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(WkbByteOrder) === N/A ==== Remarks ==== N/A Return Value * Return Type:Byte[] * Description:N/A ==== Parameters ==== byteOrder * Type:WkbByteOrder * 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 === 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(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 === 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,RingShape) === This method removes the selected vertex from ring 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 ring shape, otherwise it will return false and ring shape will keep the same. ringShape * Type:RingShape * Description:The line shape will be removed one vertex. Go Back === RemoveVertex(Vertex) === This method removes the selected vertex from ring 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 ring shape, otherwise it will return false and ring shape will keep the same. Go Back === ReversePoints() === This method reverses the order of the points in the ring. ==== 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:MultipolygonShape * 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:MultipolygonShape * 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 === ToPolygon() === This method returns the current shape as a PolygonShape. ==== Remarks ==== This method is mainly used to convert this GIS non-standard shape to a GIS standard shape. Return Value * Return Type:PolygonShape * Description:This method returns the current shape as a PolygonShape. ==== 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) === 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 === 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 === 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 === 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 === Union(Feature) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetFeature * Type:Feature * Description:N/A Go Back === Union(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * 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 === 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 === GetAccurateAreaCore(String,AreaUnit,DistanceCalculationMode) === N/A ==== Remarks ==== N/A Return Value * Return Type:Double * Description:N/A ==== Parameters ==== shapeProj4ProjectionParameters * Type:String * Description:N/A returningUnit * Type:AreaUnit * Description:N/A distanceCalculationMode * Type:DistanceCalculationMode * Description:N/A Go Back === GetAccuratePerimeterCore(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 === GetAreaCore(GeographyUnit,AreaUnit) === This method returns the area of the shape, defined as the size of the region enclosed by the figure. ==== Remarks ==== You would use this method to find the area inside the shape. Return Value * Return Type:Double * Description:The return unit is based on the AreaUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit. ==== Parameters ==== shapeUnit * Type:GeographyUnit * Description:This is the GeographyUnit of the shape you are performing the operation on. returningUnit * Type:AreaUnit * Description:This is the AreaUnit you would like to use as the return value. For example, if you select square miles as your returningUnit, then the distance will be returned in square miles. 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, then the bounding box's upper left and lower right points will be equal. This will create a RectangleShape with no area. 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 GeographicUnit of the shape you are performing the operation on. Go Back === GetConvexHullCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:RingShape * Description:N/A ==== Parameters ==== Go Back === GetCrossingCore(BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipointShape * Description:N/A ==== Parameters ==== targetShape * Type:BaseShape * Description:N/A Go Back === GetDifferenceCore(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A 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. Return Value * Return Type:Double * Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above. ==== Parameters ==== targetShape * Type:BaseShape * Description:The shape you are trying to find the distance to. shapeUnit * Type:GeographyUnit * Description:The GeographUnit of the targetShape. distanceUnit * Type:DistanceUnit * Description:The DistanceUnit of the returned value. 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:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetPerimeterCore(GeographyUnit,DistanceUnit) === This method returns the perimeter of the shape, defined as the sum of the lengths of all its sides. ==== Remarks ==== You would use this method to find the distance around the area shape. Return Value * Return Type:Double * Description:The return unit is based on the LengthUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit. ==== 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 === 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 === GetSymmetricalDifferenceCore(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * Description:N/A Go Back === GetWellKnownBinaryCore(RingOrder,WkbByteOrder) === This method returns a byte array that represents the shape in well-known binary. ==== Remarks ==== This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe a geometry as a binary array. Well-known binary is useful when you want to save a geometry in an efficient format using as little space as possible. An alternative to well-known binary is well-known text, which is a textual representation of a geometry object. We have methods that work with well-known text as well. Return Value * Return Type:Byte[] * Description:This method returns a byte array that represents the shape in well-known binary. ==== Parameters ==== outerRingOrder * Type:RingOrder * Description:N/A byteOrder * Type:WkbByteOrder * Description:This parameter specifies whether the byte order is big- or little-endian. 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 shapes.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 === 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(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 === 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 === 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 ring. ==== Remarks ==== None Return Value * Return Type:Void * Description:N/A ==== Parameters ==== 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 === SEM=(RingShape,Double,Double,Double) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== targetRingShape * Type:RingShape * Description:N/A multiplicator * Type:Double * Description:N/A centerX * Type:Double * Description:N/A centerY * Type:Double * Description:N/A Go Back === ScaleDownCore(Double) === This method decreases the size of the area shape by the percentage given in the percentage parameter. ==== Remarks ==== None Return Value * Return Type:Void * Description: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. ==== 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 area shape 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:MultipolygonShape * Description:N/A ==== Parameters ==== tolerance * Type:Double * Description:N/A simplificationType * Type:SimplificationType * Description:N/A Go Back === TUM=() === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== Go Back === TkM=() === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== 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 moves the base shape from one location to another, based on an angleInDegrees and distance parameter. With this overload, it is important to note that the distance units are the same GeographicUnit as the shape. For example, if your shape is in decimal degrees and you call this method with a distance of 1, you're going to move this shape 1 decimal degree in direction of the angleInDegrees. In many cases it is more useful to specify the DistanceUnit of movement, such as in miles or yards, so for these scenarios there is another overload you may want to use instead.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 in the angle specified. The distance unit will be the same as the GeographyUnit for the shape. 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 xOffsetDistance and yOffsetDistance 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 moves the base shape 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 1 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 to 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 DistanceUnit specified as the distanceUnit. yOffsetDistance * Type:Double * Description:This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit. 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 xOffsetDistance and yOffsetDistance will be calculated in miles. Go Back === UnionCore(AreaBaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:MultipolygonShape * Description:N/A ==== Parameters ==== targetShape * Type:AreaBaseShape * 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 === N/A ==== Remarks ==== N/A ==== 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 RingShape. ==== Remarks ==== None ==== Return Value ==== Return Type**:Collection<Vertex>

Go Back