Skip to content

Commit 3704a52

Browse files
authored
Merge pull request #2946 from jadeddelta/sketchpad-doc-update
sketchpad documentation fixes
2 parents 4533e3d + 5be8bce commit 3704a52

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/plugins/sketchpad.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ In addition to the [parameters available in all plugins](../overview/plugins.md#
2424
| Parameter | Type | Default Value | Description |
2525
| ------------------ | --------------- | ------------- | ---------------------------------------- |
2626
| canvas_shape | `"rectangle"` or `"circle"` | `"rectangle"` | The shape of the canvas element. |
27-
| canvas_width | int | 500 | Width of the canvas in pixels when `canvas_shape` is `"rectangle"` |
28-
| canvas_height | int | 500 | Height of the canvas in pixels when `canvas_shape` is `"rectangle"` |
29-
| canvas_diameter | int | 500 | Diameter of the canvas in pixels when `canvas_shape` is `"circle"` |
30-
| canvas_border_width | int | 0 | Width of the canvas border |
31-
| canvas_border_color | string | `"#000"` | Color of the canvas border |
32-
| background_image | image path | `null` | Path to an image to render as the background of the canvas |
27+
| canvas_width | int | 500 | Width of the canvas in pixels when `canvas_shape` is a `"rectangle"`. |
28+
| canvas_height | int | 500 | Height of the canvas in pixels when `canvas_shape` is a `"rectangle"`. |
29+
| canvas_diameter | int | 500 | Diameter of the canvas in pixels when `canvas_shape` is a `"circle"`. |
30+
| canvas_border_width | int | 0 | Width of the canvas border. |
31+
| canvas_border_color | string | `"#000"` | Color of the canvas border. |
32+
| background_image | image path | `null` | Path to an image to render as the background of the canvas. |
3333
| background_color | string | `"#fff"` | Color of the canvas background. Note that a `background_image` will render on top of the color.
34-
| stroke_width | int | 2 | Width of the stroke on the canvas |
35-
| stroke_color | string | `"#000"` | Color of the stroke on the canvas |
34+
| stroke_width | int | 2 | Width of the stroke on the canvas. |
35+
| stroke_color | string | `"#000"` | Color of the stroke on the canvas. |
3636
| stroke_color_palette | array of strings | `[]` | Array of colors to render as a palette of choices for stroke color. Clicking on the corresponding color button will change the stroke color. |
3737
| prompt | string | null | HTML content to render on the screen.
3838
| prompt_location | `"abovecanvas"` or `"belowcanvas"` or `"belowbutton"` | `"abovecanvas"` | The location to render the prompt content. |
@@ -60,7 +60,7 @@ In addition to the [default data collected by all plugins](../overview/plugins.m
6060
| -------------- | ----------- | ---------------------------------------- |
6161
| rt | int | The length of time from the start of the trial to the end of the trial.
6262
| response | string | If the trial was ended by clicking the finished button, then `"button"`. If the trial was ended by pressing a key, then the key that was pressed. If the trial timed out, then `null`. |
63-
| png | base64 data URL string | If `save_image` is true, then this will contain the base64 encoded data URL for the image, in png format. |
63+
| png | base64 data URL string | If `save_final_image` is true, then this will contain the base64 encoded data URL for the image, in png format. |
6464
| strokes | array of stroke objects | If `save_strokes` is true, then this will contain an array of stroke objects. Objects have an `action` property that is either `"start"`, `"move"`, or `"end"`. If `action` is `"start"` or `"move"` it will have an `x` and `y` property that report the coordinates of the action relative to the upper-left corner of the canvas. If `action` is `"start"` then the object will also have a `t` and `color` property, specifying the time of the action relative to the onset of the trial (ms) and the color of the stroke. If `action` is `"end"` then it will only have a `t` property. |
6565

6666
## Simulation Mode

0 commit comments

Comments
 (0)