RectangleShape¶
Inheritance Hierarchy¶
Object
BaseShape
AreaBaseShape
RectangleShape
Members Summary¶
Public Constructors Summary¶
Name |
---|
RectangleShape() |
RectangleShape(PointShape,PointShape) |
RectangleShape(Double,Double,Double,Double) |
RectangleShape(String) |
RectangleShape(Byte[]) |
Protected Constructors Summary¶
Name |
---|
N/A |
Public Properties Summary¶
Name | Return Type | Description |
---|---|---|
Height | Double | This property returns the height of the RectangleShape in the unit of the shape. |
Id | String | N/A |
LowerLeftPoint | PointShape | This property returns the PointShape that represents the lower left point of the RectangleShape. |
LowerRightPoint | PointShape | This property returns or sets the PointShape that represents the lower right point of the RectangleShape. |
Tag | Object | N/A |
UpperLeftPoint | PointShape | This property returns or sets the PointShape that represents the upper left point of the RectangleShape. |
UpperRightPoint | PointShape | This property returns the PointShape that represents the upper right point of the RectangleShape. |
Width | Double | This property returns the width of the RectangleShape in the unit of the shape. |
Protected Properties Summary¶
Name | Return Type | Description |
---|---|---|
N/A | N/A | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
Name | Event Arguments | Description |
---|---|---|
N/A | N/A | N/A |
Members Detail¶
Public Constructors¶
Name |
---|
RectangleShape() |
RectangleShape(PointShape,PointShape) |
RectangleShape(Double,Double,Double,Double) |
RectangleShape(String) |
RectangleShape(Byte[]) |
Protected Constructors¶
Public Properties¶
Height
¶
Summary
This property returns the height of the RectangleShape in the unit of the shape.
Remarks
None
Return Value
Double
Id
¶
Summary
N/A
Remarks
N/A
Return Value
String
LowerLeftPoint
¶
Summary
This property returns the PointShape that represents the lower left point of the RectangleShape.
Remarks
None
Return Value
LowerRightPoint
¶
Summary
This property returns or sets the PointShape that represents the lower right point of the RectangleShape.
Remarks
None
Return Value
Tag
¶
Summary
N/A
Remarks
N/A
Return Value
Object
UpperLeftPoint
¶
Summary
This property returns or sets the PointShape that represents the upper left point of the RectangleShape.
Remarks
None
Return Value
UpperRightPoint
¶
Summary
This property returns the PointShape that represents the upper right point of the RectangleShape.
Remarks
None
Return Value
Width
¶
Summary
This property returns the width of the RectangleShape in the unit of the shape.
Remarks
None
Return Value
Double
Protected Properties¶
Public Methods¶
Buffer(Double,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
Buffer(Double,Int32,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
quadrantSegments | Int32 | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
quadrantSegments | Int32 | N/A |
bufferCapType | BufferCapType | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
CloneDeep()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
BaseShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Contains(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
Contains(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
Crosses(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
Crosses(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
Equals(Object)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
obj | Object | N/A |
ExpandToInclude(BaseShape)
¶
Summary
This method will expand the current RectangleShape to include the targetShape parameter.
Remarks
There is also an overload that can expand the RectangleShape using a list of multiple shapes.
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | This parameter is used to expand the current rectangle. |
ExpandToInclude(Feature)
¶
Summary
This method will expand the current RectangleShape to include the target feature parameter.
Remarks
There is also an overload that can expand the RectangleShape using a collection of features.
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | This parameter is used to expand the current feature. |
ExpandToInclude(IEnumerable<BaseShape>)
¶
Summary
This method will expand the current RectangleShape to include the shapes in the targetShapes parameter.
Remarks
There is also an overload that can expand the RectangleShape using a single shape.
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShapes | IEnumerable<BaseShape > | This parameter is used to expand the current rectangle. |
ExpandToInclude(IEnumerable<Feature>)
¶
Summary
This method will expand the current RectangleShape to include the features in the targetFeatures parameter.
Remarks
There also is an overload that can expand the RectangleShape using a single feature.
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeatures | IEnumerable<Feature > | This parameter is a group of features used to expand the current rectangle. |
GetArea(GeographyUnit,AreaUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeUnit | GeographyUnit | N/A |
returningUnit | AreaUnit | N/A |
GetArea(Int32,AreaUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeSrid | Int32 | N/A |
returningUnit | AreaUnit | N/A |
GetArea(String,AreaUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjString | String | N/A |
returningUnit | AreaUnit | N/A |
GetArea(Projection,AreaUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | AreaUnit | N/A |
GetArea(Int32,AreaUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeSrid | Int32 | N/A |
returningUnit | AreaUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetArea(String,AreaUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjString | String | N/A |
returningUnit | AreaUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetArea(Projection,AreaUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | AreaUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetBoundingBox()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
RectangleShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetCenterPoint()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
PointShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetClosestPointTo(BaseShape,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
PointShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
shapeUnit | GeographyUnit | N/A |
GetClosestPointTo(Feature,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
PointShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
shapeUnit | GeographyUnit | N/A |
GetConvexHull()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
RingShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetCrossing(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipointShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
GetDifference(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetDifference(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
GetDistanceTo(Feature,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
GetFeature()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Feature | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetFeature(IDictionary<String,String>)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Feature | N/A |
Parameters
Name | Type | Description |
---|---|---|
columnValues | IDictionary<String ,String > | N/A |
GetGeoJson()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetHashCode()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Int32 | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetIntersection(RectangleShape)
¶
Summary
This method returns the intersection of the current RectangleShape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.
Remarks
None
Return Value
Type | Description |
---|---|
RectangleShape | The return type is a RectangleShape that contains the set of all points which lie in both the current shape and the target shape. |
Parameters
Name | Type | Description |
---|---|---|
targetShape | RectangleShape | The shape you are trying to find the intersection with. |
GetIntersection(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetIntersection(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
GetPerimeter(GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeUnit | GeographyUnit | N/A |
returningUnit | DistanceUnit | N/A |
GetPerimeter(Int32,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeSrid | Int32 | N/A |
returningUnit | DistanceUnit | N/A |
GetPerimeter(String,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjString | String | N/A |
returningUnit | DistanceUnit | N/A |
GetPerimeter(Projection,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | DistanceUnit | N/A |
GetPerimeter(Int32,DistanceUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeSrid | Int32 | N/A |
returningUnit | DistanceUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetPerimeter(String,DistanceUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjString | String | N/A |
returningUnit | DistanceUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetPerimeter(Projection,DistanceUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | DistanceUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetShortestLineTo(BaseShape,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultilineShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
shapeUnit | GeographyUnit | N/A |
GetShortestLineTo(Feature,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultilineShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
shapeUnit | GeographyUnit | N/A |
GetSymmetricalDifference(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetSymmetricalDifference(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
GetType()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Type | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetWellKnownBinary()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Byte[] | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetWellKnownBinary(WkbByteOrder)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Byte[] | N/A |
Parameters
Name | Type | Description |
---|---|---|
byteOrder | WkbByteOrder | N/A |
GetWellKnownBinary(RingOrder)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Byte[] | N/A |
Parameters
Name | Type | Description |
---|---|---|
outerRingOrder | RingOrder | N/A |
GetWellKnownBinary(RingOrder,WkbByteOrder)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Byte[] | N/A |
Parameters
Name | Type | Description |
---|---|---|
outerRingOrder | RingOrder | N/A |
byteOrder | WkbByteOrder | N/A |
GetWellKnownText()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetWellKnownText(RingOrder)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
outerRingOrder | RingOrder | N/A |
GetWellKnownType()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
WellKnownType | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Intersects(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
Intersects(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
IsDisjointed(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
IsDisjointed(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
IsTopologicallyEqual(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
IsTopologicallyEqual(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
IsWithin(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
IsWithin(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
LoadFromWellKnownData(String)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
wellKnownText | String | N/A |
LoadFromWellKnownData(Byte[])
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
wellKnownBinary | Byte[] | N/A |
Overlaps(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
Overlaps(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
Register(PointShape,PointShape,DistanceUnit,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
BaseShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
fromPoint | PointShape | N/A |
toPoint | PointShape | N/A |
fromUnit | DistanceUnit | N/A |
toUnit | GeographyUnit | N/A |
Register(Feature,Feature,DistanceUnit,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
BaseShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
fromPoint | Feature | N/A |
toPoint | Feature | N/A |
fromUnit | DistanceUnit | N/A |
toUnit | GeographyUnit | N/A |
Rotate(PointShape,Single)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
pivotPoint | PointShape | N/A |
degreeAngle | Single | N/A |
ScaleDown(Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
percentage | Double | N/A |
ScaleTo(Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
scale | Double | N/A |
ScaleUp(Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
percentage | Double | N/A |
Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeUnit | GeographyUnit | N/A |
tolerance | Double | N/A |
toleranceUnit | DistanceUnit | N/A |
simplificationType | SimplificationType | N/A |
Simplify(Double,SimplificationType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
tolerance | Double | N/A |
simplificationType | SimplificationType | N/A |
ToPolygon()
¶
Summary
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
Type | Description |
---|---|
PolygonShape | This method returns the current shape as a PolygonShape. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
ToString()
¶
Summary
This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value.
Remarks
The value will be formatted in the standard string format: -180,90,180,-90"
Return Value
Type | Description |
---|---|
String | This method returns a formatted representation of the UpperLeftPoint.X, UpperLeftPoint.Y, LowerRightPoint.X and LowerRightPoint.Y value. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
Touches(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
Touches(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
angleInDegrees | Double | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
TranslateByDegree(Double,Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
angleInDegrees | Double | N/A |
TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
xOffsetDistance | Double | N/A |
yOffsetDistance | Double | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
TranslateByOffset(Double,Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
xOffsetDistance | Double | N/A |
yOffsetDistance | Double | N/A |
Union(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
Union(Feature)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetFeature | Feature | N/A |
Validate(ShapeValidationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
ShapeValidationResult | N/A |
Parameters
Name | Type | Description |
---|---|---|
validationMode | ShapeValidationMode | N/A |
Protected Methods¶
BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | N/A |
quadrantSegments | Int32 | N/A |
bufferCapType | BufferCapType | N/A |
shapeUnit | GeographyUnit | N/A |
distanceUnit | DistanceUnit | N/A |
CloneDeepCore()
¶
Summary
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 copy.
Return Value
Type | Description |
---|---|
BaseShape | This method returns a complete copy of the shape without any references in common. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
ContainsCore(BaseShape)
¶
Summary
This method returns if the targetShape lies within the interior of the current shape.
Remarks
Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
Type | Description |
---|---|
Boolean | This method returns if the targetShape lies within the interior of the current shape. |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | The shape you wish to compare the current one to. |
CrossesCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
ExpandToIncludeCore(BaseShape)
¶
Summary
This method will expand the current RectangleShape to include the shape in the targetShape parameter.
Remarks
There is also an overload that can expand the RectangleShape using a list of shapes.
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | This parameter is used to expand the current rectangle. |
Finalize()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetAreaCore(GeographyUnit,AreaUnit)
¶
Summary
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
Type | Description |
---|---|
Double | The return unit is based on the AreaUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit. |
Parameters
Name | Type | Description |
---|---|---|
shapeUnit | GeographyUnit | This is the GeographyUnit of the shape you are performing the operation on. |
returningUnit | AreaUnit | 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. |
GetAreaCore(Projection,AreaUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | AreaUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetBoundingBoxCore()
¶
Summary
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
Type | Description |
---|---|
RectangleShape | The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetCenterPointCore()
¶
Summary
This method returns the center point of the current shape's bounding box.
Remarks
This method returns the center point of the current shape's bounding box. It is important to note that this is the center point of the bounding box. There are numerous ways to calculate the "center" of a geometry such, as its weighted center, etc. You can find other centers by examining the various methods of the shape itself. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
Type | Description |
---|---|
PointShape | A PointShape representing the center point of the current shape's bounding box. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetClosestPointToCore(BaseShape,GeographyUnit)
¶
Summary
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
Type | Description |
---|---|
PointShape | A PointShape representing the closest point of the current shape to the targetShape. |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | The shape you are trying to find the closest point to. |
shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
GetConvexHullCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
RingShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetCrossingCore(BaseShape)
¶
Summary
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
Type | Description |
---|---|
MultipointShape | This method returns the crossing points between the current shape and the passed-in target shape. |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | The target shape you wish to get crossing with. |
GetDifferenceCore(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)
¶
Summary
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
Type | Description |
---|---|
Double | 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
Name | Type | Description |
---|---|---|
targetShape | BaseShape | The shape you are trying to find the distance to. |
shapeUnit | GeographyUnit | The GeographyUnit of the targetShape. |
distanceUnit | DistanceUnit | The DistanceUnit of the returned value. |
GetGeoJsonCore()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
String | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
GetIntersectionCore(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetPerimeterCore(GeographyUnit,DistanceUnit)
¶
Summary
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
Type | Description |
---|---|
Double | The return unit is based on the LengthUnit you specify in the returningUnit parameter, regardless of the shape's GeographyUnit. |
Parameters
Name | Type | Description |
---|---|---|
shapeUnit | GeographyUnit | This is the GeographyUnit of the shape you are performing the operation on. |
returningUnit | DistanceUnit | 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. |
GetPerimeterCore(Projection,DistanceUnit,DistanceCalculationMode)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Double | N/A |
Parameters
Name | Type | Description |
---|---|---|
shapeProjection | Projection | N/A |
returningUnit | DistanceUnit | N/A |
distanceCalculationMode | DistanceCalculationMode | N/A |
GetShortestLineToCore(BaseShape,GeographyUnit)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultilineShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
shapeUnit | GeographyUnit | N/A |
GetSymmetricalDifferenceCore(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
GetWellKnownBinaryCore(RingOrder,WkbByteOrder)
¶
Summary
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
Type | Description |
---|---|
Byte[] | This method returns a byte array that represents the shape in well-known binary. |
Parameters
Name | Type | Description |
---|---|---|
outerRingOrder | RingOrder | N/A |
byteOrder | WkbByteOrder | This parameter specifies whether the byte order is big- or little-endian. |
GetWellKnownTextCore(RingOrder)
¶
Summary
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((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4)))
Return Value
Type | Description |
---|---|
String | This method returns a string that represents the shape in well-known text. |
Parameters
Name | Type | Description |
---|---|---|
outerRingOrder | RingOrder | N/A |
GetWellKnownTypeCore()
¶
Summary
This method returns the well-known type for the shape.
Remarks
None
Return Value
Type | Description |
---|---|
WellKnownType | This method returns the well-known type for the shape. |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
IntersectsCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
IsDisjointedCore(BaseShape)
¶
Summary
This method returns whether the current shape and the targetShape have no points in common.
Remarks
Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.
Return Value
Type | Description |
---|---|
Boolean | This method returns whether the current shape and the targetShape have no points in common. |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | The shape you wish to compare the current one to. |
IsTopologicallyEqualCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
IsWithinCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
LoadFromWellKnownDataCore(String)
¶
Summary
This method hydrates the current shape with its data from well-known text.
Remarks
None
Return Value
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
wellKnownText | String | This parameter is the well-known text you will use to hydrate your object. |
LoadFromWellKnownDataCore(Byte[])
¶
Summary
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
Type | Description |
---|---|
Void | None |
Parameters
Name | Type | Description |
---|---|---|
wellKnownBinary | Byte[] | This parameter is the well-known binary used to populate the shape. |
MemberwiseClone()
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Object | N/A |
Parameters
Name | Type | Description |
---|---|---|
N/A | N/A | N/A |
OverlapsCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)
¶
Summary
This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes.
Remarks
The register method is useful, for example, when a group of points represented by a MultipointShape has been generated in a non-geographic coordinate in meters, and you want to plot the points on a map that is in decimal degrees.
Return Value
Type | Description |
---|---|
BaseShape | This method returns a MultipointShape which has been registered from its original coordinate system to another based on two anchor PointShapes. |
Parameters
Name | Type | Description |
---|---|---|
fromPoint | PointShape | This parameter is the anchor PointShape in the coordinate of origin. |
toPoint | PointShape | This parameter is the anchor PointShape in the coordinate of destination. |
fromUnit | DistanceUnit | This parameter is the GeographyUnit of the coordinate of origin. |
toUnit | GeographyUnit | This parameter is the GeographyUnit of the coordinate of destination. |
RotateCore(PointShape,Single)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
pivotPoint | PointShape | N/A |
degreeAngle | Single | N/A |
ScaleDownCore(Double)
¶
Summary
This method decreases the size of the area shape by the percentage given in the percentage parameter.
Remarks
None
Return Value
Type | Description |
---|---|
Void | 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
Name | Type | Description |
---|---|---|
percentage | Double | This is the percentage by which to decrease the shape's size. |
ScaleToCore(Double)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
scale | Double | N/A |
ScaleUpCore(Double)
¶
Summary
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
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
percentage | Double | This is the percentage by which to increase the shape's size. |
SimplifyCore(Double,SimplificationType)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
tolerance | Double | N/A |
simplificationType | SimplificationType | N/A |
TouchesCore(BaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
Boolean | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | BaseShape | N/A |
TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)
¶
Summary
This method moves the shape from one location to another, based on a direction in degrees and distance.
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
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
distance | Double | 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 | Double | A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up. |
shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
distanceUnit | DistanceUnit | 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. |
TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)
¶
Summary
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
Type | Description |
---|---|
Void | N/A |
Parameters
Name | Type | Description |
---|---|---|
xOffsetDistance | Double | This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit. |
yOffsetDistance | Double | This is the number of horizontal units of movement in the DistanceUnit specified as the distanceUnit. |
shapeUnit | GeographyUnit | This is the GeographicUnit of the shape you are performing the operation on. |
distanceUnit | DistanceUnit | 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. |
UnionCore(AreaBaseShape)
¶
Summary
N/A
Remarks
N/A
Return Value
Type | Description |
---|---|
MultipolygonShape | N/A |
Parameters
Name | Type | Description |
---|---|---|
targetShape | AreaBaseShape | N/A |
ValidateCore(ShapeValidationMode)
¶
Summary
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
Type | Description |
---|---|
ShapeValidationResult | This method returns a ShapeValidationResult based on a series of tests. |
Parameters
Name | Type | Description |
---|---|---|
validationMode | ShapeValidationMode | 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. |