- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class nokia.maps.util.Rectangle
Class Summary
A Rectangle specifies an area in a two-dimensional coordinate space which is enclosed
by the rectangle object's top-left and bottom-right corners. The corners are
defined as instances of nokia.maps.util.Point.
new nokia.maps.util.Rectangle
(points)
Method Summary
addPoint
(point)
: nokia.maps.util.Rectangle
This method computes a wider rectangle that covers the point specified by the caller.
addPoints
(points)
: nokia.maps.util.Rectangle
This method widens the given rectangle so that it covers the points provided by the caller.
centerTo
(point)
: nokia.maps.util.Rectangle
This method widens the rectangle so that the given point lies in its center.
clone
()
: nokia.maps.util.Rectangle
This method obtains a clone of the given rectangle.
Field Summary
nokia.maps.util.Point
bottomRight
This property holds a
Point object that contains the coordinates of the lower right corner of the given rectangle.
nokia.maps.util.Point
topLeft
This property holds a
Point object that contains the coordinates of the upper left corner of the given rectangle.
Constructor Detail
A Rectangle specifies an area in a two-dimensional coordinate space which is enclosed
by the rectangle object's top-left and bottom-right corners. The corners are
defined as instances of nokia.maps.util.Point.
new nokia.maps.util.Rectangle(points)
Parameters:
| {nokia.maps.util.Point[]} | points | A list containing at least one point; the the created rectangle contains all the received points |
- Exceptions:
- {Error}
- if
pointsis empty
Method Detail
addPoint
(point)
: nokia.maps.util.Rectangle
This method computes a wider rectangle that covers the point specified by
the caller.
Parameters:
| {nokia.maps.util.Point} | point | The point to cover |
Returns:
| {nokia.maps.util.Rectangle} | A reference to the newly computed rectangle |
addPoints
(points)
: nokia.maps.util.Rectangle
This method widens the given rectangle so that it covers the points
provided by the caller.
Parameters:
| {nokia.maps.util.Point[]} | points | An array of points to cover |
Returns:
| {nokia.maps.util.Rectangle} | A reference to the given rectangle |
centerTo
(point)
: nokia.maps.util.Rectangle
This method widens the rectangle so that the given point lies in its center.
Parameters:
| {nokia.maps.util.Point} | point | The intended center of the rectangle |
Returns:
| {nokia.maps.util.Rectangle} | A reference to the given rectangle |
clone
()
: nokia.maps.util.Rectangle
This method obtains a clone of the given rectangle.
Returns:
| {nokia.maps.util.Rectangle} | A clone of the given rectangle |
Field Detail
nokia.maps.util.Point
bottomRight
This property holds a
Point object that contains the
coordinates of the lower right corner of the given rectangle.
nokia.maps.util.Point
topLeft
This property holds a
Point object that contains the
coordinates of the upper left corner of the given rectangle.