remove getAllTimelineVariables doc

This commit is contained in:
Josh de Leeuw 2023-09-23 13:42:07 -04:00
parent 0f68893daa
commit 77725fa1f5

View File

@ -287,39 +287,6 @@ This method tells jsPsych that the current trial is over. It is used in all of t
jsPsych.finishTrial({correct_response: true});
```
---
## jsPsych.getAllTimelineVariables
```javascript
jsPsych.getAllTimelineVariables()
```
### Parameters
None.
### Return value
Returns an object with all available timeline variables at this moment in the experiment, represented as `key: value` pairs.
### Description
This function can be used to get all the timeline variables at a particular moment in the experiment. Can be useful for annotating
data, such as in the example below.
### Example
```javascript
var trial = {
type: jsPsychHtmlKeyboardResponse,
stimulus: 'Just a demo',
on_finish: function(data){
// merge all timeline variables available at this trial into the data for this trial
Object.assign(data, jsPsych.getAllTimelineVariables())
}
}
```
---
## jsPsych.getCurrentTimelineNodeID