The abstract class from which area shapes, line shapes, and point shapes inherit from.

• System.Object
  • ThinkGeo.MapSuite.Core.BaseShape
    • ThinkGeo.MapSuite.Core.GeometryCollectionShape
    • ThinkGeo.MapSuite.Core.AreaBaseShape
    • ThinkGeo.MapSuite.Core.LineBaseShape
    • ThinkGeo.MapSuite.Core.PointBaseShape

BaseShape()

This is the default constructor for BaseShape.

N/A

LoadFromWellKnownData(String)

This method hydrates the current shape with its data from well-known text.

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.

• Type:Void
• Description:None

• wellKnownText
  • Type:String
  • Description:This parameter is the well-known text you will use to hydrate your object.

GetWellKnownText()

This method returns the well-known text representation of this shape.

This method returns a string that represents the shape in well-known text. Well-known text allows you to describe geometries 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 geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON¹⁾MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING²⁾MULTIPOLYGON³⁾,⁴⁾) 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.

• Type:String
• Description:This method returns a string that represents the shape in well-known text.

GetGeoJson()

N/A

N/A

• Type:String
• Description:N/A

GetWellKnownText(RingOrder)

This method returns the well-known text representation of this shape.

This method returns a stringthat represents the shape in well-known text. Well-known text allows you to describe geometries 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 geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON⁵⁾MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING⁶⁾MULTIPOLYGON⁷⁾,⁸⁾) Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:String
• Description:This method returns a string that represents the shape in well-known text.

• outerRingOrder
  • Type:RingOrder
  • Description:N/A

LoadFromWellKnownData(Byte[])

This method hydrates the current shape with its data from well-known binary.

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

• Type:Void
• Description:None

• wellKnownBinary
  • Type:Byte[]
  • Description:This parameter is the well-known binary used to populate the shape.

GetWellKnownBinary()

This method returns a byte array that represents the shape in well-known binary.

This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries 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. 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.

• Type:Byte[]
• Description:This method returns a byte array that represents the shape in well-known binary.

GetWellKnownBinary(WkbByteOrder)

This method returns a byte array that represents the shape in well-known binary.

This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries 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. 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.

• Type:Byte[]
• Description:This method returns a byte array that represents the shape in well-known binary.

• byteOrder
  • Type:WkbByteOrder
  • Description:This parameter is the byte order used to encode the well-known binary.

GetWellKnownBinary(RingOrder)

N/A

N/A

• Type:Byte[]
• Description:N/A

• outerRingOrder
  • Type:RingOrder
  • Description:N/A

GetWellKnownBinary(RingOrder,WkbByteOrder)

N/A

N/A

• Type:Byte[]
• Description:N/A

• outerRingOrder
  • Type:RingOrder
  • Description:N/A

• byteOrder
  • Type:WkbByteOrder
  • Description:N/A

GetBoundingBox()

This method calculates the smallest RectangleShape that encompasses the entire geometry.

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

• Type:RectangleShape
• Description:The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry.

GetWellKnownType()

This method returns the well-known type for the shape.

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.

• Type:WellKnownType
• Description:This method returns the well-known type for the shape.

CloneDeep()

This method returns a complete copy of the shape without any references in common.

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.

• Type:BaseShape
• Description:This method returns a complete copy of the shape without any references in common.

TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)

This method moves a base shape from one location to another based on an X and Y offset distance.

This method moves a 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 one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. 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.

• Type:Void
• Description:N/A

• xOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• yOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the base shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

TranslateByOffset(Double,Double)

This method moves a base shape from one location to another based on an X and Y offset distance.

This method moves a 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 one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. 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.

• Type:Void
• Description:N/A

• xOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• yOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)

This method moves a base shape from one location to another based on a distance and a direction in degrees.

This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. 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.

• Type:Void
• Description:N/A

• distance
  • Type:Double
  • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0.

