diff --git a/README.md b/README.md index 43333eb..acddc00 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ PsychoJS is a JavaScript library that makes it possible to run neuroscience, psychology, and psychophysics experiments in a browser. It is the online counterpart of the [PsychoPy](http://www.psychopy.org/) Python library. -You can create online experiments from the [PsychoPy Builder](http://www.psychopy.org/builder/builder.html), you can find and adapt existing experiments on [pavlovia.org](https://www.pavlovia.org), or create them from scratch: the PsychoJS API is available [here](https://psychopy.github.io/psychojs/). +You can create online experiments from the [PsychoPy Builder](http://www.psychopy.org/builder/builder.html), you can find and adapt existing experiments on [pavlovia.org](https://www.pavlovia.org), or create them from scratch. PsychoJS is an open-source project. You can contribute by submitting pull requests to the [PsychoJS GitHub repository](https://github.com/psychopy/psychojs), and discuss issues and current and future features on the [Online category of the PsychoPy Forum](https://discourse.psychopy.org/c/online). @@ -55,8 +55,8 @@ Alain Pitiot - [@apitiot](https://github.com/apitiot) The PsychoJS library was initially written by [Ilixa](http://www.ilixa.com) with support from the [Wellcome Trust](https://wellcome.ac.uk). It is now a collaborative effort, supported by the [Chan Zuckerberg Initiative](https://chanzuckerberg.com/) (2020-2021) and [Open Science Tools](https://opensciencetools.org/) (2020-): - Alain Pitiot - [@apitiot](https://github.com/apitiot) -- Sotiri Bakagiannis - [@thewhodidthis](https://github.com/thewhodidthis) - Nikita Agafonov - [@lightest](https://github.com/lightest) +- Sotiri Bakagiannis - [@thewhodidthis](https://github.com/thewhodidthis) - Jonathan Peirce - [@peircej](https://github.com/peircej) - Thomas Pronk - [@tpronk](https://github.com/tpronk) - Hiroyuki Sogo - [@hsogo](https://github.com/hsogo) diff --git a/docs/AudioClip.html b/docs/AudioClip.html new file mode 100644 index 0000000..0ed740c --- /dev/null +++ b/docs/AudioClip.html @@ -0,0 +1,2132 @@ + + + + + + AudioClip - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

AudioClip

+ + + + + + + +
+ +
+ +

+ sound + + AudioClip +

+ +

AudioClip encapsulates an audio recording.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new AudioClip(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

name + + +String + + + + + + <optional>
+ + + + + + 		+ + 'audioclip' + +

the name used when logging messages

format + + +string + + + + + + + + + + + +

the format for the audio file

sampleRateHz + + +number + + + + + + + + + + + +

the sampling rate

data + + +Blob + + + + + + + + + + + +

the audio data, in the given format, at the given sampling rate

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Engine :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
GOOGLE + + +Symbol + + + +

Google Cloud Speech-to-Text.

+ + + + + + +
+

Recognition engines.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) Status :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
CREATED + + +Symbol + + + +
DECODING + + +Symbol + + + +
READY + + +Symbol + + + +
+ + + + + + +
+

AudioClip status.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(protected) _base64ArrayBuffer(arrayBuffer) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert an array buffer to a base64 string.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
arrayBuffer + +

the input buffer

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the base64 encoded input buffer

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(protected) _decodeAudio()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Decode the formatted audio data (e.g. webm) into a 32bit float PCM audio buffer.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _GoogleTranscribe(transcriptionKey, languageCode) → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Transcribe the audio clip using the Google Cloud Speech-To-Text Engine.

+

ref: https://cloud.google.com/speech-to-text/docs/reference/rest/v1/speech/recognize

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
transcriptionKey + + +String + + + +

the secret key to the Google service

languageCode + + +String + + + +

the BCP-47 language code for the recognition, e.g. 'en-GB'

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

a promise resolving to the transcript and associated +transcription confidence

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

download()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Offer the audio clip to the participant as a sound file to download.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) getDuration() → {Promise.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the duration of the audio clip, in seconds.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the duration of the audio clip

+
+ + + +
+
+ Type +
+
+ +Promise.<number> + + +
+
+ + + + + + + + + + +

setVolume(volume)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the volume of the playback.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
volume + + +number + + + +

the volume of the playback (must be between 0.0 and 1.0)

+ + + + + + + + + + + + + + + + + + + + + + + + +

(async) startPlayback()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the audio clip.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) stopPlayback(fadeDurationopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop playing the audio clip.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fadeDuration + + +number + + + + + + <optional>
+ + + + + + 		+ + 17 + +

how long the fading out should last, in ms

+ + + + + + + + + + + + + + + + + + + + + + + + +

(async) transcribe(options) → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Transcribe the audio clip.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
engine + + +Symbol + + + +

the speech-to-text engine

languageCode + + +String + + + +

the BCP-47 language code for the recognition, +e.g. 'en-GB'

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

a promise resolving to the transcript and associated +transcription confidence

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

upload()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Upload the audio clip to the pavlovia server.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/AudioClipPlayer.html b/docs/AudioClipPlayer.html new file mode 100644 index 0000000..6c8d83c --- /dev/null +++ b/docs/AudioClipPlayer.html @@ -0,0 +1,1672 @@ + + + + + + AudioClipPlayer - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

AudioClipPlayer

+ + + + + + + +
+ +
+ +

+ sound + + AudioClipPlayer +

+ +

This class handles the playback of an audio clip, e.g. a microphone recording.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new AudioClipPlayer(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

audioClip + + +Object + + + + + + + + + + + +

the module:sound.AudioClip

startTime + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

start of playback (in seconds)

stopTime + + +number + + + + + + <optional>
+ + + + + + 		+ + -1 + +

end of playback (in seconds)

stereo + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to play the sound or track in stereo

volume + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

volume of the sound (must be between 0 and 1.0)

loops + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

how many times to repeat the track or tone after it has played *

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) accept(sound) → {Object|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether this player can play the given sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sound + + +module:sound.Sound + + + +

the sound object, which should be an AudioClip

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

an instance of AudioClipPlayer if sound is an AudioClip or undefined otherwise

+
+ + + +
+
+ Type +
+
+ +Object +| + +undefined + + +
+
+ + + + + + + + + + +

getDuration() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the duration of the AudioClip, in seconds.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the duration of the clip, in seconds

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

play(loops, fadeDurationopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
loops + + +number + + + + + + + + + + + +

how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped.

fadeDuration + + +number + + + + + + <optional>
+ + + + + + 		+ + 17 + +

how long should the fading in last in ms

+ + + + + + + + + + + + + + + + + + + + + + + + +

setDuration(duration_s)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the duration of the audio clip.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
duration_s + + +number + + + +

the duration of the clip in seconds

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLoops(loops)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the number of loops.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loops + + +number + + + +

how many times to repeat the clip after it has played once. If loops == -1, the clip will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

setVolume(volume, muteopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the volume of the playback.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
volume + + +number + + + + + + + + + + + +

the volume of the playback (must be between 0.0 and 1.0)

mute + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to mute the playback

+ + + + + + + + + + + + + + + + + + + + + + + + +

stop(fadeDurationopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop playing the sound immediately.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fadeDuration + + +number + + + + + + <optional>
+ + + + + + 		+ + 17 + +

how long the fading out should last, in ms

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/BuilderKeyResponse.html b/docs/BuilderKeyResponse.html new file mode 100644 index 0000000..84b980d --- /dev/null +++ b/docs/BuilderKeyResponse.html @@ -0,0 +1,306 @@ + + + + + + BuilderKeyResponse - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

BuilderKeyResponse

+ + + + + + + +
+ +
+ +

+ BuilderKeyResponse +

+ +

Utility class used by the experiment scripts to keep track of a clock and of the current status (whether or not we are currently checking the keyboard)

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new BuilderKeyResponse(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +

Classes

+ +
+
BuilderKeyResponse
+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/ButtonStim.html b/docs/ButtonStim.html new file mode 100644 index 0000000..c803113 --- /dev/null +++ b/docs/ButtonStim.html @@ -0,0 +1,4100 @@ + + + + + + ButtonStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

ButtonStim

+ + + + + + + +
+ +
+ +

+ visual + + ButtonStim +

+ +

ButtonStim visual stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new ButtonStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
win + + +module:core.Window + + + + + + + + + + + +

the associated Window

name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

text + + +string + + + + + + <optional>
+ + + + + + 		+ + "" + +

the text to be rendered

font + + +string + + + + + + <optional>
+ + + + + + 		+ + "Arial" + +

the font family

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the text

anchor + + +string + + + + + + <optional>
+ + + + + + 		+ + "center" + +

horizontal alignment

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the text size and position

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color("white") + +

the background color

fillColor + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color("darkgrey") + +

the fill color

borderColor + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color("white") + +

the border color

borderWidth + + +Color + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the border width

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

letterHeight + + +number + + + + + + <optional>
+ + + + + + 		+ +

the height of the text

bold + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the text is bold

italic + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the text is italic

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Members

+ + + +

isClicked

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Is this button currently being clicked on?

+
+ + + + + + + + + + +

numClicks

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

How many times has this button been clicked on?

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _addEventListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add event listeners to text-box object. Method is called internally upon object construction.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getAnchor() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert the anchor attribute into numerical values.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the anchor, as an array of numbers in [0,1]
    • +
+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _getDefaultLetterHeight() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the default letter height given the stimulus' units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the letter height corresponding to this stimulus' units.
    • +
+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected) _getTextInputOptions()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the TextInput options applied to the PIXI.TextInput.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • take size into account
    • +
+
+ +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

clear()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clears the current text value.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getText() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

For accessing the underlying input value.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the current text value of the underlying input element.
    • +
+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

reset()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clears the current text value or sets it back to match the placeholder.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setAlignment(alignment, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the alignment attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
alignment + + +boolean + + + + + + + + + + + + left + +

alignment of the text

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setAnchor(anchor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the anchor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
anchor + + +boolean + + + + + + + + + + + + center + +

anchor of the textbox

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setBorderColor(borderColor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the borderColor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
borderColor + + +Color + + + + + + + + + + + +

border color of the text box

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setColor(color, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the color attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
color + + +boolean + + + + + + + + + + + +

color of the text

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFillColor(fillColor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the fillColor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fillColor + + +boolean + + + + + + + + + + + +

fill color of the text box

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFitToContent(fitToContent, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the fitToContent attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fitToContent + + +boolean + + + + + + + + + + + +

whether or not to autoresize textbox to fit to text content

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFont(font, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the font for textbox.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
font + + +string + + + + + + + + + + + + Arial + +

the font family

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLanguageStyle(languageStyle, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the languageStyle attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
languageStyle + + +String + + + + + + + + + + + + LTR + +

text direction in textbox, accepts values ["LTR", "RTL", "Arabic"]

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLetterHeight(fontSizeopt, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set letterHeight (font size) for textbox.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fontSize + + +string + + + + + + <optional>
+ + + + + + 		+ + <default value> + +

the size of the font

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setSize(size, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the size attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
size + + +boolean + + + + + + + + + + + +

whether or not to wrap the text at the given width

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setText(text)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

For tweaking the underlying input value.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
text + + +string + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Clock.html b/docs/Clock.html new file mode 100644 index 0000000..2685592 --- /dev/null +++ b/docs/Clock.html @@ -0,0 +1,752 @@ + + + + + + Clock - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Clock

+ + + + + + + +
+ +
+ +

+ util + + Clock +

+ +

Clock is a MonotonicClock that also offers the possibility of being reset.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Clock()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

add(deltaTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add more time to the clock's 'start' time (t0).

+

Note: by adding time to t0, the current time is pushed forward (it becomes +smaller). As a consequence, getTime() may return a negative number.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
deltaTime + + +number + + + + + + <optional>
+ + + + + +

the time to be added to the clock's start time (t0)

+ + + + + + + + + + + + + + + + + + + + + + + + +

getLastResetTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current offset being applied to the high resolution timebase used by this Clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the offset (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

getTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current time on this clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the current time (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

reset(newTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the time on the clock.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
newTime + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the new time on the clock.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Color.html b/docs/Color.html new file mode 100644 index 0000000..d111e6e --- /dev/null +++ b/docs/Color.html @@ -0,0 +1,6506 @@ + + + + + + Color - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Color

+ + + + + + + +
+ +
+ +

+ util + + Color +

+ +

This class handles multiple color spaces, and offers various +static methods for converting colors from one space to another.

+

The constructor accepts the following color representations: +

    +
  • a named color, e.g. 'aliceblue' (the colorspace must be RGB)
    • +
  • an hexadecimal string representation, e.g. '#FF0000' (the colorspace must be RGB)
    • +
  • an hexadecimal number representation, e.g. 0xFF0000 (the colorspace must be RGB)
    • +
  • a triplet of numbers, e.g. [-1, 0, 1], [0, 128, 255] (the numbers must be within the range determined by the colorspace)
    • +
+

+

Note: internally, colors are represented as a [r,g,b] triplet with r,g,b in [0,1].

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Color(objopt, colorspaceopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • implement HSV, DKL, and LMS colorspaces
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
obj + + +string +| + +number +| + +Array.<number> +| + +undefined + + + + + + <optional>
+ + + + + + 		+ + 'black' + +

an object representing a color

colorspace + + +module:util.Color#COLOR_SPACE +| + +undefined + + + + + + <optional>
+ + + + + + 		+ + Color.COLOR_SPACE.RGB + +

the colorspace of that color

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) COLOR_SPACE :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
RGB + + +Symbol + + + +

RGB colorspace: [r,g,b] with r,g,b in [-1, 1]

RGB255 + + +Symbol + + + +

RGB255 colorspace: [r,g,b] with r,g,b in [0, 255]

+ + + + + + +
+

Color spaces.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) NAMED_COLORS :string

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
aliceblue + + +string + + + +
antiquewhite + + +string + + + +
aqua + + +string + + + +
aquamarine + + +string + + + +
azure + + +string + + + +
beige + + +string + + + +
bisque + + +string + + + +
black + + +string + + + +
blanchedalmond + + +string + + + +
blue + + +string + + + +
blueviolet + + +string + + + +
brown + + +string + + + +
burlywood + + +string + + + +
cadetblue + + +string + + + +
chartreuse + + +string + + + +
chocolate + + +string + + + +
coral + + +string + + + +
cornflowerblue + + +string + + + +
cornsilk + + +string + + + +
crimson + + +string + + + +
cyan + + +string + + + +
darkblue + + +string + + + +
darkcyan + + +string + + + +
darkgoldenrod + + +string + + + +
darkgray + + +string + + + +
darkgrey + + +string + + + +
darkgreen + + +string + + + +
darkkhaki + + +string + + + +
darkmagenta + + +string + + + +
darkolivegreen + + +string + + + +
darkorange + + +string + + + +
darkorchid + + +string + + + +
darkred + + +string + + + +
darksalmon + + +string + + + +
darkseagreen + + +string + + + +
darkslateblue + + +string + + + +
darkslategray + + +string + + + +
darkslategrey + + +string + + + +
darkturquoise + + +string + + + +
darkviolet + + +string + + + +
deeppink + + +string + + + +
deepskyblue + + +string + + + +
dimgray + + +string + + + +
dimgrey + + +string + + + +
dodgerblue + + +string + + + +
firebrick + + +string + + + +
floralwhite + + +string + + + +
forestgreen + + +string + + + +
fuchsia + + +string + + + +
gainsboro + + +string + + + +
ghostwhite + + +string + + + +
gold + + +string + + + +
goldenrod + + +string + + + +
gray + + +string + + + +
grey + + +string + + + +
green + + +string + + + +
greenyellow + + +string + + + +
honeydew + + +string + + + +
hotpink + + +string + + + +
indianred + + +string + + + +
indigo + + +string + + + +
ivory + + +string + + + +
khaki + + +string + + + +
lavender + + +string + + + +
lavenderblush + + +string + + + +
lawngreen + + +string + + + +
lemonchiffon + + +string + + + +
lightblue + + +string + + + +
lightcoral + + +string + + + +
lightcyan + + +string + + + +
lightgoldenrodyellow + + +string + + + +
lightgray + + +string + + + +
lightgrey + + +string + + + +
lightgreen + + +string + + + +
lightpink + + +string + + + +
lightsalmon + + +string + + + +
lightseagreen + + +string + + + +
lightskyblue + + +string + + + +
lightslategray + + +string + + + +
lightslategrey + + +string + + + +
lightsteelblue + + +string + + + +
lightyellow + + +string + + + +
lime + + +string + + + +
limegreen + + +string + + + +
linen + + +string + + + +
magenta + + +string + + + +
maroon + + +string + + + +
mediumaquamarine + + +string + + + +
mediumblue + + +string + + + +
mediumorchid + + +string + + + +
mediumpurple + + +string + + + +
mediumseagreen + + +string + + + +
mediumslateblue + + +string + + + +
mediumspringgreen + + +string + + + +
mediumturquoise + + +string + + + +
mediumvioletred + + +string + + + +
midnightblue + + +string + + + +
mintcream + + +string + + + +
mistyrose + + +string + + + +
moccasin + + +string + + + +
navajowhite + + +string + + + +
navy + + +string + + + +
oldlace + + +string + + + +
olive + + +string + + + +
olivedrab + + +string + + + +
orange + + +string + + + +
orangered + + +string + + + +
orchid + + +string + + + +
palegoldenrod + + +string + + + +
palegreen + + +string + + + +
paleturquoise + + +string + + + +
palevioletred + + +string + + + +
papayawhip + + +string + + + +
peachpuff + + +string + + + +
peru + + +string + + + +
pink + + +string + + + +
plum + + +string + + + +
powderblue + + +string + + + +
purple + + +string + + + +
red + + +string + + + +
rosybrown + + +string + + + +
royalblue + + +string + + + +
saddlebrown + + +string + + + +
salmon + + +string + + + +
sandybrown + + +string + + + +
seagreen + + +string + + + +
seashell + + +string + + + +
sienna + + +string + + + +
silver + + +string + + + +
skyblue + + +string + + + +
slateblue + + +string + + + +
slategray + + +string + + + +
slategrey + + +string + + + +
snow + + +string + + + +
springgreen + + +string + + + +
steelblue + + +string + + + +
tan + + +string + + + +
teal + + +string + + + +
thistle + + +string + + + +
tomato + + +string + + + +
turquoise + + +string + + + +
violet + + +string + + + +
wheat + + +string + + + +
white + + +string + + + +
whitesmoke + + +string + + + +
yellow + + +string + + + +
yellowgreen + + +string + + + +
+ + + + + + +
+

Named colors.

+
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + + + + +

hex

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the hexadecimal color code equivalent of this Color.

+
+ + + + + + + + + + +

int

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer code equivalent of this Color.

+
+ + + + + + + + + + +

rgb

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0,1] RGB triplet equivalent of this Color.

+
+ + + + + + + + + + +

rgb255

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0,255] RGB triplet equivalent of this Color.

+
+ + + + + + + + + + +

rgbFull

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [-1,1] RGB triplet equivalent of this Color.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected, static) _checkTypeAndRange(arg, rangeopt) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check that the argument is an array of numbers of size 3, and, potentially, that its elements fall within the range.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
arg + + +any + + + + + + + + + +

the argument

range + + +Array.<number> + + + + + + <optional>
+ + + + + +

the lower and higher bounds of the range

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether the argument is an array of numbers of size 3, and, potentially, whether its elements fall within the range (if range is not undefined)

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

(protected, static) _intToRgb(hex) → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0, 1] based RGB triplet equivalent of the integer color code.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hex + + +number + + + +

the integer color code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the [0, 1] RGB equivalent

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected, static) _intToRgb255(hex) → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0, 255] based RGB triplet equivalent of the integer color code.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hex + + +number + + + +

the integer color code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the [0, 255] RGB equivalent

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected, static) _rgb255ToHex(rgb255) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the hexadecimal color code equivalent of the [0, 255] RGB triplet.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb255 + + +Array.<number> + + + +

the [0, 255] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the hexadecimal color code equivalent

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(protected, static) _rgb255ToInt(rgb255) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer equivalent of the [0, 255] RGB triplet.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb255 + + +Array.<number> + + + +

the [0, 255] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the integer equivalent

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected, static) _rgbToHex(rgb) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the hexadecimal color code equivalent of the [0, 1] RGB triplet.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb + + +Array.<number> + + + +

the [0, 1] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the hexadecimal color code equivalent

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(protected, static) _rgbToInt(rgb) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer equivalent of the [0, 1] RGB triplet.

+

Note: this is the fast, unsafe version which does not check for argument sanity

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb + + +Array.<number> + + + +

the [0, 1] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the integer equivalent

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(static) hexToRgb(hex) → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0,1] RGB triplet equivalent of the hexadecimal color code.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hex + + +string + + + +

the hexadecimal color code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the [0,1] RGB triplet equivalent

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(static) hexToRgb255(hex) → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the [0,255] RGB triplet equivalent of the hexadecimal color code.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hex + + +string + + + +

the hexadecimal color code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the [0,255] RGB triplet equivalent

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(static) rgb255ToHex(rgb255) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the hexadecimal color code equivalent of the [0, 255] RGB triplet.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb255 + + +Array.<number> + + + +

the [0, 255] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the hexadecimal color code equivalent

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) rgb255ToInt(rgb255) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer equivalent of the [0, 255] RGB triplet.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb255 + + +Array.<number> + + + +

the [0, 255] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the integer equivalent

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(static) rgbToHex(rgb) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the hexadecimal color code equivalent of the [0, 1] RGB triplet.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb + + +Array.<number> + + + +

the [0, 1] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the hexadecimal color code equivalent

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) rgbToInt(rgb) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer equivalent of the [0, 1] RGB triplet.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rgb + + +Array.<number> + + + +

the [0, 1] RGB triplet

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the integer equivalent

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

toString() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

String representation of the color, i.e. the hexadecimal representation.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the representation.

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/CountdownTimer.html b/docs/CountdownTimer.html new file mode 100644 index 0000000..596e88c --- /dev/null +++ b/docs/CountdownTimer.html @@ -0,0 +1,824 @@ + + + + + + CountdownTimer - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

CountdownTimer

+ + + + + + + +
+ +
+ +

+ util + + CountdownTimer +

+ +

CountdownTimer is a clock counts down from the time of last reset. + + +

+ +
+ +
+ + + + +

Constructor

+ + +

new CountdownTimer(startTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
startTime + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the start time of the countdown

+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

add(deltaTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add more time to the clock's 'start' time (t0).

+

Note: by adding time to t0, you push the current time forward (make it +smaller). As a consequence, getTime() may return a negative number.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
deltaTime + + +number + + + + + + <optional>
+ + + + + +

the time to be added to the clock's start time (t0)

+ + + + + + + + + + + + + + + + + + + + + + + + +

getLastResetTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current offset being applied to the high resolution timebase used by this Clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the offset (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

getTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the time currently left on the countdown.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the time left on the countdown (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

reset(newTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the time on the countdown.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
newTime + + +number + + + + + + <optional>
+ + + + + +

if newTime is undefined, the countdown time is reset to zero, otherwise we set it +to newTime

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/EventEmitter.html b/docs/EventEmitter.html new file mode 100644 index 0000000..c138eec --- /dev/null +++ b/docs/EventEmitter.html @@ -0,0 +1,895 @@ + + + + + + EventEmitter - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

EventEmitter

+ + + + + + + +
+ +
+ +

+ util + + EventEmitter +

+ +

EventEmitter implements the classic observer/observable pattern.

+

Note: this is heavily inspired by http://www.datchley.name/es6-eventemitter/

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new EventEmitter()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Example
+ + 
let observable = new EventEmitter();
+let uuid1 = observable.on('change', data => { console.log(data); });
+observable.emit("change", { a: 1 });
+observable.off("change", uuid1);
+observable.emit("change", { a: 1 });
+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

emit(name, data) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Emit an event with a given name and associated data.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

data + + +object + + + +

the data of the event

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

true if at least one listener has been registered for that event, and false otherwise

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

off(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Remove the listener with the given uuid associated to the given event name.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + + + + + + + + + +

on(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Register a new listener for events with the given name emitted by this instance.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

string - the unique identifier associated with that (event, listener) pair (useful to remove the listener)

+
+ + + + + + + + + + + + +

once(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Register a new listener for the given event name, and remove it as soon as the event has been emitted.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

string - the unique identifier associated with that (event, listener) pair (useful to remove the listener)

+
+ + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/EventManager.html b/docs/EventManager.html new file mode 100644 index 0000000..d9ec311 --- /dev/null +++ b/docs/EventManager.html @@ -0,0 +1,2386 @@ + + + + + + EventManager - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

EventManager

+ + + + + + + +
+ +
+ +

+ core + + EventManager +

+ +

This manager handles all participant interactions with the experiment, i.e. keyboard, mouse and touch events.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new EventManager(psychoJS, psychoJS)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +Object + + + +
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static, readonly) _keycodeMap :Object.<number, String>

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map provides support for browsers that have not yet +adopted the W3C KeyboardEvent.code standard for detecting key presses. +It maps the deprecated KeyboardEvent.keycode values to the W3C UI event codes.

+

Unfortunately, it is not very fine-grained: for instance, there is no difference between Alt Left and Alt +Right, or between Enter and Numpad Enter. Use at your own risk (or upgrade your browser...).

+
+ + + +
Type:
+
    +
  • + +Object.<number, String> + + +
    • +
+ + + + + + + + +

(protected, static, readonly) _pygletMap :Object.<String, String>

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates pyglet key names to the corresponding W3C KeyboardEvent codes values.

+

More information can be found here

+
+ + + +
Type:
+
    +
  • + +Object.<String, String> + + +
    • +
+ + + + + + + + +

(protected, static, readonly) _reversePygletMap :Object.<String, String>

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates W3C KeyboardEvent.codes to the corresponding pyglet key names. +

+ + + +
Type:
+
    +
  • + +Object.<String, String> + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) keycode2w3c(keycode) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert a keycode to a W3C UI Event code.

+

This is for legacy browsers.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keycode + + +number + + + +

the keycode

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

corresponding W3C UI Event code

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) pyglet2w3c(pygletKeyList) → {Array.string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert a keylist that uses pyglet key names to one that uses W3C KeyboardEvent.code values.

+

This allows key lists that work in the builder environment to work in psychoJS web experiments.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pygletKeyList + + +Array.string + + + +

the array of pyglet key names

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the w3c keyList

+
+ + + +
+
+ Type +
+
+ +Array.string + + +
+
+ + + + + + + + + + +

(static) w3c2pyglet(code) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert a W3C Key Code into a pyglet key.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +string + + + +

W3C Key Code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

corresponding pyglet key

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(protected) _addKeyListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add key listeners to the document.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

addMouseListeners(renderer)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add various mouse listeners to the Pixi renderer of the Window.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
renderer + + +PIXI.Renderer + + + +

The Pixi renderer

+ + + + + + + + + + + + + + + + + + + + + + + + +

clearEvents()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • handle the attribs argument
    • +
+
+ +
+ + + + + +
+

Clear all events from the event buffer.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

clearKeys()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clear all keys from the key buffer.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getKeys(options) → {Array.<string>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the list of keys pressed by the participant.

+

Note: The w3c key-event viewer can be used to see possible values for the items in the keyList given the user's keyboard and chosen layout. The "key" and "code" columns in the UI Events fields are the relevant values for the keyList argument.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
keyList + + +Array.<string> + + + + + + <optional>
+ + + + + + 		+ + null + +

keyList allows the user to specify a set of keys to check for. Only keypresses from this set of keys will be removed from the keyboard buffer. If no keyList is given, all keys will be checked and the key buffer will be cleared completely.

timeStamped + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

If true will return a list of tuples instead of a list of keynames. Each tuple has (keyname, time).

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the list of keys that were pressed.

+
+ + + +
+
+ Type +
+
+ +Array.<string> + + +
+
+ + + + + + + + + + +

getMouseInfo() → {EventManager.MouseInfo}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the mouse info.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the mouse info.

+
+ + + +
+
+ Type +
+
+ +EventManager.MouseInfo + + +
+
+ + + + + + + + + + +

resetMoveClock()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • not implemented
    • +
+
+ +
+ + + + + +
+

Reset the move clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

startMoveClock()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • not implemented
    • +
+
+ +
+ + + + + +
+

Start the move clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

stopMoveClock()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • not implemented
    • +
+
+ +
+ + + + + +
+

Stop the move clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Type Definitions

+ + + +

ButtonInfo

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pressed + + +Array.number + + + +

the status of each mouse button [left, center, right]: 1 for pressed, 0 for released

clocks + + +Array.Clock + + + +

the clocks associated to the mouse buttons, reset whenever the button is pressed

times + + +Array.number + + + +

the time elapsed since the last rest of the associated clock

+ + + + + + + + + + + + + + + +

MouseInfo

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pos + + +Array.number + + + +

the position of the mouse [x, y]

wheelRel + + +Array.number + + + +

the relative position of the wheel [x, y]

buttons + + +EventManager.ButtonInfo + + + +

the mouse button info

moveClock + + +Clock + + + +

the clock that is reset whenever the mouse moves

+ + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/ExperimentHandler.html b/docs/ExperimentHandler.html new file mode 100644 index 0000000..798c243 --- /dev/null +++ b/docs/ExperimentHandler.html @@ -0,0 +1,2010 @@ + + + + + + ExperimentHandler - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

ExperimentHandler

+ + + + + + + +
+ +
+ +

+ data + + ExperimentHandler +

+ +

An ExperimentHandler keeps track of multiple loops and handlers. It is particularly useful +for generating a single data file from an experiment with many different loops (e.g. interleaved +staircases or loops within loops.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new ExperimentHandler(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

name + + +string + + + +

name of the experiment

extraInfo + + +Object + + + +

additional information, such as session name, participant name, etc.

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Environment :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
SERVER + + +Symbol + + + +
LOCAL + + +Symbol + + + +
+ + + + + + +
+

Experiment environment.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) SaveFormat :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
CSV + + +Symbol + + + +

Results are saved to a .csv file

DATABASE + + +Symbol + + + +

Results are saved to a database

+ + + + + + +
+

Experiment result format

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

_thisEntry

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Legacy experiment getters.

+
+ + + + + + + + + + +

experimentEnded

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Getter for experimentEnded.

+
+ + + + + + + + + + +

experimentEnded

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for experimentEnded.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected, static) _getLoopAttributes(loop)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the attribute names and values for the current trial of a given loop.

+

Only info relating to the trial execution are returned.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loop + + +Object + + + +

the loop

+ + + + + + + + + + + + + + + + + + + + + + + + +

addData(key, value)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add the key/value pair.

+

Multiple key/value pairs can be added to any given entry of the data file. There are +considered part of the same entry until a call to nextEntry is made.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
key + + +Object + + + +

the key

value + + +Object + + + +

the value

+ + + + + + + + + + + + + + + + + + + + + + + + +

addLoop(loop)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add a loop.

+

The loop might be a TrialHandler, for instance.

+

Data from this loop will be included in the resulting data files.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loop + + +Object + + + +

the loop, e.g. an instance of TrialHandler or StairHandler

+ + + + + + + + + + + + + + + + + + + + + + + + +

isEntryEmpty() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • This really should be renamed: IsCurrentEntryNotEmpty
    • +
+
+ +
+ + + + + +
+

Whether or not the current entry (i.e. trial data) is empty.

+

Note: this is mostly useful at the end of an experiment, in order to ensure that the last entry is saved.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the current entry is empty

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

nextEntry(snapshots)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Inform this ExperimentHandler that the current trial has ended. Further calls to addData +will be associated with the next trial.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
snapshots + + +Object +| + +Array.<Object> +| + +undefined + + + +

array of loop snapshots

+ + + + + + + + + + + + + + + + + + + + + + + + +

removeLoop(loop)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Remove the given loop from the list of unfinished loops, e.g. when it has completed.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loop + + +Object + + + +

the loop, e.g. an instance of TrialHandler or StairHandler

+ + + + + + + + + + + + + + + + + + + + + + + + +

(async) save(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Save the results of the experiment.

+
    +
  • For an experiment running locally, the results are offered for immediate download.
    • +
  • For an experiment running on the server, the results are uploaded to the server.
    • +
+

+

+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
attributes + + +Array.<Object> + + + + + + <optional>
+ + + + + + 		+ +

the attributes to be saved

sync + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to communicate with the server in a synchronous manner

tag + + +string + + + + + + <optional>
+ + + + + + 		+ + '' + +

an optional tag to add to the filename to which the data is saved (for CSV and XLSX saving options)

clear + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to clear all experiment results immediately after they are saved (this is useful when saving data in separate chunks, throughout an experiment)

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/FaceDetector.html b/docs/FaceDetector.html new file mode 100644 index 0000000..19a3d73 --- /dev/null +++ b/docs/FaceDetector.html @@ -0,0 +1,1744 @@ + + + + + + FaceDetector - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

FaceDetector

+ + + + + + + +
+ +
+ +

+ visual + + FaceDetector +

+ +

This manager handles the detecting of faces in video streams. FaceDetector relies on the +Face-API library developed by +Vincent Muehler.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new FaceDetector(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from the detector

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

input + + +string +| + +HTMLVideoElement +| + +module:visual.Camera + + + + + + + + + + + +

the name of a +movie resource or of a HTMLVideoElement or of a Camera component

faceApiUrl + + +string + + + + + + <optional>
+ + + + + + 		+ + 'face-api.js' + +

the Url of the face-api library

modelDir + + +string + + + + + + <optional>
+ + + + + + 		+ + 'models' + +

the directory where to find the face detection models

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the stimulus (e.g. for size, position, vertices)

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the stimulus

units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'norm' + +

the units of the stimulus vertices, size and position

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

size + + +number + + + + + + <optional>
+ + + + + + 		+ +

the size of the rendered image (the size of the image will be used if size is not specified)

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async, protected) _initFaceApi()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Init the Face-API library.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the visual representation of the detected faces, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

isReady() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Query whether or not the face detector is ready to detect.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the face detector is ready to detect

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

setInput(input, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the video attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
input + + +string +| + +HTMLVideoElement +| + +module:visual.Camera + + + + + + + + + + + +

the name of a +movie resource or a HTMLVideoElement or a Camera component

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

start(period, detectionCallback, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start detecting faces.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
period + + +number + + + + + + + + + + + +

the detection period, in ms (e.g. 100 ms for 10Hz)

detectionCallback + + + + + + + + + +

the callback triggered when detection results are available

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

stop(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop detecting faces.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/FaceDetector_FaceDetector.html b/docs/FaceDetector_FaceDetector.html deleted file mode 100644 index e1af9f4..0000000 --- a/docs/FaceDetector_FaceDetector.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - JSDoc: Class: FaceDetector - - - - - - - - - - -
- -

Class: FaceDetector

- - - - - - -
- -
- -

FaceDetector()

- - -
- -
-
- - - - - - -

new FaceDetector()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/docs/Form.html b/docs/Form.html new file mode 100644 index 0000000..8a19b90 --- /dev/null +++ b/docs/Form.html @@ -0,0 +1,4669 @@ + + + + + + Form - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Form

+ + + + + + + +
+ +
+ +

+ visual + + Form +

+ +

Form stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Form(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the slider

size + + +Array.<number> + + + + + + + + + + + +

the size of the slider, e.g. [1, 0.1] for an horizontal slider

units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'height' + +

the units of the Slider position, and font size

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('LightGray') + +

the color of the slider

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast of the slider

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity of the slider

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth (i.e. the z order), note that the text, radio buttons and slider elements are at depth - 1

items + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the array of labels

itemPadding + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.05 + +

the granularity

font + + +string + + + + + + <optional>
+ + + + + + 		+ + 'Arial' + +

the text font

fontFamily + + +string + + + + + + <optional>
+ + + + + + 		+ + 'Helvetica' + +

the text font

bold + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the font of the labels is bold

italic + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the font of the labels is italic

fontSize + + +number + + + + + + <optional>
+ + + + + + 		+ +

the font size of the labels (in form units), the default fontSize +depends on the Form units: 14 for 'pix', 0.03 otherwise

clipMask + + +PIXI.Graphics + + + + + + <optional>
+ + + + + + 		+ + null + +

the clip mask

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every +frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static, readonly) _defaultItems

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Default form item.

+
+ + + + + + + + + + +

(static, readonly) Layout :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
HORIZONTAL + + +Symbol + + + +
VERTICAL + + +Symbol + + + +
+ + + + + + +
+

Form item layout.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) Types :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
HEADING + + +Symbol + + + +
DESCRIPTION + + +Symbol + + + +
RATING + + +Symbol + + + +
SLIDER + + +Symbol + + + +
FREE_TEXT + + +Symbol + + + +
CHOICE + + +Symbol + + + +
RADIO + + +Symbol + + + +
+ + + + + + +
+

Form item types.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getBoundingBox_px() → {PIXI.Rectangle}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the bounding box in pixel coordinates

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the bounding box, in pixel coordinates

+
+ + + +
+
+ Type +
+
+ +PIXI.Rectangle + + +
+
+ + + + + + + + + + +

(protected) _importItems()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Import the form items from either a spreadsheet resource files (.csv, .xlsx, etc.) or from an array.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _onChange(withPixiopt, withBoundingBoxopt) → {function}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Generate a callback that prepares updates to the stimulus. +This is typically called in the constructor of a stimulus, when attributes are added +with _addAttribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
withPixi + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the PIXI representation must +also be updated

withBoundingBox + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to immediately estimate +the bounding box

+ + + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + +
+
+ + + + + + + + + + +

(protected) _processItems()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Import and process the form items from either a spreadsheet resource files (.csv, .xlsx, etc.) or from an array.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _sanitizeItems()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Sanitize the form items: check that the keys are valid, and fill in default values.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupStimuli()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the stimuli, and the scrollbar.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateDecorations()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the form decorations (bounding box, lines between items, etc.)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the form visual representation, if necessary.

+

This estimate which stimuli are visible, and updates the decorations.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateVisibleStimuli()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the visible stimuli.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

addDataToExp(experiment, formatopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add the form data to the given experiment.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
experiment + + +module:data.ExperimentHandler + + + + + + + + + + + +

the experiment into which to insert the form data

format + + +string + + + + + + <optional>
+ + + + + + 		+ + 'rows' + +

whether to insert the data as rows or as columns

+ + + + + + + + + + + + + + + + + + + + + + + + +

contains(object, units) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside the bounding box of the stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +string + + + +

the units

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the object is inside the bounding box of the stimulus

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

draw()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Overridden draw that also calls the draw method of all form elements.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

formComplete() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check if the form is complete.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • whether there are any remaining incomplete responses.
    • +
+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

getData() → {object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Collate the questions and responses into a single dataset.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the dataset with all questions and responses.
    • +
+
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + + + + + + + +

hide()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Overridden hide that also calls the hide method of all form elements.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

refresh()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Force a refresh of the stimulus.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

release(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Release the PIXI representation, if there is one.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

reset()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the form.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setAutoDraw(autoDraw, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the autoDraw attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
autoDraw + + +boolean + + + + + + + + + + + +

the new value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setDepth(depth, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the depth attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
depth + + +Array.<number> + + + + + + + + + + + + 0 + +

order in which stimuli is rendered, kind of css's z-index with a negative sign.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setOri(ori, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the orientation attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
ori + + +number + + + + + + + + + + + +

the orientation in degree with 0 as the vertical position, positive values rotate clockwise.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setPos(pos, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the position attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
pos + + +Array.<number> + + + + + + + + + + + +

position of the center of the stimulus, in stimulus units

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setSize(size, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the size attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
size + + +undefined +| + +null +| + +number +| + +Array.<number> + + + + + + + + + + + +

the stimulus size

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/GUI.html b/docs/GUI.html new file mode 100644 index 0000000..aebf661 --- /dev/null +++ b/docs/GUI.html @@ -0,0 +1,2417 @@ + + + + + + GUI - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

GUI

+ + + + + + + +
+ +
+ +

+ core + + GUI +

+ +

GUI manages the various pop-up dialog boxes that guide the participant, throughout the +lifecycle of the experiment, e.g. at the start while the resources are downloading, or at the +end when the data is uploading to the server

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new GUI(psychoJS)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

DEFAULT_SETTINGS :Object

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Default settings for GUI.

+
+ + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(protected, static) _onKeyChange(gui, event)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback triggered upon change event (for required keys).

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
gui + + +module:core.GUI + + + +

this GUI

event + + +Event + + + +

the key's event

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _onCancelExperiment()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback triggered when the participant presses the Cancel button

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _onResourceEvents(signal)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback triggered upon a resource event from the Server Manager.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
signal + + +Object.<string, (string|Symbol)> + + + +

the ServerManager's signal

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _onStartExperiment()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback triggered when the participant presses the OK button

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setProgressMessage(message)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the progress message.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
message + + +string + + + +

the message

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateDialog(changeOKButtonFocusopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the dialog box.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
changeOKButtonFocus + + + + <optional>
+ + + + + + 		+ + false + +

whether to change the focus to the OK button

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateProgressBar()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the progress bar.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _userFriendlyError(errorCode) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the user-friendly html message associated to a pavlovia.or server error code.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
errorCode + + +number + + + +

the pavlovia.org server error code

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

a user-friendly error message

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

closeDialog()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Close the previously opened dialog box, if there is one.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

dialog(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Show a message to the participant in a dialog box.

+

This function can be used to display both warning and error messages.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
message + + +string + + + + + + + + + + + +

the message to be displayed

error + + +Object.<string, *> + + + + + + + + + + + +

an exception

warning + + +string + + + + + + + + + + + +

a warning message

showOK + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

specifies whether to show the OK button

onOK + + +GUI.onOK + + + + + + <optional>
+ + + + + + 		+ +

function called when the participant presses the OK button

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + +

DlgFromDict(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Create a dialog box that (a) enables the participant to set some +experimental values (e.g. the session name), (b) shows progress of resource +download, and (c) enables the participant to cancel the experiment.

+

Setting experiment values

+

DlgFromDict displays an input field for all values in the dictionary. +It is possible to specify default values e.g.:

+let expName = 'stroop';
+let expInfo = {'participant':'', 'session':'01'};
+psychoJS.schedule(psychoJS.gui.DlgFromDict({dictionary: expInfo, title: expName})); +

If the participant cancels (by pressing Cancel or by closing the dialog box), then +the dictionary remains unchanged.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
logoUrl + + +String + + + + + + <optional>
+ + + + + + 		+ +

Url of the experiment logo

text + + +String + + + + + + <optional>
+ + + + + + 		+ +

information text

dictionary + + +Object + + + + + + + + + + + +

associative array of values for the participant to set

title + + +String + + + + + + + + + + + +

name of the project

requireParticipantClick + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether the participant must click on the OK +button, when it becomes enabled, to move on with the experiment

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + +

finishDialog(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Create a dialog box with a progress bar, to inform the participant of +the last stages of the experiment: upload of results, of log, and closing +of session.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
text + + +String + + + + + + <optional>
+ + + + + +

information text

+ +
+ + + + + + + + + + + + + + + + + + + + + + + +

Type Definitions

+ + + + + + +

onOK()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/GratingStim.html b/docs/GratingStim.html new file mode 100644 index 0000000..602e4e2 --- /dev/null +++ b/docs/GratingStim.html @@ -0,0 +1,3195 @@ + + + + + + GratingStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

GratingStim

+ + + + + + + +
+ +
+ +

+ visual + + GratingStim +

+ +

Grating Stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new GratingStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +Window + + + + + + + + + + + +

the associated Window

tex + + +String +| + +HTMLImageElement + + + + + + <optional>
+ + + + + + 		+ + "sin" + +

the name of the predefined grating texture or image resource or the HTMLImageElement corresponding to the texture

mask + + +String +| + +HTMLImageElement + + + + + + <optional>
+ + + + + + 		+ +

the name of the mask resource or HTMLImageElement corresponding to the mask

units + + +String + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the stimulus (e.g. for size, position, vertices)

sf + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

spatial frequency of the function used in grating stimulus

phase + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

phase of the function used in grating stimulus, multiples of period of that function

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the stimulus

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

size + + +number + + + + + + <optional>
+ + + + + + 		+ +

the size of the rendered image (DEFAULT_STIM_SIZE_PX will be used if size is not specified)

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + "white" + +

Foreground color of the stimulus. Can be String like "red" or "#ff0000" or Number like 0xff0000.

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

Set the opacity of the stimulus. Determines how visible the stimulus is relative to background.

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

Set the contrast of the stimulus, i.e. scales how far the stimulus deviates from the middle grey. Ranges [-1, 1].

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth (i.e. the z order)

interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

Whether to interpolate (linearly) the texture in the stimulus. Currently supports only image based gratings.

blendmode + + +String + + + + + + <optional>
+ + + + + + 		+ + "avg" + +

blend mode of the stimulus, determines how the stimulus is blended with the background. Supported values: "avg", "add", "mul", "screen".

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getDisplaySize() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the size of the display image, which is either that of the GratingStim or that of the image +it contains.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the size of the displayed image

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _getPixiMeshFromPredefinedShaders(shaderName, uniforms) → {Pixi.Mesh}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Generate PIXI.Mesh object based on provided shader function name and uniforms.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shaderName + + +String + + + +

name of the shader. Must be one of the SHADERS

uniforms + + +Object + + + +

a set of uniforms to supply to the shader. Mixed together with default uniform values.

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

Pixi.Mesh object that represents shader and later added to the scene.

+
+ + + +
+
+ Type +
+
+ +Pixi.Mesh + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setBlendmode(blendMode, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set blend mode of the grating stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
blendMode + + +String + + + + + + + + + + + + avg + +

blend mode, can be one of the following: ["avg", "add", "mul", "screen"].

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setColor(colorVal, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set foreground color value for the grating stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
colorVal + + +Color + + + + + + + + + + + + white + +

color value, can be String like "red" or "#ff0000" or Number like 0xff0000.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setColorSpace(colorSpaceVal, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set color space value for the grating stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
colorSpaceVal + + +String + + + + + + + + + + + + RGB + +

color space value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setInterpolate(interpolate, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Whether to interpolate (linearly) the texture in the stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
interpolate + + +boolean + + + + + + + + + + + + false + +

interpolate or not.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setMask(mask, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the mask attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
mask + + +HTMLImageElement +| + +string + + + + + + + + + + + +

the name of the mask resource or HTMLImageElement corresponding to the mask

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setOpacity(opacityopt, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determines how visible the stimulus is relative to background.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1 + +

opacity - The value should be a single float ranging 1.0 (opaque) to 0.0 (transparent).

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setPhase(phase, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set phase value for the function.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
phase + + +number + + + + + + + + + + + +

phase value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setSF(sf, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set spatial frequency value for the function.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
sf + + +number + + + + + + + + + + + +

spatial frequency value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setTex(tex, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the tex attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
tex + + +HTMLImageElement +| + +string + + + + + + + + + + + +

the name of built in shader function or name of the image resource or HTMLImageElement corresponding to the image

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/ImageStim.html b/docs/ImageStim.html new file mode 100644 index 0000000..e992fd4 --- /dev/null +++ b/docs/ImageStim.html @@ -0,0 +1,1899 @@ + + + + + + ImageStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

ImageStim

+ + + + + + + +
+ +
+ +

+ visual + + ImageStim +

+ +

Image Stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new ImageStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
    + +
  • ColorMixin
    • + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +Window + + + + + + + + + + + +

the associated Window

image + + +string +| + +HTMLImageElement + + + + + + + + + + + +

the name of the image resource or the HTMLImageElement corresponding to the image

mask + + +string +| + +HTMLImageElement + + + + + + + + + + + +

the name of the mask resource or HTMLImageElement corresponding to the mask

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the stimulus (e.g. for size, position, vertices)

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the stimulus

units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'norm' + +

the units of the stimulus vertices, size and position

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

size + + +number + + + + + + <optional>
+ + + + + + 		+ +

the size of the rendered image (the size of the image will be used if size is not specified)

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + 'white' + +

the background color

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth (i.e. the z order)

texRes + + +number + + + + + + <optional>
+ + + + + + 		+ + 128 + +

the resolution of the text

interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the image is interpolated

flipHoriz + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip horizontally

flipVert + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip vertically

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getDisplaySize() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the size of the display image, which is either that of the ImageStim or that of the image +it contains.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the size of the displayed image

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setImage(image, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the image attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
image + + +HTMLImageElement +| + +string + + + + + + + + + + + +

the name of the image resource or HTMLImageElement corresponding to the image

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setInterpolate(interpolate, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Whether to interpolate (linearly) the texture in the stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
interpolate + + +boolean + + + + + + + + + + + + false + +

interpolate or not.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setMask(mask, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the mask attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
mask + + +HTMLImageElement +| + +string + + + + + + + + + + + +

the name of the mask resource or HTMLImageElement corresponding to the mask

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/KeyPress.html b/docs/KeyPress.html new file mode 100644 index 0000000..d6ee0b2 --- /dev/null +++ b/docs/KeyPress.html @@ -0,0 +1,301 @@ + + + + + + KeyPress - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

KeyPress

+ + + + + + + +
+ +
+ +

+ core + + KeyPress +

+ +

<pKeyPress holds information about a key that has been pressed, such as the duration of the press.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new KeyPress(code, tDown, name)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +string + + + +

W3C Key Code

tDown + + +number + + + +

time of key press (keydown event) relative to the global Monotonic Clock

name + + +string +| + +undefined + + + +

pyglet key name

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Keyboard.html b/docs/Keyboard.html new file mode 100644 index 0000000..3ea6f5d --- /dev/null +++ b/docs/Keyboard.html @@ -0,0 +1,1793 @@ + + + + + + Keyboard - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Keyboard

+ + + + + + + +
+ +
+ +

+ core + + Keyboard +

+ +

This manager handles all keyboard events. It is a substitute for the keyboard component of EventManager.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Keyboard(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

bufferSize + + +number + + + + + + <optional>
+ + + + + + 		+ + 10000 + +

the maximum size of the circular keyboard event buffer

waitForStart + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to wait for a call to module:core.Keyboard#start +before recording keyboard events

clock + + +Clock + + + + + + <optional>
+ + + + + + 		+ +

an optional clock

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) KeyStatus :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
KEY_DOWN + + +Symbol + + + +
KEY_UP + + +Symbol + + + +
+ + + + + + +
+

Keyboard KeyStatus.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) includes(keypressList, keyName) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Test whether a list of KeyPress's contains one with a particular name.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keypressList + + +Array.<module:core.KeyPress> + + + +

list of KeyPress's

keyName + + +string + + + +

pyglet key name, e.g. 'escape', 'left'

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not a KeyPress with the given pyglet key name is present in the list

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

(protected) _addKeyListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add key listeners to the document.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

clearEvents()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clear all events and resets the circular buffers.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getEvents() → {Array.<Keyboard.KeyEvent>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the list of those keyboard events still in the buffer, i.e. those that have not been +previously cleared by calls to getKeys with clear = true.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the list of events still in the buffer

+
+ + + +
+
+ Type +
+
+ +Array.<Keyboard.KeyEvent> + + +
+
+ + + + + + + + + + +

getKeys(options) → {Array.<KeyPress>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the list of keys pressed or pushed by the participant.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
keyList + + +Array.<string> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the list of keys to consider. If keyList is empty, we consider all keys. +Note that we use pyglet keys here, to make the PsychoJs code more homogeneous with PsychoPy.

waitRelease + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to include those keys pressed but not released. If +waitRelease = false, key presses without a corresponding key release will have an undefined duration.

clear + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to keep in the buffer the key presses or pushes for a subsequent call to getKeys. If a keyList has been given and clear = true, we only remove from the buffer those keys in keyList

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the list of keys that were pressed (keydown followed by keyup) or pushed +(keydown with no subsequent keyup at the time getKeys is called).

+
+ + + +
+
+ Type +
+
+ +Array.<KeyPress> + + +
+
+ + + + + + + + + + +

start()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start recording keyboard events.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

stop()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop recording keyboard events.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Type Definitions

+ + + +

KeyEvent

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
W3C + + +string + + + +

key code

W3C + + +string + + + +

key

pyglet + + +string + + + +

key

key + + +module:core.Keyboard#KeyStatus + + + +

status

timestamp + + +number + + + +

(in seconds)

+ + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Logger.html b/docs/Logger.html new file mode 100644 index 0000000..cd40f2f --- /dev/null +++ b/docs/Logger.html @@ -0,0 +1,2177 @@ + + + + + + Logger - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Logger

+ + + + + + + +
+ +
+ +

+ core + + Logger +

+ +

This class handles a variety of loggers, e.g. a browser console one (mostly for debugging), +a remote one, etc.

+

Note: we use log4javascript for the console logger, and our own for the server logger.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Logger(psychoJS, threshold)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

threshold + + +* + + + +

the logging threshold, e.g. log4javascript.Level.ERROR

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static, readonly) _ServerLevelValue :number

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
CRITICAL + + +number + + + +
ERROR + + +number + + + +
WARNING + + +number + + + +
DATA + + +number + + + +
EXP + + +number + + + +
INFO + + +number + + + +
DEBUG + + +number + + + +
NOTSET + + +number + + + +
+ + + + + + +
+

Server logging level values.

+

We use those values to determine whether a log is to be sent to the server or not.

+
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + + + + +

(static, readonly) ServerLevel :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
CRITICAL + + +Symbol + + + +
ERROR + + +Symbol + + + +
WARNING + + +Symbol + + + +
DATA + + +Symbol + + + +
EXP + + +Symbol + + + +
INFO + + +Symbol + + + +
DEBUG + + +Symbol + + + +
NOTSET + + +Symbol + + + +
+ + + + + + +
+

Server logging level.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(protected) _customConsoleLayout() → {*}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Create a custom console layout.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the custom layout

+
+ + + +
+
+ Type +
+
+ +* + + +
+
+ + + + + + + + + + +

(protected) _getValue(level) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the integer value associated with a logging level.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
level + + +module:core.Logger.ServerLevel + + + +

the logging level

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the value associated with the logging level, or 30 is the logging level is unknown.
    • +
+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected) _throttle(time) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check whether or not a log messages must be throttled.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
time + + +number + + + +

the time of the latest log message

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not to log the message

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

data(msg, timeopt, objopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Log a server message at the DATA level.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
msg + + +string + + + + + + + + + +

the message to be logged.

time + + +number + + + + + + <optional>
+ + + + + +

the logging time

obj + + +object + + + + + + <optional>
+ + + + + +

the associated object (e.g. a Trial)

+ + + + + + + + + + + + + + + + + + + + + + + + +

exp(msg, timeopt, objopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Log a server message at the EXP level.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
msg + + +string + + + + + + + + + +

the message to be logged.

time + + +number + + + + + + <optional>
+ + + + + +

the logging time

obj + + +object + + + + + + <optional>
+ + + + + +

the associated object (e.g. a Trial)

+ + + + + + + + + + + + + + + + + + + + + + + + +

(async) flush()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Flush all server logs to the server.

+

Note: the logs are compressed using Pako's zlib algorithm. +See https://github.com/nodeca/pako for details.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

log(msg, level, timeopt, objopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Log a server message.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
msg + + +string + + + + + + + + + +

the message to be logged.

level + + +module:core.Logger.ServerLevel + + + + + + + + + +

logging level

time + + +number + + + + + + <optional>
+ + + + + +

the logging time

obj + + +object + + + + + + <optional>
+ + + + + +

the associated object (e.g. a Trial)

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLevel(serverLevel)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Change the logging level.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
serverLevel + + +module:core.Logger.ServerLevel + + + +

the new logging level

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Microphone.html b/docs/Microphone.html new file mode 100644 index 0000000..6a807aa --- /dev/null +++ b/docs/Microphone.html @@ -0,0 +1,1946 @@ + + + + + + Microphone - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Microphone

+ + + + + + + +
+ +
+ +

+ sound + + Microphone +

+ +

This manager handles the recording of audio signal.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Microphone(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
win + + +module:core.Window + + + + + + + + + + + +

the associated Window

name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

format + + +string + + + + + + <optional>
+ + + + + + 		+ + 'audio/webm;codecs=opus' + +

the format for the audio file

sampleRateHz + + +number + + + + + + <optional>
+ + + + + + 		+ + 48000 + +

the audio sampling rate, in Hz

clock + + +Clock + + + + + + <optional>
+ + + + + + 		+ +

an optional clock

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _onChange()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback for changes to the recording settings.

+

Changes to the settings require the recording to stop and be re-started.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async, protected) _prepareRecording()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Prepare the recording.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

download(filename)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Offer the audio recording to the participant as a sound file to download.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
filename + + +string + + + + + + audio.webm + +

the filename

+ + + + + + + + + + + + + + + + + + + + + + + + +

flush() → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Submit a request to flush the recording.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the data has actually been made available

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

(async) getRecording(tag, flushopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current audio recording as an AudioClip in the given format.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
tag + + +string + + + + + + + + + + + +

an optional tag for the audio clip

flush + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to first flush the recording

+ + + + + + + + + + + + + + + + + + + + + + + + +

pause() → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Submit a request to pause the recording.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the recording actually paused

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

resume(options) → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Submit a request to resume the recording.

+

resume has no effect if the recording was not previously paused.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
clear + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to empty the audio buffer before +resuming the recording

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the recording actually resumed

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

start() → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Submit a request to start the recording.

+

Note that it typically takes 50ms-200ms for the recording to actually starts once +a request to start has been submitted.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the recording actually started

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

stop(options) → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Submit a request to stop the recording.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
filename + + +string + + + + + + <optional>
+ + + + + +

the name of the file to which the audio recording will be +saved

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the recording actually stopped, and the recorded +data was made available

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

(async) upload(tag)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Upload the audio recording to the pavlovia server.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tag + + +string + + + +

an optional tag for the audio file

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/MinimalStim.html b/docs/MinimalStim.html new file mode 100644 index 0000000..f4dd821 --- /dev/null +++ b/docs/MinimalStim.html @@ -0,0 +1,1213 @@ + + + + + + MinimalStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

MinimalStim

+ + + + + + + +
+ +
+ +

+ core + + MinimalStim +

+ +

MinimalStim is the base class for all stimuli.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new MinimalStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + win.autoLog + +

whether to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(abstract, protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+

Note: this is an abstract function, which should not be called.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) contains(object, units)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside this stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +String + + + +

the stimulus units

+ + + + + + + + + + + + + + + + + + + + + + + + +

draw()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Draw this stimulus on the next frame draw.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

hide()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Hide this stimulus on the next frame draw.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

release(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Release the PIXI representation, if there is one.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setAutoDraw(autoDraw, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the autoDraw attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
autoDraw + + +boolean + + + + + + + + + + + +

the new value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/MonotonicClock.html b/docs/MonotonicClock.html new file mode 100644 index 0000000..0ebd80e --- /dev/null +++ b/docs/MonotonicClock.html @@ -0,0 +1,987 @@ + + + + + + MonotonicClock - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

MonotonicClock

+ + + + + + + +
+ +
+ +

+ util + + MonotonicClock +

+ +

MonotonicClock offers a convenient way to keep track of time during experiments. An experiment can have as many independent clocks as needed, e.g. one to time responses, another one to keep track of stimuli, etc.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new MonotonicClock(startTimeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
startTime + + +number + + + + + + <optional>
+ + + + + + 		+ + <time elapsed since the reference point, i.e. the time when the module was loaded> + +

the clock's start time (in ms)

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static) _referenceTime :number

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

The clock's referenceTime is the time when the module was loaded (in seconds).

+
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) getDate(locales, options) → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current timestamp with language-sensitive formatting rules applied.

+

Note: This is just a convenience wrapper around `Intl.DateTimeFormat()`.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
locales + + +string +| + +array.string + + + + + + en-CA + +

A string with a BCP 47 language tag, or an array of such strings.

options + + +object + + + + + +

An object with detailed date and time styling information.

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

The current timestamp in the chosen format.

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) getDateStr() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the clock's current time in the default format filtering out file name unsafe characters.

+

Note: This is mostly used as an appendix to the name of the keys save to the server.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

A string representing the current time formatted as YYYY-MM-DD_HH[h]mm.ss.sss

+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) getReferenceTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the time elapsed since the reference point.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the time elapsed since the reference point (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

getLastResetTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current offset being applied to the high resolution timebase used by this Clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the offset (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

getTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current time on this clock.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the current time (in seconds)

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Mouse.html b/docs/Mouse.html new file mode 100644 index 0000000..7c2923a --- /dev/null +++ b/docs/Mouse.html @@ -0,0 +1,1757 @@ + + + + + + Mouse - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Mouse

+ + + + + + + +
+ +
+ +

+ core + + Mouse +

+ +

This manager handles the interactions between the experiment's stimuli and the mouse.

+

Note: the unit of Mouse is that of its associated Window.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Mouse(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • visible is not handled at the moment (mouse is always visible)
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +Window + + + + + + + + + + + +

the associated Window

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

clickReset(buttonsopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the clocks associated to the given mouse buttons.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
buttons + + +Array.number + + + + + + <optional>
+ + + + + + 		+ + [0,1,2] + +

the buttons to reset (0: left, 1: center, 2: right)

+ + + + + + + + + + + + + + + + + + + + + + + + +

getPos() → {Array.number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current position of the mouse in mouse/Window units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the position of the mouse in mouse/Window units

+
+ + + +
+
+ Type +
+
+ +Array.number + + +
+
+ + + + + + + + + + +

getPressed(getTimeopt) → {Array.number|Array.<Array.number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the status of each button (pressed or released) and, optionally, the time elapsed between the last call to clickReset and the pressing or releasing of the buttons.

+

Note: clickReset is typically called at stimulus onset. When the participant presses a button, the time elapsed since the clickReset is stored internally and can be accessed any time afterwards with getPressed.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
getTime + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to also return timestamps

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

either an array of size 3 with the status (1 for pressed, 0 for released) of each mouse button [left, center, right], or a tuple with that array and another array of size 3 with the timestamps.

+
+ + + +
+
+ Type +
+
+ +Array.number +| + +Array.<Array.number> + + +
+
+ + + + + + + + + + +

getRel() → {Array.number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the position of the mouse relative to that at the last call to getRel +or getPos, in mouse/Window units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the relation position of the mouse in mouse/Window units.

+
+ + + +
+
+ Type +
+
+ +Array.number + + +
+
+ + + + + + + + + + +

getWheelRel() → {Array.number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the travel of the mouse scroll wheel since the last call to getWheelRel.

+

Note: Even though this method returns a [x, y] array, for most wheels/systems y is the only +value that varies.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the mouse scroll wheel travel

+
+ + + +
+
+ Type +
+
+ +Array.number + + +
+
+ + + + + + + + + + +

isPressedIn(shape, buttonsopt, optionsopt) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Helper method for checking whether a stimulus has had any button presses within bounds.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shape + + +object +| + +module:visual.VisualStim + + + + + + + + + +

A type of visual stimulus or object having a contains() method.

buttons + + +object +| + +number + + + + + + <optional>
+ + + + + +

The target button index potentially tucked inside an object.

options + + +object + + + + + + <optional>
+ + + + + + 		+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shape + + +object +| + +module:visual.VisualStim + + + + + + <optional>
+ + + + + +
buttons + + +number + + + + + + <optional>
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

Whether button pressed is contained within stimulus.

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

mouseMoved(distanceopt, resetopt) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether the mouse has moved beyond a certain distance.

+

distance +

    +
  • mouseMoved() or mouseMoved(undefined, false): determine whether the mouse has moved at all since the last +call to getPos
    • +
  • mouseMoved(distance: number, false): determine whether the mouse has travelled further than distance, in terms of line of sight
    • +
  • mouseMoved(distance: [number,number], false): determine whether the mouse has travelled horizontally or vertically further then the given horizontal and vertical distances
    • +

+

reset +

    +
  • mouseMoved(distance, true): reset the mouse move clock, return false
    • +
  • mouseMoved(distance, 'here'): return false
    • +
  • mouseMoved(distance, [x: number, y: number]: artifically set the previous mouse position to the given coordinates and determine whether the mouse moved further than the given distance
    • +

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
distance + + +undefined +| + +number +| + +Array.number + + + + + + <optional>
+ + + + + + 		+ +

the distance to which the mouse movement is compared (see above for a full description)

reset + + +boolean +| + +String +| + +Array.number + + + + + + <optional>
+ + + + + + 		+ + false + +

see above for a full description

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

see above for a full description

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

mouseMoveTime() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the amount of time elapsed since the last mouse movement.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the time elapsed since the last mouse movement

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/MovieStim.html b/docs/MovieStim.html new file mode 100644 index 0000000..3046a12 --- /dev/null +++ b/docs/MovieStim.html @@ -0,0 +1,2363 @@ + + + + + + MovieStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

MovieStim

+ + + + + + + +
+ +
+ +

+ visual + + MovieStim +

+ +

Movie Stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new MovieStim(options, movie)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • autoPlay does not work for the moment.
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
options + + +Object + + + + + + + + + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + +

the associated Window

+ +
movie + + +string +| + +HTMLVideoElement +| + +module:visual.Camera + + + + + + + + + + + +

the name of a +movie resource or of a HTMLVideoElement or of a Camera component

options.units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the stimulus (e.g. for size, position, vertices)

options.pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the stimulus

options.units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'norm' + +

the units of the stimulus vertices, size and position

options.ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

options.size + + +number + + + + + + <optional>
+ + + + + + 		+ +

the size of the rendered image (the size of the image will be used if size is not specified)

options.color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('white') + +

the background color

options.opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

options.contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

options.interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the image is interpolated

options.flipHoriz + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip horizontally

options.flipVert + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip vertically

options.loop + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to loop the movie

options.volume + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the volume of the audio track (must be between 0.0 and 1.0)

options.noAudio + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to play the audio

options.autoPlay + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to autoplay the video

options.autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

options.autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getDisplaySize() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the size of the display image, which is either that of the ImageStim or that of the image +it contains.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the size of the displayed image

+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pause(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Pause the movie.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

play(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the movie.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

reset(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

seek(timePoint, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Jump to a specific timepoint

+

Note: seek is experimental and does not work on all browsers at the moment.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
timePoint + + +number + + + + + + + + + + + +

the timepoint to which to jump (in second)

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setMovie(movie, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the movie attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
movie + + +string +| + +HTMLVideoElement +| + +module:visual.Camera + + + + + + + + + + + +

the name of a +movie resource or of a HTMLVideoElement or of a Camera component

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

stop(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop the movie and reset to 0s.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/MultiStairHandler.html b/docs/MultiStairHandler.html new file mode 100644 index 0000000..137f7ad --- /dev/null +++ b/docs/MultiStairHandler.html @@ -0,0 +1,1410 @@ + + + + + + MultiStairHandler - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

MultiStairHandler

+ + + + + + + +
+ +
+ +

+ data + + MultiStairHandler +

+ +

A handler dealing with multiple staircases, simultaneously.

+

Note that, at the moment, using the MultiStairHandler requires the jsQuest.js +library to be loaded as a resource, at the start of the experiment.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new MultiStairHandler(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + +

the handler options

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

varName + + +string + + + + + + + + + + + +

the name of the variable / intensity / contrast +/ threshold manipulated by the staircases

stairType + + +MultiStairHandler.StaircaseType + + + + + + <optional>
+ + + + + + 		+ + "simple" + +

the +handler type

conditions + + +Array.<Object> +| + +String + + + + + + <optional>
+ + + + + + 		+ + [undefined] + +

if it is a string, +we treat it as the name of a conditions resource

method + + +module:data.TrialHandler.Method + + + + + + + + + + + +

the trial method

nTrials + + +number + + + + + + <optional>
+ + + + + + 		+ + 50 + +

maximum number of trials

randomSeed + + +number + + + + + + + + + + + +

seed for the random number generator

name + + +string + + + + + + + + + + + +

name of the handler

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • TrialHandler
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) StaircaseStatus :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
RUNNING + + +Symbol + + + +

The staircase is currently running.

FINISHED + + +Symbol + + + +

The staircase is now finished.

+ + + + + + +
+

Staircase status.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) StaircaseType :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
SIMPLE + + +Symbol + + + +

Simple staircase handler.

QUEST + + +Symbol + + + +

QUEST handler.

+ + + + + + +
+

MultiStairHandler staircase type.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

currentStaircase

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current staircase.

+
+ + + + + + + + + + +

intensity

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current intensity.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _nextTrial()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Move onto the next trial.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _prepareStaircases()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the staircases, according to the conditions.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _validateConditions()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Validate the conditions.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

addResponse()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add a response to the current staircase.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Polygon.html b/docs/Polygon.html new file mode 100644 index 0000000..fe2dfb5 --- /dev/null +++ b/docs/Polygon.html @@ -0,0 +1,2125 @@ + + + + + + Polygon - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Polygon

+ + + + + + + +
+ +
+ +

+ visual + + Polygon +

+ +

Polygonal visual stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Polygon(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Polygonal visual stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +Window + + + + + + + + + + + +

the associated Window

lineWidth + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.5 + +

the line width

lineColor + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('white') + +

the line color

fillColor + + +Color + + + + + + + + + + + +

the fill color

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

edges + + +number + + + + + + <optional>
+ + + + + + 		+ + 3 + +

the number of edges of the polygon

radius + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.5 + +

the radius of the polygon

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position

size + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the size

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

units + + +string + + + + + + + + + + + +

the units of the stimulus vertices, size and position

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth

interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the shape is interpolated

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getPixiPolygon() → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the PIXI polygon (in pixel units) corresponding to the vertices.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the PIXI polygon corresponding to this stimulus vertices.

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

(protected) _getVertices_px() → {Array.<Array.<number>>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the vertices in pixel units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the vertices (in pixel units)

+
+ + + +
+
+ Type +
+
+ +Array.<Array.<number>> + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

contains(object, units) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside the bounding box of the ShapeStim.

+

This is overridden in order to provide a finer inclusion test.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +string + + + +

the units

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the object is inside the bounding box of the ShapeStim

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

setEdges(edges, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the edges attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
edges + + +number + + + + + + + + + + + +

the number of edges

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setRadius(radius, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the radius attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
radius + + +number + + + + + + + + + + + +

the polygon radius

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setVertices(vertices, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the vertices attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
vertices + + +Array.<Array.<number>> + + + + + + + + + + + +

the vertices

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/QuestHandler.html b/docs/QuestHandler.html new file mode 100644 index 0000000..453461e --- /dev/null +++ b/docs/QuestHandler.html @@ -0,0 +1,2262 @@ + + + + + + QuestHandler - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

QuestHandler

+ + + + + + + +
+ +
+ +

+ data + + QuestHandler +

+ +

A Trial Handler that implements the Quest algorithm for quick measurement of + psychophysical thresholds. QuestHandler relies on the jsQuest library, a port of Prof Dennis Pelli's QUEST algorithm by Daiichiro Kuroki.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new QuestHandler(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + +

the handler options

+
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

varName + + +string + + + + + + + + + + + +

the name of the variable / intensity / contrast / threshold manipulated by QUEST

startVal + + +number + + + + + + + + + + + +

initial guess for the threshold

startValSd + + +number + + + + + + + + + + + +

standard deviation of the initial guess

minVal + + +number + + + + + + + + + + + +

minimum value for the threshold

maxVal + + +number + + + + + + + + + + + +

maximum value for the threshold

pThreshold + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.82 + +

threshold criterion expressed as probability of getting a correct response

nTrials + + +number + + + + + + + + + + + +

maximum number of trials

stopInterval + + +number + + + + + + + + + + + +

minimum [5%, 95%] confidence interval required for the loop to stop

method + + +QuestHandler.Method + + + + + + + + + + + +

the QUEST method

beta + + +number + + + + + + <optional>
+ + + + + + 		+ + 3.5 + +

steepness of the QUEST psychometric function

delta + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.01 + +

fraction of trials with blind responses

gamma + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.5 + +

fraction of trails that would generate a correct response when the threshold is infinitely small

grain + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.01 + +

quantization of the internal table

name + + +string + + + + + + + + + + + +

name of the handler

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • TrialHandler
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Method :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
QUANTILE + + +Symbol + + + +

Quantile threshold estimate.

MEAN + + +Symbol + + + +

Mean threshold estimate.

MODE + + +Symbol + + + +

Mode threshold estimate.

+ + + + + + +
+

QuestHandler method

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

intensity

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current value of the variable / contrast / threshold.

+

This is the getter associated to getQuestValue.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateQuestValue()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the next value of the QUEST variable, based on the current value +and on the selected QUEST method.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupJsQuest()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the JS Quest object.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

addResponse()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add a response and update the PDF.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

confInterval()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get an estimate of the 5%-95% confidence interval (CI).

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getQuestValue() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current value of the variable / contrast / threshold.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the current QUEST value for the variable / contrast / threshold

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

mean() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the mean of the Quest posterior PDF.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the mean

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

mode() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the mode of the Quest posterior PDF.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the mode

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

quantile() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the standard deviation of the Quest posterior PDF.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the quantile

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

sd() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the standard deviation of the Quest posterior PDF.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the standard deviation

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

setMethod(method, log)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the method attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
method + + +mixed + + + +

the method value, PsychoPy-style values ("mean", "median", +"quantile") are converted to their respective QuestHandler.Method values

log + + +boolean + + + +

whether or not to log the change of seed

+ + + + + + + + + + + + + + + + + + + + + + + + +

simulate()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Simulate a response.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Rect.html b/docs/Rect.html new file mode 100644 index 0000000..d803f78 --- /dev/null +++ b/docs/Rect.html @@ -0,0 +1,2214 @@ + + + + + + Rect - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Rect

+ + + + + + + +
+ +
+ +

+ visual + + Rect +

+ +

Rectangular visual stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Rect(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

lineWidth + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.5 + +

the line width

lineColor + + +Color + + + + + + <optional>
+ + + + + + 		+ + 'white' + +

the line color

fillColor + + +Color + + + + + + <optional>
+ + + + + + 		+ +

the fill color

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

width + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.5 + +

the width of the rectangle

height + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.5 + +

the height of the rectangle

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position

size + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the size

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "height" + +

the units of the stimulus vertices, size and position

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth

interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the shape is interpolated

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getPixiPolygon() → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the PIXI polygon (in pixel units) corresponding to the vertices.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the PIXI polygon corresponding to this stimulus vertices.

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

(protected) _getVertices_px() → {Array.<Array.<number>>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the vertices in pixel units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the vertices (in pixel units)

+
+ + + +
+
+ Type +
+
+ +Array.<Array.<number>> + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateVertices()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the vertices.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

contains(object, units) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside the bounding box of the ShapeStim.

+

This is overridden in order to provide a finer inclusion test.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +string + + + +

the units

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the object is inside the bounding box of the ShapeStim

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

setHeight(height, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the height attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
height + + +number + + + + + + + + + + + +

the rectangle height

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setVertices(vertices, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the vertices attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
vertices + + +Array.<Array.<number>> + + + + + + + + + + + +

the vertices

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setWidth(width, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the width attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
width + + +number + + + + + + + + + + + +

the rectangle width

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Scheduler.html b/docs/Scheduler.html new file mode 100644 index 0000000..c7a90d7 --- /dev/null +++ b/docs/Scheduler.html @@ -0,0 +1,1478 @@ + + + + + + Scheduler - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Scheduler

+ + + + + + + +
+ +
+ +

+ util + + Scheduler +

+ +

A scheduler helps run the main loop by managing scheduled functions, +called tasks, after each frame is displayed.

+

+Tasks are either another Scheduler, or a +JavaScript functions returning one of the following codes: +

    +
  • Scheduler.Event.NEXT: Move onto the next task *without* rendering the scene first.
    • +
  • Scheduler.Event.FLIP_REPEAT: Render the scene and repeat the task.
    • +
  • Scheduler.Event.FLIP_NEXT: Render the scene and move onto the next task.
    • +
  • Scheduler.Event.QUIT: Quit the scheduler.
    • +
+

+

It is possible to create sub-schedulers, e.g. to handle loops. +Sub-schedulers are added to a parent scheduler as a normal +task would be by calling scheduler.add(subScheduler).

+

Conditional branching is also available: +scheduler.addConditionalBranches

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Scheduler(psychoJS)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
psychoJS + + +module:core.PsychoJS + + + +

the PsychoJS instance

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Event :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
NEXT + + +Symbol + + + +

Move onto the next task without rendering the scene first.

FLIP_REPEAT + + +Symbol + + + +

Render the scene and repeat the task.

FLIP_NEXT + + +Symbol + + + +

Render the scene and move onto the next task.

QUIT + + +Symbol + + + +

Quit the scheduler.

+ + + + + + +
+

Events.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) Status :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
RUNNING + + +Symbol + + + +

The Scheduler is running.

STOPPED + + +Symbol + + + +

The Scheduler is stopped.

+ + + + + + +
+

Status.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

status

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the status of the scheduler.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

add(task, …args)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Schedule a new task.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
task + + +Scheduler~Task +| + +Scheduler + + + + + + + + + +

the task to be scheduled

args + + +* + + + + + + + + + + <repeatable>
+ +

arguments for that task

+ + + + + + + + + + + + + + + + + + + + + + + + +

addConditional(condition, thenScheduler, elseScheduler)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Schedule a series of task or another, based on a condition.

+

Note: the tasks are sub-schedulers.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
condition + + +Scheduler~Condition + + + +

the condition

thenScheduler + + +Scheduler + + + +

the Scheduler to be run if the condition is satisfied

elseScheduler + + +Scheduler + + + +

the Scheduler to be run if the condition is not satisfied

+ + + + + + + + + + + + + + + + + + + + + + + + +

(async) start()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start this scheduler.

+

Note: tasks are run after each animation frame.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

stop()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop this scheduler.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Type Definitions

+ + + + + + +

Condition() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Condition evaluated when the task is run.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

Task(argsopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Task to be run by the scheduler.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
args + + +* + + + + + + <optional>
+ + + + + +

optional arguments

+ + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/ServerManager.html b/docs/ServerManager.html new file mode 100644 index 0000000..7f35f0d --- /dev/null +++ b/docs/ServerManager.html @@ -0,0 +1,4671 @@ + + + + + + ServerManager - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

ServerManager

+ + + + + + + +
+ +
+ +

+ core + + ServerManager +

+ +

This manager handles all communications between the experiment running in the participant's browser and the pavlovia.org server, in an asynchronous manner.

+

It is responsible for reading the configuration file of an experiment, for opening and closing a session, for listing and downloading resources, and for uploading results, logs, and audio recordings.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new ServerManager(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Event :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
RESOURCE + + +Symbol + + + +

Event type: resource event

DOWNLOADING_RESOURCES + + +Symbol + + + +

Event: resources have started to download

DOWNLOADING_RESOURCE + + +Symbol + + + +

Event: a specific resource download has started

RESOURCE_DOWNLOADED + + +Symbol + + + +

Event: a specific resource has been downloaded

DOWNLOAD_COMPLETED + + +Symbol + + + +

Event: resources have all downloaded

STATUS + + +Symbol + + + +

Event type: status event

+ + + + + + +
+

Server event

+

A server event is emitted by the manager to inform its listeners of either a change of status, or of a resource related event (e.g. download started, download is completed).

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) ResourceStatus :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ERROR + + +Symbol + + + +

There was an error during downloading, or the resource is in an unknown state.

REGISTERED + + +Symbol + + + +

The resource has been registered.

DOWNLOADING + + +Symbol + + + +

The resource is currently downloading.

DOWNLOADED + + +Symbol + + + +

The resource has been downloaded.

+ + + + + + +
+

Resource status

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) Status :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
READY + + +Symbol + + + +

The manager is ready.

BUSY + + +Symbol + + + +

The manager is busy, e.g. it is downloaded resources.

ERROR + + +Symbol + + + +

The manager has encountered an error, e.g. it was unable to download a resource.

+ + + + + + +
+

Server status

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(readonly) ALL_RESOURCES :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Used to indicate to the ServerManager that all resources must be registered (and +subsequently downloaded)

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(async, protected) _downloadResources(resources)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Download the specified resources.

+

Note: we use the preloadjs library.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
resources + + +Set + + + +

a set of names of previously registered resources

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _listResources()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

List the resources available to the experiment.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _queryServerAPI(method, path, data, contentTypeopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Query the pavlovia server API.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
method + + + + + + + + + +

the HTTP method, i.e. GET, PUT, POST, or DELETE

path + + + + + + + + + +

the resource path, without the server address

data + + + + + + + + + +

the data to be sent

contentType + + +string + + + + + + <optional>
+ + + + + + 		+ + "JSON" + +

the content type, either JSON or FORM

+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupPreloadQueue()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the preload.js queue, and the associated callbacks.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) closeSession(isCompletedopt, syncopt) → {Promise.<ServerManager.CloseSessionPromise>|void}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Close the session for this experiment on the remote PsychoJS manager.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
isCompleted + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the experiment was completed

sync + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to communicate with the server in a synchronous manner

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.CloseSessionPromise> +| + +void + + +
+
+ + + + + + + + + + +

getConfiguration(configURL) → {Promise.<ServerManager.GetConfigurationPromise>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Read the configuration file for the experiment.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
configURL + + +string + + + +

the URL of the configuration file

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.GetConfigurationPromise> + + +
+
+ + + + + + + + + + +

getResource(name, errorIfNotDownloadedopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a resource.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +string + + + + + + + + + + + +

name of the requested resource

errorIfNotDownloaded + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to throw an exception if the +resource status is not DOWNLOADED

+ + + + + + + + + + + + + + +
Throws:
+ + + +
+
+
+

exception if no resource with that name has previously been registered

+
+
+
+
+
+
+ Type +
+
+ +Object.<string, *> + + +
+
+
+
+
+ + + + + +
Returns:
+ + +
+

value of the resource, or undefined if the resource has been registered +but not downloaded yet.

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

getResourceStatus(names) → {module:core.ServerManager.ResourceStatus}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the status of a single resource or the reduced status of an array of resources.

+

If an array of resources is given, getResourceStatus returns a single, reduced status +that is the status furthest away from DOWNLOADED, with the status ordered as follow: +ERROR (furthest from DOWNLOADED), REGISTERED, DOWNLOADING, and DOWNLOADED

+

For example, given three resources: +

    +
  • if at least one of the resource status is ERROR, the reduced status is ERROR
    • +
  • if at least one of the resource status is DOWNLOADING, the reduced status is DOWNLOADING
    • +
  • if the status of all three resources is REGISTERED, the reduced status is REGISTERED
    • +
  • if the status of all three resources is DOWNLOADED, the reduced status is DOWNLOADED
    • +
+

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
names + + +string +| + +Array.<string> + + + +

names of the resources whose statuses are requested

+ + + + + + + + + + + + + + +
Throws:
+ + + +
+
+
+

if at least one of the names is not that of a previously +registered resource

+
+
+
+
+
+
+ Type +
+
+ +Object.<string, *> + + +
+
+
+
+
+ + + + + +
Returns:
+ + +
+

status of the resource if there is only one, or reduced status otherwise

+
+ + + +
+
+ Type +
+
+ +module:core.ServerManager.ResourceStatus + + +
+
+ + + + + + + + + + +

openSession() → {Promise.<ServerManager.OpenSessionPromise>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Open a session for this experiment on the remote PsychoJS manager.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.OpenSessionPromise> + + +
+
+ + + + + + + + + + +

(async) prepareResources(resourcesopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Prepare resources for the experiment: register them with the server manager and possibly +start downloading them right away.

+
    +
  • For an experiment running locally: the root directory for the specified resources is that of index.html + unless they are prepended with a protocol, such as http:// or https://.
    • +
  • For an experiment running on the server: if no resources are specified, all files in the resources directory + of the experiment are downloaded, otherwise we only download the specified resources. All resources are assumed + local to index.html unless they are prepended with a protocol.
    • +
  • If resources is null, then we do not download any resources
    • +
+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
resources + + +String +| + +Array.<({name: string, path: string, download: boolean}|String|Symbol)> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the list of resources or a single resource

+ + + + + + + + + + + + + + + + + + + + + + + + +

resetStatus() → {ServerManager.Status.READY}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the resource manager status to ServerManager.Status.READY.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the new status

+
+ + + +
+
+ Type +
+
+ +ServerManager.Status.READY + + +
+
+ + + + + + + + + + +

setStatus()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the resource manager status.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(async) uploadAudioVideo(@param) → {Promise.<ServerManager.UploadDataPromise>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Synchronously or asynchronously upload audio data to the pavlovia server.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
@param + + +Object + + + + + + + + + + + +

options

options.mediaBlob + + +Blob + + + + + + + + + + + +

the audio or video blob to be uploaded

options.tag + + +string + + + + + + + + + + + +

additional tag

options.waitForCompletion + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to wait for completion +before returning

options.showDialog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to open a dialog box to inform the participant to wait for the data to be uploaded to the server

options.dialogMsg + + +string + + + + + + <optional>
+ + + + + + 		+ + "Please wait a few moments while the data is uploading to the server" + +

default message informing the participant to wait for the data to be uploaded to the server

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.UploadDataPromise> + + +
+
+ + + + + + + + + + +

uploadData(key, value, syncopt) → {Promise.<ServerManager.UploadDataPromise>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Asynchronously upload experiment data to the pavlovia server.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
key + + +string + + + + + + + + + + + +

the data key (e.g. the name of .csv file)

value + + +string + + + + + + + + + + + +

the data value (e.g. a string containing the .csv header and records)

sync + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to communicate with the server in a synchronous manner

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.UploadDataPromise> + + +
+
+ + + + + + + + + + +

uploadLog(logs, compressedopt) → {Promise.<ServerManager.UploadDataPromise>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Asynchronously upload experiment logs to the pavlovia server.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
logs + + +string + + + + + + + + + + + +

the base64 encoded, compressed, formatted logs

compressed + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the logs are compressed

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response

+
+ + + +
+
+ Type +
+
+ +Promise.<ServerManager.UploadDataPromise> + + +
+
+ + + + + + + + + + +

waitForResources(resourcesopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Block the experiment until the specified resources have been downloaded.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
resources + + +Array.<{name: string, path: string}> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the list of resources

+ + + + + + + + + + + + + + + + + + + + + + + +

Type Definitions

+ + + +

CloseSessionPromise

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
origin + + +string + + + + + + + +

the calling method

context + + +string + + + + + + + +

the context

error + + +Object.<string, *> + + + + + + <optional>
+ + + +

an error message if we could not close the session (e.g. if it has not previously been opened)

+ + + + + + + + + + + + + + + +

GetConfigurationPromise

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
origin + + +string + + + + + + + +

the calling method

context + + +string + + + + + + + +

the context

config + + +Object.<string, *> + + + + + + <optional>
+ + + +

the configuration

error + + +Object.<string, *> + + + + + + <optional>
+ + + +

an error message if we could not read the configuration file

+ + + + + + + + + + + + + + + +

OpenSessionPromise

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
origin + + +string + + + + + + + +

the calling method

context + + +string + + + + + + + +

the context

token + + +string + + + + + + <optional>
+ + + +

the session token

error + + +Object.<string, *> + + + + + + <optional>
+ + + +

an error message if we could not open the session

+ + + + + + + + + + + + + + + +

UploadDataPromise

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
origin + + +string + + + + + + + +

the calling method

context + + +string + + + + + + + +

the context

error + + +Object.<string, *> + + + + + + <optional>
+ + + +

an error message if we could not upload the data

+ + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/ShapeStim.html b/docs/ShapeStim.html new file mode 100644 index 0000000..c85946e --- /dev/null +++ b/docs/ShapeStim.html @@ -0,0 +1,1780 @@ + + + + + + ShapeStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

ShapeStim

+ + + + + + + +
+ +
+ +

+ visual + + ShapeStim +

+ +

This class provides the basic functionality of shape stimuli.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new ShapeStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
    + +
  • ColorMixin
    • + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

lineWidth + + +number + + + + + + + + + + + +

the line width

lineColor + + +Color + + + + + + <optional>
+ + + + + + 		+ + 'white' + +

the line color

fillColor + + +Color + + + + + + + + + + + +

the fill color

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

vertices + + +Array.<Array.<number>> + + + + + + <optional>
+ + + + + + 		+ + [[-0.5, 0], [0, 0.5], [0.5, 0]] + +

the shape vertices

closeShape + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the shape is closed

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the shape

size + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the size

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

units + + +string + + + + + + + + + + + +

the units of the stimulus vertices, size and position

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth

interpolate + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the shape is interpolated

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) KnownShapes

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Known shapes.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getPixiPolygon() → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the PIXI polygon (in pixel units) corresponding to the vertices.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the PIXI polygon corresponding to this stimulus vertices.

+
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

(protected) _getVertices_px() → {Array.<Array.<number>>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the vertices in pixel units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the vertices (in pixel units)

+
+ + + +
+
+ Type +
+
+ +Array.<Array.<number>> + + +
+
+ + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

contains(object, units) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside the bounding box of the ShapeStim.

+

This is overridden in order to provide a finer inclusion test.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +string + + + +

the units

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the object is inside the bounding box of the ShapeStim

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

setVertices(vertices, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the vertices attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
vertices + + +Array.<Array.<number>> + + + + + + + + + + + +

the vertices

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/module-data.Shelf.html b/docs/Shelf.html similarity index 52% rename from docs/module-data.Shelf.html rename to docs/Shelf.html index 03d8cfd..88566a8 100644 --- a/docs/module-data.Shelf.html +++ b/docs/Shelf.html @@ -1,23 +1,47 @@ + - JSDoc: Class: Shelf - - - + Shelf - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Class: Shelf

+ + + + +
+ +

Shelf

+ @@ -28,33 +52,80 @@
-

- data.Shelf(options)

+

+ data + + Shelf +

+ +

Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the +server, and can be accessed and manipulated in a concurrent fashion.

-
+
+ - +

Constructor

+

new Shelf(options)

- -
-

Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the -server, and be accessed and manipulated in a concurrent fashion.

-

-
+
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + @@ -163,7 +234,7 @@ server, and be accessed and manipulated in a concurrent fashion.

- the PsychoJS instance +

the PsychoJS instance

@@ -197,12 +268,12 @@ server, and be accessed and manipulated in a concurrent fashion.

- false + false - whether to log +

whether to log

@@ -221,69 +292,24 @@ server, and be accessed and manipulated in a concurrent fashion.

-
+ + + + + + + + + + + + + +
- - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -

Extends

@@ -299,10 +325,10 @@ server, and be accessed and manipulated in a concurrent fashion.

- + - + @@ -311,26 +337,7 @@ server, and be accessed and manipulated in a concurrent fashion.

-

(static) MAX_KEY_LENGTH :number

- - - - -
- Maximum number of components in a key -
- - - -
Type:
-
    -
  • - -number - - -
    • -
+

(static, readonly) Status :Symbol

@@ -339,33 +346,9 @@ server, and be accessed and manipulated in a concurrent fashion.

- - - - - - - - - - - - - - - - - - - - - - - -
Source:
@@ -374,22 +357,136 @@ server, and be accessed and manipulated in a concurrent fashion.

+ + + + + + + + + + + + + + + + + + + + + + + +
+
Properties:
+ + + + + + + + + + + + + + + + + + + + -

(static, readonly) Type :Symbol

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
READY + + +Symbol + + + +

The shelf is ready.

BUSY + + +Symbol + + + +

The shelf is busy, e.g. storing or retrieving values.

ERROR + + +Symbol + + + +

The shelf has encountered an error.

-
- Shelf record types. + + +
+

Shelf status

@@ -408,6 +505,57 @@ server, and be accessed and manipulated in a concurrent fashion.

+ + + +

(static, readonly) Type :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
@@ -552,60 +700,10 @@ server, and be accessed and manipulated in a concurrent fashion.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - -

(readonly) Status :Symbol

- - - - -
- Shelf status +
+

Shelf record types.

@@ -624,36 +722,31 @@ server, and be accessed and manipulated in a concurrent fashion.

+ + + + + +

Methods

+ + + + + + +

_checkAvailability(methodNameopt)

+ + + + + +
- - - - - - - - - - - - - - - - - - - - - - - -
Source:
@@ -662,35 +755,38 @@ server, and be accessed and manipulated in a concurrent fashion.

+ + + + + + + + + + + + + + + + + + + + + + + +
- - - - - -

Methods

- - - - - - - -

_checkAvailability(methodNameopt)

- - - - - - -
- Check whether it is possible to run a given shelf command. - +
+

Check whether it is possible to run a given shelf command.

Since all Shelf methods call _checkAvailability, we also use it as a means to throttle those calls.

@@ -702,6 +798,8 @@ server, and be accessed and manipulated in a concurrent fashion.

+ +
Parameters:
@@ -758,12 +856,12 @@ server, and be accessed and manipulated in a concurrent fashion.

- "" + "" - name of the method requiring a check +

name of the method requiring a check

@@ -775,50 +873,6 @@ server, and be accessed and manipulated in a concurrent fashion.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -833,13 +887,13 @@ server, and be accessed and manipulated in a concurrent fashion.

-
- exception if it is not possible to run the given shelf command +
+

exception if it is not possible to run the given shelf command

-
+
Type
@@ -861,23 +915,64 @@ server, and be accessed and manipulated in a concurrent fashion.

- - -

_checkKey(key)

- -
- Check the validity of the key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check the validity of the key.

@@ -888,6 +983,8 @@ server, and be accessed and manipulated in a concurrent fashion.

+ +
Parameters:
@@ -929,7 +1026,7 @@ server, and be accessed and manipulated in a concurrent fashion.

- key whose validity is to be checked +

key whose validity is to be checked

@@ -941,50 +1038,6 @@ server, and be accessed and manipulated in a concurrent fashion.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -999,13 +1052,13 @@ server, and be accessed and manipulated in a concurrent fashion.

-
- exception if the key is invalid +
+

exception if the key is invalid

-
+
Type
@@ -1027,24 +1080,64 @@ server, and be accessed and manipulated in a concurrent fashion.

- - - -

(protected) _getValue(key, type, optionsopt) → {Promise.<any>}

- +

(async) _getValue(key, type, optionsopt) → {Promise.<any>}

-
- Get the value associated with the given key. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value associated with the given key.

This is a generic method, typically called from the Shelf helper methods, e.g. getBinaryValue.

@@ -1056,6 +1149,8 @@ server, and be accessed and manipulated in a concurrent fashion.

+ +
Parameters:
@@ -1107,7 +1202,7 @@ server, and be accessed and manipulated in a concurrent fashion.

- key as an array of key components +

key as an array of key components

@@ -1120,7 +1215,7 @@ server, and be accessed and manipulated in a concurrent fashion.

-Shelf.Type +Shelf.Type @@ -1138,7 +1233,7 @@ server, and be accessed and manipulated in a concurrent fashion.

- the type of the record associated with the given key +

the type of the record associated with the given key

@@ -1171,8 +1266,8 @@ server, and be accessed and manipulated in a concurrent fashion.

- the options, e.g. the default value returned if no record with the -given key exists on the shelf +

the options, e.g. the default value returned if no record with the +given key exists on the shelf

@@ -1184,50 +1279,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1242,14 +1293,14 @@ given key exists on the shelf
-
- exception if there is a record associated with the given key but it is not of - the given type +
+

exception if there is a record associated with the given key but it is not of +the given type

-
+
Type
@@ -1272,12 +1323,12 @@ given key exists on the shelf
- the value +

the value

-
+
Type
@@ -1293,24 +1344,64 @@ given key exists on the shelf - - - -

(protected) _updateValue(key, type, update) → {Promise.<any>}

- +

(async) _updateValue(key, type, update) → {Promise.<any>}

-
- Update the value associated with the given key. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the value associated with the given key.

This is a generic method, typically called from the Shelf helper methods, e.g. setBinaryValue.

@@ -1322,6 +1413,8 @@ given key exists on the shelf + +
Parameters:
@@ -1363,7 +1456,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -1376,7 +1469,7 @@ given key exists on the shelf -Shelf.Type +Shelf.Type @@ -1386,7 +1479,7 @@ given key exists on the shelf - the type of the record associated with the given key +

the type of the record associated with the given key

@@ -1409,7 +1502,7 @@ given key exists on the shelf - the desired update +

the desired update

@@ -1421,50 +1514,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1479,14 +1528,14 @@ given key exists on the shelf
-
- exception if there is no record associated with the given key or if there is one - but it is not of the given type +
+

exception if there is no record associated with the given key or if there is one +but it is not of the given type

-
+
Type
@@ -1509,12 +1558,12 @@ given key exists on the shelf
- the updated value +

the updated value

-
+
Type
@@ -1530,23 +1579,64 @@ given key exists on the shelf - - -

addIntegerValue(options) → {Promise.<number>}

- -
- Add a delta to the value of a record of type INTEGER associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add a delta to the value of a record of type INTEGER associated with the given key.

@@ -1557,6 +1647,8 @@ given key exists on the shelf + +
Parameters:
@@ -1640,7 +1732,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -1663,7 +1755,7 @@ given key exists on the shelf - the delta, positive or negative, to add to the value +

the delta, positive or negative, to add to the value

@@ -1682,50 +1774,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1740,14 +1788,14 @@ given key exists on the shelf
-
- exception if delta is not an integer, or if there is no record with the given - key, or if there is a record but it is locked or it is not of type INTEGER +
+

exception if delta is not an integer, or if there is no record with the given +key, or if there is a record but it is locked or it is not of type INTEGER

-
+
Type
@@ -1770,12 +1818,12 @@ given key exists on the shelf
- the new value +

the new value

-
+
Type
@@ -1791,23 +1839,64 @@ given key exists on the shelf - - -

appendListValue(options) → {Promise.<Array.<*>>}

- -
- Append an element, or a list of elements, to the value of a record of type LIST associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Append an element, or a list of elements, to the value of a record of type LIST associated with the given key.

@@ -1818,6 +1907,8 @@ given key exists on the shelf + +
Parameters:
@@ -1901,7 +1992,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -1924,7 +2015,7 @@ given key exists on the shelf - the element or list of elements to be appended +

the element or list of elements to be appended

@@ -1943,50 +2034,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2001,14 +2048,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type LIST +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type LIST

-
+
Type
@@ -2031,12 +2078,12 @@ given key exists on the shelf
- the new value +

the new value

-
+
Type
@@ -2052,23 +2099,64 @@ given key exists on the shelf - - -

clearListValue(options) → {Promise.<Array.<*>>}

- -
- Empty the value of a record of type LIST associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Empty the value of a record of type LIST associated with the given key.

@@ -2079,6 +2167,8 @@ given key exists on the shelf + +
Parameters:
@@ -2162,7 +2252,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -2181,50 +2271,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2239,14 +2285,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type LIST +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type LIST

-
+
Type
@@ -2269,12 +2315,12 @@ given key exists on the shelf
- the new, empty value, i.e. [] +

the new, empty value, i.e. []

-
+
Type
@@ -2290,23 +2336,64 @@ given key exists on the shelf - - - -

counterBalanceSelect(key, groups, groupSizes) → {Promise.<any>}

- +

(async) counterBalanceSelect(options) → {Promise.<{string, boolean}>}

-
- Get the name of a group, using a counterbalanced design. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the name of a group, using a counterbalanced design.

@@ -2317,6 +2404,8 @@ given key exists on the shelf + +
Parameters:
@@ -2333,6 +2422,48 @@ given key exists on the shelf + Description + + + + + + + + + options + + + + + +Object + + + + + + + + + + +
Properties
+ + + + + + + + + + + + + + + @@ -2358,7 +2489,7 @@ given key exists on the shelf - + @@ -2381,7 +2512,7 @@ given key exists on the shelf - + @@ -2404,57 +2535,20 @@ given key exists on the shelf - +
NameTypeDescription
key as an array of key components

key as an array of key components
the names of the groups

the names of the groups
the size of the groups

the size of the groups
- - - - - -
+ + + + - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
@@ -2473,15 +2567,20 @@ given key exists on the shelf
Returns:
+
+

an object with the name of the selected group and whether all groups +have been depleted

+
-
+ +
Type
-Promise.<any> +Promise.<{string, boolean}>
@@ -2491,23 +2590,64 @@ given key exists on the shelf - - -

flipBooleanValue(options) → {Promise.<boolean>}

- -
- Flip the value of a record of type BOOLEAN associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Flip the value of a record of type BOOLEAN associated with the given key.

@@ -2518,6 +2658,8 @@ given key exists on the shelf + +
Parameters:
@@ -2601,7 +2743,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -2620,50 +2762,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2678,14 +2776,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, or - if there is a record but it is not of type BOOLEAN +
+

exception if there is no record with the given key, or +if there is a record but it is not of type BOOLEAN

-
+
Type
@@ -2708,12 +2806,12 @@ given key exists on the shelf
- the new, flipped, value +

the new, flipped, value

-
+
Type
@@ -2729,23 +2827,64 @@ given key exists on the shelf - - -

getBooleanValue(options) → {Promise.<boolean>}

- -
- Get the value of a record of type BOOLEAN associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a record of type BOOLEAN associated with the given key.

@@ -2756,6 +2895,8 @@ given key exists on the shelf + +
Parameters:
@@ -2839,7 +2980,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -2862,8 +3003,8 @@ given key exists on the shelf - the default value returned if no record with the given key exists - on the shelf +

the default value returned if no record with the given key exists +on the shelf

@@ -2882,50 +3023,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2940,14 +3037,14 @@ given key exists on the shelf
-
- exception if there is a record associated with the given key - but it is not of type BOOLEAN +
+

exception if there is a record associated with the given key +but it is not of type BOOLEAN

-
+
Type
@@ -2970,12 +3067,12 @@ given key exists on the shelf
- the value associated with the key +

the value associated with the key

-
+
Type
@@ -2991,23 +3088,64 @@ given key exists on the shelf - - - -

getDictionaryFieldNames(options) → {Promise.<Array.<string>>}

- +

(async) getDictionaryFieldNames(options) → {Promise.<Array.<string>>}

-
- Get the names of the fields in the dictionary record associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the names of the fields in the dictionary record associated with the given key.

@@ -3018,6 +3156,8 @@ given key exists on the shelf + +
Parameters:
@@ -3101,7 +3241,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -3120,50 +3260,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3178,14 +3274,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type DICTIONARY +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type DICTIONARY

-
+
Type
@@ -3208,12 +3304,12 @@ given key exists on the shelf
- the list of field names +

the list of field names

-
+
Type
@@ -3229,23 +3325,64 @@ given key exists on the shelf - - - -

getDictionaryFieldValue(options) → {Promise.<*>}

- +

(async) getDictionaryFieldValue(options) → {Promise.<*>}

-
- Get the value of a given field in the dictionary record associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a given field in the dictionary record associated with the given key.

@@ -3256,6 +3393,8 @@ given key exists on the shelf + +
Parameters:
@@ -3339,7 +3478,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -3362,7 +3501,7 @@ given key exists on the shelf - the name of the field +

the name of the field

@@ -3385,8 +3524,8 @@ given key exists on the shelf - the default value returned if no record with the given key exists on - the shelf, or if is a record of type DICTIONARY with the given key but it has no such field +

the default value returned if no record with the given key exists on +the shelf, or if is a record of type DICTIONARY with the given key but it has no such field

@@ -3405,50 +3544,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3463,14 +3558,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, - or if there is a record but it is locked or it is not of type DICTIONARY +
+

exception if there is no record with the given key, +or if there is a record but it is locked or it is not of type DICTIONARY

-
+
Type
@@ -3493,12 +3588,12 @@ given key exists on the shelf
- the value of that field +

the value of that field

-
+
Type
@@ -3514,23 +3609,64 @@ given key exists on the shelf - - -

getDictionaryValue(options) → {Promise.<Object.<string, *>>}

- -
- Get the value of a record of type DICTIONARY associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a record of type DICTIONARY associated with the given key.

@@ -3541,6 +3677,8 @@ given key exists on the shelf + +
Parameters:
@@ -3624,7 +3762,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -3647,8 +3785,8 @@ given key exists on the shelf - the default value returned if no record with the given key - exists on the shelf +

the default value returned if no record with the given key +exists on the shelf

@@ -3667,50 +3805,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3725,14 +3819,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, - or if there is a record but it is locked or it is not of type DICTIONARY +
+

exception if there is no record with the given key, +or if there is a record but it is locked or it is not of type DICTIONARY

-
+
Type
@@ -3755,12 +3849,12 @@ given key exists on the shelf
- the value associated with the key +

the value associated with the key

-
+
Type
@@ -3776,23 +3870,64 @@ given key exists on the shelf - - -

getIntegerValue(options) → {Promise.<number>}

- -
- Get the value of a record of type INTEGER associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a record of type INTEGER associated with the given key.

@@ -3803,6 +3938,8 @@ given key exists on the shelf + +
Parameters:
@@ -3886,7 +4023,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -3909,8 +4046,8 @@ given key exists on the shelf - the default value returned if no record with the given key - exists on the shelf +

the default value returned if no record with the given key +exists on the shelf

@@ -3929,50 +4066,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3987,14 +4080,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, - or if there is a record but it is locked or it is not of type BOOLEAN +
+

exception if there is no record with the given key, +or if there is a record but it is locked or it is not of type BOOLEAN

-
+
Type
@@ -4017,12 +4110,12 @@ given key exists on the shelf
- the value associated with the key +

the value associated with the key

-
+
Type
@@ -4038,23 +4131,64 @@ given key exists on the shelf - - -

getListValue(options) → {Promise.<Array.<*>>}

- -
- Get the value of a record of type LIST associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a record of type LIST associated with the given key.

@@ -4065,6 +4199,8 @@ given key exists on the shelf + +
Parameters:
@@ -4148,7 +4284,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -4171,8 +4307,8 @@ given key exists on the shelf - the default value returned if no record with the given key exists on - the shelf +

the default value returned if no record with the given key exists on +the shelf

@@ -4191,50 +4327,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -4249,14 +4341,14 @@ given key exists on the shelf
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type LIST +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type LIST

-
+
Type
@@ -4279,12 +4371,12 @@ given key exists on the shelf
- the value associated with the key +

the value associated with the key

-
+
Type
@@ -4300,23 +4392,64 @@ given key exists on the shelf - - -

getTextValue(options) → {Promise.<string>}

- -
- Get the value of a record of type TEXT associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the value of a record of type TEXT associated with the given key.

@@ -4327,6 +4460,8 @@ given key exists on the shelf + +
Parameters:
@@ -4410,7 +4545,7 @@ given key exists on the shelf - key as an array of key components +

key as an array of key components

@@ -4433,8 +4568,8 @@ given key exists on the shelf - the default value returned if no record with the given key exists on - the shelf +

the default value returned if no record with the given key exists on +the shelf

@@ -4453,50 +4588,6 @@ given key exists on the shelf -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -4511,14 +4602,14 @@ given key exists on the shelf
-
- exception if there is a record associated with the given key but it is - not of type TEXT +
+

exception if there is a record associated with the given key but it is +not of type TEXT

-
+
Type
@@ -4541,12 +4632,12 @@ given key exists on the shelf
- the value associated with the key +

the value associated with the key

-
+
Type
@@ -4562,24 +4653,65 @@ given key exists on the shelf - - -

incrementComponent(key, increment, callback) → {function}

- -
- Schedulable component that will block the experiment until the counter associated with the given key -has been incremented by the given amount. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Schedulable component that will block the experiment until the counter associated with the given key +has been incremented by the given amount.

@@ -4590,6 +4722,15 @@ has been incremented by the given amount. +
Example
+ + 
const flowScheduler = new Scheduler(psychoJS);
+var experimentCounter = '<>';
+flowScheduler.add(psychoJS.shelf.incrementComponent(['counter'], 1, (value) => experimentCounter = value));
+ + + +
Parameters:
@@ -4605,6 +4746,8 @@ has been incremented by the given amount. + Default + Description @@ -4625,6 +4768,10 @@ has been incremented by the given amount. + + + + @@ -4643,6 +4790,12 @@ has been incremented by the given amount. + + + 1 + + + @@ -4661,6 +4814,10 @@ has been incremented by the given amount. + + + + @@ -4674,50 +4831,6 @@ has been incremented by the given amount. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -4732,12 +4845,12 @@ has been incremented by the given amount.
- a component that can be scheduled +

a component that can be scheduled

-
+
Type
@@ -4753,31 +4866,65 @@ has been incremented by the given amount. - -
Example
- - 
const flowScheduler = new Scheduler(psychoJS);
-var experimentCounter = '<>';
-flowScheduler.add(psychoJS.shelf.incrementComponent(['counter'], 1, (value) => experimentCounter = value));
- - - -

popListValue(options) → {Promise.<*>}

- -
- Pop an element, at the given index, from the value of a record of type LIST associated -with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Pop an element, at the given index, from the value of a record of type LIST associated +with the given key.

@@ -4788,6 +4935,8 @@ with the given key. + +
Parameters:
@@ -4887,7 +5036,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -4921,12 +5070,12 @@ with the given key. - -1 + -1 - the index of the element to be popped +

the index of the element to be popped

@@ -4945,50 +5094,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -5003,14 +5108,14 @@ with the given key.
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type LIST +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type LIST

-
+
Type
@@ -5033,12 +5138,12 @@ with the given key.
- the popped element +

the popped element

-
+
Type
@@ -5054,23 +5159,64 @@ with the given key. - - -

setBooleanValue(options) → {Promise.<boolean>}

- -
- Set the value of a record of type BOOLEAN associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the value of a record of type BOOLEAN associated with the given key.

@@ -5081,6 +5227,8 @@ with the given key. + +
Parameters:
@@ -5164,7 +5312,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -5187,7 +5335,7 @@ with the given key. - the new value +

the new value

@@ -5206,50 +5354,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -5264,14 +5368,14 @@ with the given key.
-
- exception if value is not a boolean, or if there is no record with the given - key, or if there is a record but it is locked or it is not of type BOOLEAN +
+

exception if value is not a boolean, or if there is no record with the given +key, or if there is a record but it is locked or it is not of type BOOLEAN

-
+
Type
@@ -5294,12 +5398,12 @@ with the given key.
- the new value +

the new value

-
+
Type
@@ -5315,23 +5419,64 @@ with the given key. - - - -

setDictionaryFieldValue(options) → {Promise.<Object.<string, *>>}

- +

(async) setDictionaryFieldValue(options) → {Promise.<Object.<string, *>>}

-
- Set a field in the dictionary record associated to the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set a field in the dictionary record associated to the given key.

@@ -5342,6 +5487,8 @@ with the given key. + +
Parameters:
@@ -5425,7 +5572,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -5448,7 +5595,7 @@ with the given key. - the name of the field +

the name of the field

@@ -5471,7 +5618,7 @@ with the given key. - the value of the field +

the value of the field

@@ -5490,50 +5637,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -5548,14 +5651,14 @@ with the given key.
-
- exception if there is no record with the given key, - or if there is a record but it is locked or it is not of type DICTIONARY +
+

exception if there is no record with the given key, +or if there is a record but it is locked or it is not of type DICTIONARY

-
+
Type
@@ -5578,12 +5681,12 @@ with the given key.
- the updated dictionary +

the updated dictionary

-
+
Type
@@ -5599,23 +5702,64 @@ with the given key. - - -

setDictionaryValue(options) → {Promise.<Object.<string, *>>}

- -
- Set the value of a record of type DICTIONARY associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the value of a record of type DICTIONARY associated with the given key.

@@ -5626,6 +5770,8 @@ with the given key. + +
Parameters:
@@ -5709,7 +5855,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -5732,7 +5878,7 @@ with the given key. - the new value +

the new value

@@ -5751,50 +5897,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -5809,14 +5911,14 @@ with the given key.
-
- exception if value is not an object, or or if there is no record - with the given key, or if there is a record but it is locked or it is not of type DICTIONARY +
+

exception if value is not an object, or or if there is no record +with the given key, or if there is a record but it is locked or it is not of type DICTIONARY

-
+
Type
@@ -5839,12 +5941,12 @@ with the given key.
- the new value +

the new value

-
+
Type
@@ -5860,23 +5962,64 @@ with the given key. - - -

setIntegerValue(options) → {Promise.<number>}

- -
- Set the value of a record of type INTEGER associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the value of a record of type INTEGER associated with the given key.

@@ -5887,6 +6030,8 @@ with the given key. + +
Parameters:
@@ -5970,7 +6115,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -5993,7 +6138,7 @@ with the given key. - the new value +

the new value

@@ -6012,50 +6157,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -6070,14 +6171,14 @@ with the given key.
-
- exception if value is not an integer, or or if there is no record - with the given key, or if there is a record but it is locked or it is not of type INTEGER +
+

exception if value is not an integer, or or if there is no record +with the given key, or if there is a record but it is locked or it is not of type INTEGER

-
+
Type
@@ -6100,12 +6201,12 @@ with the given key.
- the new value +

the new value

-
+
Type
@@ -6121,23 +6222,64 @@ with the given key. - - -

setListValue(options) → {Promise.<Array.<*>>}

- -
- Set the value of a record of type LIST associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the value of a record of type LIST associated with the given key.

@@ -6148,6 +6290,8 @@ with the given key. + +
Parameters:
@@ -6231,7 +6375,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -6254,7 +6398,7 @@ with the given key. - the new value +

the new value

@@ -6273,50 +6417,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -6331,14 +6431,14 @@ with the given key.
-
- exception if value is not an array or if there is no record with the given key, - or if there is a record but it is locked or it is not of type LIST +
+

exception if value is not an array or if there is no record with the given key, +or if there is a record but it is locked or it is not of type LIST

-
+
Type
@@ -6361,12 +6461,12 @@ with the given key.
- the new value +

the new value

-
+
Type
@@ -6382,23 +6482,64 @@ with the given key. - - -

setTextValue(options) → {Promise.<string>}

- -
- Set the value of a record of type TEXT associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the value of a record of type TEXT associated with the given key.

@@ -6409,6 +6550,8 @@ with the given key. + +
Parameters:
@@ -6492,7 +6635,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -6515,7 +6658,7 @@ with the given key. - the new value +

the new value

@@ -6534,50 +6677,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -6592,14 +6691,14 @@ with the given key.
-
- exception if value is not a string, or if there is a record associated - with the given key but it is not of type TEXT +
+

exception if value is not a string, or if there is a record associated +with the given key but it is not of type TEXT

-
+
Type
@@ -6622,12 +6721,12 @@ with the given key.
- the new value +

the new value

-
+
Type
@@ -6643,23 +6742,64 @@ with the given key. - - -

shuffleListValue(options) → {Promise.<Array.<*>>}

- -
- Shuffle the elements of the value of a record of type LIST associated with the given key. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Shuffle the elements of the value of a record of type LIST associated with the given key.

@@ -6670,6 +6810,8 @@ with the given key. + +
Parameters:
@@ -6753,7 +6895,7 @@ with the given key. - key as an array of key components +

key as an array of key components

@@ -6772,50 +6914,6 @@ with the given key. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -6830,14 +6928,14 @@ with the given key.
-
- exception if there is no record with the given key, or if there is a record - but it is locked or it is not of type LIST +
+

exception if there is no record with the given key, or if there is a record +but it is locked or it is not of type LIST

-
+
Type
@@ -6860,12 +6958,12 @@ with the given key.
- the new, shuffled value +

the new, shuffled value

-
+
Type
@@ -6881,8 +6979,6 @@ with the given key. - - @@ -6896,19 +6992,23 @@ with the given key. + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + \ No newline at end of file diff --git a/docs/Slider.html b/docs/Slider.html new file mode 100644 index 0000000..781b55f --- /dev/null +++ b/docs/Slider.html @@ -0,0 +1,7169 @@ + + + + + + Slider - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Slider

+ + + + + + + +
+ +
+ +

+ visual + + Slider +

+ +

Slider stimulus.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Slider(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
+ + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • check that parameters are valid, e.g. ticks are an array of numbers, etc.
    • + +
  • readOnly
    • + +
  • complete setters, for instance setTicks should change this._isCategorical
    • + +
  • flesh out the skin approach
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the slider

size + + +Array.<number> + + + + + + + + + + + +

the size of the slider, e.g. [1, 0.1] for an horizontal slider

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'height' + +

the units of the Slider position, and font size

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('LightGray') + +

the color of the slider

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast of the slider

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity of the slider

style + + +string + + + + + + <optional>
+ + + + + + 		+ + [Slider.Style.RATING] + +

the slider style

ticks + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [1,2,3,4,5] + +

the array of ticks

labels + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the array of labels

granularity + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the granularity

flip + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip the position of the marker, ticks, +and labels with respect to the central bar

readOnly + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the slider is read only

font + + +string + + + + + + <optional>
+ + + + + + 		+ + 'Arial' + +

the text font

bold + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the font of the labels is bold

italic + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the font of the labels is italic

fontSize + + +number + + + + + + <optional>
+ + + + + + 		+ +

the font size of the labels (in pixels), the default fontSize depends on the +Slider's units: 14 for 'pix', 0.03 otherwise

compact + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the slider is compact, i.e. whether all graphical +elements (e.g. labels) fit within its size

clipMask + + +PIXI.Graphics + + + + + + + + + + + +

the clip mask

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every +frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

dependentStims + + +Array.<core.MinimalStim> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the list of dependent stimuli, +which must be updated when this Slider is updated, e.g. a Form.

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Members

+ + + +

(static, readonly) Shape :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
DISC + + +Symbol + + + +
TRIANGLE + + +Symbol + + + +
LINE + + +Symbol + + + +
BOX + + +Symbol + + + +
+ + + + + + +
+

Shape of the marker and of the ticks.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

(static, readonly) Skin :any

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
MARKER_SIZE + + +any + + + +
STANDARD + + +any + + + +
WHITE_ON_BLACK + + +any + + + +
+ + + + + + +
+

Skin.

+
+ + + +
Type:
+
    +
  • + +any + + +
    • +
+ + + + + + + + +

(static, readonly) Style :Symbol

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
RATING + + +Symbol + + + +
TRIANGLE_MARKER + + +Symbol + + + +
SLIDER + + +Symbol + + + +
WHITE_ON_BLACK + + +Symbol + + + +
LABELS_45 + + +Symbol + + + +
RADIO + + +Symbol + + + +
+ + + + + + +
+

Styles.

+
+ + + +
Type:
+
    +
  • + +Symbol + + +
    • +
+ + + + + + + + +

borderColor

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Let borderColor alias lineColor to parallel PsychoPy

+
+ + + + + + + + + + +

fillColor

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Let fillColor alias markerColor to parallel PsychoPy

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _addEventListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add event listeners.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getBoundingBox_px() → {PIXI.Rectangle}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the bounding box in pixel coordinates

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the bounding box, in pixel coordinates

+
+ + + +
+
+ Type +
+
+ +PIXI.Rectangle + + +
+
+ + + + + + + + + + +

(protected) _getPosition_px() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the position of the slider, taking the compactness into account.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the position of the slider, in pixels
    • +
+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _getTextStyle()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the PIXI Text Style applied to the PIXI.Text labels.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _granularise(rating) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Calculate the rating once granularity has been taken into account.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rating + + +number + + + +

the input rating

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the new rating with granularity applied

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected) _handlePointerDown()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Handle pointerdown event.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _handlePointerMove()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Handle pointermove event.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _handlePointerUp()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Handle pointerup event.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _isHorizontal() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether the slider is horizontal.

+

The slider is horizontal is its x-axis size is larger than its y-axis size.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the slider is horizontal

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

(protected) _onChange(withPixiopt, withBoundingBoxopt) → {function}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Generate a callback that prepares updates to the stimulus. +This is typically called in the constructor of a stimulus, when attributes are added +with _addAttribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
withPixi + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the PIXI representation must +also be updated

withBoundingBox + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to immediately estimate +the bounding box

+ + + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + +
+
+ + + + + + + + + + +

(protected) _posToRating(pos_px) → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert a [x,y] position, in pixel units, relative to the slider, into a rating.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pos_px + + +Array.<number> + + + +

the [x,y] position, in pixel units, relative to the slider.

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the corresponding rating.

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected) _ratingToPos(ratings) → {Array.<Array.<number>>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert an array of ratings into an array of [x,y] positions (in Slider units, with 0 at the center of the Slider)

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ratings + + +Array.<number> + + + +

the array of ratings

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the positions corresponding to the ratings (in Slider units, +with 0 at the center of the Slider)

+
+ + + +
+
+ Type +
+
+ +Array.<Array.<number>> + + +
+
+ + + + + + + + + + +

(protected) _removeEventListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Remove event listeners.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _sanitizeAttributes()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Sanitize the slider attributes: check for attribute conflicts, missing values, etc.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupBar()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the central bar.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupLabels()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the labels.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupMarker()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the marker, and the associated mouse events.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupSlider()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the PIXI components of the slider (bar, ticks, labels, marker, etc.).

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupStyle()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Apply a particular style to the slider.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupTicks()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup the ticks.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

contains(object, units) → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether an object is inside the bounding box of the stimulus.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
object + + +Object + + + +

the object

units + + +string + + + +

the units

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the object is inside the bounding box of the stimulus

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

draw()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Draw this stimulus on the next frame draw.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getRating() → {number|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the current value of the rating.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the rating or undefined if there is none

+
+ + + +
+
+ Type +
+
+ +number +| + +undefined + + +
+
+ + + + + + + + + + +

getRT() → {number|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the response time of the most recent change to the rating.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the response time (in second) or undefined if there is none

+
+ + + +
+
+ Type +
+
+ +number +| + +undefined + + +
+
+ + + + + + + + + + +

hide()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Hide this stimulus on the next frame draw.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

isMarkerDragging() → {boolean}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Query whether or not the marker is currently being dragged.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

whether or not the marker is being dragged

+
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

recordRating(rating, responseTimeopt, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the current rating.

+

Setting the rating does also change the visible position of the marker.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
rating + + +number + + + + + + + + + + + +

the rating

responseTime + + +number + + + + + + <optional>
+ + + + + + 		+ +

the reaction time

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

refresh()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Force a refresh of the stimulus.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

release(logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Release the PIXI representation, if there is one.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

reset()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Reset the slider.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setAutoDraw(autoDraw, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the autoDraw attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
autoDraw + + +boolean + + + + + + + + + + + +

the new value

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setDepth(depth, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the depth attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
depth + + +Array.<number> + + + + + + + + + + + + 0 + +

order in which stimuli is rendered, kind of css's z-index with a negative sign.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setMarkerPos(displayedRating, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the markerPos attribute.

+

Setting markerPos changes the visible position of the marker to the specified rating +but does not change the actual rating returned by the slider.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
displayedRating + + +number + + + + + + + + + + + +

the displayed rating

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setOri(ori, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the orientation attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
ori + + +number + + + + + + + + + + + + 0 + +

the orientation in degree with 0 as the vertical position, positive values rotate clockwise.

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setPos(pos, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the position attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
pos + + +Array.<number> + + + + + + + + + + + +

position of the center of the stimulus, in stimulus units

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setRating(rating, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the rating attribute.

+

Setting the rating does not change the visible position of the marker.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
rating + + +number + + + + + + + + + + + +

the rating

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setReadOnly(readOnlyopt, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the readOnly attribute.

+

Read-only sliders are half-opaque and do not provide responses.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
readOnly + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the slider is read-only

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setSize(size, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the size attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
size + + +undefined +| + +null +| + +number +| + +Array.<number> + + + + + + + + + + + +

the stimulus size

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/SoundPlayer.html b/docs/SoundPlayer.html new file mode 100644 index 0000000..716df83 --- /dev/null +++ b/docs/SoundPlayer.html @@ -0,0 +1,1079 @@ + + + + + + SoundPlayer - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

SoundPlayer

+ + + + + + + +
+ +
+ +

+ sound + + SoundPlayer +

+ +

SoundPlayer is an interface for the sound players, who are responsible for actually playing the sounds, i.e. the tracks or the tones.

+ + +
+ +
+ +
+ + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(abstract, static) accept(sound) → {Object|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether this player can play the given sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sound + + +module:sound.Sound + + + +

the sound

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

an instance of the SoundPlayer that can play the sound, or undefined if none could be found

+
+ + + +
+
+ Type +
+
+ +Object +| + +undefined + + +
+
+ + + + + + + + + + +

(abstract) getDuration()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the duration of the sound, in seconds.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) play(loopsopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
loops + + +number + + + + + + <optional>
+ + + + + +

how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) setDuration()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the duration of the sound, in seconds.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) setLoops(loops)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the number of loops.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loops + + +number + + + +

how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) setVolume(volume, muteopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the volume of the tone.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
volume + + +Integer + + + + + + + + + + + +

the volume of the tone

mute + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to mute the tone

+ + + + + + + + + + + + + + + + + + + + + + + + +

(abstract) stop()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop playing the sound immediately.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/SpeechRecognition.html b/docs/SpeechRecognition.html new file mode 100644 index 0000000..8bd9a3a --- /dev/null +++ b/docs/SpeechRecognition.html @@ -0,0 +1,1436 @@ + + + + + + SpeechRecognition - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

SpeechRecognition

+ + + + + + + +
+ +
+ +

+ sound + + SpeechRecognition +

+ +

This manager handles the live transcription of speech into text.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new SpeechRecognition(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • deal with alternatives, interim results, and recognition errors
    • +
+
+ +
+ + + + + +
+

This manager handles the live transcription of speech into text.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

name + + +String + + + + + + + + + + + +

the name used when logging messages

bufferSize + + +number + + + + + + <optional>
+ + + + + + 		+ + 10000 + +

the maximum size of the circular transcript buffer

continuous + + +Array.<String> + + + + + + <optional>
+ + + + + + 		+ + true + +

whether to continuously recognise

lang + + +Array.<String> + + + + + + <optional>
+ + + + + + 		+ + 'en-US' + +

the spoken language

interimResults + + +Array.<String> + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to make interim results available

maxAlternatives + + +Array.<String> + + + + + + <optional>
+ + + + + + 		+ + 1 + +

the maximum number of recognition alternatives

tokens + + +Array.<String> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the tokens to be recognised. This is experimental technology, not available in all browser.

clock + + +Clock + + + + + + <optional>
+ + + + + + 		+ +

an optional clock

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _onChange()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Callback for changes to the recognition settings.

+

Changes to the recognition settings require the speech recognition process +to be stopped and be re-started.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _prepareRecognition()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Prepare the speech recognition process.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

clearTranscripts()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clear all transcripts and resets the circular buffers.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getTranscripts(options) → {Array.<Transcript>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the list of transcripts still in the buffer, i.e. those that have not been +previously cleared by calls to getTranscripts with clear = true.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
transcriptList + + +Array.<string> + + + + + + <optional>
+ + + + + + 		+ + [] + +

the list of transcripts texts to consider. If transcriptList is empty, we consider all transcripts.

clear + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to keep in the buffer the transcripts for a subsequent call to getTranscripts. If a keyList has been given and clear = true, we only remove from the buffer those keys in keyList

+ +
+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the list of transcripts still in the buffer

+
+ + + +
+
+ Type +
+
+ +Array.<Transcript> + + +
+
+ + + + + + + + + + +

start() → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start the speech recognition process.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the process actually starts

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + +

stop() → {Promise}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop the speech recognition process.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

promise fulfilled when the process actually stops

+
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/TextBox.html b/docs/TextBox.html new file mode 100644 index 0000000..c3a61a6 --- /dev/null +++ b/docs/TextBox.html @@ -0,0 +1,4353 @@ + + + + + + TextBox - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

TextBox

+ + + + + + + +
+ +
+ +

+ visual + + TextBox +

+ + +
+ +
+ +
+ + + + + +

new TextBox(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
    + +
  • ColorMixin
    • + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

text + + +string + + + + + + <optional>
+ + + + + + 		+ + "" + +

the text to be rendered

font + + +string + + + + + + <optional>
+ + + + + + 		+ + "Arial" + +

the font family

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the text

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('white') + +

color of the text

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth (i.e. the z order)

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the text size and position

ori + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.0 + +

the orientation (in degrees)

letterHeight + + +number + + + + + + <optional>
+ + + + + + 		+ + <default value> + +

the height of the text

bold + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the text is bold

italic + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the text is italic

anchor + + +string + + + + + + <optional>
+ + + + + + 		+ + 'left' + +

horizontal alignment

multiline + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not a multiline element is used

autofocus + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not the first input should receive focus by default

flipHoriz + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip the text horizontally

flipVert + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip the text vertically

fillColor + + +Color + + + + + + <optional>
+ + + + + + 		+ +

fill color of the text-box

languageStyle + + +String + + + + + + <optional>
+ + + + + + 		+ + "LTR" + +

sets the direction property of the text inputs. Possible values ["LTR", "RTL", "Arabic"]. "Arabic" is added for consistency with PsychoPy

borderColor + + +Color + + + + + + <optional>
+ + + + + + 		+ +

border color of the text-box

clipMask + + +PIXI.Graphics + + + + + + <optional>
+ + + + + + 		+ + null + +

the clip mask

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

fitToContent + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to resize itself automaitcally to fit to the text content

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static, readonly) _defaultLetterHeightMap

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates units to default letter height.

+
+ + + + + + + + + + +

(protected, static, readonly) _defaultSizeMap

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates units to default sizes.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _addEventListeners()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add event listeners to text-box object. Method is called internally upon object construction.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getAnchor() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert the anchor attribute into numerical values.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the anchor, as an array of numbers in [0,1]
    • +
+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _getDefaultLetterHeight() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the default letter height given the stimulus' units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the letter height corresponding to this stimulus' units.
    • +
+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

(protected) _getTextInputOptions()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the TextInput options applied to the PIXI.TextInput.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • take size into account
    • +
+
+ +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

clear()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clears the current text value.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getText() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

For accessing the underlying input value.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the current text value of the underlying input element.
    • +
+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

reset()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Clears the current text value or sets it back to match the placeholder.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setAlignment(alignment, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the alignment attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
alignment + + +boolean + + + + + + + + + + + + left + +

alignment of the text

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setAnchor(anchor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the anchor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
anchor + + +boolean + + + + + + + + + + + + center + +

anchor of the textbox

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setBorderColor(borderColor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the borderColor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
borderColor + + +Color + + + + + + + + + + + +

border color of the text box

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setColor(color, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the color attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
color + + +boolean + + + + + + + + + + + +

color of the text

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFillColor(fillColor, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the fillColor attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fillColor + + +boolean + + + + + + + + + + + +

fill color of the text box

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFitToContent(fitToContent, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the fitToContent attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fitToContent + + +boolean + + + + + + + + + + + +

whether or not to autoresize textbox to fit to text content

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setFont(font, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the font for textbox.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
font + + +string + + + + + + + + + + + + Arial + +

the font family

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLanguageStyle(languageStyle, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the languageStyle attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
languageStyle + + +String + + + + + + + + + + + + LTR + +

text direction in textbox, accepts values ["LTR", "RTL", "Arabic"]

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLetterHeight(fontSizeopt, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set letterHeight (font size) for textbox.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fontSize + + +string + + + + + + <optional>
+ + + + + + 		+ + <default value> + +

the size of the font

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setSize(size, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the size attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
size + + +boolean + + + + + + + + + + + +

whether or not to wrap the text at the given width

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ + + + + + + + + + + + + + + + + + + + + + + + +

setText(text)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

For tweaking the underlying input value.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
text + + +string + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/TextStim.html b/docs/TextStim.html new file mode 100644 index 0000000..b77c618 --- /dev/null +++ b/docs/TextStim.html @@ -0,0 +1,2296 @@ + + + + + + TextStim - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

TextStim

+ + + + + + + +
+ +
+ +

+ visual + + TextStim +

+ +

TextStim handles text stimuli.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new TextStim(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + +
Mixes In:
+ +
    + +
  • ColorMixin
    • + +
+ + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • vertical alignment, and orientation are currently NOT implemented
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
name + + +String + + + + + + + + + + + +

the name used when logging messages from this stimulus

win + + +module:core.Window + + + + + + + + + + + +

the associated Window

text + + +string + + + + + + <optional>
+ + + + + + 		+ + "Hello World" + +

the text to be rendered

font + + +string + + + + + + <optional>
+ + + + + + 		+ + "Arial" + +

the font family

pos + + +Array.<number> + + + + + + <optional>
+ + + + + + 		+ + [0, 0] + +

the position of the center of the text

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + 'white' + +

the background color

opacity + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the opacity

depth + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

the depth (i.e. the z order)

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

the contrast

units + + +string + + + + + + <optional>
+ + + + + + 		+ + "norm" + +

the units of the text size and position

ori + + +number + + + + + + + + + + + +

the orientation (in degrees)

height + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.1 + +

the height of the text

bold + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the text is bold

italic + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the text is italic

alignHoriz + + +string + + + + + + <optional>
+ + + + + + 		+ + 'center' + +

horizontal alignment

alignVert + + +string + + + + + + <optional>
+ + + + + + 		+ + 'center' + +

vertical alignment

wrapWidth + + +boolean + + + + + + + + + + + +

whether or not to wrap the text horizontally

flipHoriz + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip the text horizontally

flipVert + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to flip the text vertically

clipMask + + +PIXI.Graphics + + + + + + <optional>
+ + + + + + 		+ + null + +

the clip mask

autoDraw + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not the stimulus should be automatically drawn on every frame flip

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • VisualStim
    • +
+ + + + + + + + + + + + + + + +

Members

+ + + +

(protected, static, readonly) _defaultLetterHeightMap

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates units to default letter height.

+
+ + + + + + + + + + +

(protected, static, readonly) _defaultWrapWidthMap

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This map associates units to default wrap width.

+
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(protected) _estimateBoundingBox()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the bounding box.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getAnchor() → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert the alignment attributes into an anchor.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the anchor
    • +
+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

(protected) _getDefaultLetterHeight()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the default letter height given the stimulus' units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getDefaultWrapWidth()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the default wrap width given the stimulus' units.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _getTextStyle()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the PIXI Text Style applied to the PIXI.Text

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update the stimulus, if necessary.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) getBoundingBox(tightopt) → {Array.<number>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the bounding gox.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
tight + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to fit as closely as possible to the text

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the bounding box, in the units of this TextStim
    • +
+
+ + + +
+
+ Type +
+
+ +Array.<number> + + +
+
+ + + + + + + + + + +

getTextMetrics()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the metrics estimated for the text and style.

+

Note: getTextMetrics does not require the PIXI representation of the stimulus +to be instantiated, unlike getSize().

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

setColor(color, logopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setter for the color attribute.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
color + + +undefined +| + +null +| + +number + + + + + + + + + + + +

the color

log + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether of not to log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/TonePlayer.html b/docs/TonePlayer.html new file mode 100644 index 0000000..94dc9ce --- /dev/null +++ b/docs/TonePlayer.html @@ -0,0 +1,1657 @@ + + + + + + TonePlayer - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

TonePlayer

+ + + + + + + +
+ +
+ +

+ sound + + TonePlayer +

+ +

This class handles the playing of tones.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new TonePlayer(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

This class handles the playing of tones.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

duration_s + + +number + + + + + + <optional>
+ + + + + + 		+ + 0.5 + +

duration of the tone (in seconds). If duration_s == -1, the sound will play indefinitely.

note + + +string +| + +number + + + + + + <optional>
+ + + + + + 		+ + 'C4' + +

note (if string) or frequency (if number)

volume + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

volume of the tone (must be between 0 and 1.0)

loops + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

how many times to repeat the tone after it has played once. If loops == -1, the tone will repeat indefinitely until stopped.

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Members

+ + + +

(static) SoundLibrary :Object

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) accept(sound) → {Object|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether this player can play the given sound.

+

Note: if TonePlayer accepts the sound but Tone.js is not available, e.g. if the browser is IE11, +we throw an exception.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sound + + +module:sound.Sound + + + +

the sound

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

an instance of TonePlayer that can play the given sound or undefined otherwise

+
+ + + +
+
+ Type +
+
+ +Object +| + +undefined + + +
+
+ + + + + + + + + + +

(protected) _initSoundLibrary()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Initialise the sound library.

+

Note: if TonePlayer accepts the sound but Tone.js is not available, e.g. if the browser is IE11, +we throw an exception.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getDuration() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the duration of the sound.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the duration of the sound, in seconds

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

play(loopsopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
loops + + +boolean + + + + + + <optional>
+ + + + + +

how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

setDuration(duration_s)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the duration of the tone.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
duration_s + + +number + + + +

the duration of the tone (in seconds) If duration_s == -1, the sound will play indefinitely.

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLoops(loops)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the number of loops.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loops + + +number + + + +

how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

setVolume(volume, muteopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the volume of the tone.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
volume + + +Integer + + + + + + + + + + + +

the volume of the tone

mute + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to mute the tone

+ + + + + + + + + + + + + + + + + + + + + + + + +

stop()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop playing the sound immediately.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/TrackPlayer.html b/docs/TrackPlayer.html new file mode 100644 index 0000000..952f3d0 --- /dev/null +++ b/docs/TrackPlayer.html @@ -0,0 +1,1682 @@ + + + + + + TrackPlayer - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

TrackPlayer

+ + + + + + + +
+ +
+ +

+ sound + + TrackPlayer +

+ +

This class handles the playback of sound tracks.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new TrackPlayer(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
To Do:
+
+
    +
  • stopTime is currently not implemented (tracks will play from startTime to finish)
    • + +
  • stereo is currently not implemented
    • +
+
+ +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

howl + + +Object + + + + + + + + + + + +

the sound object (see https://howlerjs.com/)

startTime + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

start of playback (in seconds)

stopTime + + +number + + + + + + <optional>
+ + + + + + 		+ + -1 + +

end of playback (in seconds)

stereo + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to play the sound or track in stereo

volume + + +number + + + + + + <optional>
+ + + + + + 		+ + 1.0 + +

volume of the sound (must be between 0 and 1.0)

loops + + +number + + + + + + <optional>
+ + + + + + 		+ + 0 + +

how many times to repeat the track or tone after it has played

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(static) accept(sound) → {Object|undefined}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Determine whether this player can play the given sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sound + + +module:sound.Sound + + + +

the sound, which should be the name of an audio resource +file

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

an instance of TrackPlayer that can play the given track or undefined otherwise

+
+ + + +
+
+ Type +
+
+ +Object +| + +undefined + + +
+
+ + + + + + + + + + +

getDuration() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the duration of the sound, in seconds.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the duration of the track, in seconds

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

play(loops, fadeDurationopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Start playing the sound.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
loops + + +number + + + + + + + + + + + +

how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped.

fadeDuration + + +number + + + + + + <optional>
+ + + + + + 		+ + 17 + +

how long should the fading in last in ms

+ + + + + + + + + + + + + + + + + + + + + + + + +

setDuration(duration_s)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the duration of the track.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
duration_s + + +number + + + +

the duration of the track in seconds

+ + + + + + + + + + + + + + + + + + + + + + + + +

setLoops(loops)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the number of loops.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
loops + + +number + + + +

how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped.

+ + + + + + + + + + + + + + + + + + + + + + + + +

setVolume(volume, muteopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Set the volume of the tone.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
volume + + +Integer + + + + + + + + + + + +

the volume of the track (must be between 0 and 1.0)

mute + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to mute the track

+ + + + + + + + + + + + + + + + + + + + + + + + +

stop(fadeDurationopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Stop playing the sound immediately.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
fadeDuration + + +number + + + + + + <optional>
+ + + + + + 		+ + 17 + +

how long should the fading out last in ms

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/Transcript.html b/docs/Transcript.html new file mode 100644 index 0000000..b196e51 --- /dev/null +++ b/docs/Transcript.html @@ -0,0 +1,323 @@ + + + + + + Transcript - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Transcript

+ + + + + + + +
+ +
+ +

+ Transcript +

+ +

Transcript.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Transcript(transcriber, text, confidence)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Object holding a transcription result.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
transcriber + + +SpeechRecognition + + + + + +

the transcriber

text + + +string + + + + + +

the transcript

confidence + + +number + + + + + + 0 + +

confidence in the transcript

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +

Classes

+ +
+
Transcript
+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/Window.html b/docs/Window.html new file mode 100644 index 0000000..abbc7eb --- /dev/null +++ b/docs/Window.html @@ -0,0 +1,2327 @@ + + + + + + Window - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

Window

+ + + + + + + +
+ +
+ +

+ core + + Window +

+ +

Window displays the various stimuli of the experiment.

+

It sets up a PIXI renderer, which we use to render the experiment stimuli.

+ + +
+ +
+ +
+ + + + +

Constructor

+ + +

new Window(options)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
psychoJS + + +module:core.PsychoJS + + + + + + + + + + + +

the PsychoJS instance

name + + +string + + + + + + <optional>
+ + + + + + 		+ +

the name of the window

fullscr + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to go fullscreen

color + + +Color + + + + + + <optional>
+ + + + + + 		+ + Color('black') + +

the background color of the window

gamma + + +number + + + + + + <optional>
+ + + + + + 		+ + 1 + +

sets the divisor for gamma correction. In other words gamma correction is calculated as pow(rgb, 1/gamma)

contrast + + +number + + + + + + <optional>
+ + + + + + 		+ + 1 + +

sets the contrast value

units + + +string + + + + + + <optional>
+ + + + + + 		+ + 'pix' + +

the units of the window

waitBlanking + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + +

whether or not to wait for all rendering operations to be done +before flipping

autoLog + + +boolean + + + + + + <optional>
+ + + + + + 		+ + true + +

whether or not to log

+ +
+ + + + + + + + + + + + + + + + + + + + +
+ + + +

Extends

+ + + + +
    +
  • PsychObject
    • +
+ + + + + + + + + + + + + + + + + +

Methods

+ + + + + + +

(protected, static) _resizePixiRenderer(pjsWindow, event)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Adjust the size of the renderer and the position of the root container +in response to a change in the browser's size.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pjsWindow + + +module:core.Window + + + +

the PsychoJS Window

event + +
+ + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _fullRefresh()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Force an update of all stimuli in this window's drawlist.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _refresh()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Recompute this window's draw list and _container children for the next animation frame.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _setupPixi()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Setup PIXI.

+

A new renderer is created and a container is added to it. The renderer's touch and mouse events +are handled by the EventManager.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _updateIfNeeded()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Update this window, if need be.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

(protected) _writeLogOnFlip()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Send all logged messages to the Logger.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

addPixiObject()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add PIXI.DisplayObject to the container displayed on the scene (window)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

adjustScreenSize()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Take the browser full screen if possible.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

callOnFlip(flipCallback, …flipCallbackArgs)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add a callback function that will run after the next screen flip, i.e. immediately after the next rendering of the +Window.

+

This is typically used to reset a timer or clock.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
flipCallback + + +module:core.Window~OnFlipCallback + + + + + + + + + +

callback function.

flipCallbackArgs + + +* + + + + + + + + + + <repeatable>
+ +

arguments for the callback function.

+ + + + + + + + + + + + + + + + + + + + + + + + +

close()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Close the window.

+

Note: this actually only removes the canvas used to render the experiment stimuli.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

closeFullScreen()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Take the browser back from full screen if needed.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

getActualFrameRate() → {number}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Estimate the frame rate.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

rAF based delta time based approximation, 60.0 by default

+
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + +

logOnFlip(options, levelopt, objopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Log a message.

+

Note: the message will be time-stamped at the next call to requestAnimationFrame.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
options + + +Object + + + + + + + + + + + + +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
msg + + +String + + + +

the message to be logged

+ +
level + + +module:util.Logger.ServerLevel + + + + + + <optional>
+ + + + + + 		+ + module:util.Logger.ServerLevel.EXP + +

the log level

obj + + +Object + + + + + + <optional>
+ + + + + + 		+ +

the object associated with the message

+ + + + + + + + + + + + + + + + + + + + + + + + +

removePixiObject()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Remove PIXI.DisplayObject from the container displayed on the scene (window)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

render()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Render the stimuli onto the canvas.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:50 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/core_EventManager.js.html b/docs/core_EventManager.js.html index ee1a208..124bf9d 100644 --- a/docs/core_EventManager.js.html +++ b/docs/core_EventManager.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/EventManager.js - - - + core/EventManager.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/EventManager.js

+ + + + +
+ +

core/EventManager.js

+ @@ -30,8 +54,8 @@ * Manager handling the keyboard and mouse/touch events. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -39,16 +63,15 @@ import { Clock, MonotonicClock } from "../util/Clock.js"; import { PsychoJS } from "./PsychoJS.js"; /** - * @class * <p>This manager handles all participant interactions with the experiment, i.e. keyboard, mouse and touch events.</p> - * - * @name module:core.EventManager - * @class - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance */ export class EventManager { + /** + * @memberof module:core + * @param {Object} psychoJS + * @param {module:core.PsychoJS} psychoJS - the PsychoJS instance + */ constructor(psychoJS) { this._psychoJS = psychoJS; @@ -85,9 +108,6 @@ export class EventManager * * <p>Note: The w3c [key-event viewer]{@link https://w3c.github.io/uievents/tools/key-event-viewer.html} can be used to see possible values for the items in the keyList given the user's keyboard and chosen layout. The "key" and "code" columns in the UI Events fields are the relevant values for the keyList argument.</p> * - * @name module:core.EventManager#getKeys - * @function - * @public * @param {Object} options * @param {string[]} [options.keyList= null] - keyList allows the user to specify a set of keys to check for. Only keypresses from this set of keys will be removed from the keyboard buffer. If no keyList is given, all keys will be checked and the key buffer will be cleared completely. * @param {boolean} [options.timeStamped= false] - If true will return a list of tuples instead of a list of keynames. Each tuple has (keyname, time). @@ -165,9 +185,6 @@ export class EventManager /** * Get the mouse info. * - * @name module:core.EventManager#getMouseInfo - * @function - * @public * @return {EventManager.MouseInfo} the mouse info. */ getMouseInfo() @@ -178,10 +195,6 @@ export class EventManager /** * Clear all events from the event buffer. * - * @name module:core.EventManager#clearEvents - * @function - * @public - * * @todo handle the attribs argument */ clearEvents(attribs) @@ -191,10 +204,6 @@ export class EventManager /** * Clear all keys from the key buffer. - * - * @name module:core.EventManager#clearKeys - * @function - * @public */ clearKeys() { @@ -204,10 +213,6 @@ export class EventManager /** * Start the move clock. * - * @name module:core.EventManager#startMoveClock - * @function - * @public - * * @todo not implemented */ startMoveClock() @@ -217,10 +222,6 @@ export class EventManager /** * Stop the move clock. * - * @name module:core.EventManager#stopMoveClock - * @function - * @public - * * @todo not implemented */ stopMoveClock() @@ -230,10 +231,6 @@ export class EventManager /** * Reset the move clock. * - * @name module:core.EventManager#resetMoveClock - * @function - * @public - * * @todo not implemented */ resetMoveClock() @@ -243,9 +240,6 @@ export class EventManager /** * Add various mouse listeners to the Pixi renderer of the {@link Window}. * - * @name module:core.EventManager#addMouseListeners - * @function - * @public * @param {PIXI.Renderer} renderer - The Pixi renderer */ addMouseListeners(renderer) @@ -347,9 +341,7 @@ export class EventManager /** * Add key listeners to the document. * - * @name module:core.EventManager#_addKeyListeners - * @function - * @private + * @protected */ _addKeyListeners() { @@ -387,9 +379,6 @@ export class EventManager * Convert a keylist that uses pyglet key names to one that uses W3C KeyboardEvent.code values. * <p>This allows key lists that work in the builder environment to work in psychoJS web experiments.</p> * - * @name module:core.EventManager#pyglet2w3c - * @function - * @public * @param {Array.string} pygletKeyList - the array of pyglet key names * @return {Array.string} the w3c keyList */ @@ -414,10 +403,6 @@ export class EventManager /** * Convert a W3C Key Code into a pyglet key. * - * @name module:core.EventManager#w3c2pyglet - * @function - * @public - * @static * @param {string} code - W3C Key Code * @returns {string} corresponding pyglet key */ @@ -437,10 +422,6 @@ export class EventManager * Convert a keycode to a W3C UI Event code. * <p>This is for legacy browsers.</p> * - * @name module:core.EventManager#keycode2w3c - * @function - * @public - * @static * @param {number} keycode - the keycode * @returns {string} corresponding W3C UI Event code */ @@ -458,9 +439,8 @@ export class EventManager * <p>Unfortunately, it is not very fine-grained: for instance, there is no difference between Alt Left and Alt * Right, or between Enter and Numpad Enter. Use at your own risk (or upgrade your browser...).</p> * - * @name module:core.EventManager#_keycodeMap * @readonly - * @private + * @protected * @type {Object.<number,String>} */ EventManager._keycodeMap = { @@ -546,9 +526,8 @@ EventManager._keycodeMap = { * This map associates pyglet key names to the corresponding W3C KeyboardEvent codes values. * <p>More information can be found [here]{@link https://www.w3.org/TR/uievents-code}</p> * - * @name module:core.EventManager#_pygletMap * @readonly - * @private + * @protected * @type {Object.<String,String>} */ EventManager._pygletMap = { @@ -647,9 +626,8 @@ EventManager._pygletMap = { /** * <p>This map associates W3C KeyboardEvent.codes to the corresponding pyglet key names. * - * @name module:core.EventManager#_reversePygletMap * @readonly - * @private + * @protected * @type {Object.<String,String>} */ EventManager._reversePygletMap = {}; @@ -657,8 +635,6 @@ EventManager._reversePygletMap = {}; /** * Utility class used by the experiment scripts to keep track of a clock and of the current status (whether or not we are currently checking the keyboard) * - * @name module:core.BuilderKeyResponse - * @class * @param {Object} options * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance */ @@ -682,19 +658,23 @@ export class BuilderKeyResponse + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_GUI.js.html b/docs/core_GUI.js.html index 0b0cdbf..6d863b1 100644 --- a/docs/core_GUI.js.html +++ b/docs/core_GUI.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/GUI.js - - - + core/GUI.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/GUI.js

+ + + + +
+ +

core/GUI.js

+ @@ -31,8 +55,8 @@ * * @author Alain Pitiot * @author Sijia Zhao - fine-grained resource loading - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2021.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -43,22 +67,37 @@ import { Scheduler } from "../util/Scheduler.js"; import * as util from "../util/Util.js"; import { PsychoJS } from "./PsychoJS.js"; import { ServerManager } from "./ServerManager.js"; +import A11yDialog from "a11y-dialog"; /** - * @class - * Graphic User Interface - * - * @name module:core.GUI - * @class - * @param {module:core.PsychoJS} psychoJS the PsychoJS instance + * <p>GUI manages the various pop-up dialog boxes that guide the participant, throughout the + * lifecycle of the experiment, e.g. at the start while the resources are downloading, or at the + * end when the data is uploading to the server</p> */ export class GUI { + /** + * Default settings for GUI. + * + * @type {Object} + */ + static DEFAULT_SETTINGS = { + DlgFromDict: { + // The dialog box shows an OK button. The button becomes enable when all registered resources + // have been downloaded. Participants must click on the OK button to move on with the experiment. + requireParticipantClick: true + } + }; + get dialogComponent() { return this._dialogComponent; } + /** + * @memberof module:core + * @param {module:core.PsychoJS} psychoJS - the PsychoJS instance + */ constructor(psychoJS) { this._psychoJS = psychoJS; @@ -68,8 +107,6 @@ export class GUI { this._onResourceEvents(signal); }); - - this._dialogScalingFactor = 0; } /** @@ -86,37 +123,39 @@ export class GUI * <p>If the participant cancels (by pressing Cancel or by closing the dialog box), then * the dictionary remains unchanged.</p> * - * @name module:core.GUI#DlgFromDict - * @function - * @public * @param {Object} options * @param {String} [options.logoUrl] - Url of the experiment logo * @param {String} [options.text] - information text * @param {Object} options.dictionary - associative array of values for the participant to set * @param {String} options.title - name of the project + * @param {boolean} [options.requireParticipantClick=true] - whether the participant must click on the OK + * button, when it becomes enabled, to move on with the experiment */ DlgFromDict({ logoUrl, text, dictionary, title, + requireParticipantClick = GUI.DEFAULT_SETTINGS.DlgFromDict.requireParticipantClick }) { // get info from URL: const infoFromUrl = util.getUrlParameters(); - this._progressMsg = "&nbsp;"; this._progressBarMax = 0; this._allResourcesDownloaded = false; this._requiredKeys = []; this._setRequiredKeys = new Map(); + this._progressMessage = "&nbsp;"; + this._requireParticipantClick = requireParticipantClick; + this._dictionary = dictionary; - // prepare PsychoJS component: + // prepare a PsychoJS component: this._dialogComponent = {}; this._dialogComponent.status = PsychoJS.Status.NOT_STARTED; const dialogClock = new Clock(); - const self = this; + const self = this; return () => { const t = dialogClock.getTime(); @@ -128,38 +167,30 @@ export class GUI // if the experiment is licensed, and running on the license rather than on credit, // we use the license logo: - if ( - self._psychoJS.getEnvironment() === ExperimentHandler.Environment.SERVER + if (self._psychoJS.getEnvironment() === ExperimentHandler.Environment.SERVER && typeof self._psychoJS.config.experiment.license !== "undefined" && self._psychoJS.config.experiment.runMode === "LICENSE" - && typeof self._psychoJS.config.experiment.license.institutionLogo !== "undefined" - ) + && typeof self._psychoJS.config.experiment.license.institutionLogo !== "undefined") { logoUrl = self._psychoJS.config.experiment.license.institutionLogo; } - // prepare jquery UI dialog box: - let htmlCode = '<div id="expDialog" title="' + title + '">'; + // prepare the markup for the a11y-dialog: + let markup = "<div class='dialog-container' id='experiment-dialog' aria-hidden='true' role='alertdialog'>"; + markup += "<div class='dialog-overlay'></div>"; + // markup += "<div class='dialog-overlay' data-a11y-dialog-hide></div>"; + markup += "<div class='dialog-content'>"; - // uncomment for older version of the library: - // htmlCode += '<p style="font-size: 0.8em; padding: 0.5em; margin-bottom: 0.5em; color: #FFAA00; border: 1px solid #FFAA00;">&#9888; This experiment uses a deprecated version of the PsychoJS library. Consider updating to a newer version (e.g. by updating PsychoPy and re-exporting the experiment).</p>'+ + // alert title and close button: + markup += `<div id='experiment-dialog-title' class='dialog-title'><p>${title}</p><button id='dialogClose' class='dialog-close' data-a11y-dialog-hide aria-label='Cancel Experiment'>&times;</button></div>`; - // logo: + // logo, if need be: if (typeof logoUrl === "string") { - htmlCode += '<img id="dialog-logo" class="logo" alt="logo" src="' + logoUrl + '">'; - } - - // information text: - if (typeof text === "string" && text.length > 0) - { - htmlCode += "<p>" + text + "</p>"; + markup += '<img id="dialog-logo" class="logo" alt="logo" src="' + logoUrl + '">'; } // add a combobox or text areas for each entry in the dictionary: - - // These may include Symbols as opposed to when using a for...in loop, - // but only strings are allowed in PsychoPy Object.keys(dictionary).forEach((key, keyIdx) => { const value = dictionary[key]; @@ -180,7 +211,7 @@ export class GUI if (!inUrl) { - htmlCode += '<label for="' + keyId + '">' + key + "</label>"; + markup += `<label for='${keyId}'> ${key} </label>`; // if the field is required: if (key.slice(-1) === "*") @@ -191,45 +222,76 @@ export class GUI // if value is an array, we create a select drop-down menu: if (Array.isArray(value)) { - htmlCode += '<select name="' + key + '" id="' + keyId + '" class="text ui-widget-content' - + ' ui-corner-all">'; + markup += `<select name='${key}' id='${keyId}' class='text'>`; // if the field is required, we add an empty option and select it: if (key.slice(-1) === "*") { - htmlCode += "<option disabled selected>...</option>"; + markup += "<option disabled selected>...</option>"; } for (const option of value) { - htmlCode += "<option>" + option + "</option>"; + markup += `<option> ${option} </option>`; } - htmlCode += "</select>"; - jQuery("#" + keyId).selectmenu({ classes: {} }); + markup += "</select>"; } - // otherwise we use a single string input: - /*if (typeof value === 'string')*/ + // otherwise we use a single string input: + //if (typeof value === 'string') else { - htmlCode += '<input type="text" name="' + key + '" id="' + keyId; - htmlCode += '" value="' + value + '" class="text ui-widget-content ui-corner-all">'; + markup += `<input type='text' name='${key}' id='${keyId}' value='${value}' class='text'>`; } } }); - if (this._requiredKeys.length > 0) + if (self._requiredKeys.length > 0) { - htmlCode += '<p class="validateTips">Fields marked with an asterisk (*) are required.</p>'; + markup += "<p class='validateTips'>Fields marked with an asterisk (*) are required.</p>"; } - // add a progress bar: - htmlCode += '<hr><div id="progressMsg" class="progress">' + self._progressMsg + "</div>"; - htmlCode += '<div id="progressbar"></div></div>'; + // progress bar: + markup += `<hr><div id='progressMsg' class='progress-msg'>${self._progressMessage}</div>`; + markup += "<div class='progress-container'><div id='progressBar' class='progress-bar'></div></div>"; - // replace root by the html code: + // buttons: + markup += "<hr>"; + markup += "<button id='dialogCancel' class='dialog-button' aria-label='Cancel Experiment'>Cancel</button>"; + if (self._requireParticipantClick) + { + markup += "<button id='dialogOK' class='dialog-button disabled' aria-label='Start Experiment'>Ok</button>"; + } + + markup += "</div></div>"; + + // replace root by the markup code: const dialogElement = document.getElementById("root"); - dialogElement.innerHTML = htmlCode; + dialogElement.innerHTML = markup; + + // init and open the dialog box: + const dialogDiv = document.getElementById("experiment-dialog"); + self._dialog = new A11yDialog(dialogDiv); + self._dialog.show(); + + // button callbacks: + self._dialogComponent.button = "Cancel"; + self._cancelButton = document.getElementById("dialogCancel"); + self._cancelButton.onclick = self._onCancelExperiment.bind(self); + if (self._requireParticipantClick) + { + self._okButton = document.getElementById("dialogOK"); + self._okButton.onclick = self._onStartExperiment.bind(self); + } + self._closeButton = document.getElementById("dialogClose"); + self._closeButton.onclick = self._onCancelExperiment.bind(self); + + // update the OK button status: + self._updateDialog(); + + self._progressMsg = document.getElementById("progressMsg"); + self._progressBar = document.getElementById("progressBar"); + self._updateProgressBar(); // setup change event handlers for all required keys: this._requiredKeys.forEach((keyId) => @@ -240,79 +302,6 @@ export class GUI input.oninput = (event) => GUI._onKeyChange(self, event); } }); - - // init and open the dialog box: - self._dialogComponent.button = "Cancel"; - jQuery("#expDialog").dialog({ - width: "500", - - autoOpen: true, - modal: false, - closeOnEscape: false, - resizable: false, - draggable: false, - - buttons: [ - { - id: "buttonCancel", - text: "Cancel", - click: function() - { - self._dialogComponent.button = "Cancel"; - jQuery("#expDialog").dialog("close"); - }, - }, - { - id: "buttonOk", - text: "Ok", - click: function() - { - // update dictionary: - Object.keys(dictionary).forEach((key, keyIdx) => - { - const input = document.getElementById("form-input-" + keyIdx); - if (input) - { - dictionary[key] = input.value; - } - }); - - self._dialogComponent.button = "OK"; - jQuery("#expDialog").dialog("close"); - - // Tackle browser demands on having user action initiate audio context - Tone.start(); - - // switch to full screen if requested: - self._psychoJS.window.adjustScreenSize(); - - // Clear events (and keypresses) accumulated during the dialog - self._psychoJS.eventManager.clearEvents(); - }, - }, - ], - - // close is called by both buttons and when the user clicks on the cross: - close: function() - { - // jQuery.unblockUI(); - jQuery(this).dialog("destroy").remove(); - self._dialogComponent.status = PsychoJS.Status.FINISHED; - }, - }) - // change colour of title bar - .prev(".ui-dialog-titlebar").css("background", "green"); - - // update the OK button status: - self._updateOkButtonStatus(); - - // block UI until user has pressed dialog button: - // note: block UI does not allow for text to be entered in the dialog form boxes, alas! - // jQuery.blockUI({ message: "", baseZ: 1}); - - // show dialog box: - jQuery("#progressbar").progressbar({ value: self._progressBarCurrentValue }); - jQuery("#progressbar").progressbar("option", "max", self._progressBarMax); } if (self._dialogComponent.status === PsychoJS.Status.FINISHED) @@ -334,9 +323,6 @@ export class GUI * * <p>This function can be used to display both warning and error messages.</p> * - * @name module:core.GUI#dialog - * @function - * @public * @param {Object} options * @param {string} options.message - the message to be displayed * @param {Object.<string, *>} options.error - an exception @@ -349,14 +335,16 @@ export class GUI warning, error, showOK = true, - onOK, + onOK } = {}) { // close the previously opened dialog box, if there is one: this.closeDialog(); - let htmlCode; - let titleColour; + // prepare the markup for the a11y-dialog: + let markup = "<div class='dialog-container' id='experiment-dialog' aria-hidden='true' role='alertdialog'>"; + markup += "<div class='dialog-overlay'></div>"; + markup += "<div class='dialog-content'>"; // we are displaying an error: if (typeof error !== "undefined") @@ -369,9 +357,8 @@ export class GUI error = "Unspecified JavaScript error"; } - let errorCode = null; - // go through the error stack and look for errorCode if there is one: + let errorCode = null; let stackCode = "<ul>"; while (true) { @@ -403,101 +390,206 @@ export class GUI if (errorCode) { const error = this._userFriendlyError(errorCode); - htmlCode = error.htmlCode; - titleColour = error.titleColour; + markup += `<div id='experiment-dialog-title' class='dialog-title ${error.class}'><p>${error.title}</p></div>`; + markup += `<p>${error.text}</p>`; } else { - htmlCode = '<div id="msgDialog" title="Error">'; - htmlCode += '<p class="validateTips">Unfortunately we encountered the following error:</p>'; - htmlCode += stackCode; - htmlCode += "<p>Try to run the experiment again. If the error persists, contact the experiment designer.</p>"; - htmlCode += "</div>"; - - titleColour = "red"; + markup += `<div id='experiment-dialog-title' class='dialog-title dialog-error'><p>Error</p></div>`; + markup += `<p>Unfortunately we encountered the following error:</p>`; + markup += stackCode; + markup += "<p>Try to run the experiment again. If the error persists, contact the experiment designer.</p>"; } } - // we are displaying a message: - else if (typeof message !== "undefined") - { - htmlCode = '<div id="msgDialog" title="Message">' - + '<p class="validateTips">' + message + "</p>" - + "</div>"; - titleColour = "green"; - } + // we are displaying a warning: else if (typeof warning !== "undefined") { - htmlCode = '<div id="msgDialog" title="Warning">' - + '<p class="validateTips">' + warning + "</p>" - + "</div>"; - titleColour = "orange"; + markup += `<div id='experiment-dialog-title' class='dialog-title dialog-warning'><p>Warning</p></div>`; + markup += `<p>${warning}</p>`; } - // replace root by the html code: + // we are displaying a message: + else if (typeof message !== "undefined") + { + markup += `<div id='experiment-dialog-title' class='dialog-title'><p>Message</p></div>`; + markup += `<p>${message}</p>`; + } + + if (showOK) + { + markup += "<hr><button id='dialogOK' class='dialog-button' aria-label='Close dialog'>Ok</button>"; + } + markup += "</div></div>"; + + // replace root by the markup code: const dialogElement = document.getElementById("root"); - dialogElement.innerHTML = htmlCode; + dialogElement.innerHTML = markup; // init and open the dialog box: - const self = this; - jQuery("#msgDialog").dialog({ - dialogClass: "no-close", + const dialogDiv = document.getElementById("experiment-dialog"); + this._dialog = new A11yDialog(dialogDiv); + this._dialog.show(); - width: "500", + // button callbacks: + if (showOK) + { + this._okButton = document.getElementById("dialogOK"); + this._okButton.onclick = () => + { + this.closeDialog(); - autoOpen: true, - modal: false, - closeOnEscape: false, - resizable: false, - draggable: false, - - buttons: (!showOK) ? [] : [{ - id: "buttonOk", - text: "Ok", - click: function() + // execute callback function: + if (typeof onOK !== "undefined") { - jQuery(this).dialog("destroy").remove(); + onOK(); + } + }; + } + } - // execute callback function: - if (typeof onOK !== "undefined") - { - onOK(); - } - }, - }], - }) - // change colour of title bar - .prev(".ui-dialog-titlebar").css("background", titleColour); + /** + * <p>Create a dialog box with a progress bar, to inform the participant of + * the last stages of the experiment: upload of results, of log, and closing + * of session.</p> + * + * @param {Object} options + * @param {String} [options.text] - information text + */ + finishDialog({ text = "", nbSteps = 0 }) + { + this.closeDialog(); + + // prepare the markup for the a11y-dialog: + let markup = "<div class='dialog-container' id='experiment-dialog' aria-hidden='true' role='alertdialog'>"; + markup += "<div class='dialog-overlay'></div>"; + markup += "<div class='dialog-content'>"; + markup += `<div id='experiment-dialog-title' class='dialog-title dialog-warning'><p>Warning</p></div>`; + markup += `<p>${text}</p>`; + + // progress bar: + markup += `<hr><div id='progressMsg' class='progress-msg'>&nbsp;</div>`; + markup += "<div class='progress-container'><div id='progressBar' class='progress-bar'></div></div>"; + + markup += "</div></div>"; + + // replace root by the markup code: + const dialogElement = document.getElementById("root"); + dialogElement.innerHTML = markup; + + // init and open the dialog box: + const dialogDiv = document.getElementById("experiment-dialog"); + this._dialog = new A11yDialog(dialogDiv); + this._dialog.show(); + + this._progressMsg = document.getElementById("progressMsg"); + this._progressBar = document.getElementById("progressBar"); + + this._progressMessage = "&nbsp;"; + this._progressBarCurrentValue = 0; + this._progressBarMax = nbSteps; + this._updateProgressBar(); + } + + finishDialogNextStep(text) + { + this._setProgressMessage(text); + ++ this._progressBarCurrentValue; + this._updateProgressBar(); } /** * Close the previously opened dialog box, if there is one. - * - * @name module:core.GUI#closeDialog - * @function - * @public */ closeDialog() { - const expDialog = jQuery("#expDialog"); - if (expDialog.length) + if (this._dialog) { - expDialog.dialog("destroy").remove(); - } - const msgDialog = jQuery("#msgDialog"); - if (msgDialog.length) - { - msgDialog.dialog("destroy").remove(); + this._dialog.hide(); } } /** - * Listener for resource event from the [Server Manager]{@link ServerManager}. + * Set the progress message. * - * @name module:core.GUI#_onResourceEvents - * @function - * @private - * @param {Object.<string, string|Symbol>} signal the signal + * @protected + * @param {string} message the message + */ + _setProgressMessage(message) + { + this._progressMessage = message; + if (typeof this._progressMsg !== "undefined") + { + this._progressMsg.innerText = message; + } + } + + /** + * Update the progress bar. + * + * @protected + */ + _updateProgressBar() + { + if (typeof this._progressBar !== "undefined") + { + this._progressBar.style.width = `${Math.round(this._progressBarCurrentValue * 100.0 / this._progressBarMax)}%`; + } + } + + /** + * Callback triggered when the participant presses the Cancel button + * + * @protected + */ + _onCancelExperiment() + { + this._dialogComponent.button = "Cancel"; + + this._dialog.hide(); + this._dialog = null; + this._dialogComponent.status = PsychoJS.Status.FINISHED; + } + + /** + * Callback triggered when the participant presses the OK button + * + * @protected + */ + _onStartExperiment() + { + this._dialogComponent.button = "OK"; + + // update the dictionary: + Object.keys(this._dictionary).forEach((key, keyIdx) => + { + const input = document.getElementById("form-input-" + keyIdx); + if (input) + { + this._dictionary[key] = input.value; + } + }); + + + // Start Tone here, since a user action is required to initiate the audio context: + Tone.start(); + + // switch to full screen if requested: + this._psychoJS.window.adjustScreenSize(); + + // clear all events (and keypresses) accumulated until now: + this._psychoJS.eventManager.clearEvents(); + + this._dialog.hide(); + this._dialog = null; + this._dialogComponent.status = PsychoJS.Status.FINISHED; + } + + /** + * Callback triggered upon a resource event from the [Server Manager]{@link module:core.ServerManager}. + * + * @protected + * @param {Object.<string, string|Symbol>} signal - the ServerManager's signal */ _onResourceEvents(signal) { @@ -508,16 +600,19 @@ export class GUI { // for each resource, we have a 'downloading resource' and a 'resource downloaded' message: this._progressBarMax = signal.count * 2; - jQuery("#progressbar").progressbar("option", "max", this._progressBarMax); - this._progressBarCurrentValue = 0; + this._updateProgressBar(); } // all the resources have been downloaded: show the ok button else if (signal.message === ServerManager.Event.DOWNLOAD_COMPLETED) { this._allResourcesDownloaded = true; - jQuery("#progressMsg").text("all resources downloaded."); - this._updateOkButtonStatus(); + this._progressBarMax = 100; + this._progressBarCurrentValue = 100; + this._updateProgressBar(); + this._setProgressMessage("all resources downloaded."); + + this._updateDialog(); } // update progress bar: else if ( @@ -533,68 +628,75 @@ export class GUI if (signal.message === ServerManager.Event.RESOURCE_DOWNLOADED) { - jQuery("#progressMsg").text("downloaded " + (this._progressBarCurrentValue / 2) + " / " + (this._progressBarMax / 2)); + this._setProgressMessage(`downloaded ${this._progressBarCurrentValue / 2} / ${this._progressBarMax / 2}`); } else { - jQuery("#progressMsg").text("downloading " + (this._progressBarCurrentValue / 2) + " / " + (this._progressBarMax / 2)); + this._setProgressMessage(`downloading ${this._progressBarCurrentValue / 2} / ${this._progressBarMax / 2}`); } - // $("#progressMsg").text(signal.resource + ': downloaded.'); - jQuery("#progressbar").progressbar("option", "value", this._progressBarCurrentValue); + + this._updateProgressBar(); } // unknown message: we just display it else { - jQuery("#progressMsg").text(signal.message); + this._progressMsg.innerHTML = signal.message; } } /** - * Update the status of the OK button. + * Update the dialog box. * - * @name module:core.GUI#_updateOkButtonStatus - * @param [changeFocus = false] - whether or not to change the focus to the OK button - * @function - * @private + * @protected + * @param [changeOKButtonFocus = false] - whether to change the focus to the OK button */ - _updateOkButtonStatus(changeFocus = true) + _updateDialog(changeOKButtonFocus = true) { - if ( - (this._psychoJS.getEnvironment() === ExperimentHandler.Environment.LOCAL) - || (this._allResourcesDownloaded && this._setRequiredKeys && this._setRequiredKeys.size >= this._requiredKeys.length) - ) + const allRequirementsFulfilled = this._allResourcesDownloaded + && (this._setRequiredKeys && this._setRequiredKeys.size >= this._requiredKeys.length); + + // if the participant is required to click on the OK button: + if (this._requireParticipantClick) { - if (changeFocus) + if (typeof this._okButton !== "undefined") { - jQuery("#buttonOk").button("option", "disabled", false).focus(); + // locally the OK button is always enabled, otherwise only if all requirements have been fulfilled: + if (this._psychoJS.getEnvironment() === ExperimentHandler.Environment.LOCAL || allRequirementsFulfilled) + { + if (changeOKButtonFocus) + { + this._okButton.classList = ["dialog-button"]; + this._okButton.focus(); + } + else + { + this._okButton.classList = ["dialog-button"]; + } + } + else + { + this._okButton.classList = ["dialog-button", "disabled"]; + } } - else - { - jQuery("#buttonOk").button("option", "disabled", false); - } - } - else - { - jQuery("#buttonOk").button("option", "disabled", true); + + return; } - // strangely, changing the disabled option sometimes fails to update the ui, - // so we need to hide it and show it again: - jQuery("#buttonOk").hide(0, () => + + // if all requirements are fulfilled and the participant is not required to click on the OK button, + // then we close the dialog box and move on with the experiment: + if (allRequirementsFulfilled) { - jQuery("#buttonOk").show(); - }); + this._onStartExperiment(); + } } /** - * Listener for change event for required keys. + * Callback triggered upon change event (for required keys). * - * @name module:core.GUI#_onKeyChange - * @function - * @static - * @private + * @protected * @param {module:core.GUI} gui - this GUI - * @param {Event} event - event + * @param {Event} event - the key's event */ static _onKeyChange(gui, event) { @@ -610,15 +712,15 @@ export class GUI gui._setRequiredKeys.delete(event.target); } - gui._updateOkButtonStatus(false); + gui._updateDialog(false); } /** - * Get a more user-friendly html message. + * Get the user-friendly html message associated to a pavlovia.or server error code. * + * @protected * @param {number} errorCode - the pavlovia.org server error code - * @private - * @return {{htmlCode: string, titleColour: string}} a user-friendly error message + * @return {{class: string, title: string, text: string}} a user-friendly error message */ _userFriendlyError(errorCode) { @@ -627,130 +729,101 @@ export class GUI // INTERNAL_ERROR case 1: return { - htmlCode: - '<div id="msgDialog" title="Error"><p>Oops we encountered an internal server error.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p></div>', - titleColour: "red", + class: "dialog-error", + title: "Error", + text: "<p>Oops we encountered an <strong>internal server error</strong>.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p>" }; // MONGODB_ERROR - case 2: return { - htmlCode: - '<div id="msgDialog" title="Error"><p>Oops we encountered a database error.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p></div>', - titleColour: "red", + class: "dialog-error", + title: "Error", + text: "<p>Oops we encountered a <strong>database error</strong>.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p>" }; // STATUS_NONE - case 20: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> does not have any status and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the status must be changed to RUNNING for participants to be able to run it.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> does not have any status and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the status must be changed to RUNNING for participants to be able to run it.</p>` }; // STATUS_INACTIVE - case 21: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is currently inactive and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the status must be changed to RUNNING for participants to be able to run it.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is currently inactive and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the status must be changed to RUNNING for participants to be able to run it.</p>` }; // STATUS_DELETED - case 22: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> has been deleted and cannot be run.</p><p>If you are the experiment designer, either go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING, or generate a new experiment.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment has been deleted and cannot be run any longer.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> has been deleted and cannot be run.</p><p>If you are the experiment designer, either go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING, or generate a new experiment.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment has been deleted and cannot be run any longer.</p>` }; // STATUS_ARCHIVED - case 23: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> has been archived and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment has been archived and cannot be run at the moment.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> has been archived and cannot be run.</p><p>If you are the experiment designer, go to your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a> and change the experiment status to either PILOTING or RUNNING.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment has been archived and cannot be run at the moment.</p>` }; // PILOTING_NO_TOKEN - case 30: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is currently in PILOTING mode but the pilot token is missing from the URL.</p><p>If you are the experiment designer, you can pilot it by pressing the pilot button on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment status must be changed to RUNNING for participants to be able to run it.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is currently in PILOTING mode but the pilot token is missing from the URL.</p><p>If you are the experiment designer, you can pilot it by pressing the pilot button on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment status must be changed to RUNNING for participants to be able to run it.</p>` }; // PILOTING_INVALID_TOKEN - case 31: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> cannot be run because the pilot token in the URL is invalid, possibly because it has expired.</p><p>If you are the experiment designer, you can generate a new token by pressing the pilot button on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment status must be changed to RUNNING for participants to be able to run it.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> cannot be run because the pilot token in the URL is invalid, possibly because it has expired.</p><p>If you are the experiment designer, you can generate a new token by pressing the pilot button on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment status must be changed to RUNNING for participants to be able to run it.</p>` }; // LICENSE_EXPIRED - case 50: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is covered by a license that has expired. </p><p>If you are the experiment designer, you can either contact the license manager to inquire about the expiration, or you can run your experiments using credits. You will find all relevant details about the license on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>, where you will also be able to change its running mode to CREDIT.</p><p>Otherwise please contact the experiment designer to let him or her know that there is an issue with the experiment's license having expired.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is covered by a license that has expired. </p><p>If you are the experiment designer, you can either contact the license manager to inquire about the expiration, or you can run your experiments using credits. You will find all relevant details about the license on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>, where you will also be able to change its running mode to CREDIT.</p><p>Otherwise please contact the experiment designer to let him or her know that there is an issue with the experiment's license having expired.</p>` }; // LICENSE_APPROVAL_NEEDED - case 51: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is covered by a license that requires one or more documents to be approved before the experiment can be run. </p><p>If you are the experiment designer, please contact the license manager and ask him or her which documents must be approved. You will find all relevant details about the license on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that there is an issue with the experiment's license requiring documents to be approved.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> is covered by a license that requires one or more documents to be approved before the experiment can be run. </p><p>If you are the experiment designer, please contact the license manager and ask him or her which documents must be approved. You will find all relevant details about the license on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that there is an issue with the experiment's license requiring documents to be approved.</p>` }; // CREDIT_NOT_ENOUGH - case 60: return { - htmlCode: - `<div id="msgDialog" title="Warning"><p><strong>${this._psychoJS.config.experiment.fullpath}</strong> does not have any assigned credit left and cannot be run.</p><p>If you are the experiment designer, you can assign more credits to it on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment requires more assigned credits to run.</p></div>`, - titleColour: "orange", + class: "dialog-warning", + title: "Warning", + text: `<p><strong>${this._psychoJS.config.experiment.fullpath}</strong> does not have any assigned credit left and cannot be run.</p><p>If you are the experiment designer, you can assign more credits to it on your <a href="https://pavlovia.org/${this._psychoJS.config.experiment.fullpath}">experiment page</a>.</p><p>Otherwise please contact the experiment designer to let him or her know that the experiment requires more assigned credits to run.</p>` }; default: return { - htmlCode: - `<div id="msgDialog" title="Error"><p>Unfortunately we encountered an unspecified error (error code: ${errorCode}.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p></div>`, - titleColour: "red", + class: "dialog-error", + title: "Error", + text: `<p>Unfortunately we encountered an unspecified error (error code: ${errorCode}.</p><p>Try to run the experiment again. If the error persists, contact the experiment designer.</p>` }; } } } -/** - * Maximal dimensions of the dialog window. - * - * @name module:core.GUI#dialogMaxSize - * @enum {Symbol} - * @readonly - * @public - */ -GUI.dialogMaxSize = [500, 600]; - -/** - * Dialog window margins. - * - * @name module:core.GUI#dialogMargin - * @enum {Symbol} - * @readonly - * @public - */ -GUI.dialogMargin = [50, 50];
@@ -758,19 +831,23 @@ GUI.dialogMargin = [50, 50]; + +
- -
- - + + + + + + + + diff --git a/docs/core_Keyboard.js.html b/docs/core_Keyboard.js.html index 9ccb9b1..0b59d26 100644 --- a/docs/core_Keyboard.js.html +++ b/docs/core_Keyboard.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/Keyboard.js - - - + core/Keyboard.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/Keyboard.js

+ + + + +
+ +

core/Keyboard.js

+ @@ -30,8 +54,8 @@ * Manager handling the keyboard events. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -41,15 +65,16 @@ import { EventManager } from "./EventManager.js"; import { PsychoJS } from "./PsychoJS.js"; /** - * @name module:core.KeyPress - * @class - * - * @param {string} code - W3C Key Code - * @param {number} tDown - time of key press (keydown event) relative to the global Monotonic Clock - * @param {string | undefined} name - pyglet key name + * <pKeyPress holds information about a key that has been pressed, such as the duration of the press.</p> */ export class KeyPress { + /** + * @memberof module:core + * @param {string} code - W3C Key Code + * @param {number} tDown - time of key press (keydown event) relative to the global Monotonic Clock + * @param {string | undefined} name - pyglet key name + */ constructor(code, tDown, name) { this.code = code; @@ -67,18 +92,20 @@ export class KeyPress /** * <p>This manager handles all keyboard events. It is a substitute for the keyboard component of EventManager. </p> * - * @name module:core.Keyboard - * @class - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {number} [options.bufferSize= 10000] - the maximum size of the circular keyboard event buffer - * @param {boolean} [options.waitForStart= false] - whether or not to wait for a call to module:core.Keyboard#start - * before recording keyboard events - * @param {Clock} [options.clock= undefined] - an optional clock - * @param {boolean} [options.autoLog= false] - whether or not to log + * @extends PsychObject */ export class Keyboard extends PsychObject { + /** + * @memberof module:core + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {number} [options.bufferSize= 10000] - the maximum size of the circular keyboard event buffer + * @param {boolean} [options.waitForStart= false] - whether or not to wait for a call to module:core.Keyboard#start + * before recording keyboard events + * @param {Clock} [options.clock= undefined] - an optional clock + * @param {boolean} [options.autoLog= false] - whether or not to log + */ constructor({ psychoJS, bufferSize = 10000, @@ -110,11 +137,6 @@ export class Keyboard extends PsychObject /** * Start recording keyboard events. - * - * @name module:core.Keyboard#start - * @function - * @public - * */ start() { @@ -123,11 +145,6 @@ export class Keyboard extends PsychObject /** * Stop recording keyboard events. - * - * @name module:core.Keyboard#stop - * @function - * @public - * */ stop() { @@ -147,9 +164,6 @@ export class Keyboard extends PsychObject * Get the list of those keyboard events still in the buffer, i.e. those that have not been * previously cleared by calls to getKeys with clear = true. * - * @name module:core.Keyboard#getEvents - * @function - * @public * @return {Keyboard.KeyEvent[]} the list of events still in the buffer */ getEvents() @@ -179,9 +193,6 @@ export class Keyboard extends PsychObject /** * Get the list of keys pressed or pushed by the participant. * - * @name module:core.Keyboard#getKeys - * @function - * @public * @param {Object} options * @param {string[]} [options.keyList= []]] - the list of keys to consider. If keyList is empty, we consider all keys. * Note that we use pyglet keys here, to make the PsychoJs code more homogeneous with PsychoPy. @@ -328,9 +339,6 @@ export class Keyboard extends PsychObject /** * Clear all events and resets the circular buffers. - * - * @name module:core.Keyboard#clearEvents - * @function */ clearEvents() { @@ -347,9 +355,6 @@ export class Keyboard extends PsychObject /** * Test whether a list of KeyPress's contains one with a particular name. * - * @name module:core.Keyboard#includes - * @function - * @static * @param {module:core.KeyPress[]} keypressList - list of KeyPress's * @param {string } keyName - pyglet key name, e.g. 'escape', 'left' * @return {boolean} whether or not a KeyPress with the given pyglet key name is present in the list @@ -368,9 +373,7 @@ export class Keyboard extends PsychObject /** * Add key listeners to the document. * - * @name module:core.Keyboard#_addKeyListeners - * @function - * @private + * @protected */ _addKeyListeners() { @@ -483,10 +486,8 @@ export class Keyboard extends PsychObject /** * Keyboard KeyStatus. * - * @name module:core.Keyboard#KeyStatus * @enum {Symbol} * @readonly - * @public */ Keyboard.KeyStatus = { KEY_DOWN: Symbol.for("KEY_DOWN"), @@ -499,19 +500,23 @@ Keyboard.KeyStatus = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_Logger.js.html b/docs/core_Logger.js.html index a0647e6..e4989fd 100644 --- a/docs/core_Logger.js.html +++ b/docs/core_Logger.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/Logger.js - - - + core/Logger.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/Logger.js

+ + + + +
+ +

core/Logger.js

+ @@ -30,8 +54,8 @@ * Logger * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -46,13 +70,14 @@ import * as util from "../util/Util.js"; * a remote one, etc.</p> * * <p>Note: we use log4javascript for the console logger, and our own for the server logger.</p> - * - * @name module:core.Logger - * @class - * @param {*} threshold - the logging threshold, e.g. log4javascript.Level.ERROR */ export class Logger { + /** + * @memberof module:core + * @param {module:core.PsychoJS} psychoJS - the PsychoJS instance + * @param {*} threshold - the logging threshold, e.g. log4javascript.Level.ERROR + */ constructor(psychoJS, threshold) { this._psychoJS = psychoJS; @@ -97,8 +122,6 @@ export class Logger /** * Change the logging level. * - * @name module:core.Logger#setLevel - * @public * @param {module:core.Logger.ServerLevel} serverLevel - the new logging level */ setLevel(serverLevel) @@ -110,8 +133,6 @@ export class Logger /** * Log a server message at the EXP level. * - * @name module:core.Logger#exp - * @public * @param {string} msg - the message to be logged. * @param {number} [time] - the logging time * @param {object} [obj] - the associated object (e.g. a Trial) @@ -124,8 +145,6 @@ export class Logger /** * Log a server message at the DATA level. * - * @name module:core.Logger#data - * @public * @param {string} msg - the message to be logged. * @param {number} [time] - the logging time * @param {object} [obj] - the associated object (e.g. a Trial) @@ -138,8 +157,6 @@ export class Logger /** * Log a server message. * - * @name module:core.Logger#log - * @public * @param {string} msg - the message to be logged. * @param {module:core.Logger.ServerLevel} level - logging level * @param {number} [time] - the logging time @@ -178,9 +195,7 @@ export class Logger /** * Check whether or not a log messages must be throttled. * - * @name module:core.Logger#_throttle * @protected - * * @param {number} time - the time of the latest log message * @return {boolean} whether or not to log the message */ @@ -256,9 +271,6 @@ export class Logger * * <p>Note: the logs are compressed using Pako's zlib algorithm. * See https://github.com/nodeca/pako for details.</p> - * - * @name module:core.Logger#flush - * @public */ async flush() { @@ -324,8 +336,7 @@ export class Logger /** * Create a custom console layout. * - * @name module:core.Logger#_customConsoleLayout - * @private + * @protected * @return {*} the custom layout */ _customConsoleLayout() @@ -396,7 +407,6 @@ export class Logger /** * Get the integer value associated with a logging level. * - * @name module:core.Logger#_getValue * @protected * @param {module:core.Logger.ServerLevel} level - the logging level * @return {number} - the value associated with the logging level, or 30 is the logging level is unknown. @@ -411,10 +421,8 @@ export class Logger /** * Server logging level. * - * @name module:core.Logger#ServerLevel * @enum {Symbol} * @readonly - * @public * * @note These are similar to PsychoPy's logging levels, as defined in logging.py */ @@ -434,7 +442,6 @@ Logger.ServerLevel = { * * <p>We use those values to determine whether a log is to be sent to the server or not.</p> * - * @name module:core.Logger#_ServerLevelValue * @enum {number} * @readonly * @protected @@ -456,19 +463,23 @@ Logger._ServerLevelValue = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_MinimalStim.js.html b/docs/core_MinimalStim.js.html index 7cacab3..cd401da 100644 --- a/docs/core_MinimalStim.js.html +++ b/docs/core_MinimalStim.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/MinimalStim.js - - - + core/MinimalStim.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/MinimalStim.js

+ + + + +
+ +

core/MinimalStim.js

+ @@ -30,8 +54,8 @@ * Base class for all stimuli. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.0 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -42,17 +66,18 @@ import { PsychoJS } from "./PsychoJS.js"; /** * <p>MinimalStim is the base class for all stimuli.</p> * - * @name module:core.MinimalStim - * @class * @extends PsychObject - * @param {Object} options - * @param {String} options.name - the name used when logging messages from this stimulus - * @param {module:core.Window} options.win - the associated Window - * @param {boolean} [options.autoDraw= false] - whether or not the stimulus should be automatically drawn on every frame flip - * @param {boolean} [options.autoLog= win.autoLog] - whether or not to log */ export class MinimalStim extends PsychObject { + /** + * @memberof module:core + * @param {Object} options + * @param {String} options.name - the name used when logging messages from this stimulus + * @param {module:core.Window} options.win - the associated Window + * @param {boolean} [options.autoDraw= false] - whether or not the stimulus should be automatically drawn on every frame flip + * @param {boolean} [options.autoLog= win.autoLog] - whether to log + */ constructor({ name, win, autoDraw, autoLog } = {}) { super(win._psychoJS, name); @@ -83,11 +108,8 @@ export class MinimalStim extends PsychObject /** * Setter for the autoDraw attribute. * - * @name module:core.MinimalStim#setAutoDraw - * @function - * @public * @param {boolean} autoDraw - the new value - * @param {boolean} [log= false] - whether or not to log + * @param {boolean} [log= false] - whether to log */ setAutoDraw(autoDraw, log = false) { @@ -107,10 +129,6 @@ export class MinimalStim extends PsychObject /** * Draw this stimulus on the next frame draw. - * - * @name module:core.MinimalStim#draw - * @function - * @public */ draw() { @@ -151,10 +169,6 @@ export class MinimalStim extends PsychObject /** * Hide this stimulus on the next frame draw. - * - * @name module:core.MinimalStim#hide - * @function - * @public */ hide() { @@ -178,10 +192,7 @@ export class MinimalStim extends PsychObject /** * Determine whether an object is inside this stimulus. * - * @name module:core.MinimalStim#contains - * @function * @abstract - * @public * @param {Object} object - the object * @param {String} units - the stimulus units */ @@ -197,11 +208,7 @@ export class MinimalStim extends PsychObject /** * Release the PIXI representation, if there is one. * - * @name module:core.MinimalStim#release - * @function - * @public - * - * @param {boolean} [log= false] - whether or not to log + * @param {boolean} [log= false] - whether to log */ release(log = false) { @@ -220,10 +227,8 @@ export class MinimalStim extends PsychObject * * Note: this is an abstract function, which should not be called. * - * @name module:core.MinimalStim#_updateIfNeeded - * @function * @abstract - * @private + * @protected */ _updateIfNeeded() { @@ -241,19 +246,23 @@ export class MinimalStim extends PsychObject + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_Mouse.js.html b/docs/core_Mouse.js.html index ae96891..b5a8362 100644 --- a/docs/core_Mouse.js.html +++ b/docs/core_Mouse.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/Mouse.js - - - + core/Mouse.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/Mouse.js

+ + + + +
+ +

core/Mouse.js

+ @@ -31,8 +55,8 @@ * * @author Alain Pitiot * @author Sotiri Bakagiannis - isPressedIn - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -44,18 +68,17 @@ import { PsychoJS } from "./PsychoJS.js"; * <p>This manager handles the interactions between the experiment's stimuli and the mouse.</p> * <p>Note: the unit of Mouse is that of its associated Window.</p> * - * @name module:core.Mouse - * @class - * @extends PsychObject - * @param {Object} options - * @param {String} options.name - the name used when logging messages from this stimulus - * @param {Window} options.win - the associated Window - * @param {boolean} [options.autoLog= true] - whether or not to log - * * @todo visible is not handled at the moment (mouse is always visible) */ export class Mouse extends PsychObject { + /** + * @memberof module:core + * @param {Object} options + * @param {String} options.name - the name used when logging messages from this stimulus + * @param {Window} options.win - the associated Window + * @param {boolean} [options.autoLog= true] - whether or not to log + */ constructor({ name, win, @@ -82,9 +105,6 @@ export class Mouse extends PsychObject /** * Get the current position of the mouse in mouse/Window units. * - * @name module:core.Mouse#getPos - * @function - * @public * @return {Array.number} the position of the mouse in mouse/Window units */ getPos() @@ -107,9 +127,6 @@ export class Mouse extends PsychObject * Get the position of the mouse relative to that at the last call to getRel * or getPos, in mouse/Window units. * - * @name module:core.Mouse#getRel - * @function - * @public * @return {Array.number} the relation position of the mouse in mouse/Window units. */ getRel() @@ -133,9 +150,6 @@ export class Mouse extends PsychObject * <p>Note: Even though this method returns a [x, y] array, for most wheels/systems y is the only * value that varies.</p> * - * @name module:core.Mouse#getWheelRel - * @function - * @public * @return {Array.number} the mouse scroll wheel travel */ getWheelRel() @@ -155,9 +169,6 @@ export class Mouse extends PsychObject * * <p>Note: clickReset is typically called at stimulus onset. When the participant presses a button, the time elapsed since the clickReset is stored internally and can be accessed any time afterwards with getPressed.</p> * - * @name module:core.Mouse#getPressed - * @function - * @public * @param {boolean} [getTime= false] whether or not to also return timestamps * @return {Array.number | Array.<Array.number>} either an array of size 3 with the status (1 for pressed, 0 for released) of each mouse button [left, center, right], or a tuple with that array and another array of size 3 with the timestamps. */ @@ -178,9 +189,6 @@ export class Mouse extends PsychObject /** * Helper method for checking whether a stimulus has had any button presses within bounds. * - * @name module:core.Mouse#isPressedIn - * @function - * @public * @param {object|module:visual.VisualStim} shape A type of visual stimulus or object having a `contains()` method. * @param {object|number} [buttons] The target button index potentially tucked inside an object. * @param {object} [options] @@ -250,9 +258,6 @@ export class Mouse extends PsychObject * <li>mouseMoved(distance, [x: number, y: number]: artifically set the previous mouse position to the given coordinates and determine whether the mouse moved further than the given distance</li> * </ul></p> * - * @name module:core.Mouse#mouseMoved - * @function - * @public * @param {undefined|number|Array.number} [distance] - the distance to which the mouse movement is compared (see above for a full description) * @param {boolean|String|Array.number} [reset= false] - see above for a full description * @return {boolean} see above for a full description @@ -347,9 +352,6 @@ export class Mouse extends PsychObject /** * Get the amount of time elapsed since the last mouse movement. * - * @name module:core.Mouse#mouseMoveTime - * @function - * @public * @return {number} the time elapsed since the last mouse movement */ mouseMoveTime() @@ -360,9 +362,6 @@ export class Mouse extends PsychObject /** * Reset the clocks associated to the given mouse buttons. * - * @name module:core.Mouse#clickReset - * @function - * @public * @param {Array.number} [buttons= [0,1,2]] the buttons to reset (0: left, 1: center, 2: right) */ clickReset(buttons = [0, 1, 2]) @@ -382,19 +381,23 @@ export class Mouse extends PsychObject + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_PsychoJS.js.html b/docs/core_PsychoJS.js.html index 2078f27..de12cdf 100644 --- a/docs/core_PsychoJS.js.html +++ b/docs/core_PsychoJS.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/PsychoJS.js - - - + core/PsychoJS.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/PsychoJS.js

+ + + + +
+ +

core/PsychoJS.js

+ @@ -31,8 +55,8 @@ * Main component of the PsychoJS library. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -49,18 +73,11 @@ import { Window } from "./Window.js"; import {Shelf} from "../data/Shelf"; /** - * <p>PsychoJS manages the lifecycle of an experiment. It initialises the PsychoJS library and its various components (e.g. the {@link ServerManager}, the {@link EventManager}), and is used by the experiment to schedule the various tasks.</p> - * - * @class - * @param {Object} options - * @param {boolean} [options.debug= true] whether or not to log debug information in the browser console - * @param {boolean} [options.collectIP= false] whether or not to collect the IP information of the participant + * <p>PsychoJS initialises the library and its various components (e.g. the [ServerManager]{@link module:core.ServerManager}, the [EventManager]{@link module:core.EventManager}), and manages + * the lifecycle of an experiment.</p> */ export class PsychoJS { - /** - * Properties - */ get status() { return this._status; @@ -143,8 +160,9 @@ export class PsychoJS } /** - * @constructor - * @public + * @param {Object} options + * @param {boolean} [options.debug= true] whether to log debug information in the browser console + * @param {boolean} [options.collectIP= false] whether to collect the IP information of the participant */ constructor({ debug = true, @@ -204,7 +222,7 @@ export class PsychoJS } this.logger.info("[PsychoJS] Initialised."); - this.logger.info("[PsychoJS] @version 2022.2.0"); + this.logger.info("[PsychoJS] @version 2022.2.1"); // hide the initialisation message: const root = document.getElementById("root"); @@ -240,8 +258,6 @@ export class PsychoJS * @param {boolean} [options.waitBlanking] whether or not to wait for all rendering operations to be done * before flipping * @throws {Object.<string, *>} exception if a window has already been opened - * - * @public */ openWindow({ name, @@ -291,9 +307,8 @@ export class PsychoJS /** * Schedule a task. * - * @param task - the task to be scheduled - * @param args - arguments for that task - * @public + * @param {module:util.Scheduler~Task} task - the task to be scheduled + * @param {*} args - arguments for that task */ schedule(task, args) { @@ -310,9 +325,8 @@ export class PsychoJS * Schedule a series of task based on a condition. * * @param {PsychoJS.condition} condition - * @param {Scheduler} thenScheduler scheduler to run if the condition is true - * @param {Scheduler} elseScheduler scheduler to run if the condition is false - * @public + * @param {Scheduler} thenScheduler - scheduler to run if the condition is true + * @param {Scheduler} elseScheduler - scheduler to run if the condition is false */ scheduleCondition(condition, thenScheduler, elseScheduler) { @@ -340,8 +354,6 @@ export class PsychoJS * @param {string} [options.expName=UNKNOWN] - the name of the experiment * @param {Object.<string, *>} [options.expInfo] - additional information about the experiment * @param {Array.<{name: string, path: string}>} [resources=[]] - the list of resources - * @async - * @public */ async start({ configURL = "config.json", expName = "UNKNOWN", expInfo = {}, resources = [], dataFileName } = {}) { @@ -452,7 +464,6 @@ export class PsychoJS * local to index.html unless they are prepended with a protocol.</li> * * @param {Array.<{name: string, path: string}>} [resources=[]] - the list of resources - * @public */ waitForResources(resources = []) { @@ -476,7 +487,6 @@ export class PsychoJS * Make the attributes of the given object those of window, such that they become global. * * @param {Object.<string, *>} obj the object whose attributes are to become global - * @public */ importAttributes(obj) { @@ -502,9 +512,7 @@ export class PsychoJS * * @param {Object} options * @param {string} [options.message] - optional message to be displayed in a dialog box before quitting - * @param {boolean} [options.isCompleted = false] - whether or not the participant has completed the experiment - * @async - * @public + * @param {boolean} [options.isCompleted = false] - whether the participant has completed the experiment */ async quit({ message, isCompleted = false } = {}) { @@ -512,6 +520,7 @@ export class PsychoJS this._experiment.experimentEnded = true; this._status = PsychoJS.Status.FINISHED; + const isServerEnv = this.getEnvironment() === ExperimentHandler.Environment.SERVER; try { @@ -519,28 +528,32 @@ export class PsychoJS this._scheduler.stop(); // remove the beforeunload listener: - if (this.getEnvironment() === ExperimentHandler.Environment.SERVER) + if (isServerEnv) { window.removeEventListener("beforeunload", this.beforeunloadCallback); } // save the results and the logs of the experiment: - this.gui.dialog({ - warning: "Closing the session. Please wait a few moments.", - showOK: false, + this.gui.finishDialog({ + text: "Terminating the experiment. Please wait a few moments...", + nbSteps: 2 + ((isServerEnv) ? 1 : 0) }); + if (isCompleted || this._config.experiment.saveIncompleteResults) { if (!this._serverMsg.has("__noOutput")) { + this.gui.finishDialogNextStep("saving results"); await this._experiment.save(); + this.gui.finishDialogNextStep("saving logs"); await this._logger.flush(); } } // close the session: - if (this.getEnvironment() === ExperimentHandler.Environment.SERVER) + if (isServerEnv) { + this.gui.finishDialogNextStep("closing the session"); await this._serverManager.closeSession(isCompleted); } @@ -575,6 +588,7 @@ export class PsychoJS } }, }); + } catch (error) { @@ -586,7 +600,6 @@ export class PsychoJS /** * Configure PsychoJS for the running experiment. * - * @async * @protected * @param {string} configURL - the URL of the configuration file * @param {string} name - the name of the experiment @@ -737,7 +750,6 @@ export class PsychoJS /** * Capture all errors and display them in a pop-up error box. - * * @protected */ _captureErrors() @@ -784,7 +796,7 @@ export class PsychoJS /** * Make the various Status top level, in order to accommodate PsychoPy's Code Components. - * @private + * @protected */ _makeStatusTopLevel() { @@ -800,7 +812,6 @@ export class PsychoJS * * @enum {Symbol} * @readonly - * @public * * @note PsychoPy is currently moving away from STOPPED and replacing STOPPED by FINISHED. * For backward compatibility reasons, we are keeping @@ -824,19 +835,23 @@ PsychoJS.Status = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_ServerManager.js.html b/docs/core_ServerManager.js.html index 4350597..916654e 100644 --- a/docs/core_ServerManager.js.html +++ b/docs/core_ServerManager.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/ServerManager.js - - - + core/ServerManager.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/ServerManager.js

+ + + + +
+ +

core/ServerManager.js

+ @@ -30,8 +54,8 @@ * Manager responsible for the communication between the experiment running in the participant's browser and the pavlovia.org server. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -47,25 +71,26 @@ import { PsychoJS } from "./PsychoJS.js"; * <p>This manager handles all communications between the experiment running in the participant's browser and the [pavlovia.org]{@link http://pavlovia.org} server, <em>in an asynchronous manner</em>.</p> * <p>It is responsible for reading the configuration file of an experiment, for opening and closing a session, for listing and downloading resources, and for uploading results, logs, and audio recordings.</p> * - * @name module:core.ServerManager - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {boolean} [options.autoLog= false] - whether or not to log */ export class ServerManager extends PsychObject { - /**************************************************************************** + /** * Used to indicate to the ServerManager that all resources must be registered (and * subsequently downloaded) * - * @type {symbol} + * @type {Symbol} * @readonly * @public */ static ALL_RESOURCES = Symbol.for("ALL_RESOURCES"); + /** + * @memberof module:core + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {boolean} [options.autoLog= false] - whether or not to log + */ constructor({ psychoJS, autoLog = false, @@ -86,21 +111,17 @@ export class ServerManager extends PsychObject this._addAttribute("status", ServerManager.Status.READY); } - /**************************************************************************** + /** * @typedef ServerManager.GetConfigurationPromise * @property {string} origin the calling method * @property {string} context the context * @property {Object.<string, *>} [config] the configuration * @property {Object.<string, *>} [error] an error message if we could not read the configuration file */ - /**************************************************************************** + /** * Read the configuration file for the experiment. * - * @name module:core.ServerManager#getConfiguration - * @function - * @public * @param {string} configURL - the URL of the configuration file - * * @returns {Promise<ServerManager.GetConfigurationPromise>} the response */ getConfiguration(configURL) @@ -147,19 +168,16 @@ export class ServerManager extends PsychObject }); } - /**************************************************************************** + /** * @typedef ServerManager.OpenSessionPromise * @property {string} origin the calling method * @property {string} context the context * @property {string} [token] the session token * @property {Object.<string, *>} [error] an error message if we could not open the session */ - /**************************************************************************** + /** * Open a session for this experiment on the remote PsychoJS manager. * - * @name module:core.ServerManager#openSession - * @function - * @public * @returns {Promise<ServerManager.OpenSessionPromise>} the response */ openSession() @@ -185,24 +203,16 @@ export class ServerManager extends PsychObject { try { - const url = `${this._psychoJS.config.pavlovia.URL}/api/v2/experiments/${this._psychoJS.config.gitlab.projectId}/sessions`; + const postResponse = await this._queryServerAPI( + "POST", + `experiments/${this._psychoJS.config.gitlab.projectId}/sessions`, + data, + "FORM" + ); - const response = await fetch(url, { - method: 'POST', - mode: 'cors', - cache: 'no-cache', - credentials: 'same-origin', - redirect: 'follow', - referrerPolicy: 'no-referrer', - headers: { - 'Content-Type': 'application/json' - }, - body: JSON.stringify(data) - }); + const openSessionResponse = await postResponse.json(); - const openSessionResponse = await response.json(); - - if (openSessionResponse.status !== 200) + if (postResponse.status !== 200) { throw ('error' in openSessionResponse) ? openSessionResponse.error : openSessionResponse; } @@ -240,7 +250,6 @@ export class ServerManager extends PsychObject self.setStatus(ServerManager.Status.READY); resolve({...response, token: openSessionResponse.token, status: openSessionResponse.status }); - } catch (error) { @@ -248,71 +257,18 @@ export class ServerManager extends PsychObject self.setStatus(ServerManager.Status.ERROR); reject({...response, error}); } - - /*jQuery.post(url, data, null, "json") - .done((data, textStatus) => - { - if (!("token" in data)) - { - self.setStatus(ServerManager.Status.ERROR); - reject(Object.assign(response, { error: "unexpected answer from server: no token" })); - // reject({...response, error: 'unexpected answer from server: no token'}); - } - if (!("experiment" in data)) - { - self.setStatus(ServerManager.Status.ERROR); - // reject({...response, error: 'unexpected answer from server: no experiment'}); - reject(Object.assign(response, { error: "unexpected answer from server: no experiment" })); - } - - self._psychoJS.config.session = { - token: data.token, - status: "OPEN", - }; - self._psychoJS.config.experiment.status = data.experiment.status2; - self._psychoJS.config.experiment.saveFormat = Symbol.for(data.experiment.saveFormat); - self._psychoJS.config.experiment.saveIncompleteResults = data.experiment.saveIncompleteResults; - self._psychoJS.config.experiment.license = data.experiment.license; - self._psychoJS.config.experiment.runMode = data.experiment.runMode; - - // secret keys for various services, e.g. Google Speech API - if ("keys" in data.experiment) - { - self._psychoJS.config.experiment.keys = data.experiment.keys; - } - else - { - self._psychoJS.config.experiment.keys = []; - } - - self.setStatus(ServerManager.Status.READY); - // resolve({ ...response, token: data.token, status: data.status }); - resolve(Object.assign(response, { token: data.token, status: data.status })); - }) - .fail((jqXHR, textStatus, errorThrown) => - { - self.setStatus(ServerManager.Status.ERROR); - - const errorMsg = util.getRequestError(jqXHR, textStatus, errorThrown); - console.error("error:", errorMsg); - - reject(Object.assign(response, { error: errorMsg })); - });*/ }); } - /**************************************************************************** + /** * @typedef ServerManager.CloseSessionPromise * @property {string} origin the calling method * @property {string} context the context * @property {Object.<string, *>} [error] an error message if we could not close the session (e.g. if it has not previously been opened) */ - /**************************************************************************** + /** * Close the session for this experiment on the remote PsychoJS manager. * - * @name module:core.ServerManager#closeSession - * @function - * @public * @param {boolean} [isCompleted= false] - whether or not the experiment was completed * @param {boolean} [sync= false] - whether or not to communicate with the server in a synchronous manner * @returns {Promise<ServerManager.CloseSessionPromise> | void} the response @@ -323,78 +279,61 @@ export class ServerManager extends PsychObject origin: "ServerManager.closeSession", context: "when closing the session for experiment: " + this._psychoJS.config.experiment.fullpath, }; - this._psychoJS.logger.debug("closing the session for experiment: " + this._psychoJS.config.experiment.name); this.setStatus(ServerManager.Status.BUSY); - // prepare DELETE query: - const url = this._psychoJS.config.pavlovia.URL - + "/api/v2/experiments/" + this._psychoJS.config.gitlab.projectId - + "/sessions/" + this._psychoJS.config.session.token; - - // synchronous query the pavlovia server: + // synchronously query the pavlovia server: if (sync) { - /* This is now deprecated in most browsers. - const request = new XMLHttpRequest(); - request.open("DELETE", url, false); - request.setRequestHeader("Content-Type", "application/json;charset=UTF-8"); - request.send(JSON.stringify(data)); - */ - /* This does not work in Chrome because of a CORS bug - await fetch(url, { - method: 'DELETE', - headers: { 'Content-Type': 'application/json;charset=UTF-8' }, - body: JSON.stringify(data), - // keepalive makes it possible for the request to outlive the page (e.g. when the participant closes the tab) - keepalive: true - }); - */ + const url = this._psychoJS.config.pavlovia.URL + + "/api/v2/experiments/" + this._psychoJS.config.gitlab.projectId + + "/sessions/" + this._psychoJS.config.session.token + "/delete"; const formData = new FormData(); formData.append("isCompleted", isCompleted); - navigator.sendBeacon(url + "/delete", formData); + + navigator.sendBeacon(url, formData); this._psychoJS.config.session.status = "CLOSED"; } // asynchronously query the pavlovia server: else { const self = this; - return new Promise((resolve, reject) => + return new Promise(async (resolve, reject) => { - jQuery.ajax({ - url, - type: "delete", - data: { isCompleted }, - dataType: "json", - }) - .done((data, textStatus) => + try + { + const deleteResponse = await this._queryServerAPI( + "DELETE", + `experiments/${this._psychoJS.config.gitlab.projectId}/sessions/${this._psychoJS.config.session.token}`, + { isCompleted }, + "FORM" + ); + + const closeSessionResponse = await deleteResponse.json(); + + if (deleteResponse.status !== 200) { - self.setStatus(ServerManager.Status.READY); - self._psychoJS.config.session.status = "CLOSED"; + throw ('error' in closeSessionResponse) ? closeSessionResponse.error : closeSessionResponse; + } - // resolve({ ...response, data }); - resolve(Object.assign(response, { data })); - }) - .fail((jqXHR, textStatus, errorThrown) => - { - self.setStatus(ServerManager.Status.ERROR); - - const errorMsg = util.getRequestError(jqXHR, textStatus, errorThrown); - console.error("error:", errorMsg); - - reject(Object.assign(response, { error: errorMsg })); - }); + self.setStatus(ServerManager.Status.READY); + self._psychoJS.config.session.status = "CLOSED"; + resolve({ ...response, ...closeSessionResponse }); + } + catch (error) + { + console.error(error); + self.setStatus(ServerManager.Status.ERROR); + reject({...response, error}); + } }); } } - /**************************************************************************** + /** * Get the value of a resource. * - * @name module:core.ServerManager#getResource - * @function - * @public * @param {string} name - name of the requested resource * @param {boolean} [errorIfNotDownloaded = false] whether or not to throw an exception if the * resource status is not DOWNLOADED @@ -428,7 +367,7 @@ export class ServerManager extends PsychObject return pathStatusData.data; } - /**************************************************************************** + /** * Get the status of a single resource or the reduced status of an array of resources. * * <p>If an array of resources is given, getResourceStatus returns a single, reduced status @@ -443,11 +382,8 @@ export class ServerManager extends PsychObject * </ul> * </p> * - * @name module:core.ServerManager#getResourceStatus - * @function - * @public * @param {string | string[]} names names of the resources whose statuses are requested - * @return {core.ServerManager.ResourceStatus} status of the resource if there is only one, or reduced status otherwise + * @return {module:core.ServerManager.ResourceStatus} status of the resource if there is only one, or reduced status otherwise * @throws {Object.<string, *>} if at least one of the names is not that of a previously * registered resource */ @@ -497,12 +433,8 @@ export class ServerManager extends PsychObject return reducedStatus; } - /**************************************************************************** + /** * Set the resource manager status. - * - * @name module:core.ServerManager#setStatus - * @function - * @public */ setStatus(status) { @@ -530,12 +462,9 @@ export class ServerManager extends PsychObject return this._status; } - /**************************************************************************** + /** * Reset the resource manager status to ServerManager.Status.READY. * - * @name module:core.ServerManager#resetStatus - * @function - * @public * @return {ServerManager.Status.READY} the new status */ resetStatus() @@ -543,7 +472,7 @@ export class ServerManager extends PsychObject return this.setStatus(ServerManager.Status.READY); } - /**************************************************************************** + /** * Prepare resources for the experiment: register them with the server manager and possibly * start downloading them right away. * @@ -556,10 +485,7 @@ export class ServerManager extends PsychObject * <li>If resources is null, then we do not download any resources</li> * </ul> * - * @name module:core.ServerManager#prepareResources * @param {String | Array.<{name: string, path: string, download: boolean} | String | Symbol>} [resources=[]] - the list of resources or a single resource - * @function - * @public */ async prepareResources(resources = []) { @@ -708,13 +634,10 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * Block the experiment until the specified resources have been downloaded. * - * @name module:core.ServerManager#waitForResources * @param {Array.<{name: string, path: string}>} [resources=[]] - the list of resources - * @function - * @public */ waitForResources(resources = []) { @@ -810,22 +733,18 @@ export class ServerManager extends PsychObject }; } - /**************************************************************************** + /** * @typedef ServerManager.UploadDataPromise * @property {string} origin the calling method * @property {string} context the context * @property {Object.<string, *>} [error] an error message if we could not upload the data */ - /**************************************************************************** + /** * Asynchronously upload experiment data to the pavlovia server. * - * @name module:core.ServerManager#uploadData - * @function - * @public * @param {string} key - the data key (e.g. the name of .csv file) * @param {string} value - the data value (e.g. a string containing the .csv header and records) * @param {boolean} [sync= false] - whether or not to communicate with the server in a synchronous manner - * * @returns {Promise<ServerManager.UploadDataPromise>} the response */ uploadData(key, value, sync = false) @@ -834,59 +753,58 @@ export class ServerManager extends PsychObject origin: "ServerManager.uploadData", context: "when uploading participant's results for experiment: " + this._psychoJS.config.experiment.fullpath, }; - this._psychoJS.logger.debug("uploading data for experiment: " + this._psychoJS.config.experiment.fullpath); + this.setStatus(ServerManager.Status.BUSY); - const url = this._psychoJS.config.pavlovia.URL - + "/api/v2/experiments/" + encodeURIComponent(this._psychoJS.config.experiment.fullpath) - + "/sessions/" + this._psychoJS.config.session.token - + "/results"; + const path = `experiments/${this._psychoJS.config.gitlab.projectId}/sessions/${this._psychoJS.config.session.token}/results`; - // synchronous query the pavlovia server: + // synchronously query the pavlovia server: if (sync) { const formData = new FormData(); formData.append("key", key); formData.append("value", value); - navigator.sendBeacon(url, formData); + navigator.sendBeacon(`${this._psychoJS.config.pavlovia.URL}/api/v2/${path}`, formData); } // asynchronously query the pavlovia server: else { const self = this; - return new Promise((resolve, reject) => + return new Promise(async (resolve, reject) => { - const data = { - key, - value, - }; + try + { + const postResponse = await this._queryServerAPI( + "POST", + `experiments/${this._psychoJS.config.gitlab.projectId}/sessions/${this._psychoJS.config.session.token}/results`, + { key, value }, + "FORM" + ); - jQuery.post(url, data, null, "json") - .done((serverData, textStatus) => + const uploadDataResponse = await postResponse.json(); + + if (postResponse.status !== 200) { - self.setStatus(ServerManager.Status.READY); - resolve(Object.assign(response, { serverData })); - }) - .fail((jqXHR, textStatus, errorThrown) => - { - self.setStatus(ServerManager.Status.ERROR); + throw ('error' in uploadDataResponse) ? uploadDataResponse.error : uploadDataResponse; + } - const errorMsg = util.getRequestError(jqXHR, textStatus, errorThrown); - console.error("error:", errorMsg); - - reject(Object.assign(response, { error: errorMsg })); - }); + self.setStatus(ServerManager.Status.READY); + resolve({ ...response, ...uploadDataResponse }); + } + catch (error) + { + console.error(error); + self.setStatus(ServerManager.Status.ERROR); + reject({...response, error}); + } }); } } - /**************************************************************************** + /** * Asynchronously upload experiment logs to the pavlovia server. * - * @name module:core.ServerManager#uploadLog - * @function - * @public * @param {string} logs - the base64 encoded, compressed, formatted logs * @param {boolean} [compressed=false] - whether or not the logs are compressed * @returns {Promise<ServerManager.UploadDataPromise>} the response @@ -897,55 +815,56 @@ export class ServerManager extends PsychObject origin: "ServerManager.uploadLog", context: "when uploading participant's log for experiment: " + this._psychoJS.config.experiment.fullpath, }; - this._psychoJS.logger.debug("uploading server log for experiment: " + this._psychoJS.config.experiment.fullpath); + this.setStatus(ServerManager.Status.BUSY); - // prepare the POST query: + // prepare a POST query: const info = this.psychoJS.experiment.extraInfo; - const participant = ((typeof info.participant === "string" && info.participant.length > 0) ? info.participant : "PARTICIPANT"); - const experimentName = (typeof info.expName !== "undefined") ? info.expName : this.psychoJS.config.experiment.name; - const datetime = ((typeof info.date !== "undefined") ? info.date : MonotonicClock.getDateStr()); - const filename = participant + "_" + experimentName + "_" + datetime + ".log"; + const filenameWithoutPath = this.psychoJS.experiment.dataFileName.split(/[\\/]/).pop(); + const filename = `${filenameWithoutPath}.log`; const data = { filename, logs, - compressed, + compressed }; // query the pavlovia server: const self = this; - return new Promise((resolve, reject) => + return new Promise(async (resolve, reject) => { - const url = self._psychoJS.config.pavlovia.URL - + "/api/v2/experiments/" + encodeURIComponent(self._psychoJS.config.experiment.fullpath) - + "/sessions/" + self._psychoJS.config.session.token - + "/logs"; + try + { + const postResponse = await this._queryServerAPI( + "POST", + `experiments/${this._psychoJS.config.gitlab.projectId}/sessions/${self._psychoJS.config.session.token}/logs`, + data, + "FORM" + ); - jQuery.post(url, data, null, "json") - .done((serverData, textStatus) => + const uploadLogsResponse = await postResponse.json(); + + if (postResponse.status !== 200) { - self.setStatus(ServerManager.Status.READY); - resolve(Object.assign(response, { serverData })); - }) - .fail((jqXHR, textStatus, errorThrown) => - { - self.setStatus(ServerManager.Status.ERROR); + throw ('error' in uploadLogsResponse) ? uploadLogsResponse.error : uploadLogsResponse; + } - const errorMsg = util.getRequestError(jqXHR, textStatus, errorThrown); - console.error("error:", errorMsg); + self.setStatus(ServerManager.Status.READY); + resolve({...response, ...uploadLogsResponse }); + } + catch (error) + { + console.error(error); + self.setStatus(ServerManager.Status.ERROR); + reject({...response, error}); + } - reject(Object.assign(response, { error: errorMsg })); - }); }); } - /**************************************************************************** + /** * Synchronously or asynchronously upload audio data to the pavlovia server. * - * @name module:core.ServerManager#uploadAudioVideo - * @function - * @public * @param @param {Object} options * @param {Blob} options.mediaBlob - the audio or video blob to be uploaded * @param {string} options.tag - additional tag @@ -1075,12 +994,10 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * List the resources available to the experiment. * - * @name module:core.ServerManager#_listResources - * @function - * @private + * @protected */ _listResources() { @@ -1092,61 +1009,53 @@ export class ServerManager extends PsychObject this.setStatus(ServerManager.Status.BUSY); - // prepare GET data: + // prepare a GET query: const data = { "token": this._psychoJS.config.session.token, }; - // query pavlovia server: + // query the server: const self = this; - return new Promise((resolve, reject) => + return new Promise(async (resolve, reject) => { - const url = this._psychoJS.config.pavlovia.URL - + "/api/v2/experiments/" + encodeURIComponent(this._psychoJS.config.experiment.fullpath) - + "/resources"; + try + { + const getResponse = await this._queryServerAPI( + "GET", + `experiments/${this._psychoJS.config.gitlab.projectId}/resources`, + data + ); - jQuery.get(url, data, null, "json") - .done((data, textStatus) => - { - if (!("resources" in data)) - { - self.setStatus(ServerManager.Status.ERROR); - // reject({ ...response, error: 'unexpected answer from server: no resources' }); - reject(Object.assign(response, { error: "unexpected answer from server: no resources" })); - } - if (!("resourceDirectory" in data)) - { - self.setStatus(ServerManager.Status.ERROR); - // reject({ ...response, error: 'unexpected answer from server: no resourceDirectory' }); - reject(Object.assign(response, { error: "unexpected answer from server: no resourceDirectory" })); - } + const getResourcesResponse = await getResponse.json(); - self.setStatus(ServerManager.Status.READY); - // resolve({ ...response, resources: data.resources, resourceDirectory: data.resourceDirectory }); - resolve(Object.assign(response, { - resources: data.resources, - resourceDirectory: data.resourceDirectory, - })); - }) - .fail((jqXHR, textStatus, errorThrown) => + if (!("resources" in getResourcesResponse)) { self.setStatus(ServerManager.Status.ERROR); + throw "unexpected answer from server: no resources"; + } + if (!("resourceDirectory" in getResourcesResponse)) + { + self.setStatus(ServerManager.Status.ERROR); + throw "unexpected answer from server: no resourceDirectory"; + } - const errorMsg = util.getRequestError(jqXHR, textStatus, errorThrown); - console.error("error:", errorMsg); - - reject(Object.assign(response, { error: errorMsg })); - }); + self.setStatus(ServerManager.Status.READY); + resolve({ ...response, resources: data.resources, resourceDirectory: data.resourceDirectory }); + } + catch (error) + { + console.error(error); + self.setStatus(ServerManager.Status.ERROR); + reject({...response, error}); + } }); } - /**************************************************************************** + /** * Download the specified resources. * * <p>Note: we use the [preloadjs library]{@link https://www.createjs.com/preloadjs}.</p> * - * @name module:core.ServerManager#_downloadResources - * @function * @protected * @param {Set} resources - a set of names of previously registered resources */ @@ -1344,11 +1253,9 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * Setup the preload.js queue, and the associated callbacks. * - * @name module:core.ServerManager#_setupPreloadQueue - * @function * @protected */ _setupPreloadQueue() @@ -1436,18 +1343,87 @@ export class ServerManager extends PsychObject }); } + /** + * Query the pavlovia server API. + * + * @protected + * @param method the HTTP method, i.e. GET, PUT, POST, or DELETE + * @param path the resource path, without the server address + * @param data the data to be sent + * @param {string} [contentType="JSON"] the content type, either JSON or FORM + */ + _queryServerAPI(method, path, data, contentType = "JSON") + { + const fullPath = `${this._psychoJS.config.pavlovia.URL}/api/v2/${path}`; + + if (method === "PUT" || method === "POST" || method === "DELETE") + { + if (contentType === "JSON") + { + return fetch(fullPath, { + method, + mode: 'cors', + cache: 'no-cache', + credentials: 'same-origin', + redirect: 'follow', + referrerPolicy: 'no-referrer', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify(data) + }); + } + else + { + const formData = new FormData(); + for (const attribute in data) + { + formData.append(attribute, data[attribute]); + } + + return fetch(fullPath, { + method, + mode: 'cors', + cache: 'no-cache', + credentials: 'same-origin', + redirect: 'follow', + referrerPolicy: 'no-referrer', + body: formData + }); + } + } + + if (method === "GET") + { + let url = new URL(fullPath); + url.search = new URLSearchParams(data).toString(); + + return fetch(url, { + method: "GET", + mode: "cors", + cache: "no-cache", + credentials: "same-origin", + redirect: "follow", + referrerPolicy: "no-referrer" + }); + } + + throw { + origin: "ServerManager._queryServer", + context: "when querying the server", + error: "the method should be GET, PUT, POST, or DELETE" + }; + } } -/**************************************************************************** +/** * Server event * * <p>A server event is emitted by the manager to inform its listeners of either a change of status, or of a resource related event (e.g. download started, download is completed).</p> * - * @name module:core.ServerManager#Event * @enum {Symbol} * @readonly - * @public */ ServerManager.Event = { /** @@ -1473,7 +1449,7 @@ ServerManager.Event = { /** * Event: resources have all downloaded */ - DOWNLOADS_COMPLETED: Symbol.for("DOWNLOAD_COMPLETED"), + DOWNLOAD_COMPLETED: Symbol.for("DOWNLOAD_COMPLETED"), /** * Event type: status event @@ -1481,13 +1457,11 @@ ServerManager.Event = { STATUS: Symbol.for("STATUS"), }; -/**************************************************************************** +/** * Server status * - * @name module:core.ServerManager#Status * @enum {Symbol} * @readonly - * @public */ ServerManager.Status = { /** @@ -1506,13 +1480,11 @@ ServerManager.Status = { ERROR: Symbol.for("ERROR"), }; -/**************************************************************************** +/** * Resource status * - * @name module:core.ServerManager#ResourceStatus * @enum {Symbol} * @readonly - * @public */ ServerManager.ResourceStatus = { /** @@ -1542,19 +1514,23 @@ ServerManager.ResourceStatus = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_Window.js.html b/docs/core_Window.js.html index b00a7ef..267b4a4 100644 --- a/docs/core_Window.js.html +++ b/docs/core_Window.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/Window.js - - - + core/Window.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/Window.js

+ + + + +
+ +

core/Window.js

+ @@ -30,8 +54,8 @@ * Window responsible for displaying the experiment stimuli * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -46,20 +70,7 @@ import { Logger } from "./Logger.js"; * <p>Window displays the various stimuli of the experiment.</p> * <p>It sets up a [PIXI]{@link http://www.pixijs.com/} renderer, which we use to render the experiment stimuli.</p> * - * @name module:core.Window - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} [options.name] the name of the window - * @param {boolean} [options.fullscr= false] whether or not to go fullscreen - * @param {Color} [options.color= Color('black')] the background color of the window - * @param {number} [options.gamma= 1] sets the divisor for gamma correction. In other words gamma correction is calculated as pow(rgb, 1/gamma) - * @param {number} [options.contrast= 1] sets the contrast value - * @param {string} [options.units= 'pix'] the units of the window - * @param {boolean} [options.waitBlanking= false] whether or not to wait for all rendering operations to be done - * before flipping - * @param {boolean} [options.autoLog= true] whether or not to log */ export class Window extends PsychObject { @@ -75,6 +86,20 @@ export class Window extends PsychObject return 1.0 / this.getActualFrameRate(); } + /** + * @memberof module:core + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} [options.name] the name of the window + * @param {boolean} [options.fullscr= false] whether or not to go fullscreen + * @param {Color} [options.color= Color('black')] the background color of the window + * @param {number} [options.gamma= 1] sets the divisor for gamma correction. In other words gamma correction is calculated as pow(rgb, 1/gamma) + * @param {number} [options.contrast= 1] sets the contrast value + * @param {string} [options.units= 'pix'] the units of the window + * @param {boolean} [options.waitBlanking= false] whether or not to wait for all rendering operations to be done + * before flipping + * @param {boolean} [options.autoLog= true] whether or not to log + */ constructor({ psychoJS, name, @@ -104,7 +129,7 @@ export class Window extends PsychObject this._addAttribute("fullscr", fullscr); this._addAttribute("color", color, new Color("black"), () => { if (this._backgroundSprite) { - this._backgroundSprite.tint = color.int; + this._backgroundSprite.tint = this._color.int; } }); this._addAttribute("gamma", gamma, 1, () => { @@ -152,10 +177,6 @@ export class Window extends PsychObject * Close the window. * * <p> Note: this actually only removes the canvas used to render the experiment stimuli.</p> - * - * @name module:core.Window#close - * @function - * @public */ close() { @@ -189,9 +210,6 @@ export class Window extends PsychObject /** * Estimate the frame rate. * - * @name module:core.Window#getActualFrameRate - * @function - * @public * @return {number} rAF based delta time based approximation, 60.0 by default */ getActualFrameRate() @@ -205,10 +223,6 @@ export class Window extends PsychObject /** * Take the browser full screen if possible. - * - * @name module:core.Window#adjustScreenSize - * @function - * @public */ adjustScreenSize() { @@ -250,10 +264,6 @@ export class Window extends PsychObject /** * Take the browser back from full screen if needed. - * - * @name module:core.Window#closeFullScreen - * @function - * @public */ closeFullScreen() { @@ -293,9 +303,6 @@ export class Window extends PsychObject * * <p> Note: the message will be time-stamped at the next call to requestAnimationFrame.</p> * - * @name module:core.Window#logOnFlip - * @function - * @public * @param {Object} options * @param {String} options.msg the message to be logged * @param {module:util.Logger.ServerLevel} [level = module:util.Logger.ServerLevel.EXP] the log level @@ -322,9 +329,6 @@ export class Window extends PsychObject * * <p>This is typically used to reset a timer or clock.</p> * - * @name module:core.Window#callOnFlip - * @function - * @public * @param {module:core.Window~OnFlipCallback} flipCallback - callback function. * @param {...*} flipCallbackArgs - arguments for the callback function. */ @@ -335,10 +339,6 @@ export class Window extends PsychObject /** * Add PIXI.DisplayObject to the container displayed on the scene (window) - * - * @name module:core.Window#addPixiObject - * @function - * @public */ addPixiObject(pixiObject) { @@ -347,10 +347,6 @@ export class Window extends PsychObject /** * Remove PIXI.DisplayObject from the container displayed on the scene (window) - * - * @name module:core.Window#removePixiObject - * @function - * @public */ removePixiObject(pixiObject) { @@ -359,10 +355,6 @@ export class Window extends PsychObject /** * Render the stimuli onto the canvas. - * - * @name module:core.Window#render - * @function - * @public */ render() { @@ -406,9 +398,7 @@ export class Window extends PsychObject /** * Update this window, if need be. * - * @name module:core.Window#_updateIfNeeded - * @function - * @private + * @protected */ _updateIfNeeded() { @@ -417,6 +407,7 @@ export class Window extends PsychObject if (this._renderer) { this._renderer.backgroundColor = this._color.int; + this._backgroundSprite.tint = this._color.int; } // we also change the background color of the body since @@ -430,9 +421,7 @@ export class Window extends PsychObject /** * Recompute this window's draw list and _container children for the next animation frame. * - * @name module:core.Window#_refresh - * @function - * @private + * @protected */ _refresh() { @@ -454,9 +443,7 @@ export class Window extends PsychObject /** * Force an update of all stimuli in this window's drawlist. * - * @name module:core.Window#_fullRefresh - * @function - * @private + * @protected */ _fullRefresh() { @@ -476,9 +463,7 @@ export class Window extends PsychObject * <p>A new renderer is created and a container is added to it. The renderer's touch and mouse events * are handled by the {@link EventManager}.</p> * - * @name module:core.Window#_setupPixi - * @function - * @private + * @protected */ _setupPixi() { @@ -538,6 +523,8 @@ export class Window extends PsychObject this._resizeCallback = (e) => { Window._resizePixiRenderer(this, e); + this._backgroundSprite.width = this._size[0]; + this._backgroundSprite.height = this._size[1]; this._fullRefresh(); }; window.addEventListener("resize", this._resizeCallback); @@ -548,9 +535,7 @@ export class Window extends PsychObject * Adjust the size of the renderer and the position of the root container * in response to a change in the browser's size. * - * @name module:core.Window#_resizePixiRenderer - * @function - * @private + * @protected * @param {module:core.Window} pjsWindow - the PsychoJS Window * @param event */ @@ -579,9 +564,7 @@ export class Window extends PsychObject /** * Send all logged messages to the {@link Logger}. * - * @name module:core.Window#_writeLogOnFlip - * @function - * @private + * @protected */ _writeLogOnFlip() { @@ -601,19 +584,23 @@ export class Window extends PsychObject + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/core_WindowMixin.js.html b/docs/core_WindowMixin.js.html index 11de007..047687f 100644 --- a/docs/core_WindowMixin.js.html +++ b/docs/core_WindowMixin.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: core/WindowMixin.js - - - + core/WindowMixin.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: core/WindowMixin.js

+ + + + +
+ +

core/WindowMixin.js

+ @@ -30,8 +54,8 @@ * Mixin implementing various unit-handling measurement methods. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -221,19 +245,23 @@ export let WindowMixin = (superclass) => + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/data_ExperimentHandler.js.html b/docs/data_ExperimentHandler.js.html index 9ee6b40..6a59258 100644 --- a/docs/data_ExperimentHandler.js.html +++ b/docs/data_ExperimentHandler.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: data/ExperimentHandler.js - - - + data/ExperimentHandler.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: data/ExperimentHandler.js

+ + + + +
+ +

data/ExperimentHandler.js

+ @@ -30,8 +54,8 @@ * Experiment Handler * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -45,22 +69,12 @@ import * as util from "../util/Util.js"; * for generating a single data file from an experiment with many different loops (e.g. interleaved * staircases or loops within loops.</p> * - * @name module:data.ExperimentHandler - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} options.name - name of the experiment - * @param {Object} options.extraInfo - additional information, such as session name, participant name, etc. */ export class ExperimentHandler extends PsychObject { /** * Getter for experimentEnded. - * - * @name module:data.ExperimentHandler#experimentEnded - * @function - * @public */ get experimentEnded() { @@ -69,10 +83,6 @@ export class ExperimentHandler extends PsychObject /** * Setter for experimentEnded. - * - * @name module:data.ExperimentHandler#experimentEnded - * @function - * @public */ set experimentEnded(ended) { @@ -92,6 +102,13 @@ export class ExperimentHandler extends PsychObject return this._trialsData; } + /** + * @memberof module:data + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} options.name - name of the experiment + * @param {Object} options.extraInfo - additional information, such as session name, participant name, etc. + */ constructor({ psychoJS, name, @@ -139,9 +156,6 @@ export class ExperimentHandler extends PsychObject * Whether or not the current entry (i.e. trial data) is empty. * <p>Note: this is mostly useful at the end of an experiment, in order to ensure that the last entry is saved.</p> * - * @name module:data.ExperimentHandler#isEntryEmpty - * @function - * @public * @returns {boolean} whether or not the current entry is empty * @todo This really should be renamed: IsCurrentEntryNotEmpty */ @@ -156,9 +170,6 @@ export class ExperimentHandler extends PsychObject * <p> The loop might be a {@link TrialHandler}, for instance.</p> * <p> Data from this loop will be included in the resulting data files.</p> * - * @name module:data.ExperimentHandler#addLoop - * @function - * @public * @param {Object} loop - the loop, e.g. an instance of TrialHandler or StairHandler */ addLoop(loop) @@ -171,9 +182,6 @@ export class ExperimentHandler extends PsychObject /** * Remove the given loop from the list of unfinished loops, e.g. when it has completed. * - * @name module:data.ExperimentHandler#removeLoop - * @function - * @public * @param {Object} loop - the loop, e.g. an instance of TrialHandler or StairHandler */ removeLoop(loop) @@ -191,9 +199,6 @@ export class ExperimentHandler extends PsychObject * <p> Multiple key/value pairs can be added to any given entry of the data file. There are * considered part of the same entry until a call to {@link nextEntry} is made. </p> * - * @name module:data.ExperimentHandler#addData - * @function - * @public * @param {Object} key - the key * @param {Object} value - the value */ @@ -217,9 +222,6 @@ export class ExperimentHandler extends PsychObject * Inform this ExperimentHandler that the current trial has ended. Further calls to {@link addData} * will be associated with the next trial. * - * @name module:data.ExperimentHandler#nextEntry - * @function - * @public * @param {Object | Object[] | undefined} snapshots - array of loop snapshots */ nextEntry(snapshots) @@ -284,9 +286,6 @@ export class ExperimentHandler extends PsychObject * </ul> * <p> * - * @name module:data.ExperimentHandler#save - * @function - * @public * @param {Object} options * @param {Array.<Object>} [options.attributes] - the attributes to be saved * @param {boolean} [options.sync=false] - whether or not to communicate with the server in a synchronous manner @@ -408,9 +407,6 @@ export class ExperimentHandler extends PsychObject * Get the attribute names and values for the current trial of a given loop. * <p> Only info relating to the trial execution are returned.</p> * - * @name module:data.ExperimentHandler#_getLoopAttributes - * @function - * @static * @protected * @param {Object} loop - the loop */ @@ -470,10 +466,8 @@ export class ExperimentHandler extends PsychObject /** * Experiment result format * - * @name module:core.ServerManager#SaveFormat * @enum {Symbol} * @readonly - * @public */ ExperimentHandler.SaveFormat = { /** @@ -492,7 +486,6 @@ ExperimentHandler.SaveFormat = { * * @enum {Symbol} * @readonly - * @public */ ExperimentHandler.Environment = { SERVER: Symbol.for("SERVER"), @@ -505,19 +498,23 @@ ExperimentHandler.Environment = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/data_MultiStairHandler.js.html b/docs/data_MultiStairHandler.js.html index 6d5b8d7..f77f3b8 100644 --- a/docs/data_MultiStairHandler.js.html +++ b/docs/data_MultiStairHandler.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: data/MultiStairHandler.js - - - + data/MultiStairHandler.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: data/MultiStairHandler.js

+ + + + +
+ +

data/MultiStairHandler.js

+ @@ -26,13 +50,12 @@
- 
/** @module data */
-/**
+            
/**
  * Multiple Staircase Trial Handler
  *
  * @author Alain Pitiot
- * @version 2021.2.1
- * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd.
+ * @version 2021.2.3
+ * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd.
  *   (https://opensciencetools.org)
  * @license Distributed under the terms of the MIT License
  */
@@ -50,27 +73,25 @@ import seedrandom from "seedrandom";
  * <p>Note that, at the moment, using the MultiStairHandler requires the jsQuest.js
  * library to be loaded as a resource, at the start of the experiment.</p>
  *
- * @class module.data.MultiStairHandler
  * @extends TrialHandler
- * @param {Object} options - the handler options
- * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
- * @param {string} options.varName - the name of the variable / intensity / contrast
- * 	/ threshold manipulated by the staircases
- * @param {module:data.MultiStairHandler.StaircaseType} [options.stairType="simple"] - the
- * 	handler type
- * @param {Array.<Object> | String} [options.conditions= [undefined] ] - if it is a string,
- * 	we treat it as the name of a conditions resource
- * @param {module:data.TrialHandler.Method} options.method - the trial method
- * @param {number} [options.nTrials=50] - maximum number of trials
- * @param {number} options.randomSeed - seed for the random number generator
- * @param {string} options.name - name of the handler
- * @param {boolean} [options.autoLog= false] - whether or not to log
  */
 export class MultiStairHandler extends TrialHandler
 {
 	/**
-	 * @constructor
-	 * @public
+	 * @memberof module:data
+	 * @param {Object} options - the handler options
+	 * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
+	 * @param {string} options.varName - the name of the variable / intensity / contrast
+	 * 	/ threshold manipulated by the staircases
+	 * @param {MultiStairHandler.StaircaseType} [options.stairType="simple"] - the
+	 * 	handler type
+	 * @param {Array.<Object> | String} [options.conditions= [undefined] ] - if it is a string,
+	 * 	we treat it as the name of a conditions resource
+	 * @param {module:data.TrialHandler.Method} options.method - the trial method
+	 * @param {number} [options.nTrials=50] - maximum number of trials
+	 * @param {number} options.randomSeed - seed for the random number generator
+	 * @param {string} options.name - name of the handler
+	 * @param {boolean} [options.autoLog= false] - whether or not to log
 	 */
 	constructor({
 		psychoJS,
@@ -119,10 +140,7 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Get the current staircase.
 	 *
-	 * @name module:data.MultiStairHandler#currentStaircase
-	 * @function
-	 * @public
-	 * @returns {module.data.TrialHandler} the current staircase, or undefined if the trial has ended
+	 * @returns {TrialHandler} the current staircase, or undefined if the trial has ended
 	 */
 	get currentStaircase()
 	{
@@ -132,9 +150,6 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Get the current intensity.
 	 *
-	 * @name module:data.MultiStairHandler#intensity
-	 * @function
-	 * @public
 	 * @returns {number} the intensity of the current staircase, or undefined if the trial has ended
 	 */
 	get intensity()
@@ -156,13 +171,9 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Add a response to the current staircase.
 	 *
-	 * @name module:data.MultiStairHandler#addResponse
-	 * @function
-	 * @public
 	 * @param{number} response - the response to the trial, must be either 0 (incorrect or
 	 * non-detected) or 1 (correct or detected)
 	 * @param{number | undefined} [value] - optional intensity / contrast / threshold
-	 * @returns {void}
 	 */
 	addResponse(response, value)
 	{
@@ -191,10 +202,7 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Validate the conditions.
 	 *
-	 * @name module:data.MultiStairHandler#_validateConditions
-	 * @function
 	 * @protected
-	 * @returns {void}
 	 */
 	_validateConditions()
 	{
@@ -250,10 +258,7 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Setup the staircases, according to the conditions.
 	 *
-	 * @name module:data.MultiStairHandler#_prepareStaircases
-	 * @function
 	 * @protected
-	 * @returns {void}
 	 */
 	_prepareStaircases()
 	{
@@ -310,10 +315,7 @@ export class MultiStairHandler extends TrialHandler
 	/**
 	 * Move onto the next trial.
 	 *
-	 * @name module:data.MultiStairHandler#_nextTrial
-	 * @function
 	 * @protected
-	 * @returns {void}
 	 */
 	_nextTrial()
 	{
@@ -453,7 +455,6 @@ export class MultiStairHandler extends TrialHandler
  *
  * @enum {Symbol}
  * @readonly
- * @public
  */
 MultiStairHandler.StaircaseType = {
 	/**
@@ -472,7 +473,6 @@ MultiStairHandler.StaircaseType = {
  *
  * @enum {Symbol}
  * @readonly
- * @public
  */
 MultiStairHandler.StaircaseStatus = {
 	/**
@@ -492,19 +492,23 @@ MultiStairHandler.StaircaseStatus = {
 
 
 
+    
+
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/data_QuestHandler.js.html b/docs/data_QuestHandler.js.html index 878d5a9..56a736f 100644 --- a/docs/data_QuestHandler.js.html +++ b/docs/data_QuestHandler.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: data/QuestHandler.js - - - + data/QuestHandler.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: data/QuestHandler.js

+ + + + +
+ +

data/QuestHandler.js

+ @@ -26,13 +50,12 @@
- 
/** @module data */
-/**
+            
/**
  * Quest Trial Handler
  *
  * @author Alain Pitiot & Thomas Pronk
- * @version 2021.2.0
- * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org)
+ * @version 2022.2.3
+ * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org)
  * @license Distributed under the terms of the MIT License
  */
 
@@ -43,31 +66,29 @@ import {TrialHandler} from "./TrialHandler.js";
  * <p>A Trial Handler that implements the Quest algorithm for quick measurement of
     psychophysical thresholds. QuestHandler relies on the [jsQuest]{@link https://github.com/kurokida/jsQUEST} library, a port of Prof Dennis Pelli's QUEST algorithm by [Daiichiro Kuroki]{@link https://github.com/kurokida}.</p>
  *
- * @class module.data.QuestHandler
  * @extends TrialHandler
- * @param {Object} options - the handler options
- * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
- * @param {string} options.varName - the name of the variable / intensity / contrast / threshold manipulated by QUEST
- * @param {number} options.startVal - initial guess for the threshold
- * @param {number} options.startValSd - standard deviation of the initial guess
- * @param {number} options.minVal - minimum value for the threshold
- * @param {number} options.maxVal - maximum value for the threshold
- * @param {number} [options.pThreshold=0.82] - threshold criterion expressed as probability of getting a correct response
- * @param {number} options.nTrials - maximum number of trials
- * @param {number} options.stopInterval - minimum [5%, 95%] confidence interval required for the loop to stop
- * @param {module:data.QuestHandler.Method} options.method - the QUEST method
- * @param {number} [options.beta=3.5] - steepness of the QUEST psychometric function
- * @param {number} [options.delta=0.01] - fraction of trials with blind responses
- * @param {number} [options.gamma=0.5] - fraction of trails that would generate a correct response when the threshold is infinitely small
- * @param {number} [options.grain=0.01] - quantization of the internal table
- * @param {string} options.name - name of the handler
- * @param {boolean} [options.autoLog= false] - whether or not to log
  */
 export class QuestHandler extends TrialHandler
 {
 	/**
-	 * @constructor
-	 * @public
+	 * @memberof module:data
+	 * @param {Object} options - the handler options
+	 * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
+	 * @param {string} options.varName - the name of the variable / intensity / contrast / threshold manipulated by QUEST
+	 * @param {number} options.startVal - initial guess for the threshold
+	 * @param {number} options.startValSd - standard deviation of the initial guess
+	 * @param {number} options.minVal - minimum value for the threshold
+	 * @param {number} options.maxVal - maximum value for the threshold
+	 * @param {number} [options.pThreshold=0.82] - threshold criterion expressed as probability of getting a correct response
+	 * @param {number} options.nTrials - maximum number of trials
+	 * @param {number} options.stopInterval - minimum [5%, 95%] confidence interval required for the loop to stop
+	 * @param {QuestHandler.Method} options.method - the QUEST method
+	 * @param {number} [options.beta=3.5] - steepness of the QUEST psychometric function
+	 * @param {number} [options.delta=0.01] - fraction of trials with blind responses
+	 * @param {number} [options.gamma=0.5] - fraction of trails that would generate a correct response when the threshold is infinitely small
+	 * @param {number} [options.grain=0.01] - quantization of the internal table
+	 * @param {string} options.name - name of the handler
+	 * @param {boolean} [options.autoLog= false] - whether or not to log
 	 */
 	constructor({
 		psychoJS,
@@ -141,15 +162,11 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Add a response and update the PDF.
 	 *
-	 * @name module:data.QuestHandler#addResponse
-	 * @function
-	 * @public
 	 * @param{number} response	- the response to the trial, must be either 0 (incorrect or
 	 * non-detected) or 1 (correct or detected)
 	 * @param{number | undefined} value - optional intensity / contrast / threshold
 	 * @param{boolean} [doAddData = true] - whether or not to add the response as data to the
 	 * 	experiment
-	 * @returns {void}
 	 */
 	addResponse(response, value, doAddData = true)
 	{
@@ -191,9 +208,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Simulate a response.
 	 *
-	 * @name module:data.QuestHandler#simulate
-	 * @function
-	 * @public
 	 * @param{number} trueValue - the true, known value of the threshold / contrast / intensity
 	 * @returns{number} the simulated response, 0 or 1
 	 */
@@ -212,9 +226,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get the mean of the Quest posterior PDF.
 	 *
-	 * @name module:data.QuestHandler#mean
-	 * @function
-	 * @public
 	 * @returns {number} the mean
 	 */
 	mean()
@@ -225,9 +236,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get the standard deviation of the Quest posterior PDF.
 	 *
-	 * @name module:data.QuestHandler#sd
-	 * @function
-	 * @public
 	 * @returns {number} the standard deviation
 	 */
 	sd()
@@ -238,9 +246,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get the mode of the Quest posterior PDF.
 	 *
-	 * @name module:data.QuestHandler#mode
-	 * @function
-	 * @public
 	 * @returns {number} the mode
 	 */
 	mode()
@@ -252,9 +257,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get the standard deviation of the Quest posterior PDF.
 	 *
-	 * @name module:data.QuestHandler#quantile
-	 * @function
-	 * @public
 	 * @param{number} quantileOrder the quantile order
 	 * @returns {number} the quantile
 	 */
@@ -266,9 +268,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get the current value of the variable / contrast / threshold.
 	 *
-	 * @name module:data.QuestHandler#getQuestValue
-	 * @function
-	 * @public
 	 * @returns {number} the current QUEST value for the variable / contrast / threshold
 	 */
 	getQuestValue()
@@ -281,9 +280,6 @@ export class QuestHandler extends TrialHandler
 	 *
 	 * <p>This is the getter associated to getQuestValue.</p>
 	 *
-	 * @name module:data.MultiStairHandler#intensity
-	 * @function
-	 * @public
 	 * @returns {number} the intensity of the current staircase, or undefined if the trial has ended
 	 */
 	get intensity()
@@ -294,9 +290,6 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Get an estimate of the 5%-95% confidence interval (CI).
 	 *
-	 * @name module:data.QuestHandler#confInterval
-	 * @function
-	 * @public
 	 * @param{boolean} [getDifference=false] - if true, return the width of the CI instead of the CI
 	 * @returns{number[] | number} the 5%-95% CI or the width of the CI
 	 */
@@ -320,10 +313,7 @@ export class QuestHandler extends TrialHandler
 	/**
 	 * Setup the JS Quest object.
 	 *
-	 * @name module:data.QuestHandler#_setupJsQuest
-	 * @function
 	 * @protected
-	 * @returns {void}
 	 */
 	_setupJsQuest()
 	{
@@ -341,10 +331,7 @@ export class QuestHandler extends TrialHandler
 	 * Estimate the next value of the QUEST variable, based on the current value
 	 * and on the selected QUEST method.
 	 *
-	 * @name module:data.QuestHandler#_estimateQuestValue
-	 * @function
 	 * @protected
-	 * @returns {void}
 	 */
 	_estimateQuestValue()
 	{
@@ -415,7 +402,6 @@ export class QuestHandler extends TrialHandler
  *
  * @enum {Symbol}
  * @readonly
- * @public
  */
 QuestHandler.Method = {
 	/**
@@ -440,19 +426,23 @@ QuestHandler.Method = {
 
 
 
+    
+
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/data_Shelf.js.html b/docs/data_Shelf.js.html index 09e6c3e..0d58bac 100644 --- a/docs/data_Shelf.js.html +++ b/docs/data_Shelf.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: data/Shelf.js - - - + data/Shelf.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: data/Shelf.js

+ + + + +
+ +

data/Shelf.js

+ @@ -26,12 +50,12 @@
- 
/** @module data */
-/**
+            
/**
  * Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the
- * server, and be accessed and manipulated in a concurrent fashion.
+ * server, and can be accessed and manipulated in a concurrent fashion.
  *
  * @author Alain Pitiot
+ * @version 2021.2.3
  * @copyright (c) 2022 Open Science Tools Ltd. (https://opensciencetools.org)
  * @license Distributed under the terms of the MIT License
  */
@@ -44,27 +68,25 @@ import {Scheduler} from "../util/Scheduler.js";
 
 /**
  * <p>Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the
- * server, and be accessed and manipulated in a concurrent fashion.</p>
+ * server, and can be accessed and manipulated in a concurrent fashion.</p>
  *
- * <p></p>
- *
- * @name module:data.Shelf
- * @class
  * @extends PsychObject
- * @param {Object} options
- * @param {module:core.PsychoJS} options.psychoJS 	the PsychoJS instance
- * @param {boolean} [options.autoLog= false] 				whether to log
  */
 export class Shelf extends PsychObject
 {
 	/**
 	 * Maximum number of components in a key
-	 * @name module:data.Shelf.#MAX_KEY_LENGTH
 	 * @type {number}
 	 * @note this value should mirror that on the server, i.e. the server also checks that the key is valid
 	 */
 	static #MAX_KEY_LENGTH = 10;
 
+	/**
+	 * @memberOf module:data
+	 * @param {Object} options
+	 * @param {module:core.PsychoJS} options.psychoJS 	the PsychoJS instance
+	 * @param {boolean} [options.autoLog= false] 				whether to log
+	 */
 	constructor({psychoJS, autoLog = false } = {})
 	{
 		super(psychoJS);
@@ -84,9 +106,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a record of type BOOLEAN associated with the given key.
 	 *
-	 * @name module:data.Shelf#getBooleanValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key					 	key as an array of key components
 	 * @param {boolean} options.defaultValue		the default value returned if no record with the given key exists
@@ -103,9 +122,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set the value of a record of type BOOLEAN associated with the given key.
 	 *
-	 * @name module:data.Shelf#setBooleanValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 	key as an array of key components
 	 * @param {boolean} options.value 		the new value
@@ -136,9 +152,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Flip the value of a record of type BOOLEAN associated with the given key.
 	 *
-	 * @name module:data.Shelf#flipBooleanValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @return {Promise<boolean>}				the new, flipped, value
@@ -157,9 +170,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a record of type INTEGER associated with the given key.
 	 *
-	 * @name module:data.Shelf#getIntegerValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 			key as an array of key components
 	 * @param {number} options.defaultValue		the default value returned if no record with the given key
@@ -176,9 +186,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set the value of a record of type INTEGER associated with the given key.
 	 *
-	 * @name module:data.Shelf#setIntegerValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @param {number} options.value 		the new value
@@ -209,9 +216,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Add a delta to  the value of a record of type INTEGER associated with the given key.
 	 *
-	 * @name module:data.Shelf#addIntegerValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 	key as an array of key components
 	 * @param {number} options.delta 		the delta, positive or negative, to add to the value
@@ -242,9 +246,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a record of type TEXT associated with the given key.
 	 *
-	 * @name module:data.Shelf#getTextValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key					 	key as an array of key components
 	 * @param {string} options.defaultValue		the default value returned if no record with the given key exists on
@@ -261,9 +262,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set the value of a record of type TEXT associated with the given key.
 	 *
-	 * @name module:data.Shelf#setTextValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 	key as an array of key components
 	 * @param {string} options.value 			the new value
@@ -294,9 +292,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a record of type LIST associated with the given key.
 	 *
-	 * @name module:data.Shelf#getListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key					 			key as an array of key components
 	 * @param {Array.<*>} options.defaultValue		the default value returned if no record with the given key exists on
@@ -313,9 +308,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set the value of a record of type LIST associated with the given key.
 	 *
-	 * @name module:data.Shelf#setListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 		key as an array of key components
 	 * @param {Array.<*>} options.value 	the new value
@@ -346,9 +338,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Append an element, or a list of elements, to the value of a record of type LIST associated with the given key.
 	 *
-	 * @name module:data.Shelf#appendListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @param {*} options.elements 		the element or list of elements to be appended
@@ -370,9 +359,6 @@ export class Shelf extends PsychObject
 	 * Pop an element, at the given index, from the value of a record of type LIST associated
 	 * with the given key.
 	 *
-	 * @name module:data.Shelf#popListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key						key as an array of key components
 	 * @param {number} [options.index = -1] 	the index of the element to be popped
@@ -393,9 +379,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Empty the value of a record of type LIST associated with the given key.
 	 *
-	 * @name module:data.Shelf#clearListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @return {Promise<Array.<*>>}		the new, empty value, i.e. []
@@ -414,9 +397,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Shuffle the elements of the value of a record of type LIST associated with the given key.
 	 *
-	 * @name module:data.Shelf#shuffleListValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @return {Promise<Array.<*>>}		the new, shuffled value
@@ -436,9 +416,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the names of the fields in the dictionary record associated with the given key.
 	 *
-	 * @name module:data.Shelf#getDictionaryFieldNames
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		key as an array of key components
 	 * @return {Promise<string[]>}			the list of field names
@@ -453,9 +430,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a given field in the dictionary record associated with the given key.
 	 *
-	 * @name module:data.Shelf#getDictionaryFieldValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key					 	key as an array of key components
 	 * @param {string} options.fieldName				the name of the field
@@ -473,9 +447,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set a field in the dictionary record associated to the given key.
 	 *
-	 * @name module:data.Shelf#setDictionaryFieldValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key					key as an array of key components
 	 * @param {string} options.fieldName			the name of the field
@@ -498,9 +469,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the value of a record of type DICTIONARY associated with the given key.
 	 *
-	 * @name module:data.Shelf#getDictionaryValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key		 									key as an array of key components
 	 * @param {Object.<string, *>} options.defaultValue		the default value returned if no record with the given key
@@ -517,9 +485,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Set the value of a record of type DICTIONARY associated with the given key.
 	 *
-	 * @name module:data.Shelf#setDictionaryValue
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} options.key							key as an array of key components
 	 * @param {Object.<string, *>} options.value 	the new value
@@ -551,9 +516,6 @@ export class Shelf extends PsychObject
 	 * Schedulable component that will block the experiment until the counter associated with the given key
 	 * has been incremented by the given amount.
 	 *
-	 * @name module:data.Shelf#incrementComponent
-	 * @function
-	 * @public
 	 * @param key
 	 * @param increment
 	 * @param callback
@@ -604,15 +566,14 @@ export class Shelf extends PsychObject
 	/**
 	 * Get the name of a group, using a counterbalanced design.
 	 *
-	 * @name module:data.Shelf#counterBalanceSelect
-	 * @function
-	 * @public
-	 * @param {string[]} key						key as an array of key components
-	 * @param {string[]} groups				the names of the groups
-	 * @param {number[]} groupSizes	the size of the groups
-	 * @return {Promise<any>}
+	 * @param {Object} options
+	 * @param {string[]} options.key					key as an array of key components
+	 * @param {string[]} options.groups				the names of the groups
+	 * @param {number[]} options.groupSizes		the size of the groups
+	 * @return {Promise<{string, boolean}>}		an object with the name of the selected group and whether all groups
+	 * 	have been depleted
 	 */
-	async counterBalanceSelect(key, groups, groupSizes)
+	async counterBalanceSelect({key, groups, groupSizes} = {})
 	{
 		const response = {
 			origin: 'Shelf.counterBalanceSelect',
@@ -625,7 +586,6 @@ export class Shelf extends PsychObject
 			this._checkKey(key);
 
 			// prepare the request:
-			// const componentList = key.reduce((list, component) => list + '+' + component, '');
 			const url = `${this._psychoJS.config.pavlovia.URL}/api/v2/shelf/${this._psychoJS.config.session.token}/counterbalance`;
 			const data = {
 				key,
@@ -634,7 +594,7 @@ export class Shelf extends PsychObject
 			};
 
 			// query the server:
-			const response = await fetch(url, {
+			const putResponse = await fetch(url, {
 				method: 'PUT',
 				mode: 'cors',
 				cache: 'no-cache',
@@ -648,16 +608,19 @@ export class Shelf extends PsychObject
 			});
 
 			// convert the response to json:
-			const document = await response.json();
+			const document = await putResponse.json();
 
-			if (response.status !== 200)
+			if (putResponse.status !== 200)
 			{
 				throw ('error' in document) ? document.error : document;
 			}
 
 			// return the updated value:
 			this._status = Shelf.Status.READY;
-			return [ document.group, document.finished ];
+			return {
+				group: document.group,
+				finished: document.finished
+			};
 		}
 		catch (error)
 		{
@@ -672,9 +635,6 @@ export class Shelf extends PsychObject
 	 *
 	 * <p>This is a generic method, typically called from the Shelf helper methods, e.g. setBinaryValue.</p>
 	 *
-	 * @name module:data.Shelf#_updateValue
-	 * @function
-	 * @protected
 	 * @param {string[]} key					 	key as an array of key components
 	 * @param {Shelf.Type} type 				the type of the record associated with the given key
 	 * @param {*} update 							the desired update
@@ -703,7 +663,7 @@ export class Shelf extends PsychObject
 			};
 
 			// query the server:
-			const response = await fetch(url, {
+			const postResponse = await fetch(url, {
 				method: 'POST',
 				mode: 'cors',
 				cache: 'no-cache',
@@ -717,9 +677,9 @@ export class Shelf extends PsychObject
 			});
 
 			// convert the response to json:
-			const document = await response.json();
+			const document = await postResponse.json();
 
-			if (response.status !== 200)
+			if (postResponse.status !== 200)
 			{
 				throw ('error' in document) ? document.error : document;
 			}
@@ -740,9 +700,6 @@ export class Shelf extends PsychObject
 	 *
 	 * <p>This is a generic method, typically called from the Shelf helper methods, e.g. getBinaryValue.</p>
 	 *
-	 * @name module:data.Shelf#_getValue
-	 * @function
-	 * @protected
 	 * @param {string[]} key					 	key as an array of key components
 	 * @param {Shelf.Type} type 				the type of the record associated with the given key
 	 * @param {Object} [options] 			the options, e.g. the default value returned if no record with the
@@ -782,7 +739,7 @@ export class Shelf extends PsychObject
 			}
 
 			// query the server:
-			const response = await fetch(url, {
+			const putResponse = await fetch(url, {
 				method: 'PUT',
 				mode: 'cors',
 				cache: 'no-cache',
@@ -795,9 +752,9 @@ export class Shelf extends PsychObject
 				body: JSON.stringify(data)
 			});
 
-			const document = await response.json();
+			const document = await putResponse.json();
 
-			if (response.status !== 200)
+			if (putResponse.status !== 200)
 			{
 				throw ('error' in document) ? document.error : document;
 			}
@@ -818,11 +775,8 @@ export class Shelf extends PsychObject
 	 *
 	 * <p>Since all Shelf methods call _checkAvailability, we also use it as a means to throttle those calls.</p>
 	 *
-	 * @name module:data.Shelf#_checkAvailability
-	 * @function
-	 * @public
-	 * @param {string} [methodName=""] 	name of the method requiring a check
-	 * @throws {Object.<string, *>} 				exception if it is not possible to run the given shelf command
+	 * @param {string} [methodName=""] - name of the method requiring a check
+	 * @throws {Object.<string, *>} exception if it is not possible to run the given shelf command
 	 */
 	_checkAvailability(methodName = "")
 	{
@@ -871,9 +825,6 @@ export class Shelf extends PsychObject
 	/**
 	 * Check the validity of the key.
 	 *
-	 * @name module:data.Shelf#_checkKey
-	 * @function
-	 * @public
 	 * @param {object} key 							key whose validity is to be checked
 	 * @throws {Object.<string, *>} 	exception if the key is invalid
 	 */
@@ -898,10 +849,8 @@ export class Shelf extends PsychObject
 /**
  * Shelf status
  *
- * @name module:data.Shelf#Status
  * @enum {Symbol}
  * @readonly
- * @public
  */
 Shelf.Status = {
 	/**
@@ -925,7 +874,6 @@ Shelf.Status = {
  *
  * @enum {Symbol}
  * @readonly
- * @public
  */
 Shelf.Type = {
 	INTEGER: Symbol.for('INTEGER'),
@@ -941,19 +889,23 @@ Shelf.Type = {
 
 
 
+    
+
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/data_TrialHandler.js.html b/docs/data_TrialHandler.js.html index 8767079..df179b4 100644 --- a/docs/data_TrialHandler.js.html +++ b/docs/data_TrialHandler.js.html @@ -1,23 +1,47 @@ + - JSDoc: Source: data/TrialHandler.js - - - + data/TrialHandler.js - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Source: data/TrialHandler.js

+ + + + +
+ +

data/TrialHandler.js

+ @@ -32,8 +56,8 @@ * * @author Alain Pitiot * @author Hiroyuki Sogo & Sotiri Bakagiannis - better support for BOM and accented characters - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -45,25 +69,12 @@ import * as util from "../util/Util.js"; /** * <p>A Trial Handler handles the importing and sequencing of conditions.</p> * - * @class * @extends PsychObject - * @param {Object} options - the handler options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {Array.<Object> | String} [options.trialList= [undefined] ] - if it is a string, we treat it as the name of a condition resource - * @param {number} options.nReps - number of repetitions - * @param {module:data.TrialHandler.Method} options.method - the trial method - * @param {Object} options.extraInfo - additional information to be stored alongside the trial data, e.g. session ID, participant ID, etc. - * @param {number} options.seed - seed for the random number generator - * @param {boolean} [options.autoLog= false] - whether or not to log */ export class TrialHandler extends PsychObject { /** * Getter for experimentHandler. - * - * @name module:core.Window#experimentHandler - * @function - * @public */ get experimentHandler() { @@ -72,10 +83,6 @@ export class TrialHandler extends PsychObject /** * Setter for experimentHandler. - * - * @name module:core.Window#experimentHandler - * @function - * @public */ set experimentHandler(exp) { @@ -83,8 +90,14 @@ export class TrialHandler extends PsychObject } /** - * @constructor - * @public + * @param {Object} options - the handler options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {Array.<Object> | String} [options.trialList= [undefined] ] - if it is a string, we treat it as the name of a condition resource + * @param {number} options.nReps - number of repetitions + * @param {module:data.TrialHandler.Method} options.method - the trial method + * @param {Object} options.extraInfo - additional information to be stored alongside the trial data, e.g. session ID, participant ID, etc. + * @param {number} options.seed - seed for the random number generator + * @param {boolean} [options.autoLog= false] - whether or not to log * * @todo extraInfo is not taken into account, we use the expInfo of the ExperimentHandler instead */ @@ -251,7 +264,6 @@ export class TrialHandler extends PsychObject * * <p>This is typically used in the LoopBegin function, in order to capture the current state of a TrialHandler</p> * - * @public * @return {Snapshot} - a snapshot of the current internal state. */ getSnapshot() @@ -324,8 +336,6 @@ export class TrialHandler extends PsychObject /** * Set the internal state of the snapshot's trial handler from the snapshot. * - * @public - * @static * @param {Snapshot} snapshot - the snapshot from which to update the current internal state of the * snapshot's trial handler */ @@ -393,7 +403,6 @@ export class TrialHandler extends PsychObject /** * Get the trial index. * - * @public * @return {number} the current trial index */ getTrialIndex() @@ -417,7 +426,6 @@ export class TrialHandler extends PsychObject * <p>Note: we assume that all trials in the trialList share the same attributes * and consequently consider only the attributes of the first trial.</p> * - * @public * @return {Array.string} the attributes */ getAttributes() @@ -439,7 +447,6 @@ export class TrialHandler extends PsychObject /** * Get the current trial. * - * @public * @return {Object} the current trial */ getCurrentTrial() @@ -466,7 +473,6 @@ export class TrialHandler extends PsychObject /** * Get the nth future or past trial, without advancing through the trial list. * - * @public * @param {number} [n = 1] - increment * @return {Object|undefined} the future trial (if n is positive) or past trial (if n is negative) * or undefined if attempting to go beyond the last trial. @@ -485,7 +491,6 @@ export class TrialHandler extends PsychObject * Get the nth previous trial. * <p> Note: this is useful for comparisons in n-back tasks.</p> * - * @public * @param {number} [n = -1] - increment * @return {Object|undefined} the past trial or undefined if attempting to go prior to the first trial. */ @@ -497,7 +502,6 @@ export class TrialHandler extends PsychObject /** * Add a key/value pair to data about the current trial held by the experiment handler * - * @public * @param {Object} key - the key * @param {Object} value - the value */ @@ -536,8 +540,6 @@ export class TrialHandler extends PsychObject * '5:' * '-5:-2, 9, 11:5:22' * - * @public - * @static * @param {module:core.ServerManager} serverManager - the server manager * @param {String} resourceName - the name of the resource containing the list of conditions, which must have been registered with the server manager. * @param {Object} [selection = null] - the selection @@ -645,7 +647,6 @@ export class TrialHandler extends PsychObject /** * Prepare the trial list. * - * @function * @protected * @returns {void} */ @@ -683,7 +684,7 @@ export class TrialHandler extends PsychObject } } - /* + /** * Prepare the sequence of trials. * * <p>The returned sequence is a matrix (an array of arrays) of trial indices @@ -708,7 +709,7 @@ export class TrialHandler extends PsychObject * </p> * * @protected - */ + **/ _prepareSequence() { const response = { @@ -766,7 +767,6 @@ export class TrialHandler extends PsychObject * * @enum {Symbol} * @readonly - * @public */ TrialHandler.Method = { /** @@ -796,19 +796,23 @@ TrialHandler.Method = { + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + diff --git a/docs/fonts/Montserrat/Montserrat-Bold.eot b/docs/fonts/Montserrat/Montserrat-Bold.eot new file mode 100644 index 0000000..f2970bb Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Bold.eot differ diff --git a/docs/fonts/Montserrat/Montserrat-Bold.ttf b/docs/fonts/Montserrat/Montserrat-Bold.ttf new file mode 100644 index 0000000..3bfd79b Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Bold.ttf differ diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff b/docs/fonts/Montserrat/Montserrat-Bold.woff new file mode 100644 index 0000000..9260765 Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Bold.woff differ diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff2 b/docs/fonts/Montserrat/Montserrat-Bold.woff2 new file mode 100644 index 0000000..d9940cd Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Bold.woff2 differ diff --git a/docs/fonts/Montserrat/Montserrat-Regular.eot b/docs/fonts/Montserrat/Montserrat-Regular.eot new file mode 100644 index 0000000..735d12b Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Regular.eot differ diff --git a/docs/fonts/Montserrat/Montserrat-Regular.ttf b/docs/fonts/Montserrat/Montserrat-Regular.ttf new file mode 100644 index 0000000..5da852a Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Regular.ttf differ diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff b/docs/fonts/Montserrat/Montserrat-Regular.woff new file mode 100644 index 0000000..bf91832 Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Regular.woff differ diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff2 b/docs/fonts/Montserrat/Montserrat-Regular.woff2 new file mode 100644 index 0000000..72d13c6 Binary files /dev/null and b/docs/fonts/Montserrat/Montserrat-Regular.woff2 differ diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot deleted file mode 100644 index 5d20d91..0000000 Binary files a/docs/fonts/OpenSans-Bold-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg deleted file mode 100644 index 3ed7be4..0000000 --- a/docs/fonts/OpenSans-Bold-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff deleted file mode 100644 index 1205787..0000000 Binary files a/docs/fonts/OpenSans-Bold-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot deleted file mode 100644 index 1f639a1..0000000 Binary files a/docs/fonts/OpenSans-BoldItalic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg deleted file mode 100644 index 6a2607b..0000000 --- a/docs/fonts/OpenSans-BoldItalic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff deleted file mode 100644 index ed760c0..0000000 Binary files a/docs/fonts/OpenSans-BoldItalic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot deleted file mode 100644 index 0c8a0ae..0000000 Binary files a/docs/fonts/OpenSans-Italic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg deleted file mode 100644 index e1075dc..0000000 --- a/docs/fonts/OpenSans-Italic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff deleted file mode 100644 index ff652e6..0000000 Binary files a/docs/fonts/OpenSans-Italic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot deleted file mode 100644 index 1486840..0000000 Binary files a/docs/fonts/OpenSans-Light-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg deleted file mode 100644 index 11a472c..0000000 --- a/docs/fonts/OpenSans-Light-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff deleted file mode 100644 index e786074..0000000 Binary files a/docs/fonts/OpenSans-Light-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot deleted file mode 100644 index 8f44592..0000000 Binary files a/docs/fonts/OpenSans-LightItalic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg deleted file mode 100644 index 431d7e3..0000000 --- a/docs/fonts/OpenSans-LightItalic-webfont.svg +++ /dev/null @@ -1,1835 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff deleted file mode 100644 index 43e8b9e..0000000 Binary files a/docs/fonts/OpenSans-LightItalic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot deleted file mode 100644 index 6bbc3cf..0000000 Binary files a/docs/fonts/OpenSans-Regular-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg deleted file mode 100644 index 25a3952..0000000 --- a/docs/fonts/OpenSans-Regular-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff deleted file mode 100644 index e231183..0000000 Binary files a/docs/fonts/OpenSans-Regular-webfont.woff and /dev/null differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot new file mode 100644 index 0000000..0f24510 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg new file mode 100644 index 0000000..5384f98 --- /dev/null +++ b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg @@ -0,0 +1,978 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf new file mode 100644 index 0000000..e6c158c Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff new file mode 100644 index 0000000..d0a1c29 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 new file mode 100644 index 0000000..d286974 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot new file mode 100644 index 0000000..b420448 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg new file mode 100644 index 0000000..dee0949 --- /dev/null +++ b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg @@ -0,0 +1,1049 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf new file mode 100644 index 0000000..4d56c33 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff new file mode 100644 index 0000000..4681019 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff differ diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 new file mode 100644 index 0000000..8ddcae3 Binary files /dev/null and b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 differ diff --git a/docs/hardware_Camera.js.html b/docs/hardware_Camera.js.html new file mode 100644 index 0000000..917b8f8 --- /dev/null +++ b/docs/hardware_Camera.js.html @@ -0,0 +1,724 @@ + + + + + + hardware/Camera.js - PsychoJS API + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

hardware/Camera.js

+ + + + + + + +
+
+ 
/** **/
+/**
+ * Manager handling the recording of video signal.
+ *
+ * @author Alain Pitiot
+ * @version 2022.2.0
+ * @copyright (c) 2022 Open Science Tools Ltd. (https://opensciencetools.org)
+ * @license Distributed under the terms of the MIT License
+ */
+
+import {Clock} from "../util/Clock.js";
+import {PsychObject} from "../util/PsychObject.js";
+import {PsychoJS} from "../core/PsychoJS.js";
+import * as util from "../util/Util.js";
+import {ExperimentHandler} from "../data/ExperimentHandler.js";
+// import {VideoClip} from "./VideoClip";
+
+
+/**
+ * <p>This manager handles the recording of video signal.</p>
+ *
+ * @name module:hardware.Camera
+ * @class
+ * @param {Object} options
+ * @param {module:core.Window} options.win - the associated Window
+ * @param {string} [options.format='video/webm;codecs=vp9'] the video format
+ * @param {Clock} [options.clock= undefined] - an optional clock
+ * @param {boolean} [options.autoLog= false] - whether or not to log
+ *
+ * @todo add video constraints as parameter
+ */
+export class Camera extends PsychObject
+{
+	constructor({win, name, format, clock, autoLog} = {})
+	{
+		super(win._psychoJS);
+
+		this._addAttribute("win", win, undefined);
+		this._addAttribute("name", name, "camera");
+		this._addAttribute("format", format, "video/webm;codecs=vp9", this._onChange);
+		this._addAttribute("clock", clock, new Clock());
+		this._addAttribute("autoLog", autoLog, false);
+		this._addAttribute("status", PsychoJS.Status.NOT_STARTED);
+
+		this._stream = null;
+		this._recorder = null;
+
+		if (this._autoLog)
+		{
+			this._psychoJS.experimentLogger.exp(`Created ${this.name} = ${this.toString()}`);
+		}
+	}
+
+	/**
+	 * Prompt the user for permission to use the camera on their device.
+	 *
+	 * @name module:hardware.Camera#authorize
+	 * @function
+	 * @public
+	 * @param {boolean} [showDialog=false] - whether to open a dialog box to inform the
+	 * 	participant to wait for the camera to be initialised
+	 * @param {string} [dialogMsg] - the dialog message
+	 * @returns {boolean} whether or not the camera is ready to record
+	 */
+	async authorize(showDialog = false, dialogMsg = undefined)
+	{
+		const response = {
+			origin: "Camera.authorize",
+			context: "when authorizing access to the device's camera"
+		};
+
+		// open pop-up dialog, if required:
+		if (showDialog)
+		{
+			dialogMsg ??= "Please wait a few moments while the camera initialises. You may need to grant permission to your browser to use the camera.";
+			this.psychoJS.gui.dialog({
+				warning: dialogMsg,
+				showOK: false,
+			});
+		}
+
+		try
+		{
+			// prompt for permission and get a MediaStream:
+			// TODO use size constraints [https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia]
+			this._stream = await navigator.mediaDevices.getUserMedia({
+				video: true
+			});
+		}
+		catch (error)
+		{
+			// close the dialog, if need be:
+			if (showDialog)
+			{
+				this.psychoJS.gui.closeDialog();
+			}
+
+			this._status = PsychoJS.Status.ERROR;
+			throw {...response, error};
+		}
+
+		// close the dialog, if need be:
+		if (showDialog)
+		{
+			this.psychoJS.gui.closeDialog();
+		}
+	}
+
+	/**
+	 * Query whether the camera is ready to record.
+	 *
+	 * @name module:hardware.Camera#isReady
+	 * @function
+	 * @public
+	 * @returns {boolean} true if the camera is ready to record, false otherwise
+	 */
+	get isReady()
+	{
+		return (this._recorder !== null);
+	}
+
+	/**
+	 * Get the underlying video stream.
+	 *
+	 * @name module:hardware.Camera#getStream
+	 * @function
+	 * @public
+	 * @returns {MediaStream} the video stream
+	 */
+	getStream()
+	{
+		return this._stream;
+	}
+
+	/**
+	 * Get a video element pointing to the Camera stream.
+	 *
+	 * @name module:hardware.Camera#getVideo
+	 * @function
+	 * @public
+	 * @returns {HTMLVideoElement} a video element
+	 */
+	getVideo()
+	{
+		// note: we need to return a new video each time, since the camera feed can be used by
+		// several stimuli and one of them might pause the feed
+
+		// create a video with the appropriate size:
+		const video = document.createElement("video");
+		this._videos.push(video);
+
+		video.width = this._streamSettings.width;
+		video.height = this._streamSettings.height;
+		video.autoplay = true;
+
+		// prevent clicking:
+		video.onclick = (mouseEvent) =>
+		{
+			mouseEvent.preventDefault();
+			return false;
+		};
+
+		// use the camera stream as source for the video:
+		video.srcObject = this._stream;
+
+		return video;
+	}
+
+	/**
+	 * Open the video stream.
+	 *
+	 * @name module:hardware.Camera#open
+	 * @function
+	 * @public
+	 */
+	open()
+	{
+		if (this._stream === null)
+		{
+			throw {
+				origin: "Camera.open",
+				context: "when opening the camera's video stream",
+				error: "access to the camera has not been authorized, or no camera could be found"
+			};
+		}
+
+		// prepare the recording:
+		this._prepareRecording();
+	}
+
+	/**
+	 * Submit a request to start the recording.
+	 *
+	 * @name module:hardware.Camera#record
+	 * @function
+	 * @public
+	 * @return {Promise} promise fulfilled when the recording actually starts
+	 */
+	record()
+	{
+		// if the camera is currently paused, a call to start resumes it
+		// with a new recording:
+		if (this._status === PsychoJS.Status.PAUSED)
+		{
+			return this.resume({clear: true});
+		}
+
+		if (this._status !== PsychoJS.Status.STARTED)
+		{
+			this._psychoJS.logger.debug("request to start video recording");
+
+			try
+			{
+				if (!this._recorder)
+				{
+					throw "the recorder has not been created yet, possibly because the participant has not given the authorisation to record video";
+				}
+
+				this._recorder.start();
+
+				// return a promise, which will be satisfied when the recording actually starts, which
+				// is also when the reset of the clock and the change of status takes place
+				const self = this;
+				return new Promise((resolve, reject) =>
+				{
+					self._startCallback = resolve;
+					self._errorCallback = reject;
+				});
+			}
+			catch (error)
+			{
+				this._psychoJS.logger.error("unable to start the video recording: " + JSON.stringify(error));
+				this._status = PsychoJS.Status.ERROR;
+
+				throw {
+					origin: "Camera.record",
+					context: "when starting the video recording for camera: " + this._name,
+					error
+				};
+			}
+
+		}
+
+	}
+
+	/**
+	 * Submit a request to stop the recording.
+	 *
+	 * @name module:hardware.Camera#stop
+	 * @function
+	 * @public
+	 * @param {Object} options
+	 * @return {Promise} promise fulfilled when the recording actually stopped, and the recorded
+	 * 	data was made available
+	 */
+	stop()
+	{
+		if (this._status === PsychoJS.Status.STARTED || this._status === PsychoJS.Status.PAUSED)
+		{
+			this._psychoJS.logger.debug("request to stop video recording");
+
+			// stop the videos:
+			for (const video of this._videos)
+			{
+				video.pause();
+			}
+
+			// note: calling the MediaRecorder.stop will first raise a dataavailable event, and then a stop event
+			// ref: https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/stop
+			this._recorder.stop();
+
+			// return a promise, which will be satisfied when the recording actually stops and the data
+			// has been made available:
+			const self = this;
+			return new Promise((resolve, reject) =>
+			{
+				self._stopCallback = resolve;
+				self._errorCallback = reject;
+			});
+		}
+	}
+
+	/**
+	 * Submit a request to pause the recording.
+	 *
+	 * @name module:hardware.Camera#pause
+	 * @function
+	 * @public
+	 * @return {Promise} promise fulfilled when the recording actually paused
+	 */
+	pause()
+	{
+		if (this._status === PsychoJS.Status.STARTED)
+		{
+			this._psychoJS.logger.debug("request to pause video recording");
+
+			try
+			{
+				if (!this._recorder)
+				{
+					throw "the recorder has not been created yet, possibly because the participant has not given the authorisation to record video";
+				}
+
+				// note: calling the pause method of the MediaRecorder raises a pause event
+				this._recorder.pause();
+
+				// return a promise, which will be satisfied when the recording actually pauses:
+				const self = this;
+				return new Promise((resolve, reject) =>
+				{
+					self._pauseCallback = resolve;
+					self._errorCallback = reject;
+				});
+			}
+			catch (error)
+			{
+				self._psychoJS.logger.error("unable to pause the video recording: " + JSON.stringify(error));
+				this._status = PsychoJS.Status.ERROR;
+
+				throw {
+					origin: "Camera.pause",
+					context: "when pausing the video recording for camera: " + this._name,
+					error
+				};
+			}
+
+		}
+	}
+
+	/**
+	 * Submit a request to resume the recording.
+	 *
+	 * <p>resume has no effect if the recording was not previously paused.</p>
+	 *
+	 * @name module:hardware.Camera#resume
+	 * @function
+	 * @param {Object} options
+	 * @param {boolean} [options.clear= false] whether or not to empty the video buffer before
+	 * 	resuming the recording
+	 * @return {Promise} promise fulfilled when the recording actually resumed
+	 */
+	resume({clear = false } = {})
+	{
+		if (this._status === PsychoJS.Status.PAUSED)
+		{
+			this._psychoJS.logger.debug("request to resume video recording");
+
+			try
+			{
+				if (!this._recorder)
+				{
+					throw "the recorder has not been created yet, possibly because the participant has not given the authorisation to record video";
+				}
+
+				// empty the audio buffer is needed:
+				if (clear)
+				{
+					this._audioBuffer = [];
+					this._videoBuffer.length = 0;
+				}
+
+				this._recorder.resume();
+
+				// return a promise, which will be satisfied when the recording actually resumes:
+				const self = this;
+				return new Promise((resolve, reject) =>
+				{
+					self._resumeCallback = resolve;
+					self._errorCallback = reject;
+				});
+			}
+			catch (error)
+			{
+				self._psychoJS.logger.error("unable to resume the video recording: " + JSON.stringify(error));
+				this._status = PsychoJS.Status.ERROR;
+
+				throw {
+					origin: "Camera.resume",
+					context: "when resuming the video recording for camera: " + this._name,
+					error
+				};
+			}
+
+		}
+	}
+
+	/**
+	 * Submit a request to flush the recording.
+	 *
+	 * @name module:hardware.Camera#flush
+	 * @function
+	 * @public
+	 * @return {Promise} promise fulfilled when the data has actually been made available
+	 */
+	flush()
+	{
+		if (this._status === PsychoJS.Status.STARTED || this._status === PsychoJS.Status.PAUSED)
+		{
+			this._psychoJS.logger.debug("request to flush video recording");
+
+			// note: calling the requestData method of the MediaRecorder will raise a
+			// dataavailable event
+			// ref: https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder/requestData
+			this._recorder.requestData();
+
+			// return a promise, which will be satisfied when the data has been made available:
+			const self = this;
+			return new Promise((resolve, reject) =>
+			{
+				self._dataAvailableCallback = resolve;
+				self._errorCallback = reject;
+			});
+		}
+	}
+
+	/**
+	 * Get the current video recording as a VideoClip in the given format.
+	 *
+	 * @name module:hardware.Camera#getRecording
+	 * @function
+	 * @public
+	 * @param {string} tag an optional tag for the video clip
+	 * @param {boolean} [flush=false] whether or not to first flush the recording
+	 */
+	async getRecording({tag, flush = false} = {})
+	{
+		// default tag: the name of this Microphone object
+		if (typeof tag === "undefined")
+		{
+			tag = this._name;
+		}
+
+		// TODO
+	}
+
+	/**
+	 * Upload the video recording to the pavlovia server.
+	 *
+	 * @name module:hardware.Camera#_upload
+	 * @function
+	 * @protected
+	 * @param {string} tag an optional tag for the video file
+	 * @param {boolean} [waitForCompletion= false] whether to wait for completion
+	 * 	before returning
+	 * @param {boolean} [showDialog=false] - whether to open a dialog box to inform the participant to wait for the data to be uploaded to the server
+	 * @param {string} [dialogMsg=""] - default message informing the participant to wait for the data to be uploaded to the server
+	 */
+	save({tag, waitForCompletion = false, showDialog = false, dialogMsg = ""} = {})
+	{
+		this._psychoJS.logger.info("[PsychoJS] Save video recording.");
+
+		// default tag: the name of this Camera object
+		if (typeof tag === "undefined")
+		{
+			tag = this._name;
+		}
+
+		// add a format-dependent video extension to the tag:
+		tag += util.extensionFromMimeType(this._format);
+
+		// if the video recording cannot be uploaded, e.g. the experiment is running locally, or
+		// if it is piloting mode, then we offer the video recording as a file for download:
+		if (this._psychoJS.getEnvironment() !== ExperimentHandler.Environment.SERVER ||
+			this._psychoJS.config.experiment.status !== "RUNNING" ||
+			this._psychoJS._serverMsg.has("__pilotToken"))
+		{
+			const videoBlob = new Blob(this._videoBuffer);
+
+			const anchor = document.createElement("a");
+			anchor.href = window.URL.createObjectURL(videoBlob);
+			anchor.download = tag;
+			document.body.appendChild(anchor);
+			anchor.click();
+			document.body.removeChild(anchor);
+
+			return;
+		}
+
+		// upload the blob:
+		const videoBlob = new Blob(this._videoBuffer);
+		return this._psychoJS.serverManager.uploadAudioVideo({
+			mediaBlob: videoBlob,
+			tag,
+			waitForCompletion,
+			showDialog,
+			dialogMsg});
+	}
+
+	/**
+	 * Close the camera stream.
+	 *
+	 * @name module:hardware.Camera#close
+	 * @function
+	 * @public
+	 * @returns {Promise<void>} promise fulfilled when the stream has stopped and is now closed
+	 */
+	async close()
+	{
+		await this.stop();
+
+		this._videos = [];
+		this._stream = null;
+		this._recorder = null;
+	}
+
+	/**
+	 * Callback for changes to the recording settings.
+	 *
+	 * <p>Changes to the settings require the recording to stop and be re-started.</p>
+	 *
+	 * @name module:hardware.Camera#_onChange
+	 * @function
+	 * @protected
+	 */
+	_onChange()
+	{
+		if (this._status === PsychoJS.Status.STARTED)
+		{
+			this.stop();
+		}
+
+		this._prepareRecording();
+
+		this.start();
+	}
+
+	/**
+	 * Prepare the recording.
+	 *
+	 * @name module:hardware.Camera#_prepareRecording
+	 * @function
+	 * @protected
+	 */
+	_prepareRecording()
+	{
+		// empty the video buffer:
+		this._videoBuffer = [];
+		this._recorder = null;
+		this._videos = [];
+
+		// check the actual width and height:
+		this._streamSettings = this._stream.getVideoTracks()[0].getSettings();
+		this._psychoJS.logger.debug(`camera stream settings: ${JSON.stringify(this._streamSettings)}`);
+
+		// check that the specified format is supported, use default if it is not:
+		let options;
+		if (typeof this._format === "string" && MediaRecorder.isTypeSupported(this._format))
+		{
+			options = { type: this._format };
+		}
+		else
+		{
+			this._psychoJS.logger.warn(`The specified video format, ${this._format}, is not supported by this browser, using the default format instead`);
+		}
+
+		// create a video recorder:
+		this._recorder = new MediaRecorder(this._stream, options);
+
+		// setup the callbacks:
+		const self = this;
+
+		// called upon Camera.start(), at which point the audio data starts being gathered
+		// into a blob:
+		this._recorder.onstart = () =>
+		{
+			self._videoBuffer = [];
+			self._videoBuffer.length = 0;
+			self._clock.reset();
+			self._status = PsychoJS.Status.STARTED;
+			self._psychoJS.logger.debug("video recording started");
+
+			// resolve the Camera.start promise:
+			if (self._startCallback)
+			{
+				self._startCallback(self._psychoJS.monotonicClock.getTime());
+			}
+		};
+
+		// called upon Camera.pause():
+		this._recorder.onpause = () =>
+		{
+			self._status = PsychoJS.Status.PAUSED;
+			self._psychoJS.logger.debug("video recording paused");
+
+			// resolve the Camera.pause promise:
+			if (self._pauseCallback)
+			{
+				self._pauseCallback(self._psychoJS.monotonicClock.getTime());
+			}
+		};
+
+		// called upon Camera.resume():
+		this._recorder.onresume = () =>
+		{
+			self._status = PsychoJS.Status.STARTED;
+			self._psychoJS.logger.debug("video recording resumed");
+
+			// resolve the Camera.resume promise:
+			if (self._resumeCallback)
+			{
+				self._resumeCallback(self._psychoJS.monotonicClock.getTime());
+			}
+		};
+
+		// called when video data is available, typically upon Camera.stop() or Camera.flush():
+		this._recorder.ondataavailable = (event) =>
+		{
+			const data = event.data;
+
+			// add data to the buffer:
+			self._videoBuffer.push(data);
+			self._psychoJS.logger.debug("video data added to the buffer");
+
+			// resolve the data available promise, if needed:
+			if (self._dataAvailableCallback)
+			{
+				self._dataAvailableCallback(self._psychoJS.monotonicClock.getTime());
+			}
+		};
+
+		// called upon Camera.stop(), after data has been made available:
+		this._recorder.onstop = () =>
+		{
+			self._psychoJS.logger.debug("video recording stopped");
+			self._status = PsychoJS.Status.STOPPED;
+
+			// resolve the Camera.stop promise:
+			if (self._stopCallback)
+			{
+				self._stopCallback(self._psychoJS.monotonicClock.getTime());
+			}
+		};
+
+		// called upon recording errors:
+		this._recorder.onerror = (event) =>
+		{
+			// TODO
+			self._psychoJS.logger.error("video recording error: " + JSON.stringify(event));
+			self._status = PsychoJS.Status.ERROR;
+		};
+	}
+
+}
+
+
+
+
+
+ + + + + + +
+ +
+ +
+ Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme. +
+ + + + + + + + + + + diff --git a/docs/index.html b/docs/index.html index 99acce7..601a1ba 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,23 +1,45 @@ + - JSDoc: Home - - - + Home - PsychoJS API + + + + + + + + + + - - + + + + - + + + + + + +
- -

Home

+ @@ -26,8 +48,9 @@ -

- +
+

+
@@ -41,14 +64,13 @@ - -
+

PsychoJS

Automated Test (short) Automated Test (full) Contributor Covenant

PsychoJS is a JavaScript library that makes it possible to run neuroscience, psychology, and psychophysics experiments in a browser. It is the online counterpart of the PsychoPy Python library.

-

You can create online experiments from the PsychoPy Builder, you can find and adapt existing experiments on pavlovia.org, or create them from scratch: the PsychoJS API is available here.

+

You can create online experiments from the PsychoPy Builder, you can find and adapt existing experiments on pavlovia.org, or create them from scratch.

PsychoJS is an open-source project. You can contribute by submitting pull requests to the PsychoJS GitHub repository, and discuss issues and current and future features on the Online category of the PsychoPy Forum.

Motivation

Many studies in behavioural sciences (e.g. psychology, neuroscience, linguistics or mental health) use computers to present stimuli and record responses in a precise manner. These studies are still typically conducted on small numbers of people in laboratory environments equipped with dedicated hardware.

@@ -75,8 +97,8 @@ taskshe hood PsychoJS relies on PixiJS to pr It is now a collaborative effort, supported by the Chan Zuckerberg Initiative (2020-2021) and Open Science Tools (2020-):

- the name of the attribute +

the name of the attribute

@@ -717,7 +791,7 @@ It is responsible for handling attributes.

- the value of the attribute +

the value of the attribute

@@ -751,12 +825,12 @@ It is responsible for handling attributes.

- false + false - whether of not to log +

whether of not to log

@@ -793,7 +867,7 @@ It is responsible for handling attributes.

- the binary operation such that the new value of the attribute is the result of the application of the operation to the current value of the attribute and attributeValue +

the binary operation such that the new value of the attribute is the result of the application of the operation to the current value of the attribute and attributeValue

@@ -827,12 +901,12 @@ It is responsible for handling attributes.

- false + false - whether or not to call the potential attribute setters when setting the value of this attribute +

whether or not to call the potential attribute setters when setting the value of this attribute

@@ -844,50 +918,6 @@ It is responsible for handling attributes.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -902,13 +932,13 @@ It is responsible for handling attributes.

- whether or not the value of that attribute has changed (false if the attribute -was not previously set) +

whether or not the value of that attribute has changed (false if the attribute +was not previously set)

-
+
Type
@@ -924,25 +954,69 @@ was not previously set) - - - -

toString() → {string}

- +

emit(name, data) → {boolean}

-
- String representation of the PsychObject. -

Note: attribute values are limited to 50 characters.

+
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Emit an event with a given name and associated data.

@@ -955,47 +1029,77 @@ was not previously set) +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String -
+ +

the name of the event

data + + +object + + + +

the data of the event

- - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
@@ -1015,12 +1119,634 @@ was not previously set)
- the representation +

true if at least one listener has been registered for that event, and false otherwise

-
+
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + +

off(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Remove the listener with the given uuid associated to the given event name.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + + + + + + + + + +

on(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Register a new listener for events with the given name emitted by this instance.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

string - the unique identifier associated with that (event, listener) pair (useful to remove the listener)

+
+ + + + + + + + + + + + +

once(name, listener)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Register a new listener for the given event name, and remove it as soon as the event has been emitted.

+
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +String + + + +

the name of the event

listener + + +module:util.EventEmitter~Listener + + + +

a listener called upon emission of the event

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+

string - the unique identifier associated with that (event, listener) pair (useful to remove the listener)

+
+ + + + + + + + + + + + +

toString() → {string}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

String representation of the PsychObject.

+

Note: attribute values are limited to 50 characters.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+

the representation

+
+ + + +
Type
@@ -1036,8 +1762,6 @@ was not previously set) - - @@ -1051,19 +1775,23 @@ was not previously set) + +
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) + Documentation generated by JSDoc 3.6.7 on Mon Aug 01 2022 09:56:49 GMT+0200 (Central European Summer Time) using the docdash theme.
- - + + + + + + + + \ No newline at end of file diff --git a/docs/module-util.Scheduler.html b/docs/module-util.Scheduler.html deleted file mode 100644 index 30d31ab..0000000 --- a/docs/module-util.Scheduler.html +++ /dev/null @@ -1,960 +0,0 @@ - - - - - JSDoc: Class: Scheduler - - - - - - - - - - -
- -

Class: Scheduler

- - - - - - -
- -
- -

- util.Scheduler(psychoJS)

- - -
- -
-
- - - - - - -

new Scheduler(psychoJS)

- - - - - - -
-

A scheduler helps run the main loop by managing scheduled functions, -called tasks, after each frame is displayed.

- -

-Tasks are either another Scheduler, or a -JavaScript functions returning one of the following codes: -

    -
  • Scheduler.Event.NEXT: Move onto the next task *without* rendering the scene first.
    • -
  • Scheduler.Event.FLIP_REPEAT: Render the scene and repeat the task.
    • -
  • Scheduler.Event.FLIP_NEXT: Render the scene and move onto the next task.
    • -
  • Scheduler.Event.QUIT: Quit the scheduler.
    • -
-

- -

It is possible to create sub-schedulers, e.g. to handle loops. -Sub-schedulers are added to a parent scheduler as a normal -task would be by calling scheduler.add(subScheduler).

- -

Conditional branching is also available: -scheduler.addConditionalBranches

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
psychoJS - - -module:core.PsychoJS - - - - the PsychoJS instance
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - -

Members

- - - -

add

- - - - -
- Schedule a new task. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

addConditional

- - - - -
- Schedule a series of task or another, based on a condition. - -

Note: the tasks are sub-schedulers.

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(readonly) Event :Symbol

- - - - -
- Events. -
- - - -
Type:
-
    -
  • - -Symbol - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

start

- - - - -
- Start this scheduler. - -

Note: tasks are run after each animation frame.

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

status

- - - - -
- Get the status of the scheduler. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(readonly) Status :Symbol

- - - - -
- Status. -
- - - -
Type:
-
    -
  • - -Symbol - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

stop

- - - - -
- Stop this scheduler. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - -

Type Definitions

- - - - - - - -

Condition() → {boolean}

- - - - - - -
- Condition evaluated when the task is run. -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -boolean - - -
-
- - - - - - - - - - - - - -

Task(argsopt)

- - - - - - -
- Task to be run by the scheduler. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
args - - -* - - - - - - <optional>
- - - - - - 		optional arguments
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- -
- Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) -
- - - - - \ No newline at end of file diff --git a/docs/module-util.html b/docs/module-util.html index 6e4d3bb..fa15676 100644 --- a/docs/module-util.html +++ b/docs/module-util.html @@ -1,23 +1,47 @@ + - JSDoc: Module: util - - - + util - PsychoJS API + + + + + + + + + + - - + + + + - -
+ + -

Module: util

+ + + + +
+ +

util

+ @@ -33,13 +57,15 @@
-
+
+ + +
-
@@ -49,35 +75,32 @@

Classes

-
Clock
+
Clock
-
Color
+
Color
-
CountdownTimer
+
CountdownTimer
-
EventEmitter
-
- -
MixinBuilder
-
- -
MonotonicClock
+
EventEmitter
PsychObject
-
Scheduler
+
MonotonicClock
+
+ +
Scheduler
- + - +

Mixins

@@ -89,6 +112,147 @@ +

Members

+ + + +

(static) mix

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Syntactic sugar for Mixins

+

This is heavily adapted from: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/

+
+ + + + + + + +
Example
+ + 
class BaseClass { ... }
+let Mixin1 = (superclass) => class extends superclass { ... }
+let Mixin2 = (superclass) => class extends superclass { ... }
+class NewClass extends mix(BaseClass).with(Mixin1, Mixin2) { ... }
+ + + + + +

(static, constant) TEXT_DIRECTION

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Enum that stores possible text directions. +Note that Arabic is the same as RTL but added here to support PsychoPy's +languageStyle enum. Arabic reshaping is handled by the browser automatically.

+
+ + + + + + + + + +

Methods

@@ -98,17 +262,59 @@ -

(static) addInfoFromUrl(info)

- -
- Add info extracted from the URL to the given dictionary. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Add info extracted from the URL to the given dictionary.

We exclude all URL parameters starting with a double underscore since those are reserved for client/server communication

@@ -121,6 +327,8 @@ since those are reserved for client/server communication

+ +
Parameters:
@@ -162,7 +370,7 @@ since those are reserved for client/server communication

- the dictionary +

the dictionary

@@ -172,52 +380,6 @@ since those are reserved for client/server communication

- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -238,18 +400,60 @@ since those are reserved for client/server communication

-

(static) average(input) → {number}

- -
- Calculate the average of the elements in the input array. -If 'input' is not an array, or if it is an empty array, then we return 0. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Calculate the average of the elements in the input array.

+

If 'input' is not an array, or if it is an empty array, then we return 0.

@@ -260,6 +464,8 @@ If 'input' is not an array, or if it is an empty array, then we return 0. + +
Parameters:
@@ -301,7 +507,7 @@ If 'input' is not an array, or if it is an empty array, then we return 0. - an array of numbers, or of objects that can be cast into a number, e.g. ['1', 2.5, 3e1] +

an array of numbers, or of objects that can be cast into a number, e.g. ['1', 2.5, 3e1]

@@ -313,50 +519,6 @@ If 'input' is not an array, or if it is an empty array, then we return 0. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -371,12 +533,12 @@ If 'input' is not an array, or if it is an empty array, then we return 0.
- the average of the elements in the array +

the average of the elements in the array

-
+
Type
@@ -392,24 +554,64 @@ If 'input' is not an array, or if it is an empty array, then we return 0. - - -

(static) count(input, value)

- -
- Count the number of elements in the input array that match the given value. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Count the number of elements in the input array that match the given value.

Note: count is able to handle NaN, null, as well as any value convertible to a JSON string.

@@ -421,6 +623,8 @@ If 'input' is not an array, or if it is an empty array, then we return 0. + +
Parameters:
@@ -462,7 +666,7 @@ If 'input' is not an array, or if it is an empty array, then we return 0. - the input array +

the input array

@@ -494,7 +698,7 @@ If 'input' is not an array, or if it is an empty array, then we return 0. - the matching value +

the matching value

@@ -506,50 +710,6 @@ If 'input' is not an array, or if it is an empty array, then we return 0. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -564,7 +724,7 @@ If 'input' is not an array, or if it is an empty array, then we return 0.
- the number of matching elements +

the number of matching elements

@@ -573,24 +733,64 @@ If 'input' is not an array, or if it is an empty array, then we return 0. - - -

(static) detectBrowser() → {string}

- -
- Detect the user's browser. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Detect the user's browser.

Note: since user agent is easily spoofed, we use a more sophisticated approach, as described here: https://stackoverflow.com/a/9851769

@@ -607,48 +807,6 @@ https://stackoverflow.com/a/9851769

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - @@ -665,13 +823,13 @@ https://stackoverflow.com/a/9851769

- the detected browser, one of 'Opera', 'Firefox', 'Safari', -'IE', 'Edge', 'EdgeChromium', 'Chrome', 'unknown' +

the detected browser, one of 'Opera', 'Firefox', 'Safari', +'IE', 'Edge', 'EdgeChromium', 'Chrome', 'unknown'

-
+
Type
@@ -687,25 +845,66 @@ https://stackoverflow.com/a/9851769

- - -

(static) extensionFromMimeType(mimeType) → {string}

- -
- Return the file extension corresponding to an audio mime type. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Return the file extension corresponding to an audio mime type. If the provided mimeType is not a string (e.g. null, undefined, an array) -or unknown, then '.dat' is returned, instead of throwing an exception. +or unknown, then '.dat' is returned, instead of throwing an exception.

@@ -716,6 +915,8 @@ or unknown, then '.dat' is returned, instead of throwing an exception. + +
Parameters:
@@ -757,7 +958,7 @@ or unknown, then '.dat' is returned, instead of throwing an exception. - the MIME type, e.g. 'audio/webm;codecs=opus' +

the MIME type, e.g. 'audio/webm;codecs=opus'

@@ -769,50 +970,6 @@ or unknown, then '.dat' is returned, instead of throwing an exception. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -827,12 +984,12 @@ or unknown, then '.dat' is returned, instead of throwing an exception.
- the corresponding file extension, e.g. '.webm' +

the corresponding file extension, e.g. '.webm'

-
+
Type
@@ -848,23 +1005,64 @@ or unknown, then '.dat' is returned, instead of throwing an exception. - - -

(static) flattenArray(array) → {Array.<Object>}

- -
- Recursively flatten an array of arrays. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Recursively flatten an array of arrays.

@@ -875,6 +1073,8 @@ or unknown, then '.dat' is returned, instead of throwing an exception. + +
Parameters:
@@ -916,7 +1116,7 @@ or unknown, then '.dat' is returned, instead of throwing an exception. - the input array of arrays +

the input array of arrays

@@ -928,50 +1128,6 @@ or unknown, then '.dat' is returned, instead of throwing an exception. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -986,12 +1142,12 @@ or unknown, then '.dat' is returned, instead of throwing an exception.
- the flatten array +

the flatten array

-
+
Type
@@ -1007,24 +1163,65 @@ or unknown, then '.dat' is returned, instead of throwing an exception. - - -

(static) getDownloadSpeed(psychoJS, nbDownloadsopt) → {number}

- -
- Get an estimate of the download speed, by repeatedly downloading an image file from a distant -server. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get an estimate of the download speed, by repeatedly downloading an image file from a distant +server.

@@ -1035,6 +1232,8 @@ server. + +
Parameters:
@@ -1092,7 +1291,7 @@ server. - the instance of PsychoJS +

the instance of PsychoJS

@@ -1126,13 +1325,13 @@ server. - 1 + 1 - the number of image downloads over which to average - the download speed +

the number of image downloads over which to average +the download speed

@@ -1144,50 +1343,6 @@ server. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1202,12 +1357,12 @@ server.
- the download speed, in megabits per second +

the download speed, in megabits per second

-
+
Type
@@ -1223,23 +1378,64 @@ server. - - -

(static) getErrorStack() → {string}

- -
- Get the error stack of the calling, exception-throwing function. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the error stack of the calling, exception-throwing function.

@@ -1254,48 +1450,6 @@ server. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - @@ -1312,12 +1466,12 @@ server.
- the error stack as a string +

the error stack as a string

-
+
Type
@@ -1333,23 +1487,64 @@ server. - - -

(static) getPositionFromObject(object, units) → {Array.<number>}

- -
- Get the position of the object, in pixel units + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the position of the object, in pixel units

@@ -1360,6 +1555,8 @@ server. + +
Parameters:
@@ -1401,7 +1598,7 @@ server. - the input object +

the input object

@@ -1424,7 +1621,7 @@ server. - the units +

the units

@@ -1436,50 +1633,6 @@ server. -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1494,12 +1647,12 @@ server.
- the position of the object, in pixel units +

the position of the object, in pixel units

-
+
Type
@@ -1515,23 +1668,64 @@ server. - - -

(static) getRequestError(jqXHR, textStatus, errorThrown)

- -
- Get the most informative error from the server response from a jquery server request. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the most informative error from the server response from a jquery server request.

@@ -1542,6 +1736,8 @@ server. + +
Parameters:
@@ -1624,52 +1820,6 @@ server. - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1690,16 +1840,59 @@ server. -

(static) getUrlParameters() → {URLSearchParams}

- -
- Get the URL parameters. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the URL parameters.

@@ -1710,49 +1903,14 @@ server. - - - - -
- +
Example
+ 
const urlParameters = util.getUrlParameters();
+for (const [key, value] of urlParameters)
+  console.log(key + ' = ' + value);
- - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
@@ -1772,12 +1930,12 @@ server.
- the iterable URLSearchParams +

the iterable URLSearchParams

-
+
Type
@@ -1793,31 +1951,64 @@ server. - -
Example
- - 
const urlParameters = util.getUrlParameters();
-for (const [key, value] of urlParameters)
-  console.log(key + ' = ' + value);
- - - -

(static) index(input, value)

- -
- Get the index in the input array of the first element that matches the given value. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get the index in the input array of the first element that matches the given value.

Note: index is able to handle NaN, null, as well as any value convertible to a JSON string.

@@ -1829,6 +2020,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -1870,7 +2063,7 @@ for (const [key, value] of urlParameters) - the input array +

the input array

@@ -1902,7 +2095,7 @@ for (const [key, value] of urlParameters) - the matching value +

the matching value

@@ -1914,50 +2107,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -1970,9 +2119,9 @@ for (const [key, value] of urlParameters) -
+
- if the input array does not contain any matching element +

if the input array does not contain any matching element

@@ -1984,7 +2133,7 @@ for (const [key, value] of urlParameters)
- the index of the first element that matches the value +

the index of the first element that matches the value

@@ -1993,23 +2142,64 @@ for (const [key, value] of urlParameters) - - -

(static) isEmpty(x) → {boolean}

- -
- Test if x is an 'empty' value. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Test if x is an 'empty' value.

@@ -2020,6 +2210,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -2061,7 +2253,7 @@ for (const [key, value] of urlParameters) - the value to test +

the value to test

@@ -2073,50 +2265,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2131,12 +2279,12 @@ for (const [key, value] of urlParameters)
- true if x is one of the following: undefined, [], [undefined] +

true if x is one of the following: undefined, [], [undefined]

-
+
Type
@@ -2152,23 +2300,64 @@ for (const [key, value] of urlParameters) - - -

(static) isInt(obj) → {boolean}

- -
- Test whether an object is either an integer or the string representation of an integer. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Test whether an object is either an integer or the string representation of an integer.

This is adapted from: https://stackoverflow.com/a/14794066

@@ -2180,6 +2369,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -2221,7 +2412,7 @@ for (const [key, value] of urlParameters) - the input object +

the input object

@@ -2233,50 +2424,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2291,12 +2438,12 @@ for (const [key, value] of urlParameters)
- whether or not the object is an integer or the string representation of an integer +

whether or not the object is an integer or the string representation of an integer

-
+
Type
@@ -2312,23 +2459,64 @@ for (const [key, value] of urlParameters) - - -

(static) isNumeric(input) → {boolean}

- -
- Check whether a value looks like a number + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check whether a value looks like a number

@@ -2339,6 +2527,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -2380,7 +2570,7 @@ for (const [key, value] of urlParameters) - Some value +

Some value

@@ -2392,50 +2582,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2450,12 +2596,12 @@ for (const [key, value] of urlParameters)
- Whether or not the value can be converted into a number +

Whether or not the value can be converted into a number

-
+
Type
@@ -2471,23 +2617,64 @@ for (const [key, value] of urlParameters) - - -

(static) IsPointInsidePolygon(point, vertices) → {boolean}

- -
- Check whether a point lies within a polygon + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Check whether a point lies within a polygon

We are using the algorithm described here: https://wrf.ecse.rpi.edu//Research/Short_Notes/pnpoly.html

@@ -2499,6 +2686,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -2540,7 +2729,7 @@ for (const [key, value] of urlParameters) - the point +

the point

@@ -2563,7 +2752,7 @@ for (const [key, value] of urlParameters) - the vertices defining the polygon +

the vertices defining the polygon

@@ -2575,50 +2764,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2633,12 +2778,12 @@ for (const [key, value] of urlParameters)
- whether or not the point lies within the polygon +

whether or not the point lies within the polygon

-
+
Type
@@ -2654,23 +2799,64 @@ for (const [key, value] of urlParameters) - - -

(static) makeUuid() → {string}

- -
- Get a Universally Unique Identifier (RFC4122 version 4) + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Get a Universally Unique Identifier (RFC4122 version 4)

See details here: https://www.ietf.org/rfc/rfc4122.txt

@@ -2686,48 +2872,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - @@ -2744,12 +2888,12 @@ for (const [key, value] of urlParameters)
- the uuid +

the uuid

-
+
Type
@@ -2765,23 +2909,64 @@ for (const [key, value] of urlParameters) - - -

(static) offerDataForDownload(filename, data, type)

- -
- Offer data as download in the browser. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Offer data as download in the browser.

@@ -2792,6 +2977,8 @@ for (const [key, value] of urlParameters) + +
Parameters:
@@ -2833,7 +3020,7 @@ for (const [key, value] of urlParameters) - the name of the file to be downloaded +

the name of the file to be downloaded

@@ -2856,7 +3043,7 @@ for (const [key, value] of urlParameters) - the data +

the data

@@ -2879,7 +3066,7 @@ for (const [key, value] of urlParameters) - the MIME type of the data, e.g. 'text/csv' or 'application/json' +

the MIME type of the data, e.g. 'text/csv' or 'application/json'

@@ -2889,52 +3076,6 @@ for (const [key, value] of urlParameters) - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -2955,16 +3096,60 @@ for (const [key, value] of urlParameters) - -

(static) promiseToTupple(promise) → {Array.<Object>}

- +

(static) pad(n, width) → {string}

-
- Convert the resulting value of a promise into a tupple. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Pad the given floating-point number with however many 0 needed at the start such that +the padded integer part of the number is of the given width.

@@ -2975,6 +3160,181 @@ for (const [key, value] of urlParameters) + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
n + +

the input floating-point number

width + +

the desired width

+ + + + + + + + + + + + + + + + +
Returns:
+ + +
+
    +
  • the padded number, whose integer part has the given width
    • +
+
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + +

(static) promiseToTupple(promise) → {Array.<Object>}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Convert the resulting value of a promise into a tupple.

+
+ + + + + + + + + + +
Parameters:
@@ -3016,7 +3376,7 @@ for (const [key, value] of urlParameters) - the promise +

the promise

@@ -3028,50 +3388,6 @@ for (const [key, value] of urlParameters) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3086,13 +3402,13 @@ for (const [key, value] of urlParameters)
- the resulting value in the format [error, return data] -where error is null if there was no error +

the resulting value in the format [error, return data] +where error is null if there was no error

-
+
Type
@@ -3108,23 +3424,64 @@ where error is null if there was no error - - -

(static) randchoice(array, randomNumberGeneratoropt) → {Array.<Object>}

- -
- Pick a random value from an array, uses `util.shuffle` to shuffle the array and returns the last value. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Pick a random value from an array, uses util.shuffle to shuffle the array and returns the last value.

@@ -3135,6 +3492,8 @@ where error is null if there was no error + +
Parameters:
@@ -3186,7 +3545,7 @@ where error is null if there was no error - the input 1-D array +

the input 1-D array

@@ -3219,7 +3578,7 @@ where error is null if there was no error - A function used to generated random numbers in the interal [0, 1). Defaults to Math.random +

A function used to generated random numbers in the interal [0, 1). Defaults to Math.random

@@ -3231,50 +3590,6 @@ where error is null if there was no error -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3289,12 +3604,12 @@ where error is null if there was no error
- a chosen value from the array +

a chosen value from the array

-
+
Type
@@ -3310,23 +3625,64 @@ where error is null if there was no error - - -

(static) randint(minopt, max) → {number}

- -
- Generates random integers a-la NumPy's in the "half-open" interval [min, max). In other words, from min inclusive to max exclusive. When max is undefined, as is the case by default, results are chosen from [0, min). An error is thrown if max is less than min. + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Generates random integers a-la NumPy's in the "half-open" interval [min, max). In other words, from min inclusive to max exclusive. When max is undefined, as is the case by default, results are chosen from [0, min). An error is thrown if max is less than min.

@@ -3337,6 +3693,8 @@ where error is null if there was no error + +
Parameters:
@@ -3393,12 +3751,12 @@ where error is null if there was no error - 0 + 0 - lowest integer to be drawn, or highest plus one if max is undefined (default) +

lowest integer to be drawn, or highest plus one if max is undefined (default)

@@ -3433,7 +3791,7 @@ where error is null if there was no error - one above the largest integer to be drawn +

one above the largest integer to be drawn

@@ -3445,50 +3803,6 @@ where error is null if there was no error -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3503,12 +3817,12 @@ where error is null if there was no error
- a random integer in the requested range (signed) +

a random integer in the requested range (signed)

-
+
Type
@@ -3524,26 +3838,65 @@ where error is null if there was no error - - -

(static) range(startopt, stop, stepopt) → {Array.<Number>}

- -
- Create a sequence of integers. -The sequence is such that the integer at index i is: start + step * i, with i >= 0 and start + step * i < stop +
+ +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Create a sequence of integers.

+

The sequence is such that the integer at index i is: start + step * i, with i >= 0 and start + step * i < stop

Note: this is a JavaScript implement of the Python range function, which explains the unusual management of arguments.

@@ -3555,6 +3908,8 @@ The sequence is such that the integer at index i is: start + step * i, with i >= + +
Parameters:
@@ -3611,12 +3966,12 @@ The sequence is such that the integer at index i is: start + step * i, with i >= - 0 + 0 - the value of start +

the value of start

@@ -3651,7 +4006,7 @@ The sequence is such that the integer at index i is: start + step * i, with i >= - the value of stop +

the value of stop

@@ -3685,12 +4040,12 @@ The sequence is such that the integer at index i is: start + step * i, with i >= - 1 + 1 - the value of step +

the value of step

@@ -3702,50 +4057,6 @@ The sequence is such that the integer at index i is: start + step * i, with i >= -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - @@ -3760,12 +4071,12 @@ The sequence is such that the integer at index i is: start + step * i, with i >=
- the range as an array of numbers +

the range as an array of numbers

-
+
Type
@@ -3781,25 +4092,72 @@ The sequence is such that the integer at index i is: start + step * i, with i >= - - -

(static) round(input, places) → {number}

- -
- Round to a certain number of decimal places. -This is the Crib Sheet provided solution, but please note that as of 2020 the most popular SO answer is different. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
See:
+
+ +
+ + + +
+ + + + + +
+

Round to a certain number of decimal places.

+

This is the Crib Sheet provided solution, but please note that as of 2020 the most popular SO answer is different.

@@ -3810,6 +4168,8 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo + +
Parameters:
@@ -3851,7 +4211,7 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo - the number to be rounded +

the number to be rounded

@@ -3874,7 +4234,7 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo - the max number of decimals desired +

the max number of decimals desired

@@ -3886,57 +4246,6 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - @@ -3951,12 +4260,12 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo
- input rounded to the specified number of decimal places at most +

input rounded to the specified number of decimal places at most

-
+
Type
@@ -3972,24 +4281,64 @@ This is the Crib Sheet provided solution, but please note that as of 2020 the mo - - -

(static) selectFromArray(array, selection) → {Object|Array.<Object>}

- -
- Select values from an array. +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Select values from an array.

'selection' can be a single integer, an array of indices, or a string to be parsed, e.g.:

*

* - * @name module:core.ServerManager#getResourceStatus - * @function - * @public * @param {string | string[]} names names of the resources whose statuses are requested - * @return {core.ServerManager.ResourceStatus} status of the resource if there is only one, or reduced status otherwise + * @return {module:core.ServerManager.ResourceStatus} status of the resource if there is only one, or reduced status otherwise * @throws {Object.} if at least one of the names is not that of a previously * registered resource */ @@ -394,12 +381,8 @@ export class ServerManager extends PsychObject return reducedStatus; } - /**************************************************************************** + /** * Set the resource manager status. - * - * @name module:core.ServerManager#setStatus - * @function - * @public */ setStatus(status) { @@ -427,12 +410,9 @@ export class ServerManager extends PsychObject return this._status; } - /**************************************************************************** + /** * Reset the resource manager status to ServerManager.Status.READY. * - * @name module:core.ServerManager#resetStatus - * @function - * @public * @return {ServerManager.Status.READY} the new status */ resetStatus() @@ -440,7 +420,7 @@ export class ServerManager extends PsychObject return this.setStatus(ServerManager.Status.READY); } - /**************************************************************************** + /** * Prepare resources for the experiment: register them with the server manager and possibly * start downloading them right away. * @@ -453,10 +433,7 @@ export class ServerManager extends PsychObject *
  • If resources is null, then we do not download any resources
    • * * - * @name module:core.ServerManager#prepareResources * @param {String | Array.<{name: string, path: string, download: boolean} | String | Symbol>} [resources=[]] - the list of resources or a single resource - * @function - * @public */ async prepareResources(resources = []) { @@ -605,13 +582,10 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * Block the experiment until the specified resources have been downloaded. * - * @name module:core.ServerManager#waitForResources * @param {Array.<{name: string, path: string}>} [resources=[]] - the list of resources - * @function - * @public */ waitForResources(resources = []) { @@ -707,22 +681,18 @@ export class ServerManager extends PsychObject }; } - /**************************************************************************** + /** * @typedef ServerManager.UploadDataPromise * @property {string} origin the calling method * @property {string} context the context * @property {Object.} [error] an error message if we could not upload the data */ - /**************************************************************************** + /** * Asynchronously upload experiment data to the pavlovia server. * - * @name module:core.ServerManager#uploadData - * @function - * @public * @param {string} key - the data key (e.g. the name of .csv file) * @param {string} value - the data value (e.g. a string containing the .csv header and records) * @param {boolean} [sync= false] - whether or not to communicate with the server in a synchronous manner - * * @returns {Promise} the response */ uploadData(key, value, sync = false) @@ -780,12 +750,9 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * Asynchronously upload experiment logs to the pavlovia server. * - * @name module:core.ServerManager#uploadLog - * @function - * @public * @param {string} logs - the base64 encoded, compressed, formatted logs * @param {boolean} [compressed=false] - whether or not the logs are compressed * @returns {Promise} the response @@ -843,12 +810,9 @@ export class ServerManager extends PsychObject }); } - /**************************************************************************** + /** * Synchronously or asynchronously upload audio data to the pavlovia server. * - * @name module:core.ServerManager#uploadAudioVideo - * @function - * @public * @param @param {Object} options * @param {Blob} options.mediaBlob - the audio or video blob to be uploaded * @param {string} options.tag - additional tag @@ -978,12 +942,10 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * List the resources available to the experiment. * - * @name module:core.ServerManager#_listResources - * @function - * @private + * @protected */ _listResources() { @@ -1037,13 +999,11 @@ export class ServerManager extends PsychObject }); } - /**************************************************************************** + /** * Download the specified resources. * *

    Note: we use the [preloadjs library]{@link https://www.createjs.com/preloadjs}.

    * - * @name module:core.ServerManager#_downloadResources - * @function * @protected * @param {Set} resources - a set of names of previously registered resources */ @@ -1241,11 +1201,9 @@ export class ServerManager extends PsychObject } } - /**************************************************************************** + /** * Setup the preload.js queue, and the associated callbacks. * - * @name module:core.ServerManager#_setupPreloadQueue - * @function * @protected */ _setupPreloadQueue() @@ -1336,8 +1294,6 @@ export class ServerManager extends PsychObject /** * Query the pavlovia server API. * - * @name module:core.ServerManager#_queryServerAPI - * @function * @protected * @param method the HTTP method, i.e. GET, PUT, POST, or DELETE * @param path the resource path, without the server address @@ -1409,15 +1365,13 @@ export class ServerManager extends PsychObject } -/**************************************************************************** +/** * Server event * *

    A server event is emitted by the manager to inform its listeners of either a change of status, or of a resource related event (e.g. download started, download is completed).

    * - * @name module:core.ServerManager#Event * @enum {Symbol} * @readonly - * @public */ ServerManager.Event = { /** @@ -1443,7 +1397,7 @@ ServerManager.Event = { /** * Event: resources have all downloaded */ - DOWNLOADS_COMPLETED: Symbol.for("DOWNLOAD_COMPLETED"), + DOWNLOAD_COMPLETED: Symbol.for("DOWNLOAD_COMPLETED"), /** * Event type: status event @@ -1451,13 +1405,11 @@ ServerManager.Event = { STATUS: Symbol.for("STATUS"), }; -/**************************************************************************** +/** * Server status * - * @name module:core.ServerManager#Status * @enum {Symbol} * @readonly - * @public */ ServerManager.Status = { /** @@ -1476,13 +1428,11 @@ ServerManager.Status = { ERROR: Symbol.for("ERROR"), }; -/**************************************************************************** +/** * Resource status * - * @name module:core.ServerManager#ResourceStatus * @enum {Symbol} * @readonly - * @public */ ServerManager.ResourceStatus = { /** diff --git a/src/core/Window.js b/src/core/Window.js index 178a9fc..c666e8b 100644 --- a/src/core/Window.js +++ b/src/core/Window.js @@ -2,8 +2,8 @@ * Window responsible for displaying the experiment stimuli * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -18,20 +18,7 @@ import { Logger } from "./Logger.js"; *

    Window displays the various stimuli of the experiment.

    *

    It sets up a [PIXI]{@link http://www.pixijs.com/} renderer, which we use to render the experiment stimuli.

    * - * @name module:core.Window - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} [options.name] the name of the window - * @param {boolean} [options.fullscr= false] whether or not to go fullscreen - * @param {Color} [options.color= Color('black')] the background color of the window - * @param {number} [options.gamma= 1] sets the divisor for gamma correction. In other words gamma correction is calculated as pow(rgb, 1/gamma) - * @param {number} [options.contrast= 1] sets the contrast value - * @param {string} [options.units= 'pix'] the units of the window - * @param {boolean} [options.waitBlanking= false] whether or not to wait for all rendering operations to be done - * before flipping - * @param {boolean} [options.autoLog= true] whether or not to log */ export class Window extends PsychObject { @@ -47,6 +34,20 @@ export class Window extends PsychObject return 1.0 / this.getActualFrameRate(); } + /** + * @memberof module:core + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} [options.name] the name of the window + * @param {boolean} [options.fullscr= false] whether or not to go fullscreen + * @param {Color} [options.color= Color('black')] the background color of the window + * @param {number} [options.gamma= 1] sets the divisor for gamma correction. In other words gamma correction is calculated as pow(rgb, 1/gamma) + * @param {number} [options.contrast= 1] sets the contrast value + * @param {string} [options.units= 'pix'] the units of the window + * @param {boolean} [options.waitBlanking= false] whether or not to wait for all rendering operations to be done + * before flipping + * @param {boolean} [options.autoLog= true] whether or not to log + */ constructor({ psychoJS, name, @@ -124,10 +125,6 @@ export class Window extends PsychObject * Close the window. * *

    Note: this actually only removes the canvas used to render the experiment stimuli.

    - * - * @name module:core.Window#close - * @function - * @public */ close() { @@ -161,9 +158,6 @@ export class Window extends PsychObject /** * Estimate the frame rate. * - * @name module:core.Window#getActualFrameRate - * @function - * @public * @return {number} rAF based delta time based approximation, 60.0 by default */ getActualFrameRate() @@ -177,10 +171,6 @@ export class Window extends PsychObject /** * Take the browser full screen if possible. - * - * @name module:core.Window#adjustScreenSize - * @function - * @public */ adjustScreenSize() { @@ -222,10 +212,6 @@ export class Window extends PsychObject /** * Take the browser back from full screen if needed. - * - * @name module:core.Window#closeFullScreen - * @function - * @public */ closeFullScreen() { @@ -265,9 +251,6 @@ export class Window extends PsychObject * *

    Note: the message will be time-stamped at the next call to requestAnimationFrame.

    * - * @name module:core.Window#logOnFlip - * @function - * @public * @param {Object} options * @param {String} options.msg the message to be logged * @param {module:util.Logger.ServerLevel} [level = module:util.Logger.ServerLevel.EXP] the log level @@ -294,9 +277,6 @@ export class Window extends PsychObject * *

    This is typically used to reset a timer or clock.

    * - * @name module:core.Window#callOnFlip - * @function - * @public * @param {module:core.Window~OnFlipCallback} flipCallback - callback function. * @param {...*} flipCallbackArgs - arguments for the callback function. */ @@ -307,10 +287,6 @@ export class Window extends PsychObject /** * Add PIXI.DisplayObject to the container displayed on the scene (window) - * - * @name module:core.Window#addPixiObject - * @function - * @public */ addPixiObject(pixiObject) { @@ -319,10 +295,6 @@ export class Window extends PsychObject /** * Remove PIXI.DisplayObject from the container displayed on the scene (window) - * - * @name module:core.Window#removePixiObject - * @function - * @public */ removePixiObject(pixiObject) { @@ -331,10 +303,6 @@ export class Window extends PsychObject /** * Render the stimuli onto the canvas. - * - * @name module:core.Window#render - * @function - * @public */ render() { @@ -378,9 +346,7 @@ export class Window extends PsychObject /** * Update this window, if need be. * - * @name module:core.Window#_updateIfNeeded - * @function - * @private + * @protected */ _updateIfNeeded() { @@ -403,9 +369,7 @@ export class Window extends PsychObject /** * Recompute this window's draw list and _container children for the next animation frame. * - * @name module:core.Window#_refresh - * @function - * @private + * @protected */ _refresh() { @@ -427,9 +391,7 @@ export class Window extends PsychObject /** * Force an update of all stimuli in this window's drawlist. * - * @name module:core.Window#_fullRefresh - * @function - * @private + * @protected */ _fullRefresh() { @@ -449,9 +411,7 @@ export class Window extends PsychObject *

    A new renderer is created and a container is added to it. The renderer's touch and mouse events * are handled by the {@link EventManager}.

    * - * @name module:core.Window#_setupPixi - * @function - * @private + * @protected */ _setupPixi() { @@ -523,9 +483,7 @@ export class Window extends PsychObject * Adjust the size of the renderer and the position of the root container * in response to a change in the browser's size. * - * @name module:core.Window#_resizePixiRenderer - * @function - * @private + * @protected * @param {module:core.Window} pjsWindow - the PsychoJS Window * @param event */ @@ -554,9 +512,7 @@ export class Window extends PsychObject /** * Send all logged messages to the {@link Logger}. * - * @name module:core.Window#_writeLogOnFlip - * @function - * @private + * @protected */ _writeLogOnFlip() { diff --git a/src/core/WindowMixin.js b/src/core/WindowMixin.js index e03be11..41100df 100644 --- a/src/core/WindowMixin.js +++ b/src/core/WindowMixin.js @@ -2,8 +2,8 @@ * Mixin implementing various unit-handling measurement methods. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ diff --git a/src/data/ExperimentHandler.js b/src/data/ExperimentHandler.js index 70ce3ea..2c2bebc 100644 --- a/src/data/ExperimentHandler.js +++ b/src/data/ExperimentHandler.js @@ -2,8 +2,8 @@ * Experiment Handler * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -17,22 +17,12 @@ import * as util from "../util/Util.js"; * for generating a single data file from an experiment with many different loops (e.g. interleaved * staircases or loops within loops.

    * - * @name module:data.ExperimentHandler - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} options.name - name of the experiment - * @param {Object} options.extraInfo - additional information, such as session name, participant name, etc. */ export class ExperimentHandler extends PsychObject { /** * Getter for experimentEnded. - * - * @name module:data.ExperimentHandler#experimentEnded - * @function - * @public */ get experimentEnded() { @@ -41,10 +31,6 @@ export class ExperimentHandler extends PsychObject /** * Setter for experimentEnded. - * - * @name module:data.ExperimentHandler#experimentEnded - * @function - * @public */ set experimentEnded(ended) { @@ -64,6 +50,13 @@ export class ExperimentHandler extends PsychObject return this._trialsData; } + /** + * @memberof module:data + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} options.name - name of the experiment + * @param {Object} options.extraInfo - additional information, such as session name, participant name, etc. + */ constructor({ psychoJS, name, @@ -111,9 +104,6 @@ export class ExperimentHandler extends PsychObject * Whether or not the current entry (i.e. trial data) is empty. *

    Note: this is mostly useful at the end of an experiment, in order to ensure that the last entry is saved.

    * - * @name module:data.ExperimentHandler#isEntryEmpty - * @function - * @public * @returns {boolean} whether or not the current entry is empty * @todo This really should be renamed: IsCurrentEntryNotEmpty */ @@ -128,9 +118,6 @@ export class ExperimentHandler extends PsychObject *

    The loop might be a {@link TrialHandler}, for instance.

    *

    Data from this loop will be included in the resulting data files.

    * - * @name module:data.ExperimentHandler#addLoop - * @function - * @public * @param {Object} loop - the loop, e.g. an instance of TrialHandler or StairHandler */ addLoop(loop) @@ -143,9 +130,6 @@ export class ExperimentHandler extends PsychObject /** * Remove the given loop from the list of unfinished loops, e.g. when it has completed. * - * @name module:data.ExperimentHandler#removeLoop - * @function - * @public * @param {Object} loop - the loop, e.g. an instance of TrialHandler or StairHandler */ removeLoop(loop) @@ -163,9 +147,6 @@ export class ExperimentHandler extends PsychObject *

    Multiple key/value pairs can be added to any given entry of the data file. There are * considered part of the same entry until a call to {@link nextEntry} is made.

    * - * @name module:data.ExperimentHandler#addData - * @function - * @public * @param {Object} key - the key * @param {Object} value - the value */ @@ -189,9 +170,6 @@ export class ExperimentHandler extends PsychObject * Inform this ExperimentHandler that the current trial has ended. Further calls to {@link addData} * will be associated with the next trial. * - * @name module:data.ExperimentHandler#nextEntry - * @function - * @public * @param {Object | Object[] | undefined} snapshots - array of loop snapshots */ nextEntry(snapshots) @@ -256,9 +234,6 @@ export class ExperimentHandler extends PsychObject * *

    * - * @name module:data.ExperimentHandler#save - * @function - * @public * @param {Object} options * @param {Array.} [options.attributes] - the attributes to be saved * @param {boolean} [options.sync=false] - whether or not to communicate with the server in a synchronous manner @@ -380,9 +355,6 @@ export class ExperimentHandler extends PsychObject * Get the attribute names and values for the current trial of a given loop. *

    Only info relating to the trial execution are returned.

    * - * @name module:data.ExperimentHandler#_getLoopAttributes - * @function - * @static * @protected * @param {Object} loop - the loop */ @@ -442,10 +414,8 @@ export class ExperimentHandler extends PsychObject /** * Experiment result format * - * @name module:core.ServerManager#SaveFormat * @enum {Symbol} * @readonly - * @public */ ExperimentHandler.SaveFormat = { /** @@ -464,7 +434,6 @@ ExperimentHandler.SaveFormat = { * * @enum {Symbol} * @readonly - * @public */ ExperimentHandler.Environment = { SERVER: Symbol.for("SERVER"), diff --git a/src/data/MultiStairHandler.js b/src/data/MultiStairHandler.js index 5c71688..a2b9b51 100644 --- a/src/data/MultiStairHandler.js +++ b/src/data/MultiStairHandler.js @@ -1,10 +1,9 @@ -/** @module data */ /** * Multiple Staircase Trial Handler * * @author Alain Pitiot - * @version 2021.2.1 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. + * @version 2021.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. * (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -22,27 +21,25 @@ import seedrandom from "seedrandom"; *

    Note that, at the moment, using the MultiStairHandler requires the jsQuest.js * library to be loaded as a resource, at the start of the experiment.

    * - * @class module.data.MultiStairHandler * @extends TrialHandler - * @param {Object} options - the handler options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} options.varName - the name of the variable / intensity / contrast - * / threshold manipulated by the staircases - * @param {module:data.MultiStairHandler.StaircaseType} [options.stairType="simple"] - the - * handler type - * @param {Array. | String} [options.conditions= [undefined] ] - if it is a string, - * we treat it as the name of a conditions resource - * @param {module:data.TrialHandler.Method} options.method - the trial method - * @param {number} [options.nTrials=50] - maximum number of trials - * @param {number} options.randomSeed - seed for the random number generator - * @param {string} options.name - name of the handler - * @param {boolean} [options.autoLog= false] - whether or not to log */ export class MultiStairHandler extends TrialHandler { /** - * @constructor - * @public + * @memberof module:data + * @param {Object} options - the handler options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} options.varName - the name of the variable / intensity / contrast + * / threshold manipulated by the staircases + * @param {MultiStairHandler.StaircaseType} [options.stairType="simple"] - the + * handler type + * @param {Array. | String} [options.conditions= [undefined] ] - if it is a string, + * we treat it as the name of a conditions resource + * @param {module:data.TrialHandler.Method} options.method - the trial method + * @param {number} [options.nTrials=50] - maximum number of trials + * @param {number} options.randomSeed - seed for the random number generator + * @param {string} options.name - name of the handler + * @param {boolean} [options.autoLog= false] - whether or not to log */ constructor({ psychoJS, @@ -91,10 +88,7 @@ export class MultiStairHandler extends TrialHandler /** * Get the current staircase. * - * @name module:data.MultiStairHandler#currentStaircase - * @function - * @public - * @returns {module.data.TrialHandler} the current staircase, or undefined if the trial has ended + * @returns {TrialHandler} the current staircase, or undefined if the trial has ended */ get currentStaircase() { @@ -104,9 +98,6 @@ export class MultiStairHandler extends TrialHandler /** * Get the current intensity. * - * @name module:data.MultiStairHandler#intensity - * @function - * @public * @returns {number} the intensity of the current staircase, or undefined if the trial has ended */ get intensity() @@ -128,13 +119,9 @@ export class MultiStairHandler extends TrialHandler /** * Add a response to the current staircase. * - * @name module:data.MultiStairHandler#addResponse - * @function - * @public * @param{number} response - the response to the trial, must be either 0 (incorrect or * non-detected) or 1 (correct or detected) * @param{number | undefined} [value] - optional intensity / contrast / threshold - * @returns {void} */ addResponse(response, value) { @@ -163,10 +150,7 @@ export class MultiStairHandler extends TrialHandler /** * Validate the conditions. * - * @name module:data.MultiStairHandler#_validateConditions - * @function * @protected - * @returns {void} */ _validateConditions() { @@ -222,10 +206,7 @@ export class MultiStairHandler extends TrialHandler /** * Setup the staircases, according to the conditions. * - * @name module:data.MultiStairHandler#_prepareStaircases - * @function * @protected - * @returns {void} */ _prepareStaircases() { @@ -282,10 +263,7 @@ export class MultiStairHandler extends TrialHandler /** * Move onto the next trial. * - * @name module:data.MultiStairHandler#_nextTrial - * @function * @protected - * @returns {void} */ _nextTrial() { @@ -425,7 +403,6 @@ export class MultiStairHandler extends TrialHandler * * @enum {Symbol} * @readonly - * @public */ MultiStairHandler.StaircaseType = { /** @@ -444,7 +421,6 @@ MultiStairHandler.StaircaseType = { * * @enum {Symbol} * @readonly - * @public */ MultiStairHandler.StaircaseStatus = { /** diff --git a/src/data/QuestHandler.js b/src/data/QuestHandler.js index 6eb9cc8..067e526 100644 --- a/src/data/QuestHandler.js +++ b/src/data/QuestHandler.js @@ -1,10 +1,9 @@ -/** @module data */ /** * Quest Trial Handler * * @author Alain Pitiot & Thomas Pronk - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -15,31 +14,29 @@ import {TrialHandler} from "./TrialHandler.js"; *

    A Trial Handler that implements the Quest algorithm for quick measurement of psychophysical thresholds. QuestHandler relies on the [jsQuest]{@link https://github.com/kurokida/jsQUEST} library, a port of Prof Dennis Pelli's QUEST algorithm by [Daiichiro Kuroki]{@link https://github.com/kurokida}.

    * - * @class module.data.QuestHandler * @extends TrialHandler - * @param {Object} options - the handler options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {string} options.varName - the name of the variable / intensity / contrast / threshold manipulated by QUEST - * @param {number} options.startVal - initial guess for the threshold - * @param {number} options.startValSd - standard deviation of the initial guess - * @param {number} options.minVal - minimum value for the threshold - * @param {number} options.maxVal - maximum value for the threshold - * @param {number} [options.pThreshold=0.82] - threshold criterion expressed as probability of getting a correct response - * @param {number} options.nTrials - maximum number of trials - * @param {number} options.stopInterval - minimum [5%, 95%] confidence interval required for the loop to stop - * @param {module:data.QuestHandler.Method} options.method - the QUEST method - * @param {number} [options.beta=3.5] - steepness of the QUEST psychometric function - * @param {number} [options.delta=0.01] - fraction of trials with blind responses - * @param {number} [options.gamma=0.5] - fraction of trails that would generate a correct response when the threshold is infinitely small - * @param {number} [options.grain=0.01] - quantization of the internal table - * @param {string} options.name - name of the handler - * @param {boolean} [options.autoLog= false] - whether or not to log */ export class QuestHandler extends TrialHandler { /** - * @constructor - * @public + * @memberof module:data + * @param {Object} options - the handler options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {string} options.varName - the name of the variable / intensity / contrast / threshold manipulated by QUEST + * @param {number} options.startVal - initial guess for the threshold + * @param {number} options.startValSd - standard deviation of the initial guess + * @param {number} options.minVal - minimum value for the threshold + * @param {number} options.maxVal - maximum value for the threshold + * @param {number} [options.pThreshold=0.82] - threshold criterion expressed as probability of getting a correct response + * @param {number} options.nTrials - maximum number of trials + * @param {number} options.stopInterval - minimum [5%, 95%] confidence interval required for the loop to stop + * @param {QuestHandler.Method} options.method - the QUEST method + * @param {number} [options.beta=3.5] - steepness of the QUEST psychometric function + * @param {number} [options.delta=0.01] - fraction of trials with blind responses + * @param {number} [options.gamma=0.5] - fraction of trails that would generate a correct response when the threshold is infinitely small + * @param {number} [options.grain=0.01] - quantization of the internal table + * @param {string} options.name - name of the handler + * @param {boolean} [options.autoLog= false] - whether or not to log */ constructor({ psychoJS, @@ -113,15 +110,11 @@ export class QuestHandler extends TrialHandler /** * Add a response and update the PDF. * - * @name module:data.QuestHandler#addResponse - * @function - * @public * @param{number} response - the response to the trial, must be either 0 (incorrect or * non-detected) or 1 (correct or detected) * @param{number | undefined} value - optional intensity / contrast / threshold * @param{boolean} [doAddData = true] - whether or not to add the response as data to the * experiment - * @returns {void} */ addResponse(response, value, doAddData = true) { @@ -163,9 +156,6 @@ export class QuestHandler extends TrialHandler /** * Simulate a response. * - * @name module:data.QuestHandler#simulate - * @function - * @public * @param{number} trueValue - the true, known value of the threshold / contrast / intensity * @returns{number} the simulated response, 0 or 1 */ @@ -184,9 +174,6 @@ export class QuestHandler extends TrialHandler /** * Get the mean of the Quest posterior PDF. * - * @name module:data.QuestHandler#mean - * @function - * @public * @returns {number} the mean */ mean() @@ -197,9 +184,6 @@ export class QuestHandler extends TrialHandler /** * Get the standard deviation of the Quest posterior PDF. * - * @name module:data.QuestHandler#sd - * @function - * @public * @returns {number} the standard deviation */ sd() @@ -210,9 +194,6 @@ export class QuestHandler extends TrialHandler /** * Get the mode of the Quest posterior PDF. * - * @name module:data.QuestHandler#mode - * @function - * @public * @returns {number} the mode */ mode() @@ -224,9 +205,6 @@ export class QuestHandler extends TrialHandler /** * Get the standard deviation of the Quest posterior PDF. * - * @name module:data.QuestHandler#quantile - * @function - * @public * @param{number} quantileOrder the quantile order * @returns {number} the quantile */ @@ -238,9 +216,6 @@ export class QuestHandler extends TrialHandler /** * Get the current value of the variable / contrast / threshold. * - * @name module:data.QuestHandler#getQuestValue - * @function - * @public * @returns {number} the current QUEST value for the variable / contrast / threshold */ getQuestValue() @@ -253,9 +228,6 @@ export class QuestHandler extends TrialHandler * *

    This is the getter associated to getQuestValue.

    * - * @name module:data.MultiStairHandler#intensity - * @function - * @public * @returns {number} the intensity of the current staircase, or undefined if the trial has ended */ get intensity() @@ -266,9 +238,6 @@ export class QuestHandler extends TrialHandler /** * Get an estimate of the 5%-95% confidence interval (CI). * - * @name module:data.QuestHandler#confInterval - * @function - * @public * @param{boolean} [getDifference=false] - if true, return the width of the CI instead of the CI * @returns{number[] | number} the 5%-95% CI or the width of the CI */ @@ -292,10 +261,7 @@ export class QuestHandler extends TrialHandler /** * Setup the JS Quest object. * - * @name module:data.QuestHandler#_setupJsQuest - * @function * @protected - * @returns {void} */ _setupJsQuest() { @@ -313,10 +279,7 @@ export class QuestHandler extends TrialHandler * Estimate the next value of the QUEST variable, based on the current value * and on the selected QUEST method. * - * @name module:data.QuestHandler#_estimateQuestValue - * @function * @protected - * @returns {void} */ _estimateQuestValue() { @@ -387,7 +350,6 @@ export class QuestHandler extends TrialHandler * * @enum {Symbol} * @readonly - * @public */ QuestHandler.Method = { /** diff --git a/src/data/Shelf.js b/src/data/Shelf.js index 20e477d..a92507c 100644 --- a/src/data/Shelf.js +++ b/src/data/Shelf.js @@ -1,9 +1,9 @@ -/** @module data */ /** * Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the - * server, and be accessed and manipulated in a concurrent fashion. + * server, and can be accessed and manipulated in a concurrent fashion. * * @author Alain Pitiot + * @version 2021.2.3 * @copyright (c) 2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -16,27 +16,25 @@ import {Scheduler} from "../util/Scheduler.js"; /** *

    Shelf handles persistent key/value pairs, or records, which are stored in the shelf collection on the - * server, and be accessed and manipulated in a concurrent fashion.

    + * server, and can be accessed and manipulated in a concurrent fashion.

    * - *

    - * - * @name module:data.Shelf - * @class * @extends PsychObject - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS the PsychoJS instance - * @param {boolean} [options.autoLog= false] whether to log */ export class Shelf extends PsychObject { /** * Maximum number of components in a key - * @name module:data.Shelf.#MAX_KEY_LENGTH * @type {number} * @note this value should mirror that on the server, i.e. the server also checks that the key is valid */ static #MAX_KEY_LENGTH = 10; + /** + * @memberOf module:data + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS the PsychoJS instance + * @param {boolean} [options.autoLog= false] whether to log + */ constructor({psychoJS, autoLog = false } = {}) { super(psychoJS); @@ -56,9 +54,6 @@ export class Shelf extends PsychObject /** * Get the value of a record of type BOOLEAN associated with the given key. * - * @name module:data.Shelf#getBooleanValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {boolean} options.defaultValue the default value returned if no record with the given key exists @@ -75,9 +70,6 @@ export class Shelf extends PsychObject /** * Set the value of a record of type BOOLEAN associated with the given key. * - * @name module:data.Shelf#setBooleanValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {boolean} options.value the new value @@ -108,9 +100,6 @@ export class Shelf extends PsychObject /** * Flip the value of a record of type BOOLEAN associated with the given key. * - * @name module:data.Shelf#flipBooleanValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @return {Promise} the new, flipped, value @@ -129,9 +118,6 @@ export class Shelf extends PsychObject /** * Get the value of a record of type INTEGER associated with the given key. * - * @name module:data.Shelf#getIntegerValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {number} options.defaultValue the default value returned if no record with the given key @@ -148,9 +134,6 @@ export class Shelf extends PsychObject /** * Set the value of a record of type INTEGER associated with the given key. * - * @name module:data.Shelf#setIntegerValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {number} options.value the new value @@ -181,9 +164,6 @@ export class Shelf extends PsychObject /** * Add a delta to the value of a record of type INTEGER associated with the given key. * - * @name module:data.Shelf#addIntegerValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {number} options.delta the delta, positive or negative, to add to the value @@ -214,9 +194,6 @@ export class Shelf extends PsychObject /** * Get the value of a record of type TEXT associated with the given key. * - * @name module:data.Shelf#getTextValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {string} options.defaultValue the default value returned if no record with the given key exists on @@ -233,9 +210,6 @@ export class Shelf extends PsychObject /** * Set the value of a record of type TEXT associated with the given key. * - * @name module:data.Shelf#setTextValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {string} options.value the new value @@ -266,9 +240,6 @@ export class Shelf extends PsychObject /** * Get the value of a record of type LIST associated with the given key. * - * @name module:data.Shelf#getListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {Array.<*>} options.defaultValue the default value returned if no record with the given key exists on @@ -285,9 +256,6 @@ export class Shelf extends PsychObject /** * Set the value of a record of type LIST associated with the given key. * - * @name module:data.Shelf#setListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {Array.<*>} options.value the new value @@ -318,9 +286,6 @@ export class Shelf extends PsychObject /** * Append an element, or a list of elements, to the value of a record of type LIST associated with the given key. * - * @name module:data.Shelf#appendListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {*} options.elements the element or list of elements to be appended @@ -342,9 +307,6 @@ export class Shelf extends PsychObject * Pop an element, at the given index, from the value of a record of type LIST associated * with the given key. * - * @name module:data.Shelf#popListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {number} [options.index = -1] the index of the element to be popped @@ -365,9 +327,6 @@ export class Shelf extends PsychObject /** * Empty the value of a record of type LIST associated with the given key. * - * @name module:data.Shelf#clearListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @return {Promise>} the new, empty value, i.e. [] @@ -386,9 +345,6 @@ export class Shelf extends PsychObject /** * Shuffle the elements of the value of a record of type LIST associated with the given key. * - * @name module:data.Shelf#shuffleListValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @return {Promise>} the new, shuffled value @@ -408,9 +364,6 @@ export class Shelf extends PsychObject /** * Get the names of the fields in the dictionary record associated with the given key. * - * @name module:data.Shelf#getDictionaryFieldNames - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @return {Promise} the list of field names @@ -425,9 +378,6 @@ export class Shelf extends PsychObject /** * Get the value of a given field in the dictionary record associated with the given key. * - * @name module:data.Shelf#getDictionaryFieldValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {string} options.fieldName the name of the field @@ -445,9 +395,6 @@ export class Shelf extends PsychObject /** * Set a field in the dictionary record associated to the given key. * - * @name module:data.Shelf#setDictionaryFieldValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {string} options.fieldName the name of the field @@ -470,9 +417,6 @@ export class Shelf extends PsychObject /** * Get the value of a record of type DICTIONARY associated with the given key. * - * @name module:data.Shelf#getDictionaryValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {Object.} options.defaultValue the default value returned if no record with the given key @@ -489,9 +433,6 @@ export class Shelf extends PsychObject /** * Set the value of a record of type DICTIONARY associated with the given key. * - * @name module:data.Shelf#setDictionaryValue - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {Object.} options.value the new value @@ -523,9 +464,6 @@ export class Shelf extends PsychObject * Schedulable component that will block the experiment until the counter associated with the given key * has been incremented by the given amount. * - * @name module:data.Shelf#incrementComponent - * @function - * @public * @param key * @param increment * @param callback @@ -576,9 +514,6 @@ export class Shelf extends PsychObject /** * Get the name of a group, using a counterbalanced design. * - * @name module:data.Shelf#counterBalanceSelect - * @function - * @public * @param {Object} options * @param {string[]} options.key key as an array of key components * @param {string[]} options.groups the names of the groups @@ -648,9 +583,6 @@ export class Shelf extends PsychObject * *

    This is a generic method, typically called from the Shelf helper methods, e.g. setBinaryValue.

    * - * @name module:data.Shelf#_updateValue - * @function - * @protected * @param {string[]} key key as an array of key components * @param {Shelf.Type} type the type of the record associated with the given key * @param {*} update the desired update @@ -716,9 +648,6 @@ export class Shelf extends PsychObject * *

    This is a generic method, typically called from the Shelf helper methods, e.g. getBinaryValue.

    * - * @name module:data.Shelf#_getValue - * @function - * @protected * @param {string[]} key key as an array of key components * @param {Shelf.Type} type the type of the record associated with the given key * @param {Object} [options] the options, e.g. the default value returned if no record with the @@ -794,16 +723,8 @@ export class Shelf extends PsychObject * *

    Since all Shelf methods call _checkAvailability, we also use it as a means to throttle those calls.

    * - * @name module:data.Shelf#_checkAvailability - * @function - * @public -<<<<<<< HEAD - * @param {string} [methodName=""] name of the method requiring a check - * @throws {Object.} exception if it is not possible to run the given shelf command -======= - * @param {string} [methodName=""] name of the method requiring a check - * @throw {Object.} exception when it is not possible to run the given shelf command ->>>>>>> 8cc27b9cc9844d435c0177263ef7c2991463196c + * @param {string} [methodName=""] - name of the method requiring a check + * @throws {Object.} exception if it is not possible to run the given shelf command */ _checkAvailability(methodName = "") { @@ -852,9 +773,6 @@ export class Shelf extends PsychObject /** * Check the validity of the key. * - * @name module:data.Shelf#_checkKey - * @function - * @public * @param {object} key key whose validity is to be checked * @throws {Object.} exception if the key is invalid */ @@ -879,10 +797,8 @@ export class Shelf extends PsychObject /** * Shelf status * - * @name module:data.Shelf#Status * @enum {Symbol} * @readonly - * @public */ Shelf.Status = { /** @@ -906,7 +822,6 @@ Shelf.Status = { * * @enum {Symbol} * @readonly - * @public */ Shelf.Type = { INTEGER: Symbol.for('INTEGER'), diff --git a/src/data/TrialHandler.js b/src/data/TrialHandler.js index 0dd189a..c531d7d 100644 --- a/src/data/TrialHandler.js +++ b/src/data/TrialHandler.js @@ -4,8 +4,8 @@ * * @author Alain Pitiot * @author Hiroyuki Sogo & Sotiri Bakagiannis - better support for BOM and accented characters - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -17,25 +17,12 @@ import * as util from "../util/Util.js"; /** *

    A Trial Handler handles the importing and sequencing of conditions.

    * - * @class * @extends PsychObject - * @param {Object} options - the handler options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {Array. | String} [options.trialList= [undefined] ] - if it is a string, we treat it as the name of a condition resource - * @param {number} options.nReps - number of repetitions - * @param {module:data.TrialHandler.Method} options.method - the trial method - * @param {Object} options.extraInfo - additional information to be stored alongside the trial data, e.g. session ID, participant ID, etc. - * @param {number} options.seed - seed for the random number generator - * @param {boolean} [options.autoLog= false] - whether or not to log */ export class TrialHandler extends PsychObject { /** * Getter for experimentHandler. - * - * @name module:core.Window#experimentHandler - * @function - * @public */ get experimentHandler() { @@ -44,10 +31,6 @@ export class TrialHandler extends PsychObject /** * Setter for experimentHandler. - * - * @name module:core.Window#experimentHandler - * @function - * @public */ set experimentHandler(exp) { @@ -55,8 +38,14 @@ export class TrialHandler extends PsychObject } /** - * @constructor - * @public + * @param {Object} options - the handler options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {Array. | String} [options.trialList= [undefined] ] - if it is a string, we treat it as the name of a condition resource + * @param {number} options.nReps - number of repetitions + * @param {module:data.TrialHandler.Method} options.method - the trial method + * @param {Object} options.extraInfo - additional information to be stored alongside the trial data, e.g. session ID, participant ID, etc. + * @param {number} options.seed - seed for the random number generator + * @param {boolean} [options.autoLog= false] - whether or not to log * * @todo extraInfo is not taken into account, we use the expInfo of the ExperimentHandler instead */ @@ -223,7 +212,6 @@ export class TrialHandler extends PsychObject * *

    This is typically used in the LoopBegin function, in order to capture the current state of a TrialHandler

    * - * @public * @return {Snapshot} - a snapshot of the current internal state. */ getSnapshot() @@ -296,8 +284,6 @@ export class TrialHandler extends PsychObject /** * Set the internal state of the snapshot's trial handler from the snapshot. * - * @public - * @static * @param {Snapshot} snapshot - the snapshot from which to update the current internal state of the * snapshot's trial handler */ @@ -365,7 +351,6 @@ export class TrialHandler extends PsychObject /** * Get the trial index. * - * @public * @return {number} the current trial index */ getTrialIndex() @@ -389,7 +374,6 @@ export class TrialHandler extends PsychObject *

    Note: we assume that all trials in the trialList share the same attributes * and consequently consider only the attributes of the first trial.

    * - * @public * @return {Array.string} the attributes */ getAttributes() @@ -411,7 +395,6 @@ export class TrialHandler extends PsychObject /** * Get the current trial. * - * @public * @return {Object} the current trial */ getCurrentTrial() @@ -438,7 +421,6 @@ export class TrialHandler extends PsychObject /** * Get the nth future or past trial, without advancing through the trial list. * - * @public * @param {number} [n = 1] - increment * @return {Object|undefined} the future trial (if n is positive) or past trial (if n is negative) * or undefined if attempting to go beyond the last trial. @@ -457,7 +439,6 @@ export class TrialHandler extends PsychObject * Get the nth previous trial. *

    Note: this is useful for comparisons in n-back tasks.

    * - * @public * @param {number} [n = -1] - increment * @return {Object|undefined} the past trial or undefined if attempting to go prior to the first trial. */ @@ -469,7 +450,6 @@ export class TrialHandler extends PsychObject /** * Add a key/value pair to data about the current trial held by the experiment handler * - * @public * @param {Object} key - the key * @param {Object} value - the value */ @@ -508,8 +488,6 @@ export class TrialHandler extends PsychObject * '5:' * '-5:-2, 9, 11:5:22' * - * @public - * @static * @param {module:core.ServerManager} serverManager - the server manager * @param {String} resourceName - the name of the resource containing the list of conditions, which must have been registered with the server manager. * @param {Object} [selection = null] - the selection @@ -617,7 +595,6 @@ export class TrialHandler extends PsychObject /** * Prepare the trial list. * - * @function * @protected * @returns {void} */ @@ -655,7 +632,7 @@ export class TrialHandler extends PsychObject } } - /* + /** * Prepare the sequence of trials. * *

    The returned sequence is a matrix (an array of arrays) of trial indices @@ -680,7 +657,7 @@ export class TrialHandler extends PsychObject *

    * * @protected - */ + **/ _prepareSequence() { const response = { @@ -738,7 +715,6 @@ export class TrialHandler extends PsychObject * * @enum {Symbol} * @readonly - * @public */ TrialHandler.Method = { /** diff --git a/src/data/index.js b/src/data/index.js index bd13927..1bffe5e 100644 --- a/src/data/index.js +++ b/src/data/index.js @@ -2,5 +2,4 @@ export * from "./ExperimentHandler.js"; export * from "./TrialHandler.js"; export * from "./QuestHandler.js"; export * from "./MultiStairHandler.js"; -//export * from "./Shelf.js"; export * from "./Shelf.js"; diff --git a/src/hardware/Camera.js b/src/hardware/Camera.js index c790c92..8d3b1c2 100644 --- a/src/hardware/Camera.js +++ b/src/hardware/Camera.js @@ -1,9 +1,10 @@ +/** **/ /** * Manager handling the recording of video signal. * * @author Alain Pitiot * @version 2022.2.0 - * @copyright (c) 2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @copyright (c) 2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ diff --git a/src/index.css b/src/index.css index 01475ef..00f232b 100644 --- a/src/index.css +++ b/src/index.css @@ -95,6 +95,11 @@ a:hover { transform: translate(-50%, -50%); } +#root.is-ready::after +{ + content: "" +} + .dialog-container, .dialog-overlay { @@ -144,6 +149,14 @@ a:hover { border-radius: 2px; } +.dialog-warning { + background-color: #FF9900 !important; +} + +.dialog-error { + background-color: #FF0000 !important; +} + .dialog-title p { margin: 0; padding: 0; diff --git a/src/sound/AudioClip.js b/src/sound/AudioClip.js index f21dd0f..d8d675b 100644 --- a/src/sound/AudioClip.js +++ b/src/sound/AudioClip.js @@ -2,7 +2,7 @@ * AudioClip encapsulates an audio recording. * * @author Alain Pitiot and Sotiri Bakagiannis - * @version 2021.2.0 + * @version 2022.2.3 * @copyright (c) 2021 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -15,18 +15,20 @@ import * as util from "../util/Util.js"; /** *

    AudioClip encapsulates an audio recording.

    * - * @name module:sound.AudioClip - * @class - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {String} [options.name= 'audioclip'] - the name used when logging messages - * @param {string} options.format the format for the audio file - * @param {number} options.sampleRateHz - the sampling rate - * @param {Blob} options.data - the audio data, in the given format, at the given sampling rate - * @param {boolean} [options.autoLog= false] - whether or not to log + * @extends PsychObject */ export class AudioClip extends PsychObject { + /** + * @memberOf module:sound + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {String} [options.name= 'audioclip'] - the name used when logging messages + * @param {string} options.format the format for the audio file + * @param {number} options.sampleRateHz - the sampling rate + * @param {Blob} options.data - the audio data, in the given format, at the given sampling rate + * @param {boolean} [options.autoLog= false] - whether or not to log + */ constructor({ psychoJS, name, sampleRateHz, format, data, autoLog } = {}) { super(psychoJS); @@ -53,9 +55,6 @@ export class AudioClip extends PsychObject /** * Set the volume of the playback. * - * @name module:sound.AudioClip#setVolume - * @function - * @public * @param {number} volume - the volume of the playback (must be between 0.0 and 1.0) */ setVolume(volume) @@ -66,8 +65,6 @@ export class AudioClip extends PsychObject /** * Start playing the audio clip. * - * @name module:sound.AudioClip#startPlayback - * @function * @public */ async startPlayback() @@ -102,9 +99,6 @@ export class AudioClip extends PsychObject /** * Stop playing the audio clip. * - * @name module:sound.AudioClip#startPlayback - * @function - * @public * @param {number} [fadeDuration = 17] - how long the fading out should last, in ms */ async stopPlayback(fadeDuration = 17) @@ -118,9 +112,6 @@ export class AudioClip extends PsychObject /** * Get the duration of the audio clip, in seconds. * - * @name module:sound.AudioClip#getDuration - * @function - * @public * @returns {Promise} the duration of the audio clip */ async getDuration() @@ -134,8 +125,6 @@ export class AudioClip extends PsychObject /** * Upload the audio clip to the pavlovia server. * - * @name module:sound.AudioClip#upload - * @function * @public */ upload() @@ -165,10 +154,6 @@ export class AudioClip extends PsychObject /** * Offer the audio clip to the participant as a sound file to download. - * - * @name module:sound.AudioClip#download - * @function - * @public */ download(filename = "audio.webm") { @@ -239,6 +224,7 @@ export class AudioClip extends PsychObject * * ref: https://cloud.google.com/speech-to-text/docs/reference/rest/v1/speech/recognize * + * @protected * @param {String} transcriptionKey - the secret key to the Google service * @param {String} languageCode - the BCP-47 language code for the recognition, e.g. 'en-GB' * @return {Promise} a promise resolving to the transcript and associated @@ -306,6 +292,7 @@ export class AudioClip extends PsychObject /** * Decode the formatted audio data (e.g. webm) into a 32bit float PCM audio buffer. * + * @protected */ _decodeAudio() { @@ -386,6 +373,7 @@ export class AudioClip extends PsychObject * const dataAsString = String.fromCharCode.apply(null, new Uint8Array(buffer)); * base64Data = window.btoa(dataAsString); * + * @protected * @param arrayBuffer - the input buffer * @return {string} the base64 encoded input buffer */ @@ -453,10 +441,8 @@ export class AudioClip extends PsychObject /** * Recognition engines. * - * @name module:sound.AudioClip#Engine * @enum {Symbol} * @readonly - * @public */ AudioClip.Engine = { /** @@ -470,7 +456,6 @@ AudioClip.Engine = { * * @enum {Symbol} * @readonly - * @public */ AudioClip.Status = { CREATED: Symbol.for("CREATED"), diff --git a/src/sound/AudioClipPlayer.js b/src/sound/AudioClipPlayer.js index 082a71a..10dd99b 100644 --- a/src/sound/AudioClipPlayer.js +++ b/src/sound/AudioClipPlayer.js @@ -2,8 +2,8 @@ * AudioClip Player. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -13,20 +13,21 @@ import { SoundPlayer } from "./SoundPlayer.js"; /** *

    This class handles the playback of an audio clip, e.g. a microphone recording.

    * - * @name module:sound.AudioClipPlayer - * @class * @extends SoundPlayer - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {Object} options.audioClip - the module:sound.AudioClip - * @param {number} [options.startTime= 0] - start of playback (in seconds) - * @param {number} [options.stopTime= -1] - end of playback (in seconds) - * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo - * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) - * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played * */ export class AudioClipPlayer extends SoundPlayer { + /** + * @memberOf module:sound + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {Object} options.audioClip - the module:sound.AudioClip + * @param {number} [options.startTime= 0] - start of playback (in seconds) + * @param {number} [options.stopTime= -1] - end of playback (in seconds) + * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo + * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) + * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played * + */ constructor({ psychoJS, audioClip, @@ -52,10 +53,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Determine whether this player can play the given sound. * - * @name module:sound.AudioClipPlayer.accept - * @function - * @static - * @public * @param {module:sound.Sound} sound - the sound object, which should be an AudioClip * @return {Object|undefined} an instance of AudioClipPlayer if sound is an AudioClip or undefined otherwise */ @@ -83,9 +80,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Get the duration of the AudioClip, in seconds. * - * @name module:sound.AudioClipPlayer#getDuration - * @function - * @public * @return {number} the duration of the clip, in seconds */ getDuration() @@ -96,9 +90,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Set the duration of the audio clip. * - * @name module:sound.AudioClipPlayer#setDuration - * @function - * @public * @param {number} duration_s - the duration of the clip in seconds */ setDuration(duration_s) @@ -115,9 +106,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Set the volume of the playback. * - * @name module:sound.AudioClipPlayer#setVolume - * @function - * @public * @param {number} volume - the volume of the playback (must be between 0.0 and 1.0) * @param {boolean} [mute= false] - whether or not to mute the playback */ @@ -131,9 +119,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Set the number of loops. * - * @name module:sound.AudioClipPlayer#setLoops - * @function - * @public * @param {number} loops - how many times to repeat the clip after it has played once. If loops == -1, the clip will repeat indefinitely until stopped. */ setLoops(loops) @@ -147,9 +132,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Start playing the sound. * - * @name module:sound.AudioClipPlayer#play - * @function - * @public * @param {number} loops - how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped. * @param {number} [fadeDuration = 17] - how long should the fading in last in ms */ @@ -172,9 +154,6 @@ export class AudioClipPlayer extends SoundPlayer /** * Stop playing the sound immediately. * - * @name module:sound.AudioClipPlayer#stop - * @function - * @public * @param {number} [fadeDuration = 17] - how long the fading out should last, in ms */ stop(fadeDuration = 17) diff --git a/src/sound/Microphone.js b/src/sound/Microphone.js index 2f839c6..1d1f9d3 100644 --- a/src/sound/Microphone.js +++ b/src/sound/Microphone.js @@ -2,8 +2,8 @@ * Manager handling the recording of audio signal. * * @author Alain Pitiot and Sotiri Bakagiannis - * @version 2021.2.0 - * @copyright (c) 2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -17,18 +17,20 @@ import { AudioClip } from "./AudioClip.js"; /** *

    This manager handles the recording of audio signal.

    * - * @name module:sound.Microphone - * @class - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param @param {module:core.Window} options.win - the associated Window - * @param {string} [options.format='audio/webm;codecs=opus'] the format for the audio file - * @param {number} [options.sampleRateHz= 48000] - the audio sampling rate, in Hz - * @param {Clock} [options.clock= undefined] - an optional clock - * @param {boolean} [options.autoLog= false] - whether or not to log + * @extends PsychObject */ export class Microphone extends PsychObject { + /** + * @memberOf module:sound + * @param {Object} options + * @param {module:core.Window} options.win - the associated Window + * @param {String} options.name - the name used when logging messages from this stimulus + * @param {string} [options.format='audio/webm;codecs=opus'] the format for the audio file + * @param {number} [options.sampleRateHz= 48000] - the audio sampling rate, in Hz + * @param {Clock} [options.clock= undefined] - an optional clock + * @param {boolean} [options.autoLog= false] - whether to log + */ constructor({ win, name, format, sampleRateHz, clock, autoLog } = {}) { super(win._psychoJS); @@ -56,8 +58,6 @@ export class Microphone extends PsychObject *

    Note that it typically takes 50ms-200ms for the recording to actually starts once * a request to start has been submitted.

    * - * @name module:sound.Microphone#start - * @public * @return {Promise} promise fulfilled when the recording actually started */ start() @@ -108,8 +108,6 @@ export class Microphone extends PsychObject /** * Submit a request to stop the recording. * - * @name module:sound.Microphone#stop - * @public * @param {Object} options * @param {string} [options.filename] the name of the file to which the audio recording will be * saved @@ -145,8 +143,6 @@ export class Microphone extends PsychObject /** * Submit a request to pause the recording. * - * @name module:sound.Microphone#pause - * @public * @return {Promise} promise fulfilled when the recording actually paused */ pause() @@ -192,7 +188,6 @@ export class Microphone extends PsychObject * *

    resume has no effect if the recording was not previously paused.

    * - * @name module:sound.Microphone#resume * @param {Object} options * @param {boolean} [options.clear= false] whether or not to empty the audio buffer before * resuming the recording @@ -245,8 +240,6 @@ export class Microphone extends PsychObject /** * Submit a request to flush the recording. * - * @name module:sound.Microphone#flush - * @public * @return {Promise} promise fulfilled when the data has actually been made available */ flush() @@ -273,9 +266,6 @@ export class Microphone extends PsychObject /** * Offer the audio recording to the participant as a sound file to download. * - * @name module:sound.Microphone#download - * @function - * @public * @param {string} filename the filename */ download(filename = "audio.webm") @@ -293,9 +283,6 @@ export class Microphone extends PsychObject /** * Upload the audio recording to the pavlovia server. * - * @name module:sound.Microphone#upload - * @function - * @public * @param {string} tag an optional tag for the audio file */ async upload({ tag } = {}) @@ -331,9 +318,6 @@ export class Microphone extends PsychObject /** * Get the current audio recording as an AudioClip in the given format. * - * @name module:sound.Microphone#getRecording - * @function - * @public * @param {string} tag an optional tag for the audio clip * @param {boolean} [flush=false] whether or not to first flush the recording */ @@ -361,8 +345,6 @@ export class Microphone extends PsychObject * *

    Changes to the settings require the recording to stop and be re-started.

    * - * @name module:sound.Microphone#_onChange - * @function * @protected */ _onChange() @@ -380,8 +362,6 @@ export class Microphone extends PsychObject /** * Prepare the recording. * - * @name module:sound.Microphone#_prepareRecording - * @function * @protected */ async _prepareRecording() diff --git a/src/sound/Sound.js b/src/sound/Sound.js index 51f1b01..cf4ef45 100644 --- a/src/sound/Sound.js +++ b/src/sound/Sound.js @@ -3,8 +3,8 @@ * Sound stimulus. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -35,23 +35,24 @@ import { TrackPlayer } from "./TrackPlayer.js"; * track.setVolume(1.0); * track.play(2); * - * @class * @extends PsychObject - * @param {Object} options - * @param {String} options.name - the name used when logging messages from this stimulus - * @param {module:core.Window} options.win - the associated Window - * @param {number|string} [options.value= 'C'] - the sound value (see above for a full description) - * @param {number} [options.octave= 4] - the octave corresponding to the tone (if applicable) - * @param {number} [options.secs= 0.5] - duration of the tone (in seconds) If secs == -1, the sound will play indefinitely. - * @param {number} [options.startTime= 0] - start of playback for tracks (in seconds) - * @param {number} [options.stopTime= -1] - end of playback for tracks (in seconds) - * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo - * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) - * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played once. If loops == -1, the track or tone will repeat indefinitely until stopped. - * @param {boolean} [options.autoLog= true] whether or not to log */ export class Sound extends PsychObject { + /** + * @param {Object} options + * @param {String} options.name - the name used when logging messages from this stimulus + * @param {module:core.Window} options.win - the associated Window + * @param {number|string} [options.value= 'C'] - the sound value (see above for a full description) + * @param {number} [options.octave= 4] - the octave corresponding to the tone (if applicable) + * @param {number} [options.secs= 0.5] - duration of the tone (in seconds) If secs == -1, the sound will play indefinitely. + * @param {number} [options.startTime= 0] - start of playback for tracks (in seconds) + * @param {number} [options.stopTime= -1] - end of playback for tracks (in seconds) + * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo + * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) + * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played once. If loops == -1, the track or tone will repeat indefinitely until stopped. + * @param {boolean} [options.autoLog= true] whether or not to log + */ constructor({ name, win, @@ -95,7 +96,6 @@ export class Sound extends PsychObject *

    Note: Sounds are played independently from the stimuli of the experiments, i.e. the experiment will not stop until the sound is finished playing. * Repeat calls to play may results in the sounds being played on top of each other.

    * - * @public * @param {number} loops how many times to repeat the sound after it plays once. If loops == -1, the sound will repeat indefinitely until stopped. * @param {boolean} [log= true] whether or not to log */ @@ -108,7 +108,6 @@ export class Sound extends PsychObject /** * Stop playing the sound immediately. * - * @public * @param {Object} options * @param {boolean} [options.log= true] - whether or not to log */ @@ -123,7 +122,6 @@ export class Sound extends PsychObject /** * Get the duration of the sound, in seconds. * - * @public * @return {number} the duration of the sound, in seconds */ getDuration() @@ -134,7 +132,6 @@ export class Sound extends PsychObject /** * Set the playing volume of the sound. * - * @public * @param {number} volume - the volume (values should be between 0 and 1) * @param {boolean} [mute= false] - whether or not to mute the sound * @param {boolean} [log= true] - whether of not to log @@ -152,7 +149,6 @@ export class Sound extends PsychObject /** * Set the sound value on demand past initialisation. * - * @public * @param {object} sound - a sound instance to replace the current one * @param {boolean} [log= true] - whether or not to log */ @@ -181,7 +177,6 @@ export class Sound extends PsychObject /** * Set the number of loops. * - * @public * @param {number} [loops=0] - how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped. * @param {boolean} [log=true] - whether of not to log */ @@ -198,7 +193,6 @@ export class Sound extends PsychObject /** * Set the duration (in seconds) * - * @public * @param {number} [secs=0.5] - duration of the tone (in seconds) If secs == -1, the sound will play indefinitely. * @param {boolean} [log=true] - whether or not to log */ diff --git a/src/sound/SoundPlayer.js b/src/sound/SoundPlayer.js index 4ba5bdb..512c365 100644 --- a/src/sound/SoundPlayer.js +++ b/src/sound/SoundPlayer.js @@ -2,8 +2,8 @@ * Sound player interface * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -12,13 +12,15 @@ import { PsychObject } from "../util/PsychObject.js"; /** *

    SoundPlayer is an interface for the sound players, who are responsible for actually playing the sounds, i.e. the tracks or the tones.

    * - * @name module:sound.SoundPlayer * @interface * @extends PsychObject - * @param {module:core.PsychoJS} psychoJS - the PsychoJS instance */ export class SoundPlayer extends PsychObject { + /** + * @memberOf module:sound + * @param {module:core.PsychoJS} psychoJS - the PsychoJS instance + */ constructor(psychoJS) { super(psychoJS); @@ -27,10 +29,6 @@ export class SoundPlayer extends PsychObject /** * Determine whether this player can play the given sound. * - * @name module:sound.SoundPlayer.accept - * @function - * @static - * @public * @abstract * @param {module:sound.Sound} - the sound * @return {Object|undefined} an instance of the SoundPlayer that can play the sound, or undefined if none could be found @@ -47,9 +45,6 @@ export class SoundPlayer extends PsychObject /** * Start playing the sound. * - * @name module:sound.SoundPlayer#play - * @function - * @public * @abstract * @param {number} [loops] - how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped. */ @@ -65,9 +60,6 @@ export class SoundPlayer extends PsychObject /** * Stop playing the sound immediately. * - * @name module:sound.SoundPlayer#stop - * @function - * @public * @abstract */ stop() @@ -82,9 +74,6 @@ export class SoundPlayer extends PsychObject /** * Get the duration of the sound, in seconds. * - * @name module:sound.SoundPlayer#getDuration - * @function - * @public * @abstract */ getDuration() @@ -99,9 +88,6 @@ export class SoundPlayer extends PsychObject /** * Set the duration of the sound, in seconds. * - * @name module:sound.SoundPlayer#setDuration - * @function - * @public * @abstract */ setDuration(duration_s) @@ -116,9 +102,6 @@ export class SoundPlayer extends PsychObject /** * Set the number of loops. * - * @name module:sound.SoundPlayer#setLoops - * @function - * @public * @abstract * @param {number} loops - how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped. */ @@ -134,9 +117,6 @@ export class SoundPlayer extends PsychObject /** * Set the volume of the tone. * - * @name module:sound.SoundPlayer#setVolume - * @function - * @public * @abstract * @param {Integer} volume - the volume of the tone * @param {boolean} [mute= false] - whether or not to mute the tone diff --git a/docs/sound_Transcriber.js.html b/src/sound/SpeechRecognition.js similarity index 53% rename from docs/sound_Transcriber.js.html rename to src/sound/SpeechRecognition.js index 2457c9c..53dfee3 100644 --- a/docs/sound_Transcriber.js.html +++ b/src/sound/SpeechRecognition.js @@ -1,37 +1,9 @@ - - - - - JSDoc: Source: sound/Transcriber.js - - - - - - - - - - -
    - -

    Source: sound/Transcriber.js

    - - - - - - -
    -
    - 
    /**
- * Manager handling the transcription of Speech into Text.
+/**
+ * Manager handling the live transcription of speech into text.
  *
- * @author Sotiri Bakagiannis and Alain Pitiot
- * @version 2021.2.0
- * @copyright (c) 2021 Open Science Tools Ltd. (https://opensciencetools.org)
+ * @author Alain Pitiot
+ * @version 2022.2.3
+ * @copyright (c) 2022 Open Science Tools Ltd. (https://opensciencetools.org)
  * @license Distributed under the terms of the MIT License
  */
 
@@ -41,13 +13,17 @@ import {PsychoJS} from "../core/PsychoJS";
 
 
 /**
- * Transcript returned by the transcriber
- *
- * @name module:sound.Transcript
- * @class
+ * Transcript.
  */
 export class Transcript
 {
+	/**
+	 * Object holding a transcription result.
+	 *
+	 * @param {SpeechRecognition} transcriber - the transcriber
+	 * @param {string} text - the transcript
+	 * @param {number} confidence - confidence in the transcript
+	 */
 	constructor(transcriber, text = '', confidence = 0.0)
 	{
 		// recognised text:
@@ -69,32 +45,36 @@ export class Transcript
 
 
 /**
- * <p>This manager handles the transcription of speech into text.</p>
- *
- * @name module:sound.Transcriber
- * @class
- * @param {Object} options
- * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
- * @param {String} options.name - the name used when logging messages
- * @param {number} [options.bufferSize= 10000] - the maximum size of the circular transcript buffer
- * @param {String[]} [options.continuous= true] - whether or not to continuously recognise
- * @param {String[]} [options.lang= 'en-US'] - the spoken language
- * @param {String[]} [options.interimResults= false] - whether or not to make interim results available
- * @param {String[]} [options.maxAlternatives= 1] - the maximum number of recognition alternatives
- * @param {String[]} [options.tokens= [] ] - the tokens to be recognised. This is experimental technology, not available in all browser.
- * @param {Clock} [options.clock= undefined] - an optional clock
- * @param {boolean} [options.autoLog= false] - whether or not to log
+ * 
    This manager handles the live transcription of speech into text.
    
  *
+ * @extends PsychObject
  * @todo deal with alternatives, interim results, and recognition errors
  */
-export class Transcriber extends PsychObject
+export class SpeechRecognition extends PsychObject
 {
-
+	/**
+	 * 
    This manager handles the live transcription of speech into text.
    
+	 *
+	 * @memberOf module:sound
+	 * @param {Object} options
+	 * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance
+	 * @param {String} options.name - the name used when logging messages
+	 * @param {number} [options.bufferSize= 10000] - the maximum size of the circular transcript buffer
+	 * @param {String[]} [options.continuous= true] - whether to continuously recognise
+	 * @param {String[]} [options.lang= 'en-US'] - the spoken language
+	 * @param {String[]} [options.interimResults= false] - whether to make interim results available
+	 * @param {String[]} [options.maxAlternatives= 1] - the maximum number of recognition alternatives
+	 * @param {String[]} [options.tokens= [] ] - the tokens to be recognised. This is experimental technology, not available in all browser.
+	 * @param {Clock} [options.clock= undefined] - an optional clock
+	 * @param {boolean} [options.autoLog= false] - whether to log
+	 *
+	 * @todo deal with alternatives, interim results, and recognition errors
+	 */
 	constructor({psychoJS, name, bufferSize, continuous, lang, interimResults, maxAlternatives, tokens, clock, autoLog} = {})
 	{
 		super(psychoJS);
 
-		this._addAttribute('name', name, 'transcriber');
+		this._addAttribute('name', name, 'speech recognition');
 		this._addAttribute('bufferSize', bufferSize, 10000);
 		this._addAttribute('continuous', continuous, true, this._onChange);
 		this._addAttribute('lang', lang, 'en-US', this._onChange);
@@ -105,8 +85,7 @@ export class Transcriber extends PsychObject
 		this._addAttribute('autoLog', false, autoLog);
 		this._addAttribute('status', PsychoJS.Status.NOT_STARTED);
 
-		// prepare the transcription:
-		this._prepareTranscription();
+		this._prepareRecognition();
 
 		if (this._autoLog)
 		{
@@ -116,18 +95,15 @@ export class Transcriber extends PsychObject
 
 
 	/**
-	 * Start the transcription.
+	 * Start the speech recognition process.
 	 *
-	 * @name module:sound.Transcriber#start
-	 * @function
-	 * @public
-	 * @return {Promise} promise fulfilled when the transcription actually started
+	 * @return {Promise} promise fulfilled when the process actually starts
 	 */
 	start()
 	{
 		if (this._status !== PsychoJS.Status.STARTED)
 		{
-			this._psychoJS.logger.debug('request to start speech to text transcription');
+			this._psychoJS.logger.debug('request to start the speech recognition process');
 
 			try
 			{
@@ -138,7 +114,7 @@ export class Transcriber extends PsychObject
 
 				this._recognition.start();
 
-				// return a promise, which will be satisfied when the transcription actually starts,
+				// return a promise, which will be satisfied when the process actually starts,
 				// which is also when the reset of the clock and the change of status takes place
 				const self = this;
 				return new Promise((resolve, reject) =>
@@ -167,22 +143,19 @@ export class Transcriber extends PsychObject
 
 
 	/**
-	 * Stop the transcription.
+	 * Stop the speech recognition process.
 	 *
-	 * @name module:sound.Transcriber#stop
-	 * @function
-	 * @public
-	 * @return {Promise} promise fulfilled when the speech recognition actually stopped
+	 * @return {Promise} promise fulfilled when the process actually stops
 	 */
 	stop()
 	{
 		if (this._status === PsychoJS.Status.STARTED)
 		{
-			this._psychoJS.logger.debug('request to stop speech to text transcription');
+			this._psychoJS.logger.debug('request to stop the speech recognition process');
 
 			this._recognition.stop();
 
-			// return a promise, which will be satisfied when the recognition actually stops:
+			// return a promise, which will be satisfied when the process actually stops:
 			const self = this;
 			return new Promise((resolve, reject) =>
 			{
@@ -197,9 +170,6 @@ export class Transcriber extends PsychObject
 	 * Get the list of transcripts still in the buffer, i.e. those that have not been
 	 * previously cleared by calls to getTranscripts with clear = true.
 	 *
-	 * @name module:sound.Transcriber#getTranscripts
-	 * @function
-	 * @public
 	 * @param {Object} options
 	 * @param {string[]} [options.transcriptList= []]] - the list of transcripts texts to consider. If transcriptList is empty, we consider all transcripts.
 	 * @param {boolean} [options.clear= false] - whether or not to keep in the buffer the transcripts for a subsequent call to getTranscripts. If a keyList has been given and clear = true, we only remove from the buffer those keys in keyList
@@ -216,7 +186,6 @@ export class Transcriber extends PsychObject
 			return [];
 		}
 
-
 		// iterate over the buffer, from start to end, and discard the null transcripts (i.e. those
 		// previously cleared):
 		const filteredTranscripts = [];
@@ -248,9 +217,6 @@ export class Transcriber extends PsychObject
 
 	/**
 	 * Clear all transcripts and resets the circular buffers.
-	 *
-	 * @name module:sound.Transcriber#clearTranscripts
-	 * @function
 	 */
 	clearTranscripts()
 	{
@@ -264,10 +230,9 @@ export class Transcriber extends PsychObject
 	/**
 	 * Callback for changes to the recognition settings.
 	 *
-	 * <p>Changes to the recognition settings require the recognition to stop and be re-started.</p>
+	 * 
    Changes to the recognition settings require the speech recognition process
+	 * to be stopped and be re-started.
    
 	 *
-	 * @name module:sound.Transcriber#_onChange
-	 * @function
 	 * @protected
 	 */
 	_onChange()
@@ -277,25 +242,22 @@ export class Transcriber extends PsychObject
 			this.stop();
 		}
 
-		this._prepareTranscription();
+		this._prepareRecognition();
 
 		this.start();
 	}
 
 
 	/**
-	 * Prepare the transcription.
+	 * Prepare the speech recognition process.
 	 *
-	 * @name module:sound.Transcriber#_prepareTranscription
-	 * @function
 	 * @protected
 	 */
-	_prepareTranscription()
+	_prepareRecognition()
 	{
 		// setup the circular buffer of transcripts:
 		this.clearTranscripts();
 
-
 		// recognition settings:
 		const SpeechRecognition = window.SpeechRecognition || window.webkitSpeechRecognition;
 		this._recognition = new SpeechRecognition();
@@ -305,20 +267,19 @@ export class Transcriber extends PsychObject
 		this._recognition.maxAlternatives = this._maxAlternatives;
 
 		// grammar list with tokens added:
-		if (Array.isArray(this._tokens) && this._tokens.length > 0)
+		if (Array.isArray(this._tokens) && this._tokens.length > 0)
 		{
 			const SpeechGrammarList = window.SpeechGrammarList || window.webkitSpeechGrammarList;
 
 			// note: we accepts JSGF encoded strings, and relative weight indicator between 0.0 and 1.0
 			// ref: https://www.w3.org/TR/jsgf/
-			const name = 'NULL';
-			const grammar = `#JSGF V1.0; grammar ${name}; public <${name}> = ${this._tokens.join('|')};`
+			const name = "NULL";
+			const grammar = `#JSGF V1.0; grammar ${name}; public <${name}> = ${this._tokens.join('|')};`
 			const grammarList = new SpeechGrammarList();
 			grammarList.addFromString(grammar, 1);
 			this._recognition.grammars = grammarList;
 		}
 
-
 		// setup the callbacks:
 		const self = this;
 
@@ -344,7 +305,7 @@ export class Transcriber extends PsychObject
 			this._status = PsychoJS.Status.STARTED;
 			self._psychoJS.logger.debug('speech recognition started');
 
-			// resolve the Transcriber.start promise, if need be:
+			// resolve the SpeechRecognition.start promise, if need be:
 			if (self._startCallback())
 			{
 				self._startCallback({
@@ -359,7 +320,7 @@ export class Transcriber extends PsychObject
 			this._status = PsychoJS.Status.STOPPED;
 			self._psychoJS.logger.debug('speech recognition ended');
 
-			// resolve the Transcriber.stop promise, if need be:
+			// resolve the SpeechRecognition.stop promise, if need be:
 			if (self._stopCallback)
 			{
 				self._stopCallback({
@@ -413,32 +374,8 @@ export class Transcriber extends PsychObject
 			self._psychoJS.logger.error('speech recognition error: ', JSON.stringify(event));
 			self._status = PsychoJS.Status.ERROR;
 		}
-
 	}
 
 }
 
 
-
    -
    -
    - - - - -
    - - - -
    - -
    - Documentation generated by JSDoc 3.6.7 on Thu Jun 16 2022 12:47:14 GMT+0200 (Central European Summer Time) -
    - - - - - diff --git a/src/sound/TonePlayer.js b/src/sound/TonePlayer.js index a552162..488016a 100644 --- a/src/sound/TonePlayer.js +++ b/src/sound/TonePlayer.js @@ -2,8 +2,8 @@ * Tone Player. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -14,18 +14,21 @@ import { SoundPlayer } from "./SoundPlayer.js"; /** *

    This class handles the playing of tones.

    * - * @name module:sound.TonePlayer - * @class * @extends SoundPlayer - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {number} [options.duration_s= 0.5] - duration of the tone (in seconds). If duration_s == -1, the sound will play indefinitely. - * @param {string|number} [options.note= 'C4'] - note (if string) or frequency (if number) - * @param {number} [options.volume= 1.0] - volume of the tone (must be between 0 and 1.0) - * @param {number} [options.loops= 0] - how many times to repeat the tone after it has played once. If loops == -1, the tone will repeat indefinitely until stopped. */ export class TonePlayer extends SoundPlayer { + /** + *

    This class handles the playing of tones.

    + * + * @memberOf module:sound + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {number} [options.duration_s= 0.5] - duration of the tone (in seconds). If duration_s == -1, the sound will play indefinitely. + * @param {string|number} [options.note= 'C4'] - note (if string) or frequency (if number) + * @param {number} [options.volume= 1.0] - volume of the tone (must be between 0 and 1.0) + * @param {number} [options.loops= 0] - how many times to repeat the tone after it has played once. If loops == -1, the tone will repeat indefinitely until stopped. + */ constructor({ psychoJS, note = "C4", @@ -63,10 +66,6 @@ export class TonePlayer extends SoundPlayer *

    Note: if TonePlayer accepts the sound but Tone.js is not available, e.g. if the browser is IE11, * we throw an exception.

    * - * @name module:sound.TonePlayer.accept - * @function - * @static - * @public * @param {module:sound.Sound} sound - the sound * @return {Object|undefined} an instance of TonePlayer that can play the given sound or undefined otherwise */ @@ -117,9 +116,6 @@ export class TonePlayer extends SoundPlayer /** * Get the duration of the sound. * - * @name module:sound.TonePlayer#getDuration - * @function - * @public * @return {number} the duration of the sound, in seconds */ getDuration() @@ -130,9 +126,6 @@ export class TonePlayer extends SoundPlayer /** * Set the duration of the tone. * - * @name module:sound.TonePlayer#setDuration - * @function - * @public * @param {number} duration_s - the duration of the tone (in seconds) If duration_s == -1, the sound will play indefinitely. */ setDuration(duration_s) @@ -143,9 +136,6 @@ export class TonePlayer extends SoundPlayer /** * Set the number of loops. * - * @name module:sound.TonePlayer#setLoops - * @function - * @public * @param {number} loops - how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped. */ setLoops(loops) @@ -156,9 +146,6 @@ export class TonePlayer extends SoundPlayer /** * Set the volume of the tone. * - * @name module:sound.TonePlayer#setVolume - * @function - * @public * @param {Integer} volume - the volume of the tone * @param {boolean} [mute= false] - whether or not to mute the tone */ @@ -188,9 +175,6 @@ export class TonePlayer extends SoundPlayer /** * Start playing the sound. * - * @name module:sound.TonePlayer#play - * @function - * @public * @param {boolean} [loops] - how many times to repeat the sound after it has played once. If loops == -1, the sound will repeat indefinitely until stopped. */ play(loops) @@ -254,10 +238,6 @@ export class TonePlayer extends SoundPlayer /** * Stop playing the sound immediately. - * - * @name module:sound.TonePlayer#stop - * @function - * @public */ stop() { @@ -285,8 +265,6 @@ export class TonePlayer extends SoundPlayer *

    Note: if TonePlayer accepts the sound but Tone.js is not available, e.g. if the browser is IE11, * we throw an exception.

    * - * @name module:sound.TonePlayer._initSoundLibrary - * @function * @protected */ _initSoundLibrary() diff --git a/src/sound/TrackPlayer.js b/src/sound/TrackPlayer.js index a5dcbda..7451ae6 100644 --- a/src/sound/TrackPlayer.js +++ b/src/sound/TrackPlayer.js @@ -2,8 +2,8 @@ * Track Player. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ @@ -12,22 +12,23 @@ import { SoundPlayer } from "./SoundPlayer.js"; /** *

    This class handles the playback of sound tracks.

    * - * @name module:sound.TrackPlayer - * @class * @extends SoundPlayer - * @param {Object} options - * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance - * @param {Object} options.howl - the sound object (see {@link https://howlerjs.com/}) - * @param {number} [options.startTime= 0] - start of playback (in seconds) - * @param {number} [options.stopTime= -1] - end of playback (in seconds) - * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo - * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) - * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played * * @todo stopTime is currently not implemented (tracks will play from startTime to finish) * @todo stereo is currently not implemented */ export class TrackPlayer extends SoundPlayer { + /** + * @memberOf module:sound + * @param {Object} options + * @param {module:core.PsychoJS} options.psychoJS - the PsychoJS instance + * @param {Object} options.howl - the sound object (see {@link https://howlerjs.com/}) + * @param {number} [options.startTime= 0] - start of playback (in seconds) + * @param {number} [options.stopTime= -1] - end of playback (in seconds) + * @param {boolean} [options.stereo= true] whether or not to play the sound or track in stereo + * @param {number} [options.volume= 1.0] - volume of the sound (must be between 0 and 1.0) + * @param {number} [options.loops= 0] - how many times to repeat the track or tone after it has played + */ constructor({ psychoJS, howl, @@ -53,10 +54,6 @@ export class TrackPlayer extends SoundPlayer /** * Determine whether this player can play the given sound. * - * @name module:sound.TrackPlayer.accept - * @function - * @static - * @public * @param {module:sound.Sound} sound - the sound, which should be the name of an audio resource * file * @return {Object|undefined} an instance of TrackPlayer that can play the given track or undefined otherwise @@ -90,9 +87,6 @@ export class TrackPlayer extends SoundPlayer /** * Get the duration of the sound, in seconds. * - * @name module:sound.TrackPlayer#getDuration - * @function - * @public * @return {number} the duration of the track, in seconds */ getDuration() @@ -103,9 +97,6 @@ export class TrackPlayer extends SoundPlayer /** * Set the duration of the track. * - * @name module:sound.TrackPlayer#setDuration - * @function - * @public * @param {number} duration_s - the duration of the track in seconds */ setDuration(duration_s) @@ -120,9 +111,6 @@ export class TrackPlayer extends SoundPlayer /** * Set the volume of the tone. * - * @name module:sound.TrackPlayer#setVolume - * @function - * @public * @param {Integer} volume - the volume of the track (must be between 0 and 1.0) * @param {boolean} [mute= false] - whether or not to mute the track */ @@ -137,9 +125,6 @@ export class TrackPlayer extends SoundPlayer /** * Set the number of loops. * - * @name module:sound.TrackPlayer#setLoops - * @function - * @public * @param {number} loops - how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped. */ setLoops(loops) @@ -160,9 +145,6 @@ export class TrackPlayer extends SoundPlayer /** * Start playing the sound. * - * @name module:sound.TrackPlayer#play - * @function - * @public * @param {number} loops - how many times to repeat the track after it has played once. If loops == -1, the track will repeat indefinitely until stopped. * @param {number} [fadeDuration = 17] - how long should the fading in last in ms */ @@ -201,9 +183,6 @@ export class TrackPlayer extends SoundPlayer /** * Stop playing the sound immediately. * - * @name module:sound.TrackPlayer#stop - * @function - * @public * @param {number} [fadeDuration = 17] - how long should the fading out last in ms */ stop(fadeDuration = 17) diff --git a/src/sound/index.js b/src/sound/index.js index 81637d7..979ef53 100644 --- a/src/sound/index.js +++ b/src/sound/index.js @@ -2,8 +2,7 @@ export * from "./Sound.js"; export * from "./SoundPlayer.js"; export * from "./TonePlayer.js"; export * from "./TrackPlayer.js"; - export * from "./AudioClip.js"; export * from "./AudioClipPlayer.js"; export * from "./Microphone.js"; -// export * from './Transcriber.js'; +export * from './SpeechRecognition.js'; diff --git a/src/util/Clock.js b/src/util/Clock.js index 5259a46..cd89800 100644 --- a/src/util/Clock.js +++ b/src/util/Clock.js @@ -2,20 +2,20 @@ * Clock component. * * @author Alain Pitiot - * @version 2021.2.0 - * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org) + * @version 2022.2.3 + * @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2022 Open Science Tools Ltd. (https://opensciencetools.org) * @license Distributed under the terms of the MIT License */ /** *

    MonotonicClock offers a convenient way to keep track of time during experiments. An experiment can have as many independent clocks as needed, e.g. one to time responses, another one to keep track of stimuli, etc.

    - * - * @name module:util.MonotonicClock - * @class - * @param {number} [startTime=