- 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.StyleContainer
Class Summary
This class contains an array of nokia.maps.kml.StyleSelector
objects. It is mainly used for holding the global styles on which the
attribute id is set. If a style does not have the
id attribute, it is not added to the array neither in the
constructor nor in the push() method.
new nokia.maps.kml.StyleContainer
([style])
Method Summary
getStyleById
(id, [highlighted])
: nokia.maps.kml.Style
This method gets the concrete
nokia.maps.kml.Style for the nokia.maps.kml.StyleSelector matching the id provided by the caller
getStyles
()
: Object
This method gets the internal array of
nokia.maps.kml.StyleSelector
push
(style)
: Object
This method adds new element to the internal array.
Constructor Detail
Initialize a new instance of the class with the following parameters.
new nokia.maps.kml.StyleContainer([style])
Parameters:
| {nokia.maps.kml.StyleSelector} | [style]: |
An instance of
nokia.maps.kml.StyleSelector that provides the initial
style definition; it must contain the attribute id; if
this argument is not specified, or does not contain id
attribute, then this initial array is empty
|
Method Detail
getStyleById
(id, [highlighted])
: nokia.maps.kml.Style
This method gets the concrete
nokia.maps.kml.Style for
the nokia.maps.kml.StyleSelector matching the id provided
by the caller
Parameters:
| {String} | id |
A unique identifier for the StyleSelector
|
| {Boolean} | [highlighted]: |
A Boolean value that indicates if the
method is to return the style for a highlighted case
(true); if the value is true and if the
particular style is not a StyleMap, then the method returns null,
because there is no highlighted style for the nokia.maps.kml.Style object
|
Returns:
| {nokia.maps.kml.Style} | style matching the id specified by the caller |
getStyles
()
: Object
This method gets the internal array of
nokia.maps.kml.StyleSelector
Returns:
| {Object} |
An array of instances of nokia.maps.kml.StyleSelector
|
push
(style)
: Object
This method adds new element to the internal array.
Parameters:
| {nokia.maps.kml.StyleSelector} | style |
An instance of
nokia.maps.kml.StyleSelector that provides the
style definition; it must contain the attribute id
|
Returns:
| {Object} |
An array of instances of nokia.maps.kml.StyleSelectors
|