• angleInDegrees
  • Type:Double
  • Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the DistanceUnit you would like to use as the measure of the translate. For example if you select miles as your distanceUnit then the distance will be calculated in miles.

TranslateByDegree(Double,Double)

This method moves a base shape from one location to another based on a distance and a direction in degrees.

This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. 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.

• Type:Void
• Description:N/A

• distance
  • Type:Double
  • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0.

• angleInDegrees
  • Type:Double
  • Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.

Rotate(PointShape,Single)

This method rotates a shape a number of degrees based on a pivot point.

This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. 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.

• Type:Void
• Description:N/A

• pivotPoint
  • Type:PointShape
  • Description:The pivotPoint represents the center of rotation.

• degreeAngle
  • Type:Single
  • Description:The number of degrees of rotation required, from 0 to 360.

GetShortestLineTo(BaseShape,GeographyUnit)

This method returns the shortest LineShape between this shape and the targetShape parameter.

This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This effect is similar to what you might see on an international flight when the displayed flight path is curved. 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.

• Type:MultilineShape
• Description:A LineShape representing the shortest distance between the shape you're calling the method on and the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the Shape you are trying to find the distance to.

GetShortestLineTo(Feature,GeographyUnit)

This method returns the shortest LineShape between this shape and the targetFeature. parameter.

This method returns a MultiLineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:MultilineShape
• Description:A MultiLineShape representing the shortest distance between the shape you're calling the method on and the targetFeature.

• targetFeature
  • Type:Feature
  • Description:The feature you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the feature you are trying to find the distance to.

GetClosestPointTo(BaseShape,GeographyUnit)

This method returns the point of the current shape that is closest to the target shape.

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

• Type:PointShape
• Description:A PointShape representing the closest point of the current shape to the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the closest point to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the shape you are trying to find the closet point to.

GetClosestPointTo(Feature,GeographyUnit)

This method returns the point of the current shape that is closest to the target feature.

This method returns the point of the current shape that is closest to the target feature. 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 targetFeature 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. 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.

• Type:PointShape
• Description:A PointShape representing the closest point of the current shape to the targetFeature.

• targetFeature
  • Type:Feature
  • Description:The feature you are trying to find the closest point to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the feature you are trying to find the closet point to.

GetCenterPoint()

This method returns the center point of the current shape's bounding box.

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

• Type:PointShape
• Description:A PointShape representing the center point of the current shape's bounding box.

Buffer(Double,GeographyUnit,DistanceUnit)

This method computes the area containing all of the points within a given distance from this shape.

This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. 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.

• Type:MultipolygonShape
• Description:The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape.

• distance
  • Type:Double
  • Description:The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation.

Buffer(Double,Int32,GeographyUnit,DistanceUnit)

This method computes the area containing all of the points within a given distance from this shape.

This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle. The distance unit is determined by the distanceUnit argument. 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.

• Type:MultipolygonShape
• Description:The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape.

• distance
  • Type:Double
  • Description:The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter.

• quadrantSegments
  • Type:Int32
  • Description:The quadrant segments are the number of points in each quarter circle. A good default is 8, but if you want smoother edges you can increase this number. The valid range for this number is from 3 to 100.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation.

Buffer(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

This method computes the area containing all of the points within a given distance from this shape.

This method computes the area containing all of the points within a given distance from this shape. 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.

• Type:MultipolygonShape
• Description:The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape.

• distance
  • Type:Double
  • Description:The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter.

• quadrantSegments
  • Type:Int32
  • Description:The quadrant segments are the number of points in each quarter circle. A good default is 8, but if you want smoother edges you can increase this number. The valid range for this number is from 3 to 100.

• bufferCapType
  • Type:BufferCapType
  • Description:The bufferCapType determines how the caps of the buffered object look. They range from rounded to squared off.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation.

GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)

This method computes the distance between the current shape and the targetShape.

In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified. 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.

• Type:Double
• Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:This parameter is the unit of the shape you are getting the distance to.

