# canvas-button-response

Current version: 1.1.2. [See version history](https://github.com/jspsych/jsPsych/blob/main/packages/plugin-canvas-button-response/CHANGELOG.md).

This plugin can be used to draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a button click response and response time. The canvas stimulus can be useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the participant has failed to respond within a fixed length of time. One or more button choices will be displayed under the canvas, and the button style can be customized using HTML formatting.

## Parameters

In addition to the [parameters available in all plugins](../overview/plugins.md#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.

Parameter | Type | Default Value | Description
----------|------|---------------|------------
stimulus | function | *undefined* | The function to draw on the canvas. This function automatically takes a canvas element as its only argument, e.g. `function(c) {...}`  or `function drawStim(c) {...}`, where `c` refers to the canvas element. Note that the stimulus function will still generally need to set the correct context itself, using a line like `let ctx = c.getContext("2d")`.
canvas_size | array | [500, 500] | Array that defines the size of the canvas element in pixels. First value is height, second value is width.
choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button.
button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on.
prompt | string | null | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the participant is supposed to take (e.g., what question to answer).
trial_duration | numeric | null | How long to wait for the participant to make a response before ending the trial in milliseconds. If the participant fails to make a response before this timer is reached, the participant's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial will wait for a response indefinitely.
stimulus_duration | numeric | null | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is null, then the stimulus will remain visible until the trial ends.
margin_vertical | string | '0px' | Vertical margin of the button(s).
margin_horizontal | string | '8px' | Horizontal margin of the button(s).
response_ends_trial | boolean | true | If true, then the trial will end whenever the participant makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the participant to view a stimulus for a fixed amount of time, even if they respond before the time is complete.

## Data Generated

In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.

Name | Type | Value
-----|------|------
rt | numeric | The response time in milliseconds for the participant to make a response. The time is measured from when the stimulus first appears on the screen until the participant's response.
response | numeric | Indicates which button the participant pressed. The first button in the `choices` array is 0, the second is 1, and so on.

Note: the canvas stimulus is *not* included in the trial data because it is a function. Any stimulus information that should be saved in the trial data can be added via the `data` parameter.

## Install

Using the CDN-hosted JavaScript file:

```js
<script src="https://unpkg.com/@jspsych/plugin-canvas-button-response@1.1.2"></script>
```

Using the JavaScript file downloaded from a GitHub release dist archive:

```js
<script src="jspsych/plugin-canvas-button-response.js"></script>
```

Using NPM:

```
npm install @jspsych/plugin-canvas-button-response
```
```js
import canvasButtonResponse from '@jspsych/plugin-canvas-button-response';
```

## Examples

???+ example "Drawing circles based on parameters"
    === "Code"
        ```javascript
        function filledCirc(canvas, radius, color) {
            var ctx = canvas.getContext("2d");
            ctx.beginPath();
            ctx.arc(150, 150, radius, 0, 2 * Math.PI);
            ctx.fillStyle = color;
            ctx.fill();
        }

        var circle_1 = {
            type: jsPsychCanvasButtonResponse,
            stimulus: function(c) {
                filledCirc(c, 100, 'blue');
            },
            canvas_size: [300, 300],
            choices: ['Red', 'Green', 'Blue'],
            prompt: '<p>What color is the circle?</p>',
            data: {color: 'blue', radius: 100}
        };

        var circle_2 = {
            type: jsPsychCanvasButtonResponse,
            stimulus: function(c) {
                filledCirc(c, 150, 'green');
            },
            canvas_size: [300, 300],
            choices: ['Larger', 'Smaller'],
            stimulus_duration: 1000,
            prompt: '<p>Is this circle larger or smaller than the last one?</p>'+
                '<p>Stimulus will be hidden after 1 second.</p>',
            data: {color: 'green', radius: 150}
        };
        ```

    === "Demo"
        <div style="text-align:center;">
            <iframe src="../../demos/jspsych-canvas-button-response-demo1.html" width="90%;" height="500px;" frameBorder="0"></iframe>
        </div>

    <a target="_blank" rel="noopener noreferrer" href="../../demos/jspsych-canvas-button-response-demo1.html">Open demo in new tab</a>

???+ example "Using an anonymous stimulus function"
    === "Code"
        ```javascript
        var lines = {
            type: jsPsychCanvasButtonResponse,
            stimulus: function(c) {
                var ctx = c.getContext("2d");
                // first line
                ctx.beginPath();
                ctx.moveTo(200, 10);
                ctx.lineTo(200, 250);
                ctx.lineWidth = 10;
                ctx.strokeStyle = 'MediumBlue';
                ctx.stroke();
                // second line
                ctx.beginPath();
                ctx.moveTo(20, 100);
                ctx.lineTo(100, 250);
                ctx.lineWidth = 10;
                ctx.strokeStyle = 'MediumPurple';
                ctx.stroke();
            },
            canvas_size: [300, 300],
            choices: ['Blue line', 'Purple line'],
            prompt: '<p>Which line is longer?</p>',
            data: {line1_color: 'blue', line1_length: 290, line2_color: "purple", line2_length: 170}
        };
        ```

    === "Demo"
        <div style="text-align:center;">
            <iframe src="../../demos/jspsych-canvas-button-response-demo2.html" width="90%;" height="500px;" frameBorder="0"></iframe>
        </div>

    <a target="_blank" rel="noopener noreferrer" href="../../demos/jspsych-canvas-button-response-demo2.html">Open demo in new tab</a>


???+ example "Using the canvas stimulus function with timeline variables, and recording the correctness of responses"
    === "Code"
        ```javascript
        function filledCirc(canvas, radius, color) {
            var ctx = canvas.getContext("2d");
            ctx.beginPath();
            ctx.arc(150, 150, radius, 0, 2 * Math.PI);
            ctx.fillStyle = color;
            ctx.fill();
        }

        var circle_procedure = {
            timeline: [
                {
                    type: jsPsychCanvasButtonResponse,
                    stimulus: function(c) {
                        filledCirc(c, jsPsych.timelineVariable('radius'), jsPsych.timelineVariable('color'));
                    },
                    canvas_size: [300, 300],
                    choices: ['Red', 'Green', 'Blue'],
                    prompt: '<p>What color is the circle?</p>',
                    data: {
                        radius: jsPsych.timelineVariable('radius'), 
                        color: jsPsych.timelineVariable('color'),
                        correct_response: jsPsych.timelineVariable('correct_response')
                    },
                    on_finish: function(data){
                        data.correct = data.response == data.correct_response;
                    }
                }
            ],
            timeline_variables: [
                {radius: 80, color: 'red', correct_response: 0},
                {radius: 100, color: 'green', correct_response: 1},
                {radius: 50, color: 'blue', correct_response: 2}
            ],
            randomize_order: true
        };        
        ```

    === "Demo"
        <div style="text-align:center;">
            <iframe src="../../demos/jspsych-canvas-button-response-demo3.html" width="90%;" height="500px;" frameBorder="0"></iframe>
        </div>

    <a target="_blank" rel="noopener noreferrer" href="../../demos/jspsych-canvas-button-response-demo3.html">Open demo in new tab</a>
