mirror of
https://github.com/jspsych/jsPsych.git
synced 2025-05-10 19:20:55 +00:00
332 lines
12 KiB
JavaScript
332 lines
12 KiB
JavaScript
/**
|
|
* jspsych-image-slider-response
|
|
* a jspsych plugin for free response survey questions
|
|
*
|
|
* Josh de Leeuw
|
|
*
|
|
* documentation: docs.jspsych.org
|
|
*
|
|
*/
|
|
|
|
|
|
jsPsych.plugins['image-slider-response'] = (function() {
|
|
|
|
var plugin = {};
|
|
|
|
jsPsych.pluginAPI.registerPreload('image-slider-response', 'stimulus', 'image');
|
|
|
|
plugin.info = {
|
|
name: 'image-slider-response',
|
|
description: '',
|
|
parameters: {
|
|
stimulus: {
|
|
type: jsPsych.plugins.parameterType.IMAGE,
|
|
pretty_name: 'Stimulus',
|
|
default: undefined,
|
|
description: 'The image to be displayed'
|
|
},
|
|
stimulus_height: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Image height',
|
|
default: null,
|
|
description: 'Set the image height in pixels'
|
|
},
|
|
stimulus_width: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Image width',
|
|
default: null,
|
|
description: 'Set the image width in pixels'
|
|
},
|
|
maintain_aspect_ratio: {
|
|
type: jsPsych.plugins.parameterType.BOOL,
|
|
pretty_name: 'Maintain aspect ratio',
|
|
default: true,
|
|
description: 'Maintain the aspect ratio after setting width or height'
|
|
},
|
|
min: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Min slider',
|
|
default: 0,
|
|
description: 'Sets the minimum value of the slider.'
|
|
},
|
|
max: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Max slider',
|
|
default: 100,
|
|
description: 'Sets the maximum value of the slider',
|
|
},
|
|
slider_start: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Slider starting value',
|
|
default: 50,
|
|
description: 'Sets the starting value of the slider',
|
|
},
|
|
step: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name: 'Step',
|
|
default: 1,
|
|
description: 'Sets the step of the slider'
|
|
},
|
|
labels: {
|
|
type: jsPsych.plugins.parameterType.HTML_STRING,
|
|
pretty_name:'Labels',
|
|
default: [],
|
|
array: true,
|
|
description: 'Labels of the slider.',
|
|
},
|
|
slider_width: {
|
|
type: jsPsych.plugins.parameterType.INT,
|
|
pretty_name:'Slider width',
|
|
default: null,
|
|
description: 'Width of the slider in pixels.'
|
|
},
|
|
button_label: {
|
|
type: jsPsych.plugins.parameterType.STRING,
|
|
pretty_name: 'Button label',
|
|
default: 'Continue',
|
|
array: false,
|
|
description: 'Label of the button to advance.'
|
|
},
|
|
require_movement: {
|
|
type: jsPsych.plugins.parameterType.BOOL,
|
|
pretty_name: 'Require movement',
|
|
default: false,
|
|
description: 'If true, the participant will have to move the slider before continuing.'
|
|
},
|
|
prompt: {
|
|
type: jsPsych.plugins.parameterType.STRING,
|
|
pretty_name: 'Prompt',
|
|
default: null,
|
|
description: 'Any content here will be displayed below the slider.'
|
|
},
|
|
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.'
|
|
},
|
|
response_ends_trial: {
|
|
type: jsPsych.plugins.parameterType.BOOL,
|
|
pretty_name: 'Response ends trial',
|
|
default: true,
|
|
description: 'If true, trial will end when user makes a response.'
|
|
},
|
|
render_on_canvas: {
|
|
type: jsPsych.plugins.parameterType.BOOL,
|
|
pretty_name: 'Render on canvas',
|
|
default: true,
|
|
description: 'If true, the image will be drawn onto a canvas element (prevents blank screen between consecutive images in some browsers).'+
|
|
'If false, the image will be shown via an img element.'
|
|
}
|
|
}
|
|
}
|
|
|
|
plugin.trial = function(display_element, trial) {
|
|
|
|
var height, width;
|
|
var html;
|
|
if (trial.render_on_canvas) {
|
|
// first clear the display element (because the render_on_canvas method appends to display_element instead of overwriting it with .innerHTML)
|
|
if (display_element.hasChildNodes()) {
|
|
// can't loop through child list because the list will be modified by .removeChild()
|
|
while (display_element.firstChild) {
|
|
display_element.removeChild(display_element.firstChild);
|
|
}
|
|
}
|
|
// create wrapper div, canvas element and image
|
|
var content_wrapper = document.createElement('div');
|
|
content_wrapper.id = "jspsych-image-slider-response-wrapper";
|
|
content_wrapper.style.margin = "100px 0px";
|
|
var canvas = document.createElement("canvas");
|
|
canvas.id = "jspsych-image-slider-response-stimulus";
|
|
canvas.style.margin = 0;
|
|
canvas.style.padding = 0;
|
|
var img = new Image();
|
|
img.src = trial.stimulus;
|
|
// determine image height and width
|
|
if (trial.stimulus_height !== null) {
|
|
height = trial.stimulus_height;
|
|
if (trial.stimulus_width == null && trial.maintain_aspect_ratio) {
|
|
width = img.naturalWidth * (trial.stimulus_height/img.naturalHeight);
|
|
}
|
|
} else {
|
|
height = img.naturalHeight;
|
|
}
|
|
if (trial.stimulus_width !== null) {
|
|
width = trial.stimulus_width;
|
|
if (trial.stimulus_height == null && trial.maintain_aspect_ratio) {
|
|
height = img.naturalHeight * (trial.stimulus_width/img.naturalWidth);
|
|
}
|
|
} else if (!(trial.stimulus_height !== null & trial.maintain_aspect_ratio)) {
|
|
// if stimulus width is null, only use the image's natural width if the width value wasn't set
|
|
// in the if statement above, based on a specified height and maintain_aspect_ratio = true
|
|
width = img.naturalWidth;
|
|
}
|
|
canvas.height = height;
|
|
canvas.width = width;
|
|
// create container with slider and labels
|
|
var slider_container = document.createElement('div');
|
|
slider_container.classList.add("jspsych-image-slider-response-container");
|
|
slider_container.style.position = "relative";
|
|
slider_container.style.margin = "0 auto 3em auto";
|
|
if(trial.slider_width !== null){
|
|
slider_container.style.width = trial.slider_width.toString()+'px';
|
|
}
|
|
// create html string with slider and labels, and add to slider container
|
|
html ='<input type="range" value="'+trial.slider_start+'" min="'+trial.min+'" max="'+trial.max+'" step="'+trial.step+'" style="width: 100%;" id="jspsych-image-slider-response-response"></input>';
|
|
html += '<div>'
|
|
for(var j=0; j < trial.labels.length; j++){
|
|
var label_width = 100/(trial.labels.length-1);
|
|
var left_offset = (j * (100 /(trial.labels.length - 1))) - (label_width/2);
|
|
html += '<div style="display: inline-block; position: absolute; left:'+left_offset+'%; text-align: center; width: '+label_width+'%;">';
|
|
html += '<span style="text-align: center; font-size: 80%;">'+trial.labels[j]+'</span>';
|
|
html += '</div>'
|
|
}
|
|
html += '</div>';
|
|
slider_container.innerHTML = html;
|
|
// add canvas and slider to content wrapper div
|
|
content_wrapper.insertBefore(canvas, content_wrapper.firstElementChild);
|
|
content_wrapper.insertBefore(slider_container, canvas.nextElementSibling);
|
|
// add content wrapper div to screen and draw image on canvas
|
|
display_element.insertBefore(content_wrapper, null);
|
|
var ctx = canvas.getContext("2d");
|
|
ctx.drawImage(img,0,0,width,height);
|
|
// add prompt if there is one
|
|
if (trial.prompt !== null) {
|
|
var prompt_div = document.createElement("div");
|
|
prompt_div.innerHTML = trial.prompt;
|
|
display_element.insertBefore(prompt_div, slider_container.nextElementSibling);
|
|
}
|
|
// add submit button
|
|
var submit_btn = document.createElement('button');
|
|
submit_btn.id = "jspsych-image-slider-response-next";
|
|
submit_btn.classList.add("jspsych-btn");
|
|
submit_btn.disabled = (trial.require_movement) ? true : false;
|
|
submit_btn.innerHTML = trial.button_label;
|
|
display_element.insertBefore(submit_btn, display_element.nextElementSibling);
|
|
|
|
} else {
|
|
|
|
html = '<div id="jspsych-image-slider-response-wrapper" style="margin: 100px 0px;">';
|
|
html += '<div id="jspsych-image-slider-response-stimulus">';
|
|
html += '<img src="'+trial.stimulus+'">';
|
|
html += '</div>';
|
|
html += '<div class="jspsych-image-slider-response-container" style="position:relative; margin: 0 auto 3em auto; ';
|
|
if(trial.slider_width !== null){
|
|
html += 'width:'+trial.slider_width+'px;';
|
|
}
|
|
html += '">';
|
|
html += '<input type="range" value="'+trial.slider_start+'" min="'+trial.min+'" max="'+trial.max+'" step="'+trial.step+'" style="width: 100%;" id="jspsych-image-slider-response-response"></input>';
|
|
html += '<div>'
|
|
for(var j=0; j < trial.labels.length; j++){
|
|
var label_width = 100/(trial.labels.length-1);
|
|
var left_offset = (j * (100 /(trial.labels.length - 1))) - (label_width/2);
|
|
html += '<div style="display: inline-block; position: absolute; left:'+left_offset+'%; text-align: center; width: '+label_width+'%;">';
|
|
html += '<span style="text-align: center; font-size: 80%;">'+trial.labels[j]+'</span>';
|
|
html += '</div>'
|
|
}
|
|
html += '</div>';
|
|
html += '</div>';
|
|
html += '</div>';
|
|
|
|
if (trial.prompt !== null){
|
|
html += '<div>'+trial.prompt+'</div>';
|
|
}
|
|
|
|
// add submit button
|
|
html += '<button id="jspsych-image-slider-response-next" class="jspsych-btn" '+ (trial.require_movement ? "disabled" : "") + '>'+trial.button_label+'</button>';
|
|
|
|
display_element.innerHTML = html;
|
|
|
|
// set image dimensions after image has loaded (so that we have access to naturalHeight/naturalWidth)
|
|
var img = display_element.querySelector('img');
|
|
if (trial.stimulus_height !== null) {
|
|
height = trial.stimulus_height;
|
|
if (trial.stimulus_width == null && trial.maintain_aspect_ratio) {
|
|
width = img.naturalWidth * (trial.stimulus_height/img.naturalHeight);
|
|
}
|
|
} else {
|
|
height = img.naturalHeight;
|
|
}
|
|
if (trial.stimulus_width !== null) {
|
|
width = trial.stimulus_width;
|
|
if (trial.stimulus_height == null && trial.maintain_aspect_ratio) {
|
|
height = img.naturalHeight * (trial.stimulus_width/img.naturalWidth);
|
|
}
|
|
} else if (!(trial.stimulus_height !== null & trial.maintain_aspect_ratio)) {
|
|
// if stimulus width is null, only use the image's natural width if the width value wasn't set
|
|
// in the if statement above, based on a specified height and maintain_aspect_ratio = true
|
|
width = img.naturalWidth;
|
|
}
|
|
img.style.height = height.toString() + "px";
|
|
img.style.width = width.toString() + "px";
|
|
}
|
|
|
|
var response = {
|
|
rt: null,
|
|
response: null
|
|
};
|
|
|
|
if(trial.require_movement){
|
|
display_element.querySelector('#jspsych-image-slider-response-response').addEventListener('click', function(){
|
|
display_element.querySelector('#jspsych-image-slider-response-next').disabled = false;
|
|
});
|
|
}
|
|
|
|
display_element.querySelector('#jspsych-image-slider-response-next').addEventListener('click', function() {
|
|
// measure response time
|
|
var endTime = performance.now();
|
|
response.rt = endTime - startTime;
|
|
response.response = display_element.querySelector('#jspsych-image-slider-response-response').valueAsNumber;
|
|
|
|
if(trial.response_ends_trial){
|
|
end_trial();
|
|
} else {
|
|
display_element.querySelector('#jspsych-image-slider-response-next').disabled = true;
|
|
}
|
|
|
|
});
|
|
|
|
function end_trial(){
|
|
|
|
jsPsych.pluginAPI.clearAllTimeouts();
|
|
|
|
// save data
|
|
var trialdata = {
|
|
"rt": response.rt,
|
|
"stimulus": trial.stimulus,
|
|
"slider_start": trial.slider_start,
|
|
"response": response.response
|
|
};
|
|
|
|
display_element.innerHTML = '';
|
|
|
|
// next trial
|
|
jsPsych.finishTrial(trialdata);
|
|
}
|
|
|
|
if (trial.stimulus_duration !== null) {
|
|
jsPsych.pluginAPI.setTimeout(function() {
|
|
display_element.querySelector('#jspsych-image-slider-response-stimulus').style.visibility = 'hidden';
|
|
}, trial.stimulus_duration);
|
|
}
|
|
|
|
// end trial if trial_duration is set
|
|
if (trial.trial_duration !== null) {
|
|
jsPsych.pluginAPI.setTimeout(function() {
|
|
end_trial();
|
|
}, trial.trial_duration);
|
|
}
|
|
|
|
var startTime = performance.now();
|
|
};
|
|
|
|
return plugin;
|
|
})();
|