• distanceUnit
  • Type:DistanceUnit
  • Description:This parameter is the unit of the distance you want the return value to be in.

GetDistanceTo(Feature,GeographyUnit,DistanceUnit)

This method computes the distance between the current shape and the targetFeature.

In this method we compute the closest distance between a shape and a feature. The returned unit will be in the unit of distance specified. 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.

• Type:Double
• Description:The return type is the distance between this shape and the targetFeature in the GeographyUnit of the shape.

• targetFeature
  • Type:Feature
  • Description:The feature you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:This parameter is the unit of the shape which is contained in the targetFeature you are getting the distance to.

• distanceUnit
  • Type:DistanceUnit
  • Description:This parameter is the unit of the distance you want the return value to be in.

Register(PointShape,PointShape,DistanceUnit,GeographyUnit)

This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. 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.

• Type:BaseShape
• Description:This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

• fromPoint
  • Type:PointShape
  • Description:This parameter is the anchor PointShape in the coordinate of origin.

• toPoint
  • Type:PointShape
  • Description:This parameter is the anchor PointShape in the coordinate of destination.

• fromUnit
  • Type:DistanceUnit
  • Description:This parameter is the DistanceUnit of the coordinate of origin.

• toUnit
  • Type:GeographyUnit
  • Description:This parameter is the GeographyUnit of the coordinate of destination.

Register(Feature,Feature,DistanceUnit,GeographyUnit)

This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. 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.

• Type:BaseShape
• Description:This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

• fromPoint
  • Type:Feature
  • Description:This parameter is the anchor PointFeature in the coordinate of origin.

• toPoint
  • Type:Feature
  • Description:This parameter is the anchor PointFeature in the coordinate of destination.

• fromUnit
  • Type:DistanceUnit
  • Description:This parameter is the DistanceUnit of the coordinate of origin.

• toUnit
  • Type:GeographyUnit
  • Description:This parameter is the GeographyUnit of the coordinate of destination.

Validate(ShapeValidationMode)

This method returns a ShapeValidationResult based on a series of tests.

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

• Type:ShapeValidationResult
• Description:This method returns a ShapeValidationResult based on a series of tests.

• validationMode
  • Type:ShapeValidationMode
  • Description:This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast.

IsDisjointed(BaseShape)

This method returns if the current shape and the targetShape have no points in common.

None

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have no points in common. 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.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IsDisjointed(Feature)

This method returns if the current shape and the targetFeature have no points in common.

None

• Type:Boolean
• Description:This method returns if the current shape and the targetFeature have no points in common. 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.

• targetFeature
  • Type:Feature
  • Description:The feature you wish to compare the current one to.

Intersects(BaseShape)

This method returns if the current shape and the targetShape have at least one point in common.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have at least one point in common.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Intersects(Feature)

This method returns if the current shape and the targetFeature have at least one point in common.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetFeature have at least one point in common.

• targetFeature
  • Type:Feature
  • Description:The targetFeature you wish to compare the current one to.

Touches(BaseShape)

This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Touches(Feature)

This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points.

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.

• Type:Boolean
• Description:This method returns of the current shape and the targetFeature have at least one boundary point in common, but no interior points.

• targetFeature
  • Type:Feature
  • Description:The targetFeature which contains a shape that you wish to compare the current one to.

Crosses(BaseShape)

This method returns if the current shape and the targetShape share some but not all interior points.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape share some but not all interior points.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Crosses(Feature)

This method returns if the current shape and the targetFeature share some but not all interior points.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetFeature share some but not all interior points.

• targetFeature
  • Type:Feature
  • Description:The targetFeature that contains a shape you wish to compare the current one to.

IsWithin(BaseShape)

This method returns if the current shape lies within the interior of the targetShape.

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.

• Type:Boolean
• Description:This method returns if the current shape lies within the interior of the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IsWithin(Feature)

This method returns if the current shape lies within the interior of the targetFeature.

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.

