> For the complete documentation index, see [llms.txt](https://harmoware-vis.gitbook.io/harmoware-vis-documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://harmoware-vis.gitbook.io/harmoware-vis-documents/api/actions.md).

# Actions

#### Harmoware-VIS Actions List

| action                          | update props                             | Description                                                                                                          |
| ------------------------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| addMinutes(Number)              | settime                                  | add specified time (minutes) to the current `settime`                                                                |
| setTime(Number)                 | settime                                  | set the specified time to the `settime`                                                                              |
| setLeading(Number)              | leading                                  | set the specified time (sec) to the `leading`                                                                        |
| setTrailing(Number)             | trailing                                 | set the specified time (sec) to the `trailing`                                                                       |
| setViewport(object)             | viewport                                 | set the specified view data to the `viewport`                                                                        |
| setDefaultViewport              | void                                     | <p>Set the default value for the <code>viewport</code>.</p><p><code>{ bearing: 0, zoom: 11.1, pitch: 30 }</code></p> |
| setMovesBase(object/Array)      | timeBegin, timeLength, bounds, movesbase | set the specified simulation base data to the `timeBegin`,`timeLength`,`bounds`,`movesbase`                          |
| updateMovesBase(object/Array)   | timeBegin, timeLength, bounds, movesbase | set and update `timeBegin`, `timeLength`, `bounds`, `movesbase` with the specified simulation base data.             |
| setDepotsBase(Array)            | depotsBase                               | set the specified depots position data to the `depotsBase`                                                           |
| setAnimatePause(Boolean)        | animatePause                             | set the specified animation playback control data to the `animatePause`                                              |
| setAnimateReverse(Boolean)      | animateReverse                           | set the specified animation forward and reverse control data to the `animateReverse`                                 |
| setSecPerHour(Number)           | secperhour                               | set the specified animation playback speed control data (sec/hour) to the `secperhour`                               |
| setMultiplySpeed(Number)        | multiplySpeed                            | set the specified animation playback speed control data (multiply speed) to the `multiplySpeed`                      |
| setClicked(Array)               | clickedObject                            | set the specified clicked object data to the `clickedObject`                                                         |
| setRoutePaths(Array)            | routePaths                               | set the specified route path data to the `routePaths`                                                                |
| setDefaultZoom(Number)          | defaultZoom                              | set the specified default map zoom value to the `defaultZoom`                                                        |
| setDefaultPitch(Number)         | defaultPitch                             | set the specified default map pitch value to the `defaultPitch`                                                      |
| setMovesOptionFunc(Function)    | getMovesOptionFunc                       | set the specified moves data option info process function to the `getMovesOptionFunc`                                |
| setDepotsOptionFunc(Function)   | getDepotsOptionFunc                      | set the specified depots data option info process function to the `getDepotsOptionFunc`                              |
| setExtractedDataFunc(Function)  | getExtractedDataFunc                     | set the function `getExtractedDataFunc` to extract the data to be displayed at each playback timing.                 |
| setLoading(Function)            | loading                                  | set the specified Loading in progress to the `loading`                                                               |
| setNoLoop(Boolean)              | noLoop                                   | Sets the specified loop necessity to the `noLoop`                                                                    |
| setInitialViewChange(Boolean)   | initialViewChange                        | Sets the starting viewpoint shift requirement `initialViewChange`                                                    |
| setIconGradationChange(Boolean) | iconGradation                            | Set the icon color gradation setting value `iconGradation`                                                           |
| setTimeBegin(Number)            | timeBegin                                | Dynamic setting of `timeBegin`                                                                                       |
| setTimeLength(Number)           | timeLength                               | Dynamic setting of `timeLength`                                                                                      |

#### Examples

```javascript
const minutes = -10;
this.props.actions.addMinutes(minutes);

const unix-time = 1540000000;
this.props.actions.setTime(unix-time);

const seconds = 10;
this.props.actions.setLeading(seconds);
```