map.action.Continuous
Extends IMapAction.
Map movement consisting of one or more steps. Intended for implementing complex map movements.
Constructor | Fields | Events | Methods
Constructor
map.action.Continuous()
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
Event that notifies the map that movement has finished. Inherited from IMapAction. |
|
Event that notifies the map of the next step. Contains the fields:
Inherited from IMapAction. |
Methods
Name |
Returns |
Description |
Starts the movement to be performed by the map. This method is called automatically by the map movement manager. From the moment when IMapAction.begin is called, the movement manager listens for IMapAction.event:tick and IMapAction.event:end and executes them. Inherited from IMapAction. |
||
end() |
Stops movement. Inherited from IMapAction. |
|
isActive() |
Boolean |
Checks whether map movement is being performed at this moment. |
Performs a single step of the map movement. |
Methods details
isActive
{Boolean} isActive()
Checks whether map movement is being performed at this moment.
Returns true if the movement is currently being performed by the map, otherwise false.
tick
{map.action.Continuous} tick(tick)
Performs a single step of the map movement.
Returns self-reference.
Parameters:
Parameter |
Default value |
Description |
|
— |
Type: Object Movement parameters. |
0 |
Type: Number Duration of making the move, in milliseconds. |
|
— |
Type: Number[] The new map center in global pixels. One of the parameters must be set: either pixelOffset, or globalPixelCenter. |
|
— |
Type: Number[] The offset in pixels relative to the previous center. One of the parameters must be set: either pixelOffset, or globalPixelCenter. |
|
'linear' |
Type: String Timing function. |
|
— |
Type: Number The new map zoom. If omitted, the map zoom does not change. |
* Mandatory parameter/option.
Mandatory parameter/option.