• Type:Boolean
• Description:This method returns if the current shape lies within the interior of the targetFeature.

• targetFeature
  • Type:Feature
  • Description:The targetFeature that contains a shape you wish to compare the current one to.

Contains(BaseShape)

This method returns if the targetShape lies within the interior of the current shape.

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.

• Type:Boolean
• Description:This method returns if the targetShape lies within the interior of the current shape.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Contains(Feature)

This method returns if the targetFeature lies within the interior of the current shape.

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.

• Type:Boolean
• Description:This method returns if the targetFeature lies within the interior of the current shape.

• targetFeature
  • Type:Feature
  • Description:The targetFeature that contains a shape you wish to compare the current one to.

Overlaps(BaseShape)

This method returns if the current shape and the targetShape share some but not all points in common.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape share some but not all points in common.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

Overlaps(Feature)

This method returns if the current shape and the targetFeature share some but not all points in common.

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.

• Type:Boolean
• Description:This method returns if the current shape and the targetFeature share some but not all points in common.

• targetFeature
  • Type:Feature
  • Description:The targetFeature that contains a shape you wish to compare the current one to.

IsTopologicallyEqual(BaseShape)

This method returns if the current shape and the targetShape are topologically equal.

Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. 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.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape are topologically equal.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IsTopologicallyEqual(Feature)

This method returns if the current shape and the targetFeature are topologically equal.

Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. 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.

• Type:Boolean
• Description:This method returns if the current shape and the targetFeature are topologically equal.

• targetFeature
  • Type:Feature
  • Description:The targetFeature that contains a shape you wish to compare the current one to.

GetFeature()

Get a corresponding feature which has the same Id and BaseShape as the current shape.

N/A

• Type:Feature
• Description:The feature with the same Id and BaseShape as the current BaseShape, and with empty columnValues in it.

GetFeature(IDictionary<String,String>)

N/A

N/A

• Type:Feature
• Description:N/A

• columnValues
  • Type:IDictionary<String,String>
  • Description:N/A

GetCrossing(BaseShape)

This method returns the crossing points between the current shape and the passed-in target shape.

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.

• Type:MultipointShape
• Description:This method returns the crossing points between the current shape and the passed-in target shape.

• targetShape
  • Type:BaseShape
  • Description:The target shape you wish to get crossing points with.

ScaleTo(Double)

This method increases or decreases the size of the shape by the specified scale factor given in the parameter.

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.

• Type:Void
• Description:This method is useful when you would like to increase or decrease the size of the shape.

• scale
  • Type:Double
  • Description:Pepresents a value which scaleFactor to

ToString()

N/A

N/A

• Type:String
• Description:N/A

Equals(Object)

N/A

N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

N/A

N/A

• Type:Int32
• Description:N/A

GetType()

N/A

N/A

• Type:Type
• Description:N/A

CreateShapeFromWellKnownData(String)

This method creates a BaseShape from a string of well-known text.

This method creates a BaseShape from a string of well-known text. Well-known text allows you to describe geometries 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 geometries.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON⁹⁾MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING¹⁰⁾MULTIPOLYGON¹¹⁾,¹²⁾)

• Type:BaseShape
• Description:The return type is a higher level shape constructed from the well-known text you passed into the method. Though the object is a higher level shape, such as a PolygonShape or MultiPointShape, you will need to cast it to that shape in order to use its unique properties.

• wellKnownText
  • Type:String
  • Description:A string representing the geometry in well-known text format.

CreateShapeFromWellKnownData(Byte[])

This method creates a BaseShape from a string of well-known binary.

This method creates a BaseShape from a string of well-known binary. Well-known binary allows you to describe geometries 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.

• Type:BaseShape
• Description:The return type is a higher level shape constructed from the well-known binary you passed into the method. Though the object is a higher level shape, such as a PolygonShape or MultiPointShape, you will need to cast it to that shape in order to use its unique properties.

• wellKnownBinary
  • Type:Byte[]
  • Description:An array of bytes representing the geometry in well-known binary format.

