IGeoObjectSequence
Extends ICustomizable, IEventEmitter, IParentOnMap.
Interface of an unchangeable collection of geo objects.
Constructor | Fields | Events | Methods
Constructor
IGeoObjectSequence()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Change to coordinates of the geographical area that spans the collection and its child geo objects. Instance of the Event class. |
|
Map reference changed. Data fields:
Inherited from IParentOnMap. |
|
Change to the object options. Inherited from ICustomizable. |
|
Change to pixel coordinates of the area that includes the collection and its child geo objects. Instance of the Event class. |
Methods
Name |
Returns |
Description |
Calls a handler function for each child geo object. |
||
Returns a child geo object with the specified index. |
||
Number[][]|null |
Returns geographical coordinates of the area that covers the collection and its child geo objects. |
|
Returns iterator for child geo objects in the collection. |
||
Integer |
Returns length of the collection. |
|
getMap() |
Returns reference to the map. Inherited from IParentOnMap. |
|
Number[][]|null |
Returns global pixel coordinates of the area that spans the collection and its child geo objects. |
|
Integer |
Returns index of the child geo object. If the geo object cannot be found in the collection, -1 is returned. |
Events details
boundschange
Change to coordinates of the geographical area that spans the collection and its child geo objects. Instance of the Event class.
pixelboundschange
Change to pixel coordinates of the area that includes the collection and its child geo objects. Instance of the Event class.
Methods details
each
{} each(callback[, context])
Calls a handler function for each child geo object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Function Handler function. |
|
— |
Type: Object Context for the handler function. |
* Mandatory parameter/option.
get
{IGeoObject} get(index)
Returns a child geo object with the specified index.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Integer Index. |
* Mandatory parameter/option.
getBounds
{Number[][]|null} getBounds()
Returns geographical coordinates of the area that covers the collection and its child geo objects.
getIterator
{IIterator} getIterator()
Returns iterator for child geo objects in the collection.
getLength
{Integer} getLength()
Returns length of the collection.
getPixelBounds
{Number[][]|null} getPixelBounds()
Returns global pixel coordinates of the area that spans the collection and its child geo objects.
indexOf
{Integer} indexOf(object)
Returns index of the child geo object. If the geo object cannot be found in the collection, -1 is returned.
Parameters:
Parameter |
Default value |
Description |
— |
Type: IGeoObject Child object. |
* Mandatory parameter/option.
Mandatory parameter/option.