jspsych 6.3.0 → 7.1.1

package/plugins/jspsych-image-slider-response.js

@@ -1,369 +0,0 @@
-/**
- * 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;
-    // half of the thumb width value from jspsych.css, used to adjust the label positions
-    var half_thumb_width = 7.5; 
-    
-    if (trial.render_on_canvas) {
-      var image_drawn = false;
-      // 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 ctx = canvas.getContext("2d");
-      var img = new Image();   
-      img.onload = function() {
-        // if image wasn't preloaded, then it will need to be drawn whenever it finishes loading
-        if (!image_drawn) {
-          getHeightWidth(); // only possible to get width/height after image loads
-          ctx.drawImage(img,0,0,width,height);
-        }
-      };
-      img.src = trial.stimulus;
-      // get/set image height and width - this can only be done after image loads because uses image's naturalWidth/naturalHeight properties
-      function getHeightWidth() {
-        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;
-      }
-      getHeightWidth(); // call now, in case image loads immediately (is cached)
-      // 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" class="jspsych-slider" value="'+trial.slider_start+'" min="'+trial.min+'" max="'+trial.max+'" step="'+trial.step+'" id="jspsych-image-slider-response-response"></input>';
-      html += '<div>'
-      for(var j=0; j < trial.labels.length; j++){
-        var label_width_perc = 100/(trial.labels.length-1);
-        var percent_of_range = j * (100/(trial.labels.length - 1));
-        var percent_dist_from_center = ((percent_of_range-50)/50)*100;
-        var offset = (percent_dist_from_center * half_thumb_width)/100;
-        html += '<div style="border: 1px solid transparent; display: inline-block; position: absolute; '+
-        'left:calc('+percent_of_range+'% - ('+label_width_perc+'% / 2) - '+offset+'px); text-align: center; width: '+label_width_perc+'%;">';
-        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);
-      if (img.complete && Number.isFinite(width) && Number.isFinite(height)) {
-        // if image has loaded and width/height have been set, then draw it now
-        // (don't rely on img onload function to draw image when image is in the cache, because that causes a delay in the image presentation)
-        ctx.drawImage(img,0,0,width,height);
-        image_drawn = true;  
-      }
-      // add prompt if there is one
-      if (trial.prompt !== null) {
-        display_element.insertAdjacentHTML('beforeend', trial.prompt);
-      }
-      // 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+'" style="';
-      if(trial.stimulus_height !== null){
-        html += 'height:'+trial.stimulus_height+'px; '
-        if(trial.stimulus_width == null && trial.maintain_aspect_ratio){
-          html += 'width: auto; ';
-         }
-      }
-      if(trial.stimulus_width !== null){
-        html += 'width:'+trial.stimulus_width+'px; '
-        if(trial.stimulus_height == null && trial.maintain_aspect_ratio){
-          html += 'height: auto; ';
-        }
-      }
-      html += '"></img>';
-      html += '</div>';
-      html += '<div class="jspsych-image-slider-response-container" style="position:relative; margin: 0 auto 3em auto; width:';
-      if (trial.slider_width !== null) {
-        html += trial.slider_width+'px;';
-      } else {
-        html += 'auto;';
-      }
-      html += '">';
-      html += '<input type="range" class="jspsych-slider" value="'+trial.slider_start+'" min="'+trial.min+'" max="'+trial.max+'" step="'+trial.step+'" id="jspsych-image-slider-response-response"></input>';
-      html += '<div>'
-      for(var j=0; j < trial.labels.length; j++){
-        var label_width_perc = 100/(trial.labels.length-1);
-        var percent_of_range = j * (100/(trial.labels.length - 1));
-        var percent_dist_from_center = ((percent_of_range-50)/50)*100;
-        var offset = (percent_dist_from_center * half_thumb_width)/100;
-        html += '<div style="border: 1px solid transparent; display: inline-block; position: absolute; '+
-        'left:calc('+percent_of_range+'% - ('+label_width_perc+'% / 2) - '+offset+'px); text-align: center; width: '+label_width_perc+'%;">';
-        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 += trial.prompt;
-      }
-
-      // 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;
-})();

package/plugins/jspsych-instructions.js

@@ -1,237 +0,0 @@
-/* jspsych-instructions.js
- * Josh de Leeuw
- *
- * This plugin displays text (including HTML formatted strings) during the experiment.
- * Use it to show instructions, provide performance feedback, etc...
- *
- * Page numbers can be displayed to help with navigation by setting show_page_number
- * to true.
- *
- * documentation: docs.jspsych.org
- *
- *
- */
-
-jsPsych.plugins.instructions = (function() {
-
-  var plugin = {};
-
-  plugin.info = {
-    name: 'instructions',
-    description: '',
-    parameters: {
-      pages: {
-        type: jsPsych.plugins.parameterType.HTML_STRING,
-        pretty_name: 'Pages',
-        default: undefined,
-        array: true,
-        description: 'Each element of the array is the content for a single page.'
-      },
-      key_forward: {
-        type: jsPsych.plugins.parameterType.KEY,
-        pretty_name: 'Key forward',
-        default: 'ArrowRight',
-        description: 'The key the subject can press in order to advance to the next page.'
-      },
-      key_backward: {
-        type: jsPsych.plugins.parameterType.KEY,
-        pretty_name: 'Key backward',
-        default: 'ArrowLeft',
-        description: 'The key that the subject can press to return to the previous page.'
-      },
-      allow_backward: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Allow backward',
-        default: true,
-        description: 'If true, the subject can return to the previous page of the instructions.'
-      },
-      allow_keys: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Allow keys',
-        default: true,
-        description: 'If true, the subject can use keyboard keys to navigate the pages.'
-      },
-      show_clickable_nav: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Show clickable nav',
-        default: false,
-        description: 'If true, then a "Previous" and "Next" button will be displayed beneath the instructions.'
-      },
-      show_page_number: {
-          type: jsPsych.plugins.parameterType.BOOL,
-          pretty_name: 'Show page number',
-          default: false,
-          description: 'If true, and clickable navigation is enabled, then Page x/y will be shown between the nav buttons.'
-      },
-      page_label: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Page label',
-        default: 'Page',
-        description: 'The text that appears before x/y (current/total) pages displayed with show_page_number'
-      },      
-      button_label_previous: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Button label previous',
-        default: 'Previous',
-        description: 'The text that appears on the button to go backwards.'
-      },
-      button_label_next: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Button label next',
-        default: 'Next',
-        description: 'The text that appears on the button to go forwards.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    var current_page = 0;
-
-    var view_history = [];
-
-    var start_time = performance.now();
-
-    var last_page_update_time = start_time;
-
-    function btnListener(evt){
-    	evt.target.removeEventListener('click', btnListener);
-    	if(this.id === "jspsych-instructions-back"){
-    		back();
-    	}
-    	else if(this.id === 'jspsych-instructions-next'){
-    		next();
-    	}
-    }
-
-    function show_current_page() {
-      var html = trial.pages[current_page];
-
-      var pagenum_display = "";
-      if(trial.show_page_number) {
-          pagenum_display = "<span style='margin: 0 1em;' class='"+
-          "jspsych-instructions-pagenum'>"+ trial.page_label + ' ' +(current_page+1)+"/"+trial.pages.length+"</span>";
-      }
-     
-      if (trial.show_clickable_nav) {
-
-        var nav_html = "<div class='jspsych-instructions-nav' style='padding: 10px 0px;'>";
-        if (trial.allow_backward) {
-          var allowed = (current_page > 0 )? '' : "disabled='disabled'";
-          nav_html += "<button id='jspsych-instructions-back' class='jspsych-btn' style='margin-right: 5px;' "+allowed+">&lt; "+trial.button_label_previous+"</button>";
-        }
-        if (trial.pages.length > 1 && trial.show_page_number) {
-            nav_html += pagenum_display;
-        }
-        nav_html += "<button id='jspsych-instructions-next' class='jspsych-btn'"+
-            "style='margin-left: 5px;'>"+trial.button_label_next+
-            " &gt;</button></div>";
-
-        html += nav_html;
-        display_element.innerHTML = html;
-        if (current_page != 0 && trial.allow_backward) {
-          display_element.querySelector('#jspsych-instructions-back').addEventListener('click', btnListener);
-        }
-
-        display_element.querySelector('#jspsych-instructions-next').addEventListener('click', btnListener);
-      } else {
-        if (trial.show_page_number && trial.pages.length > 1) {
-          // page numbers for non-mouse navigation
-          html += "<div class='jspsych-instructions-pagenum'>"+pagenum_display+"</div>"
-        } 
-        display_element.innerHTML = html;
-      }
-      
-    }
-
-    function next() {
-
-      add_current_page_to_view_history()
-
-      current_page++;
-
-      // if done, finish up...
-      if (current_page >= trial.pages.length) {
-        endTrial();
-      } else {
-        show_current_page();
-      }
-
-    }
-
-    function back() {
-
-      add_current_page_to_view_history()
-
-      current_page--;
-
-      show_current_page();
-    }
-
-    function add_current_page_to_view_history() {
-
-      var current_time = performance.now();
-
-      var page_view_time = current_time - last_page_update_time;
-
-      view_history.push({
-        page_index: current_page,
-        viewing_time: page_view_time
-      });
-
-      last_page_update_time = current_time;
-    }
-
-    function endTrial() {
-
-      if (trial.allow_keys) {
-        jsPsych.pluginAPI.cancelKeyboardResponse(keyboard_listener);
-      }
-
-      display_element.innerHTML = '';
-
-      var trial_data = {
-        view_history: view_history,
-        rt: performance.now() - start_time
-      };
-
-      jsPsych.finishTrial(trial_data);
-    }
-
-    var after_response = function(info) {
-
-      // have to reinitialize this instead of letting it persist to prevent accidental skips of pages by holding down keys too long
-      keyboard_listener = jsPsych.pluginAPI.getKeyboardResponse({
-        callback_function: after_response,
-        valid_responses: [trial.key_forward, trial.key_backward],
-        rt_method: 'performance',
-        persist: false,
-        allow_held_key: false
-      });
-      // check if key is forwards or backwards and update page
-      if (jsPsych.pluginAPI.compareKeys(info.key, trial.key_backward)) {
-        if (current_page !== 0 && trial.allow_backward) {
-          back();
-        }
-      }
-
-      if (jsPsych.pluginAPI.compareKeys(info.key, trial.key_forward)) {
-        next();
-      }
-
-    };
-
-    show_current_page();
-
-    if (trial.allow_keys) {
-      var keyboard_listener = jsPsych.pluginAPI.getKeyboardResponse({
-        callback_function: after_response,
-        valid_responses: [trial.key_forward, trial.key_backward],
-        rt_method: 'performance',
-        persist: false
-      });
-    }
-  };
-
-  return plugin;
-})();