CreateShapeFromGeoJson(String)

N/A

N/A

• Type:BaseShape
• Description:N/A

• geoJson
  • Type:String
  • Description:N/A

TranslateByOffset(BaseShape,Double,Double,GeographyUnit,DistanceUnit)

This method returns a shape repositioned from one location to another based on an X and Y offset distance.

This method returns a shape repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. 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.

• Type:BaseShape
• Description:This method returns a shape repositioned from one location to another based on an X and Y offset distance.

• targetShape
  • Type:BaseShape
  • Description:This parameter is the basis of the moved shape.

• xOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• yOffsetDistance
  • Type:Double
  • Description:This is the number of vertical units of movement in the distance unit specified in the distanceUnit parameter.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

TranslateByOffset(Feature,Double,Double,GeographyUnit,DistanceUnit)

This method returns a feature repositioned from one location to another based on an X and Y offset distance.

This method returns a feature repositioned from one location to another based on an X and Y offset distance. With this overload, it is important to note that the X and Y offset units are based on the distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with an X offset of 1 and a Y offset of 1, you're going to move this shape one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. 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.

• Type:Feature
• Description:This method returns a feature repositioned from one location to another based on an X and Y offset distance.

• targetFeature
  • Type:Feature
  • Description:This parameter is the basis of the moved feature.

• xOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• yOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

TranslateByDegree(BaseShape,Double,Double,GeographyUnit,DistanceUnit)

This method returns a shape repositioned from one location to another based on a distance and a direction in degrees.

This method returns a shape repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. 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.

• Type:BaseShape
• Description:This method returns a shape repositioned from one location to another based on a distance and a direction in degrees.

• targetShape
  • Type:BaseShape
  • Description:This parameter is the basis of the move.

• distance
  • Type:Double
  • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the one specified in the distanceUnit parameter. The distance must be greater than or equal to 0.

• angleInDegrees
  • Type:Double
  • Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the distance will be calculated in miles.

TranslateByDegree(Feature,Double,Double,GeographyUnit,DistanceUnit)

This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees.

This method returns a feature repositioned from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this feature a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0, then the operation is ignored. 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.

• Type:BaseShape
• Description:This method returns a feature repositioned from one location to another, based on a distance and a direction in degrees.

• targetFeature
  • Type:Feature
  • Description:This parameter is the basis of the move.

• distance
  • Type:Double
  • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0.

• angleInDegrees
  • Type:Double
  • Description:A number between 0 and 360 degrees that represents the direction you wish to move the feature, with 0 being up.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the distance will be calculated in miles.

Rotate(BaseShape,PointShape,Single)

This method returns a shape rotated by a number of degrees based on a pivot point.

This method returns a shape rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. 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.

• Type:BaseShape
• Description:This method returns a shape rotated by a number of degrees based on a pivot point.

• sourceBaseShape
  • Type:BaseShape
  • Description:This parameter is the basis for the rotation.

• pivotPoint
  • Type:PointShape
  • Description:The pivotPoint represents the center of rotation.

• degreeAngle
  • Type:Single
  • Description:The number of degrees of rotation required, from 0 to 360.

Rotate(Feature,PointShape,Single)

This method returns a feature rotated by a number of degrees based on a pivot point.

This method returns a feature rotated by a number of degrees based on a pivot point. By placing the pivot point in the center of the feature you can achieve in-place rotation. By moving the pivot point outside of the center of the feature you can translate the feature in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. 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.

• Type:BaseShape
• Description:This method returns a shape rotated by a number of degrees based on a pivot point.

• targetFeature
  • Type:Feature
  • Description:This parameter is the basis for the rotation.

• pivotPoint
  • Type:PointShape
  • Description:The pivotPoint represents the center of rotation.

• degreeAngle
  • Type:Single
  • Description:The number of degrees of rotation required, from 0 to 360.

ScaleTo(BaseShape,Double)

