Skip to content

AreaBaseShape

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
N/A

Protected Constructors Summary

Name
AreaBaseShape()

Public Properties Summary

Name Return Type Description
Id String N/A
Tag Object N/A

Protected Properties Summary

Name Return Type Description
N/A N/A N/A

Public Methods Summary

Name
Buffer(Double,GeographyUnit,DistanceUnit)
Buffer(Double,Int32,GeographyUnit,DistanceUnit)
Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)
CloneDeep()
Contains(BaseShape)
Contains(Feature)
Crosses(BaseShape)
Crosses(Feature)
Equals(Object)
GetArea(GeographyUnit,AreaUnit)
GetArea(Int32,AreaUnit)
GetArea(String,AreaUnit)
GetArea(Projection,AreaUnit)
GetArea(Int32,AreaUnit,DistanceCalculationMode)
GetArea(String,AreaUnit,DistanceCalculationMode)
GetArea(Projection,AreaUnit,DistanceCalculationMode)
GetBoundingBox()
GetCenterPoint()
GetClosestPointTo(BaseShape,GeographyUnit)
GetClosestPointTo(Feature,GeographyUnit)
GetConvexHull()
GetCrossing(BaseShape)
GetDifference(AreaBaseShape)
GetDifference(Feature)
GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)
GetDistanceTo(Feature,GeographyUnit,DistanceUnit)
GetFeature()
GetFeature(IDictionary<String,String>)
GetGeoJson()
GetHashCode()
GetIntersection(AreaBaseShape)
GetIntersection(Feature)
GetPerimeter(GeographyUnit,DistanceUnit)
GetPerimeter(Int32,DistanceUnit)
GetPerimeter(String,DistanceUnit)
GetPerimeter(Projection,DistanceUnit)
GetPerimeter(Int32,DistanceUnit,DistanceCalculationMode)
GetPerimeter(String,DistanceUnit,DistanceCalculationMode)
GetPerimeter(Projection,DistanceUnit,DistanceCalculationMode)
GetShortestLineTo(BaseShape,GeographyUnit)
GetShortestLineTo(Feature,GeographyUnit)
GetSymmetricalDifference(AreaBaseShape)
GetSymmetricalDifference(Feature)
GetType()
GetWellKnownBinary()
GetWellKnownBinary(WkbByteOrder)
GetWellKnownBinary(RingOrder)
GetWellKnownBinary(RingOrder,WkbByteOrder)
GetWellKnownText()
GetWellKnownText(RingOrder)
GetWellKnownType()
Intersects(BaseShape)
Intersects(Feature)
IsDisjointed(BaseShape)
IsDisjointed(Feature)
IsTopologicallyEqual(BaseShape)
IsTopologicallyEqual(Feature)
IsWithin(BaseShape)
IsWithin(Feature)
LoadFromWellKnownData(String)
LoadFromWellKnownData(Byte[])
Overlaps(BaseShape)
Overlaps(Feature)
Register(PointShape,PointShape,DistanceUnit,GeographyUnit)
Register(Feature,Feature,DistanceUnit,GeographyUnit)
Rotate(PointShape,Single)
ScaleDown(Double)
ScaleDown(AreaBaseShape,Double)
ScaleDown(Feature,Double)
ScaleTo(Double)
ScaleUp(Double)
ScaleUp(AreaBaseShape,Double)
ScaleUp(Feature,Double)
Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)
Simplify(Double,SimplificationType)
Simplify(AreaBaseShape,GeographyUnit,Double,DistanceUnit,SimplificationType)
Simplify(AreaBaseShape,Double,SimplificationType)
Split(AreaBaseShape,AreaBaseShape)
Split(Feature,Feature)
ToString()
Touches(BaseShape)
Touches(Feature)
TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)
TranslateByDegree(Double,Double)
TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)
TranslateByOffset(Double,Double)
Union(AreaBaseShape)
Union(Feature)
Union(IEnumerable<Feature>)
Union(IEnumerable<AreaBaseShape>)
Validate(ShapeValidationMode)

Protected Methods Summary

