Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

IGeoObjectSequence

Extends ICustomizable, IEventEmitter, IParentOnMap.

Interface of an unchangeable collection of geo objects.

Constructor | Fields | Events | Methods

Constructor

IGeoObjectSequence()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

Events

NameDescription
boundschange

Change to coordinates of the geographical area that spans the collection and its child geo objects. Instance of the Event class.

mapchange

Map reference changed. Data fields:

  • oldMap - Old map.
  • newMap - New map.

Inherited from IParentOnMap.

optionschange

Change to the object options.

Inherited from ICustomizable.

pixelboundschange

Change to pixel coordinates of the area that includes the collection and its child geo objects. Instance of the Event class.

Methods

NameReturnsDescription
each(callback[, context])

Calls a handler function for each child geo object.

get(index)

IGeoObject

Returns a child geo object with the specified index.

getBounds()

Number[][]|null

Returns geographical coordinates of the area that covers the collection and its child geo objects.

getIterator()

IIterator

Returns iterator for child geo objects in the collection.

getLength()

Integer

Returns length of the collection.

getMap()

Map

Returns reference to the map.

Inherited from IParentOnMap.

getPixelBounds()

Number[][]|null

Returns global pixel coordinates of the area that spans the collection and its child geo objects.

indexOf(object)

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:

ParameterDefault valueDescription
callback*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Function

Handler function.

context

Type: Object

Context for the handler function.

* Mandatory parameter/option.

get

Returns a child geo object with the specified index.

Parameters:

ParameterDefault valueDescription
index*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

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:

ParameterDefault valueDescription
object*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IGeoObject

Child object.

* Mandatory parameter/option.