This method increases or decreases the size of the shape by the specified scale factor given in the parameter.

It will call the instanced method ScaleTo internally.

• Type:BaseShape
• Description:This method is useful when you would like to increase or decrease the size of the shape.

• baseShape
  • Type:BaseShape
  • Description:Represents a shape which you want to resize

• scale
  • Type:Double
  • Description:Pepresents a value which scaleFactor to.

LoadFromWellKnownDataCore(String)

This method hydrates the current shape with its data from well-known text.

None

• Type:Void
• Description:None

• wellKnownText
  • Type:String
  • Description:This parameter is the well-known text you will use to hydrate your object.

GetGeoJsonCore()

N/A

N/A

• Type:String
• Description:N/A

GetWellKnownTextCore(RingOrder)

N/A

N/A

• Type:String
• Description:N/A

• outerRingOrder
  • Type:RingOrder
  • Description:N/A

LoadFromWellKnownDataCore(Byte[])

This method hydrates the current shape with its data from well-known binary.

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.

• Type:Void
• Description:None

• wellKnownBinary
  • Type:Byte[]
  • Description:This parameter is the well-known binary used to populate the shape.

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)

This method returns a byte array that represents the shape in well-known binary.

This method returns a byte array that represents the shape in well-known binary. Well-known binary allows you to describe geometries 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. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:Byte[]
• Description:This method returns a byte array that represents the shape in well-known binary.

• outerRingOrder
  • Type:RingOrder
  • Description:N/A

• byteOrder
  • Type:WkbByteOrder
  • Description:This parameter specifies if the byte order is big- or little-endian.

GetBoundingBoxCore()

This method calculates the smallest RectangleShape that encompasses the entire geometry.

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

• Type:RectangleShape
• Description:The RectangleShape returned is the smallest RectangleShape that can encompass the entire geometry.

GetWellKnownTypeCore()

This method returns the well-known type for the shape.

None

• Type:WellKnownType
• Description:This method returns the well-known type for the shape.

CloneDeepCore()

This method returns a complete copy of the shape without any references in common.

When you override this method, you need to ensure that there are no references in common between the original and copy.

• Type:BaseShape
• Description:This method returns a complete copy of the shape without any references in common.

TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)

This method moves a base shape from one location to another based on an X and Y offset distance.

This method moves a 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 one unit of the distanceUnit in the horizontal direction and one unit of the distanceUnit in the vertical direction. In this way, you can easily move a shape in decimal degrees five miles on the X axis and 3 miles on the Y axis. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:Void
• Description:N/A

• xOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• yOffsetDistance
  • Type:Double
  • Description:This is the number of horizontal units of movement in the distance unit specified in the distanceUnit parameter.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the base shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the measure for the move. For example, if you select miles as your distance unit, then the xOffsetDistance and yOffsetDistance will be calculated in miles.

TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)

This method moves a base shape from one location to another based on a distance and a direction in degrees.

This method moves a base shape from one location to another based on angleInDegrees and distance parameter. With this overload, it is important to note that the distance is based on the supplied distanceUnit parameter. For example, if your shape is in decimal degrees and you call this method with a distanceUnit of miles, you're going to move this shape a number of miles based on the distance value and the angleInDegrees. In this way, you can easily move a shape in decimal degrees five miles to the north.If you pass a distance of 0 then the operation is ignored. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:Void
• Description:N/A

• distance
  • Type:Double
  • Description:The distance is the number of units to move the shape using the angle specified. The distance unit will be the DistanceUnit specified in the distanceUnit parameter. The distance must be greater than or equal to 0.

• angleInDegrees
  • Type:Double
  • Description:A number between 0 and 360 degrees that represents the direction you wish to move the shape, with 0 being up.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the DistanceUnit you would like to use as the measure of the translate. For example if you select miles as your distanceUnit then the distance will be calculated in miles.

RotateCore(PointShape,Single)

This method rotates a shape a number of degrees based on a pivot point.