Name
BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)
CloneDeepCore()
ContainsCore(BaseShape)
CrossesCore(BaseShape)
Finalize()
GetAreaCore(GeographyUnit,AreaUnit)
GetAreaCore(Projection,AreaUnit,DistanceCalculationMode)
GetBoundingBoxCore()
GetCenterPointCore()
GetClosestPointToCore(BaseShape,GeographyUnit)
GetConvexHullCore()
GetCrossingCore(BaseShape)
GetDifferenceCore(AreaBaseShape)
GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)
GetGeoJsonCore()
GetIntersectionCore(AreaBaseShape)
GetPerimeterCore(GeographyUnit,DistanceUnit)
GetPerimeterCore(Projection,DistanceUnit,DistanceCalculationMode)
GetShortestLineToCore(BaseShape,GeographyUnit)
GetSymmetricalDifferenceCore(AreaBaseShape)
GetWellKnownBinaryCore(RingOrder,WkbByteOrder)
GetWellKnownTextCore(RingOrder)
GetWellKnownTypeCore()
IntersectsCore(BaseShape)
IsDisjointedCore(BaseShape)
IsTopologicallyEqualCore(BaseShape)
IsWithinCore(BaseShape)
LoadFromWellKnownDataCore(String)
LoadFromWellKnownDataCore(Byte[])
MemberwiseClone()
OverlapsCore(BaseShape)
RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)
RotateCore(PointShape,Single)
ScaleDownCore(Double)
ScaleToCore(Double)
ScaleUpCore(Double)
SimplifyCore(Double,SimplificationType)
TouchesCore(BaseShape)
TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)
TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)
UnionCore(AreaBaseShape)
ValidateCore(ShapeValidationMode)

Public Events Summary

Name Event Arguments Description
N/A N/A N/A

Members Detail

Public Constructors

Name
N/A

Protected Constructors

AreaBaseShape()

Summary

This is the default constructor for AreaBaseShape.

Remarks

This constructor simply calls the base constructor.

Return Value

Type Description
N/A

Parameters

Name Type Description
N/A N/A N/A

Public Properties

Id

Summary

N/A

Remarks

N/A

Return Value

String


Tag

Summary

N/A

Remarks

N/A

Return Value

Object


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

