/** * jspsych-canvas-button-response * Chris Jungerius (modified from Josh de Leeuw) * * a jsPsych plugin for displaying a canvas stimulus and getting a button response * * documentation: docs.jspsych.org * **/ import jsPsych from "jspsych"; const plugin = {}; plugin.info = { name: "canvas-button-response", description: "", parameters: { stimulus: { type: jsPsych.plugins.parameterType.FUNCTION, pretty_name: "Stimulus", default: undefined, description: "The drawing function to apply to the canvas. Should take the canvas object as argument.", }, choices: { type: jsPsych.plugins.parameterType.STRING, pretty_name: "Choices", default: undefined, array: true, description: "The labels for the buttons.", }, button_html: { type: jsPsych.plugins.parameterType.STRING, pretty_name: "Button HTML", default: '', array: true, description: "The html of the button. Can create own style.", }, prompt: { type: jsPsych.plugins.parameterType.STRING, pretty_name: "Prompt", default: null, description: "Any content here will be displayed under the button.", }, stimulus_duration: { type: jsPsych.plugins.parameterType.INT, pretty_name: "Stimulus duration", default: null, description: "How long to hide the stimulus.", }, trial_duration: { type: jsPsych.plugins.parameterType.INT, pretty_name: "Trial duration", default: null, description: "How long to show the trial.", }, margin_vertical: { type: jsPsych.plugins.parameterType.STRING, pretty_name: "Margin vertical", default: "0px", description: "The vertical margin of the button.", }, margin_horizontal: { type: jsPsych.plugins.parameterType.STRING, pretty_name: "Margin horizontal", default: "8px", description: "The horizontal margin of the button.", }, response_ends_trial: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: "Response ends trial", default: true, description: "If true, then trial will end when user responds.", }, canvas_size: { type: jsPsych.plugins.parameterType.INT, array: true, pretty_name: "Canvas size", default: [500, 500], description: "Array containing the height (first value) and width (second value) of the canvas element.", }, }, }; plugin.trial = function (display_element, trial) { // create canvas var html = '
' + '' + "
"; //display buttons var buttons = []; if (Array.isArray(trial.button_html)) { if (trial.button_html.length == trial.choices.length) { buttons = trial.button_html; } else { console.error( "Error in canvas-button-response plugin. The length of the button_html array does not equal the length of the choices array" ); } } else { for (var i = 0; i < trial.choices.length; i++) { buttons.push(trial.button_html); } } html += '
'; for (var i = 0; i < trial.choices.length; i++) { var str = buttons[i].replace(/%choice%/g, trial.choices[i]); html += '
' + str + "
"; } html += "
"; //show prompt if there is one if (trial.prompt !== null) { html += trial.prompt; } display_element.innerHTML = html; //draw let c = document.getElementById("jspsych-canvas-stimulus"); trial.stimulus(c); // start time var start_time = performance.now(); // add event listeners to buttons for (var i = 0; i < trial.choices.length; i++) { display_element .querySelector("#jspsych-canvas-button-response-button-" + i) .addEventListener("click", function (e) { var choice = e.currentTarget.getAttribute("data-choice"); // don't use dataset for jsdom compatibility after_response(choice); }); } // store response var response = { rt: null, button: null, }; // function to handle responses by the subject function after_response(choice) { // measure rt var end_time = performance.now(); var rt = end_time - start_time; response.button = parseInt(choice); response.rt = rt; // after a valid response, the stimulus will have the CSS class 'responded' // which can be used to provide visual feedback that a response was recorded display_element.querySelector("#jspsych-canvas-button-response-stimulus").className += " responded"; // disable all the buttons after a response var btns = document.querySelectorAll(".jspsych-canvas-button-response-button button"); for (var i = 0; i < btns.length; i++) { //btns[i].removeEventListener('click'); btns[i].setAttribute("disabled", "disabled"); } if (trial.response_ends_trial) { end_trial(); } } // function to end trial when it is time function end_trial() { // kill any remaining setTimeout handlers jsPsych.pluginAPI.clearAllTimeouts(); // gather the data to store for the trial var trial_data = { rt: response.rt, response: response.button, }; // clear the display display_element.innerHTML = ""; // move on to the next trial jsPsych.finishTrial(trial_data); } // hide image if timing is set if (trial.stimulus_duration !== null) { jsPsych.pluginAPI.setTimeout(function () { display_element.querySelector("#jspsych-canvas-button-response-stimulus").style.visibility = "hidden"; }, trial.stimulus_duration); } // end trial if time limit is set if (trial.trial_duration !== null) { jsPsych.pluginAPI.setTimeout(function () { end_trial(); }, trial.trial_duration); } }; export default plugin;