This method rotates a shape by a number of degrees based on a pivot point. By placing the pivot point in the center of the shape you can achieve in-place rotation. By moving the pivot point outside of the center of the shape you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:Void
• Description:N/A

• pivotPoint
  • Type:PointShape
  • Description:The pivotPoint represents the center of rotation.

• degreeAngle
  • Type:Single
  • Description:The number of degrees of rotation required, from 0 to 360.

GetShortestLineToCore(BaseShape,GeographyUnit)

This method returns the shortest LineShape between this shape and the targetShape parameter.

This method returns a LineShape representing the shortest distance between the shape you're calling the method on and the targetShape. In some instances, based on the GeographicType or Projection, the line may not be straight. This is effect is similar to what you might see on an international flight when the displayed flight path is curved. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:MultilineShape
• Description:A LineShape representing the shortest distance between the shape you're calling the method on and the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the shape you are trying to find the distance to.

GetClosestPointToCore(BaseShape,GeographyUnit)

This method returns the point of the current shape that is closest to the target shape.

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

• Type:PointShape
• Description:A PointShape representing the closest point of the current shape to the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the closest point to.

• shapeUnit
  • Type:GeographyUnit
  • Description:The geographic unit of the shape you are trying to find the closet point to.

GetCenterPointCore()

This method returns the center point of the current shape's bounding box.

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.

• Type:PointShape
• Description:A PointShape representing the center point of the current shape's bounding box.

BufferCore(Double,Int32,BufferCapType,GeographyUnit,DistanceUnit)

This method computes the area containing all of the points within a given distance from this shape.

This method computes the area containing all of the points within a given distance from this shape. In this case, you will be using the rounded RoundedBufferCapStyle and the default 8 quadrant segments. The distance unit is determined by the distanceUnit argument. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:MultipolygonShape
• Description:The return type is a MultiPolygonShape that represents all of the points within a given distance from the shape.

• distance
  • Type:Double
  • Description:The distance is the number of units to buffer the current shape. The distance unit will be the one specified in the distanceUnit parameter.

• quadrantSegments
  • Type:Int32
  • Description:The number of quadrantSegments used in the buffer logic.

• bufferCapType
  • Type:BufferCapType
  • Description:The bufferCapType used in the buffer logic.

• shapeUnit
  • Type:GeographyUnit
  • Description:This is the geographic unit of the shape you are performing the operation on.

• distanceUnit
  • Type:DistanceUnit
  • Description:This is the distance unit you would like to use as the distance. For example, if you select miles as your distanceUnit, then the distance will be calculated in miles for the operation.

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)

This method computes the distance between the current shape and the targetShape.

In this method we compute the closest distance between the two shapes. The returned unit will be in the unit of distance specified.

• Type:Double
• Description:The return type is the distance between this shape and the targetShape in the GeographyUnit of the shape. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• targetShape
  • Type:BaseShape
  • Description:The shape you are trying to find the distance to.

• shapeUnit
  • Type:GeographyUnit
  • Description:the geographic unit of the targetShape.

• distanceUnit
  • Type:DistanceUnit
  • Description:The returning distance unit.

RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)

This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

Registering allows you to take a geometric shape generated in a planar system and attach it to the ground in a Geographic Unit.A common scenario is integrating geometric shapes from external programs (such as CAD software or a modeling system) and placing them onto a map. You may have the schematics of a building in a CAD system and the relationship between all the points of the building are in feet. You want to then take the CAD image and attach it to where it really exists on a map. You would use the register method to do this.Registering is also useful for scientific modeling, where software models things such as a plume of hazardous materials or the fallout from a volcano. The modeling software typically generates these models in a fictitious planar system. You would then use the register to take the abstract model and attach it to a map with real coordinates. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:BaseShape
• Description:This method returns a BaseShape which has been registered from its original coordinate system to another based on two anchor PointShapes.

• fromPoint
  • Type:PointShape
  • Description:This parameter is the anchor PointShape in the coordinate of origin.

