geoObject.Sequence
Extends IGeoObject, IGeoObjectSequence.
An unchanged collection of geo objects. Allows you to group geo objects for adding them to the map, setting options, etc. Collections are geo objects too.
Constructor | Fields | Events | Methods
Constructor
geoObject.Sequence([feature[, options]])
Creates an unchangeable collection of geo objects.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Collection description. For all purposes, corresponds to the geo object description. See GeoObject object. |
|
— |
Type: IGeoObject[] Array of child geoobjects. |
|
— |
Type: IGeometry|Object Geometry of a collection. |
|
— |
Type: IDataManager|Object Collection data. |
|
— |
Type: Object Collection options. You can set all the options described in the GeoObject object. Option values will be applied both to the collection itself and to its child objects, if these options are not set for them. |
Fields
Name |
Type |
Description |
Event manager. Inherited from IDomEventEmitter. |
||
IGeometry|null |
Geo object geometry. Inherited from IGeoObject. |
|
Options manager. Inherited from ICustomizable. |
||
Geo object data. Inherited from IGeoObject. |
||
State of the geo object. Inherited from IGeoObject. |
Events
Name |
Description |
Change to coordinates of the geographical area that spans the collection and its child geo objects. Instance of the Event class. Inherited from IGeoObjectSequence. |
|
Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Change to the geo object geometry. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
Map reference changed. Data fields:
Inherited from IParentOnMap. |
|
Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from IDomEventEmitter. |
|
Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:
Inherited from IDomEventEmitter. |
|
Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields:
Inherited from IDomEventEmitter. |
|
Change to the object options. Inherited from ICustomizable. |
|
Change to the geo object overlay. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
The parent object reference changed. Data fields:
Inherited from IChild. |
|
Change to pixel coordinates of the area that includes the collection and its child geo objects. Instance of the Event class. Inherited from IGeoObjectSequence. |
|
Change to the geo object data. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeoObject. |
|
Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
Methods
Name |
Returns |
Description |
Calls a handler function for each child geo object. Inherited from IGeoObjectSequence. |
||
Returns a child geo object with the specified index. Inherited from IGeoObjectSequence. |
||
Number[][]|null |
Returns geographical coordinates of the area that covers the collection and its child geo objects. Inherited from IGeoObjectSequence. |
|
Returns iterator for child geo objects in the collection. Inherited from IGeoObjectSequence. |
||
Integer |
Returns length of the collection. Inherited from IGeoObjectSequence. |
|
getMap() |
Returns reference to the map. Inherited from IParentOnMap. |
|
Returns the promise object, which is confirmed by the overlay object at the time it is actually created, or is rejected with an appropriate error message. Inherited from IGeoObject. |
||
IOverlay|null |
The method provides synchronous access to the overlay. Inherited from IGeoObject. |
|
IParentOnMap|null |
Returns link to the parent object, or null if the parent element was not set. Inherited from IChildOnMap. |
|
Number[][]|null |
Returns global pixel coordinates of the area that spans the collection and its child geo objects. Inherited from IGeoObjectSequence. |
|
Integer |
Returns index of the child geo object. If the geo object cannot be found in the collection, -1 is returned. Inherited from IGeoObjectSequence. |
|
Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object. Inherited from IChildOnMap. |