GetArea(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 a 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.

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

This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

Remarks

This method is useful when you want to create a perimeter around the shape. For example, if you had a MultiPolygon that represented buildings on a campus, you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes, where each point may represent a certain type of person you are doing statistics on. With convex hull, you can get an idea of the regions those points are located in.

Return Value

Type Description
RingShape This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

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

This method returns the difference between two shapes, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

None

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the targetShape.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the difference with.

GetDifference(Feature)

Summary

This method returns the difference between current shape and the specified feature, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

None

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the target feature.

Parameters

Name Type Description
targetFeature Feature The feture you are trying to find the difference with.

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(AreaBaseShape)

Summary

This method returns the intersection of the current shape 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
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target shape.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the intersection with.

GetIntersection(Feature)

Summary

This method returns the intersection of the current shape and the target feature, defined as the set of all points which lie in both the current shape and the target feature.

Remarks

None

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target feature.

Parameters

Name Type Description
targetFeature Feature The feature you are trying to find the intersection with.

GetPerimeter(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 a 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.

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

This method returns the symmetrical difference between two shapes, defined as the set of all points which lie in the current shape or the targetShape but not both.

Remarks

None

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetShape but not both.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the symmetrical difference with.

GetSymmetricalDifference(Feature)

Summary

This method returns the symmetrical difference between current shape and the specified feature, defined as the set of all points which lie in the current shape or the targetFeature but not both.

Remarks

None

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetFeature but not both.

Parameters

Name Type Description
targetFeature Feature The feature you are trying to find the symmetrical difference with.

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

This method decreases the size of the area shape 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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Parameters

Name Type Description
percentage Double This is the percentage by which to decrease the shape's size.

ScaleDown(AreaBaseShape,Double)

Summary

This method returns a new area shape that has been scaled down 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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Return Value

Type Description
AreaBaseShape 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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Parameters

Name Type Description
targetShape AreaBaseShape This parameter is the shape to use as the base for the scaling.
percentage Double This is the percentage by which to decrease the shape's size.

ScaleDown(Feature,Double)

Summary

This method returns a new area feature that has been scaled down by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to decrease the size of the feature. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Return Value

Type Description
Feature This method is useful when you would like to decrease the size of the feature. Note that a larger percentage will scale the shape down faster, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well.

Parameters

Name Type Description
targetFeature Feature This parameter is the shape to use as the base for the scaling.
percentage Double This is the percentage by which to decrease the shape's size.

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

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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape. as well.

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.

ScaleUp(AreaBaseShape,Double)

Summary

This method returns a new area shape that has been scaled up 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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well.

Return Value

Type Description
AreaBaseShape N/A

Parameters

Name Type Description
targetShape AreaBaseShape This parameter is the shape to use as the base for the scaling.
percentage Double This is the percentage by which to increase the shape's size.

ScaleUp(Feature,Double)

Summary

This method returns a new area shape that has been scaled up 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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well.

Return Value

Type Description
Feature N/A

Parameters

Name Type Description
targetFeature Feature This parameter is the feature to use as the base for the scaling.
percentage Double This is the percentage by which to increase the shape's size.

Simplify(GeographyUnit,Double,DistanceUnit,SimplificationType)

Summary

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value

Type Description
MultipolygonShape This method returns a simplification multipolgyon by the specified parameters.

Parameters

Name Type Description
shapeUnit GeographyUnit This parameter specifies the geographic unit of this current shape you are performing the operation
tolerance Double This parameter specifes the tolerance to be used when simplification.
toleranceUnit DistanceUnit This parameter specifes the distance unit of the tolerance.
simplificationType SimplificationType This prameter specifies the type of simplification operation.

Simplify(Double,SimplificationType)

Summary

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value

Type Description
MultipolygonShape This method returns a simplification multipolgyon by the specified parameters.

Parameters

Name Type Description
tolerance Double This parameter specifes the tolerance to be used when simplification.
simplificationType SimplificationType This prameter specifies the type of simplification operation.

Simplify(AreaBaseShape,GeographyUnit,Double,DistanceUnit,SimplificationType)

Summary

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value

Type Description
MultipolygonShape This method returns a simplification multipolgyon by the specified parameters.

Parameters

Name Type Description
targetShape AreaBaseShape This parameter specifies the area shape to be simplfied.
targetShapeUnit GeographyUnit This parameter specifies the geographic unit of the shape you are performing the operation
tolerance Double This parameter specifes the tolerance to be used when simplification.
toleranceUnit DistanceUnit This parameter specifes the distance unit of the tolerance.
simplificationType SimplificationType This prameter specifies the type of simplification operation.

Simplify(AreaBaseShape,Double,SimplificationType)

Summary

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value

Type Description
MultipolygonShape This method returns a simplification multipolgyon by the specified parameters.

Parameters

Name Type Description
targetShape AreaBaseShape This parameter specifies the area shape to be simplfied.
tolerance Double This parameter specifes the tolerance to be used when simplification.
simplificationType SimplificationType This prameter specifies the type of simplification operation.

Split(AreaBaseShape,AreaBaseShape)

Summary

This method returns a collection of MultiPolygonShapes split by the specified parameters.

Remarks

None.

Return Value

Type Description
Collection<MultipolygonShape> This method returns a collection of MultiPolygonShape split by the specified parameters.

Parameters

Name Type Description
areaToSplit AreaBaseShape This parameter represents the shape to be split.
areaToSplitBy AreaBaseShape This parameter represents the shape that will be used to perform the split.

Split(Feature,Feature)

Summary

This method returns a collection of Features split by the specified parameters.

Remarks

None.

Return Value

Type Description
Collection<Feature> This method returns a collection of Features split by the specified parameters.

Parameters

Name Type Description
areaToSplit Feature This parameter represents the feature to be split.
areaToSplitBy Feature This parameter represents the feature that will be used to perform the split.

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

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

This method returns the union of the current shape and the target shape, defined as the set of all points in the current shape or the target shape.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target shape.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the union with.

Union(Feature)

Summary

This method returns the union of the current shape and the target feature, defined as the set of all points in the current shape or the target feature.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target feature.

Parameters

Name Type Description
targetFeature Feature The feature you are trying to find the union with.

Union(IEnumerable<Feature>)

Summary

This method returns the union of the current shape and the target features, defined as the set of all points in the current shape or the target features.

Remarks

This is useful for adding area shapes together to form a larger area shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target features. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Parameters

Name Type Description
targetFeatures IEnumerable<Feature> The target features you are trying to find the union with.

Union(IEnumerable<AreaBaseShape>)

Summary

This method returns the union of the specified area shapes.

Remarks

This is useful for adding area shapes together to form a larger area shape.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points that lie within the shapes you specified.

Parameters

Name Type Description
areaShapes IEnumerable<AreaBaseShape> The shapes you are trying to find the union with.

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

N/A

Remarks

N/A

Return Value

Type Description
BaseShape N/A

Parameters

Name Type Description
N/A N/A N/A

ContainsCore(BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
targetShape BaseShape N/A

CrossesCore(BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
targetShape BaseShape N/A

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. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
Double The return unit is based on a 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

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetCenterPointCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
PointShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetClosestPointToCore(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

GetConvexHullCore()

Summary

This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

Remarks

This method is useful when you want to create a perimeter around the shape. For example, if you had a MultiPolygon that represented buildings on a campus, you could easily get the convex hull of the buildings and determine the perimeter of all of the buildings together. This also works with MultiPoint shapes, where each point may represent a certain type of person you are doing statistics on. With convex hull, you can get an idea of the regions those points are located in. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
RingShape This method returns the convex hull of the shape, defined as the smallest convex ring that contains all of the points in the shape.

Parameters

Name Type Description
N/A N/A N/A

GetCrossingCore(BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
MultipointShape N/A

Parameters

Name Type Description
targetShape BaseShape N/A

GetDifferenceCore(AreaBaseShape)

Summary

This method returns the difference between two shapes, defined as the set of all points which lie in the current shape but not in the targetShape.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape but not in the targetShape.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the difference with.

GetDistanceToCore(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

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

This method returns the intersection of the current shape and the target shape, defined as the set of all points which lie in both the current shape and the target shape.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in both the current shape and the target shape.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the intersection with.

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. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
Double The return unit is based on a 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

This method returns the symmetrical difference between two shapes, defined as the set of all points which lie in the current shape or the targetShape but not both.

Remarks

Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that is the set of all points which lie in the current shape or the targetShape but not both.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the symmetrical difference with.

GetWellKnownBinaryCore(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

GetWellKnownTextCore(RingOrder)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
outerRingOrder RingOrder N/A

GetWellKnownTypeCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
WellKnownType N/A

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

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
targetShape BaseShape N/A

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

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
wellKnownText String N/A

LoadFromWellKnownDataCore(Byte[])

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
wellKnownBinary Byte[] N/A

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

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

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

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, since you apply the operation multiple times. There is a ScaleUp method that will enlarge the shape as well. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
Void N/A

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, since you apply the operation multiple times. There is a ScaleDown method that will shrink the shape as well. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

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

This method performed a simplification operation based on the parameters passed in. Simplify permanently alters the input geometry so that the geometry becomes topologically consistent.

Remarks

N/A

Return Value

Type Description
MultipolygonShape This method returns a simplification multipolgyon by the specified parameters.

Parameters

Name Type Description
tolerance Double This parameter specifes the tolerance to be used when simplification.
simplificationType SimplificationType This prameter specifies the type of simplification operation.

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

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

TranslateByOffsetCore(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

UnionCore(AreaBaseShape)

Summary

This method returns the union of the current shape and the target shapes, defined as the set of all points in the current shape or the target shape.

Remarks

This is useful for adding area shapes together to form a larger area shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Type Description
MultipolygonShape The return type is a MultiPolygonShape that contains the set of all points which lie in the current shape or the target shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Parameters

Name Type Description
targetShape AreaBaseShape The shape you are trying to find the union with.

ValidateCore(ShapeValidationMode)

Summary

N/A

Remarks

N/A

Return Value

Type Description
ShapeValidationResult N/A

Parameters

Name Type Description
validationMode ShapeValidationMode N/A

Public Events