• toPoint
  • Type:PointShape
  • Description:This parameter is the anchor PointShape in the coordinate of destination.

• fromUnit
  • Type:DistanceUnit
  • Description:This parameter is the DistanceUnit of the coordinate of origin.

• toUnit
  • Type:GeographyUnit
  • Description:This parameter is the GeographyUnit of the coordinate of destination.

ValidateCore(ShapeValidationMode)

This method returns a ShapeValidationResult based on a series of tests.

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

• Type:ShapeValidationResult
• Description:This method returns a ShapeValidationResult based on a series of tests.

• validationMode
  • Type:ShapeValidationMode
  • Description:This parameter determines whether the test is simple or advanced. In some cases, the advanced tests can take some time. The simple test is designed to always be fast.

IsDisjointedCore(BaseShape)

This method returns if the current shape and the targetShape have no points in common.

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

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have no points in common.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IntersectsCore(BaseShape)

This method returns if the current shape and the targetShape have at least one point in common.

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

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have at least one point in common.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

TouchesCore(BaseShape)

This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.

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

• Type:Boolean
• Description:This method returns if the current shape and the targetShape have at least one boundary point in common, but no interior points.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

CrossesCore(BaseShape)

This method returns if the current shape and the targetShape share some but not all interior points.

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

• Type:Boolean
• Description:This method returns if the current shape and the targetShape share some but not all interior points.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IsWithinCore(BaseShape)

This method returns if the current shape lies within the interior of the targetShape.

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

• Type:Boolean
• Description:This method returns if the current shape lies within the interior of the targetShape.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

ContainsCore(BaseShape)

This method returns if the targetShape lies within the interior of the current shape.

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

• Type:Boolean
• Description:This method returns if the targetShape lies within the interior of the current shape.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

OverlapsCore(BaseShape)

This method returns if the current shape and the targetShape share some but not all points in common.

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

• Type:Boolean
• Description:This method returns if the current shape and the targetShape share some but not all points in common.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

IsTopologicallyEqualCore(BaseShape)

This method returns if the current shape and the targetShape are topologically equal.

Topologically equal means that the shapes are essentially the same. For example, let's say you have a line with two points, point A and point B. You also have another line that is made up of point A, point B and point C. Point A of line one shares the same vertex as point A of line two, and point B of line one shares the same vertex as point C of line two. They are both straight lines, so point B of line two would lie on the first line. Essentially the two lines are the same, with line 2 having just one extra point. Topologically they are the same line, so this method would return true. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

• Type:Boolean
• Description:This method returns if the current shape and the targetShape are topologically equal.

• targetShape
  • Type:BaseShape
  • Description:The shape you wish to compare the current one to.

GetCrossingCore(BaseShape)

This method returns the crossing points between the current shape and the passed-in target shape.

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.

• Type:MultipointShape
• Description:This method returns the crossing points between the current shape and the passed-in target shape.

• targetShape
  • Type:BaseShape
  • Description:The target shape you wish to get crossing with.

ScaleToCore(Double)

This method increases or decreases the size of the shape by the specified scale factor given in the parameter.

This protected virtual method is called from the concrete public method ScaleTo. It does not take into account any transaction activity, as this is the responsibility of the concrete public method ScaleTo. This way, as a developer, if you choose to override this method you do not have to consider transactions at all.

• Type:Void
• Description:This method is useful when you would like to increase or decrease the size of the shape.

• scale
  • Type:Double
  • Description:Pepresents a value which scaleFactor to

Finalize()

N/A

N/A

• Type:Void
• Description:N/A

MemberwiseClone()

N/A

N/A

• Type:Object
• Description:N/A

Id

The id of the shape.

N/A

• Type:String

Tag

The tag of the shape.

N/A

• Type:Object

CanRotate

This property specifies whether the shape can be rotated.

If this property returns false and you attempt to call the rotate method, it will throw a NotImplementedException.

• Type:Boolean