API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class MultiPoint

Package | org.openscales.core.geometry
Class | public class MultiPoint
Inheritance | MultiPoint Collection Geometry
Subclasses | LineString

MultiPoint is a collection of Points.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | area : Number [read-only] Calculate the approximate area of this geometry (the projection and the geodesic are not managed). | MultiPoint
|  | bounds : Bounds | Geometry
|  | components : Array Setter of the components (children) of this collection. | Collection
|  | componentsLength : int Number of components in the collection | Collection
|  | componentsString : String Get a string representing the components for this collection | Collection
|  | componentTypes : Array Getter and setter of the authorized types for the components (children) of this collection | Collection
|  | id : String | Geometry
|  | length : Number Returns the geometry's length. | Geometry
|  | parent : Geometry | Geometry

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | _bounds : Bounds = null The bounds of this geometry | Geometry

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | MultiPoint(components:Array = null) | MultiPoint
|  | addComponent(component:Geometry, index:Number):Boolean Add a new component (geometry) to the collection. | Collection
|  | addComponents(components:Array):void Add components to this geometry. | Collection
|  | addPoint(point:Point, index:Number):void Component of the specified index, casted to the Point type | MultiPoint
|  | atPoint(lonlat:LonLat, toleranceLon:Number, toleranceLat:Number):Boolean Determines if the feature is placed at the given point with a certain tolerance (or not). | Geometry
|  | calculateBounds():void Recalculate the bounds by iterating through the components and calling extendBounds() on each item. | Collection
|  | clearBounds():void Clear the geometry's bounds | Geometry
|  | clone():Geometry To get this geometry clone | MultiPoint
|  | componentByIndex(i:int):Geometry Component of the specified index, casted to the Geometry type | Collection
|  | contains(geom:Geometry, assertIntersection:Boolean = false):Boolean Determine if the input geometry is fully contained in this one. | Geometry
|  | containsPoint(p:Point):Boolean Test if a point is inside this geometry. | Collection
|  | destroy():void Destroy the collection. | Collection
|  | distanceTo(geom:Geometry):Number Calculate the closest distance between two geometries (on the x-y plane). | Geometry
|  | extendBounds(newBounds:Bounds):void Extends geometry's bounds If bounds are not defined yet, it initializes the bounds. | Geometry
|  | getcomponentsClone():Array TO get component clone | Collection
|  | intersects(geom:Geometry):Boolean Determine if the input geometry intersects this one. | Collection
|  | isLeftOrRight(p:Point, p0:Point, p1:Point):Number [static] Test if a point is at the left, at the right or on an infinite line. | Geometry
|  | removeComponent(component:Geometry):void Remove a component from this geometry. | Collection
|  | removeComponents(components:Array):void Remove components from this geometry. | Collection
|  | removePoint(point:Point):void | MultiPoint
|  | replaceComponent(index:int, component:Geometry):Boolean replace the component of specified index by the input geometry. | Collection
|  | segmentsIntersect(seg1:Array, seg2:Array, tolerance:Number = 0.0):Boolean [static] Determine whether two line segments intersect or not. | Geometry
|  | toShortString():String | MultiPoint
|  | toVertices():Array Return an array of all the vertices (Point) of this geometry | Collection
|  | transform(source:ProjProjection, dest:ProjProjection):void Method to convert the multipoint (x/y) from a projection system to an other. | MultiPoint

Property detail

area | property

`area:Number` [read-only]

Calculate the approximate area of this geometry (the projection and the geodesic are not managed).

Implementation
`public function get area():Number`
Constructor detail

MultiPoint | () | constructor

`public function MultiPoint(components:Array = null)`Parameters

| `components:Array` (default = `null`)``

Method detail

addPoint | () | method

`public function addPoint(point:Point, index:Number):void`

Component of the specified index, casted to the Point type

Parameters

| `point:Point`
| `index:Number`

clone | () | method |

`public override function clone():Geometry`

To get this geometry clone

Returns

| `Geometry`

removePoint | () | method |

`public function removePoint(point:Point):void` Parameters

| `point:Point`

toShortString | () | method |

`public override function toShortString():String`

Returns

| `String`

transform | () | method |

`public override function transform(source:ProjProjection, dest:ProjProjection):void`

Method to convert the multipoint (x/y) from a projection system to an other.

Parameters

| `source:ProjProjection` — The source projection
| `dest:ProjProjection` — The destination projection