IGeoObjectCollection
Extends ICustomizable, IEventEmitter, IParentOnMap.
Interface of a collection of geo objects.
Constructor | Fields | Events | Methods
Constructor
IGeoObjectCollection()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
A child geo object has been added (inserted). Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
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. |
|
A child geo object has been removed. Instance of the Event class. Names of fields that are available via the Event.get method:
|
|
A new child geo object has been added to the collection. Instance of the Event class. Names of fields that are available via the Event.get method:
|
Methods
Name |
Returns |
Description |
Adds (inserts) a child geo object to the collection. |
||
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 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. |
|
Removes a child geo object from the collection. |
||
Clears the collection. |
||
Adds a new child geo object to the collection. |
||
Removes geo objects from the collection. If necessary, puts other objects in their place. Objects that will be added in place of the deleted ones are passed as additional parameters (after the "number" parameter). |
Events details
add
A child geo object has been added (inserted). Instance of the Event class. Names of fields that are available via the Event.get method:
- index: Integer - Index of the added geo object.
- child: IGeoObject - Reference to the added geo object.
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.
remove
A child geo object has been removed. Instance of the Event class. Names of fields that are available via the Event.get method:
- index: Integer - Index of the deleted geo object.
- child: IGeoObject - Reference to the deleted geo object.
set
A new child geo object has been added to the collection. Instance of the Event class. Names of fields that are available via the Event.get method:
- index: Integer - Index of the geo object.
- child: IGeoObject - Reference to the new geo object.
- prevChild: IGeoObject - Reference to the previous value for this index.
Methods details
add
{IGeoObjectCollection} add(child[, index])
Adds (inserts) a child geo object to the collection.
Returns self-reference.
Parameters:
Parameter |
Default value |
Description |
— |
Type: IGeoObject Child object. |
|
— |
Type: Integer The index where the new object is added. By default, the object is added to the end of the collection. |
* Mandatory parameter/option.
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 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: Object Child object. |
* Mandatory parameter/option.
remove
{IGeoObjectCollection} remove(child)
Removes a child geo object from the collection.
Returns self-reference.
Parameters:
Parameter |
Default value |
Description |
— |
Type: IGeoObject Geo object being removed. |
* Mandatory parameter/option.
removeAll
{IGeoObjectCollection} removeAll()
Clears the collection.
Returns self-reference.
set
{IGeoObjectCollection} set(index, child)
Adds a new child geo object to the collection.
Returns self-reference.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Integer Index. |
|
— |
Type: IGeoObject Child object. |
* Mandatory parameter/option.
splice
{IGeoObjectCollection} splice(index, number)
Removes geo objects from the collection. If necessary, puts other objects in their place. Objects that will be added in place of the deleted ones are passed as additional parameters (after the "number" parameter).
Returns collection of deleted geo objects.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Integer Index of the geo object to start deletion from. |
|
— |
Type: Integer The number of geo objects to be deleted. |
* Mandatory parameter/option.
Mandatory parameter/option.