- 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.map.Polygon
Class Summary
This class represents map object that is, in effect, a closed polyline
(nokia.maps.map.Polyline). In other words, the last
point in the array of points that define the line is connected with the
first point.
new nokia.maps.map.Polygon
(path, props)
Properties
This interface defines the properties (keys) that can be passed to the constructor of
nokia.maps.map.Polygon.
Field Summary
Number
CHANGE_SPATIAL
Represents the invalidation type for spatial changes
Number
CHANGE_VISUAL
Represents the invalidation type for visual changes
Number
CHANGE_ZINDEX
Represents the invalidation type for zIndex changes
nokia.maps.util.IBrush
brush
This property specifies the brush used to fill the shape of the polygon.
Boolean
draggable
This property indicates if the given event target is draggable and may receive a
dragstart, drag and dragend events (true); false otherwise.
Object
eventListener
This property is either undefined or holds a hash table that, for every event type, contains an array with the values: (listener, useCapture, namespaceURI)(, listener, useCapture, namespaceURI)(,…)
Boolean
isEventTarget
This property indicates whether an object implements the nokia.maps.dom.EventTarget interface (
true>) or not (false).
nokia.maps.dom.EventTarget
parentNode
This property holds a reference to the parent node of the event target (if set).
Object
parentNodes
If this property is set it holds a hash table that contains the "namespaceURI" as key and the corresponding value is the parent node of the given event target.
nokia.maps.geo.Shape
path
The path to define the shape.
Number
simplify
The value of this property is specified as a number of pixels and indicates if and how much the rendering result is to be simplified.
Boolean
visibility
A flag that determines the visibility of the given
Object instance.
Number
zIndex
The z-index relative to the container.
Direct Inheritance
Inherited from nokia.maps.map.Polygon.Properties:
brush
Indirect Inheritance
Inherited from nokia.maps.map.Spatial:
drawToTile
Inherited from nokia.maps.map.Spatial.Properties:
simplify
Inherited from nokia.maps.map.Object:
destroy
getBoundingBox
getDisplays
getParent
isAdded
isVisible
CHANGE_SPATIAL
CHANGE_VISUAL
CHANGE_ZINDEX
Inherited from nokia.maps.dom.DragEventTarget:
drag
dragend
dragenter
dragleave
dragover
dragstart
drop
Inherited from nokia.maps.dom.EventTarget:
addListener
addListenerNS
disableDrag
disableUserSelect
dispatch
enableDrag
enableUserSelect
insertListener
insertListenerNS
nmHitTest
removeListener
removeListenerNS
draggable
eventListener
isEventTarget
parentNode
parentNodes
Inherited from nokia.maps.dom.MouseEventTarget:
click
dblclick
longpress
mousedown
mouseenter
mouseleave
mousemove
mouseout
mouseover
mouseup
mousewheel
Constructor Detail
This class represents map object that is, in effect, a closed polyline
(nokia.maps.map.Polyline). In other words, the last
point in the array of points that define the line is connected with the
first point.
new nokia.maps.map.Polygon(path, props)
Parameters:
| {nokia.maps.geo.Strip | nokia.maps.geo.Coordinate[]} | path |
An object containing the points (geographical locations) that define the polygon;
the object can be an instance of nokia.maps.geo.Strip or an array of
objects, each containing the latitude and longitude of a geographical location
|
| {nokia.maps.map.Polygon.Properties} | props | An object that names polygon properties to initialize and provides their values |