MultipointShape¶

Inheritance Hierarchy¶

• Object
• BaseShape
  • PointBaseShape
  • MultipointShape

Members Summary¶

Public Constructors Summary¶

Protected Constructors Summary¶

Public Properties Summary¶

Protected Properties Summary¶

Public Methods Summary¶

Protected Methods Summary¶

Public Events Summary¶

Members Detail¶

Public Constructors¶

Protected Constructors¶

Public Properties¶

Id¶

Summary

N/A

Remarks

N/A

Return Value

String

Points¶

Summary

This property is the collection of points that make up the MultipointShape.

Remarks

None

Return Value

Collection<PointShape>

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

Parameters

Buffer(Double,Int32,GeographyUnit,DistanceUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

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

Summary

N/A

Remarks

N/A

Return Value

Parameters

CloneDeep()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Contains(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Contains(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ConvexHull()¶

Summary

This method returns the convex hull of the shape (defined as the smallest convex ring that contains all 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 which 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

Parameters

Crosses(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Crosses(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Equals(Object)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetBoundingBox()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetCenterPoint()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointTo(BaseShape,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointTo(Feature,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetCrossing(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetDistanceTo(BaseShape,GeographyUnit,DistanceUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetDistanceTo(Feature,GeographyUnit,DistanceUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetFeature()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetFeature(IDictionary<String,String>)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetGeoJson()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetHashCode()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetShortestLineTo(BaseShape,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetShortestLineTo(Feature,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetType()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownBinary()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownBinary(WkbByteOrder)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownBinary(RingOrder)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownBinary(RingOrder,WkbByteOrder)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownText()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownText(RingOrder)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownType()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Intersects(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Intersects(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsDisjointed(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsDisjointed(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsTopologicallyEqual(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsTopologicallyEqual(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsWithin(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsWithin(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadFromWellKnownData(String)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadFromWellKnownData(Byte[])¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Overlaps(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Overlaps(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Register(PointShape,PointShape,DistanceUnit,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Register(Feature,Feature,DistanceUnit,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RemoveVertex(Vertex)¶

Summary

This method removes the point which the same coordinate as selected vertex from multipoint shape.

Remarks

N/A

Return Value

Parameters

RemoveVertex(Vertex,MultipointShape)¶

Summary

This method removes the point which the same coordinate as selected vertex from multipoint shape.

Remarks

N/A

Return Value

Parameters

Rotate(PointShape,Single)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ScaleDown(Double)¶

Summary

This method decreases the size of the shape by the percentage given in the percentage parameter.

Remarks

N/A

Return Value

Parameters

ScaleTo(Double)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ScaleUp(Double)¶

Summary

This method increases the size of the shape by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape.

Return Value

Parameters

ToString()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Touches(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Touches(Feature)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

TranslateByDegree(Double,Double,GeographyUnit,DistanceUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

TranslateByDegree(Double,Double)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

TranslateByOffset(Double,Double,GeographyUnit,DistanceUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

TranslateByOffset(Double,Double)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Validate(ShapeValidationMode)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Protected Methods¶

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

Summary

N/A

Remarks

N/A

Return Value

Parameters

CloneDeepCore()¶

Summary

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

Remarks

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

Return Value

Parameters

ContainsCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ConvexHullCore()¶

Summary

This method returns the convex hull of the shape (defined as the smallest convex ring that contains all 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 which 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

Parameters

CrossesCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Finalize()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetBoundingBoxCore()¶

Summary

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

Remarks

The GetBoundingBox method calculates the smallest RectangleShape that can encompass the entire geometry by examining each point in the geometry. Depending on the number of PointShapes and complexity of the geometry, this operation can take longer for larger objects. If the shape is a PointShape, then the bounding box�s upper left and lower right points will be equal. This will create a RectangleShape with no area. Overriding: Please ensure that you validate the parameters being passed in and raise the exceptions defined above.

Return Value

Parameters

GetCenterPointCore()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetClosestPointToCore(BaseShape,GeographyUnit)¶

Summary

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

Remarks

This method returns the point of the current shape that is closest to the target shape. It is often the case that the point returned is not a point of the object itself. An example would be a line with two points that are far apart from each other. If you set the targetShape to be a point midway between the points but a short distance away from the line, the method would return a point that is on the line but not either of the two points that make up the line.

Return Value

Parameters

GetCrossingCore(BaseShape)¶

Summary

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

Remarks

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetDistanceToCore(BaseShape,GeographyUnit,DistanceUnit)¶

Summary

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

Remarks

None

Return Value

Parameters

GetGeoJsonCore()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetShortestLineToCore(BaseShape,GeographyUnit)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownBinaryCore(RingOrder,WkbByteOrder)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWellKnownTextCore(RingOrder)¶

Summary

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

Remarks

This method returns a string that represents the shape in well-known text. Well-known text allows you to describe a geometry as a string of text. Well-known text is useful when you want to save a geometry in a format such as a text file, or when you simply want to cut and paste the text between other applications. An alternative to well-known text is well-known binary, which is a binary representation of a geometry object. We have methods that work with well-known binary as well. Below are some samples of what well-known text might look like for various kinds of geometric shapes.POINT(5 17)LINESTRING(4 5,10 50,25 80)POLYGON((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3))MULTIPOINT(3.7 9.7,4.9 11.6)MULTILINESTRING((4 5,11 51,21 26),(-4 -7,-9 -7,-14 -3))MULTIPOLYGON(((2 2,6 2,6 6,2 6,2 2),(3 3,4 3,4 4,3 4,3 3)),((4 4,7 3,7 5,4 4)))

Return Value

Parameters

GetWellKnownTypeCore()¶

Summary

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

Remarks

None

Return Value

Parameters

IntersectsCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsDisjointedCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsTopologicallyEqualCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

IsWithinCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadFromWellKnownDataCore(String)¶

Summary

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

Remarks

None

Return Value

Parameters

LoadFromWellKnownDataCore(Byte[])¶

Summary

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

Remarks

This is used when you want to hydrate a shape based on well-known binary. You can create the shape and then load the well-known binary using this method.

Return Value

Parameters

MemberwiseClone()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OverlapsCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

RegisterCore(PointShape,PointShape,DistanceUnit,GeographyUnit)¶

Summary

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

Remarks

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

Return Value

Parameters

RotateCore(PointShape,Single)¶

Summary

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

Remarks

This method rotates the shape a number of degrees based on a pivot point. By placing the pivot point in the center of the shape, you can achieve in-place rotation. By moving the pivot point outside of the center of the shape, you can translate the shape in a circular motion. Moving the pivot point further outside of the center will make the circular area larger.

Return Value

Parameters

ScaleDownCore(Double)¶

Summary

This method decreases the size of the shape by the percentage given in the percentage parameter.

Remarks

N/A

Return Value

Parameters

ScaleToCore(Double)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ScaleUpCore(Double)¶

Summary

This method increases the size of the shape by the percentage given in the percentage parameter.

Remarks

This method is useful when you would like to increase the size of the shape. Note that a larger percentage will scale the shape up faster, as you are applying the operation multiple times. There is also a ScaleDown method that will shrink the shape.

Return Value

Parameters

TouchesCore(BaseShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

TranslateByDegreeCore(Double,Double,GeographyUnit,DistanceUnit)¶

Summary

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

Remarks

This method moves the base shape from one location to another, based on an angleInDegrees and distance parameter. With this overload, it is important to note that the distance units are the same GeographicUnit as the shape. For example, if your shape is in decimal degrees and you call this method with a distance of 1, you're going to move this shape 1 decimal degree in direction of the angleInDegrees. In many cases it is more useful to specify the DistanceUnit of movement, such as in miles or yards, so for these scenarios there is another overload you may want to use instead.If you pass a distance of 0, then the operation is ignored.

Return Value

Parameters

TranslateByOffsetCore(Double,Double,GeographyUnit,DistanceUnit)¶

Summary

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

Remarks

This method moves the base shape from one location to another based on an X and Y offset distance. It is important to note that with this overload the X and Y offset units are based off of the distanceUnit parameter. For example if your shape is in decimal degrees and you call this method with an X offset of one and a Y offset of one and 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 to on the X axis and 3 miles on the Y axis.

Return Value

Parameters

ValidateCore(ShapeValidationMode)¶

Summary

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

Remarks

We use this method, with the simple enumeration, internally before doing any kind of other methods on the shape. In this way, we are able to verify the integrity of the shape itself. If you wish to test things such as whether a polygon self-intersects, we invite you to call this method with the advanced ShapeValidationMode. One thing to consider is that for complex polygon shapes this operation could take some time, which is why we only run the basic, faster test. If you are dealing with polygon shapes that are suspect, we suggest you run the advanced test.

Return Value

Parameters

Public Events¶