- 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.kml.LineString
Class Summary
This class represents the
Extends
nokia.maps.kml.Geometry.
new nokia.maps.kml.LineString
(node, lineStyle, balloonStyle)
Method Summary
getCenterCoordinate
()
: nokia.maps.geo.Coordinate
This method calculates the arithmetic average of all coordinates.
getPath
()
: Array
This method converts the coordinates from string format to an array of instances of
nokia.maps.geo.Coordinate.
getStyle
()
: Object
This method gets the styles for the given object.
Field Summary
static
String
DEFAULT_STROKE_COLOR
Default stroke color for KML line object
static
Number
DEFAULT_STROKE_WIDTH
Default stroke width for KML line object
String
coordinates
Two or more coordinate tuples, each consisting of floating point values for longitude, latitude, and altitude.
Direct Inheritance
Indirect Inheritance
Constructor Detail
Initialize a new instance of the class with the following parameters.
new nokia.maps.kml.LineString(node, lineStyle, balloonStyle)
Parameters:
| {Node} | node | An XML node from KML document, which is currently parsed |
| {nokia.maps.kml.LineStyle} | lineStyle | An object representing the line style to be used during conversion to a map object |
| {nokia.maps.kml.BalloonStyle} | balloonStyle | An object representing the balloon style to use during conversion to a map object |
Method Detail
getCenterCoordinate
()
: nokia.maps.geo.Coordinate
This method calculates the arithmetic average of all coordinates.
Returns:
| {nokia.maps.geo.Coordinate} |
An instance of
nokia.maps.geo.Coordinate |
getPath
()
: Array
This method converts the coordinates from string format to an array
of instances of
nokia.maps.geo.Coordinate. If the array
has fewer than two coordinates, then null is returned.
Returns:
| {Array} |
An array of instances of
nokia.maps.geo.Coordinate objects or null
if the conversion finished unsuccessfully or the array has fewer than
two coordinates.
|