Graphs and images

Drawing Response

Draw or annotate an answer on a canvas.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

No print view in this package

The placeholder prompt "This is the question prompt" above Fill color (White) and Outline color (Black) menus, a toolbar with select, pencil, line, rectangle, circle, text and eraser tools plus Undo and Clear All, and an empty canvas. — Drawing Response example

Try the interaction

Live example: @pie-element/drawing-response@13.0.4 · players 1.0.0-beta.5.

Open all examples for this element →

Use it in an item

Map the tag to an exact package version and match the model ID to the markup. The item player loads the views. You can use any frontend framework.

{
  "elements": {
    "drawing-response": "@pie-element/drawing-response@13.0.4"
  },
  "markup": "<drawing-response id=\"example\"></drawing-response>",
  "models": [
    {
      "id": "example",
      "element": "drawing-response",
      "prompt": "This is the question prompt",
      "promptEnabled": true,
      "backgroundImageEnabled": true,
      "toolbarEditorPosition": "bottom",
      "imageUrl": "",
      "imageDimensions": {
        "height": 0,
        "width": 0
      },
      "rubricEnabled": false
    }
  ]
}

Embed an item · Embed authoring · Print integration

Responses and scoring

Your application needs to arrange manual or external scoring for this response.

Scoring, partial credit and rubrics →

Model, configuration and session reference

The model holds content, configuration controls the editor, and the session holds the response. Fields below come from generated JSON Schemas.

Schema version: @pie-element/drawing-response@13.0.6. Example version: 13.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.

model fields (17)

Field	Type	Meaning	Default / values
`id`Required	`string`	Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.	`—`
`element`Required	`string`	The html Element tag name: the key in the item config's `elements` map, e.g. "multiple-choice"	`—`
`accessibilityCatalogs`	`array`	QTI-aligned accessibility catalogs whose cards dock to content nodes by `data-catalog-idref`	`—`
`prompt`	`string`	The question prompt or item stem	`—`
`promptEnabled`	`boolean`	Indicates if the prompt is enabled	`—`
`imageUrl`	`string`	The image over which shapes, patterns and texts will be added	`—`
`imageDimensions`	`Dimensions`	The dimensions of the image	`—`
`studentInstructions`	`string`	Not read by this element.	`—`
`teacherInstructions`	`string`	Indicates teacher instructions	`—`
`studentInstructionsEnabled`	`boolean`	Not read by this element. Default models include it.	`—`
`teacherInstructionsEnabled`	`boolean`	Indicates if Teacher Instructions are enabled	`—`
`spellCheckEnabled`	`boolean`	Indicates if spellcheck is enabled for the author. Default value is true	`—`
`backgroundImageEnabled`	`boolean`	Indicates if Background Image is enabled	`—`
`toolbarEditorPosition`	`string`	Indicates the editor's toolbar position which can be 'bottom' or 'top'	`"bottom"`["bottom","top"]
`rubricEnabled`	`boolean`	Indicates if Rubric is enabled	`—`
`language`	`string`	Indicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX	`—`
`extraCSSRules`	`ExtraCSSRules`	Host-supplied CSS scoped to the element	`—`

Named object types

AccessibilityCatalog

Field	Type	Meaning	Default / values
`identifier`Required	`string`	See the named type or the example model.	`—`
`cards`Required	`array`	See the named type or the example model.	`—`

CatalogCard

Field	Type	Meaning	Default / values
`catalog`Required	`string`	See the named type or the example model.	`—`
`language`	`string`	See the named type or the example model.	`—`
`content`	`string`	See the named type or the example model.	`—`
`payload`	`CatalogCardPayload`	See the named type or the example model.	`—`

SignLanguageCardPayload

Field	Type	Meaning	Default / values
`signLang`	`string`	Language tag for the signed translation — BCP 47, which admits ISO 639-3 subtags for languages with no 639-1/2 code. "ase" is ASL, matching QTI 3 `xml:lang`. This is the language of the adaptation, not the item's base content language (AfA/PNP's `languageOfAdaptation`). The distinction is load bearing: a Spanish item's signed alternate is LSM, not ASL, so `signLang` must never be inferred from the item or assessment content language. Optional, and redundant on almost every card. The card's `language` states the same code and is the only field pie-players resolves a card on — resolution runs before anything knows the card is a signing card, so it can only key on the generic field — and the player falls back to it when this is absent. Author it only where the two differ: a card tagged with the item's content language (`language: 'en-US'`, `signLang: 'ase'`) so resolution reaches it by the default-language rung. The pie-api-aws importer emits `language` alone.	`—`
`media`Required	`MediaAssetRef`	See the named type or the example model.	`—`
`fragment`	`MediaFragmentRange`	See the named type or the example model.	`—`

MediaAssetRef

Field	Type	Meaning	Default / values
`version`Required	`number`	See the named type or the example model.	`—`
`id`Required	`string`	See the named type or the example model.	`—`
`kind`Required	`MediaKind`	See the named type or the example model.	`—`
`sources`Required	`array`	See the named type or the example model.	`—`
`poster`	`string`	See the named type or the example model.	`—`
`thumbnail`	`string`	See the named type or the example model.	`—`
`durationSeconds`	`number`	See the named type or the example model.	`—`
`tracks`	`array`	See the named type or the example model.	`—`
`transcript`	`TranscriptRef`	See the named type or the example model.	`—`
`label`	`string`	See the named type or the example model.	`—`
`description`	`string`	See the named type or the example model.	`—`
`lang`	`string`	Language of the asset itself, as authored metadata. Sign-language cards leave it unset: the card's `language` already states the adaptation language, and a second copy is a second thing to keep in agreement.	`—`

MediaSource

Field	Type	Meaning	Default / values
`src`Required	`string`	See the named type or the example model.	`—`
`type`	`string`	MIME type, e.g. "video/mp4".	`—`
`width`	`number`	See the named type or the example model.	`—`
`height`	`number`	See the named type or the example model.	`—`
`bitrate`	`number`	See the named type or the example model.	`—`

TextTrackRef

Field	Type	Meaning	Default / values
`src`Required	`string`	See the named type or the example model.	`—`
`kind`Required	`string`	See the named type or the example model.	`—`["captions","subtitles","descriptions","chapters","metadata"]
`lang`Required	`string`	See the named type or the example model.	`—`
`label`Required	`string`	See the named type or the example model.	`—`
`default`	`boolean`	See the named type or the example model.	`—`

TranscriptRef

Field	Type	Meaning	Default / values
`src`	`string`	See the named type or the example model.	`—`
`html`	`string`	See the named type or the example model.	`—`
`plainText`	`string`	See the named type or the example model.	`—`
`lang`	`string`	See the named type or the example model.	`—`

MediaFragmentRange

Field	Type	Meaning	Default / values
`startSeconds`Required	`number`	See the named type or the example model.	`—`
`endSeconds`	`number`	See the named type or the example model.	`—`

SpokenAudioCardPayload

Field	Type	Meaning	Default / values
`media`Required	`MediaAssetRef`	See the named type or the example model.	`—`
`fragment`	`MediaFragmentRange`	See the named type or the example model.	`—`

Dimensions

Field	Type	Meaning	Default / values
`height`Required	`number`	the height of the section	`—`
`width`Required	`number`	the width of the section	`—`

ExtraCSSRules

Field	Type	Meaning	Default / values
`names`	`array`	See the named type or the example model.	`—`
`rules`	`string`	See the named type or the example model.	`—`

Open the complete JSON Schema

configuration fields (18)

Field	Type	Meaning	Default / values
`baseInputConfiguration`	`EditableHtmlConfigureProp`	Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image	`—`
`backgroundImage`	`ConfigurePropWithEnabled`	Configuration for the background image toggle; `enabled` is not read	`—`
`partialScoring`	`ConfigureProp`	Not read by this element: drawing responses are scored manually	`—`
`settingsPanelDisabled`	`boolean`	Indicates if the settings panel is not available	`—`
`spellCheck`	`ConfigurePropWithEnabled`	Configuration for the author's spellcheck; `enabled` is not read	`—`
`studentInstructions`	`ConfigureProp`	Not read by this element.	`—`
`teacherInstructions`	`EditableHtmlPluginConfigureRequired`	Teacher Instructions configuration	`—`
`prompt`	`EditableHtmlPluginConfigureRequired`	Prompt configuration	`—`
`maxImageWidth`	`ConfigureMaxImageDimensionsProp`	Maximum image width for input fields	`—`
`maxImageHeight`	`ConfigureMaxImageDimensionsProp`	Maximum image height for input fields	`—`
`withRubric`	`ConfigureWithForceProp`	Rubric configuration - only relevant in environments that use pie-player-components	`—`
`mathMlOptions`	`ConfigureMathMLProp`	Configuration for editable-html	`—`
`language`	`ConfigurePropWithEnabled`	Language configuration	`—`
`languageChoices`	`ConfigureLanguageOptions`	Language choices configuration Only available if language is enabled	`—`
`contentDimensions`	`ContentDimensions`	Dimensions of the authoring container	`—`
`showPrompt`	`boolean`	Not read by this element: the model's `promptEnabled` shows the prompt	`—`
`promptLabel`	`string`	Not read by this element: the prompt field is labelled "Item Stem"	`—`
`settingsPartialScoring`	`boolean`	Not read by this element: drawing responses are scored manually	`—`

Named object types

EditableHtmlConfigureProp

Field	Type	Meaning	Default / values
`math`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`audio`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`video`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`image`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`customPlugins`	`array`	An array of objects that determine custom plugins. A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when the button gets pressed (event).	`—`
`blockquote`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`h3`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`characters`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`bold`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`html`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`italic`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`ol_list`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`redo`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`strikethrough`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`sub`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`sup`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`table`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`ul_list`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`underline`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`undo`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`textAlign`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`showParagraphs`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`separateParagraphs`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`pasteFormatting`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`superscript`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`subscript`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`languageCharacters`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`
`responseArea`	`EditableHtmlButtonConfigure`	See the named type or the example model.	`—`

EditableHtmlButtonConfigure

Field	Type	Meaning	Default / values
`disabled`	`boolean`	Indicates if the plugin is disabled or not	`—`

CustomPlugin

Field	Type	Meaning	Default / values
`event`Required	`string`	The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used). The event is emitted with the "PIE-" prefix.	`—`
`iconAlt`Required	`string`	The alt for the custom button icon	`—`
`iconType`Required	`string`	The icon type. Currently, only "SVG" is supported.	`—`
`icon`Required	`string`	The icon string. Currently, only SVG is supported, so it needs to be a valid svg.	`—`

ConfigurePropWithEnabled

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`enabled`	`boolean`	Indicates the value of the item if it affects config-ui (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)	`—`

ConfigureProp

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`

EditableHtmlPluginConfigureRequired

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`inputConfiguration`	`EditableHtmlConfigureProp`	Configuration for editable-html	`—`
`required`	`boolean`	Indicates if the item is required and the value cannot be empty	`—`

ConfigureMaxImageDimensionsProp

Field	Type	Meaning	Default / values
`teacherInstructions`	`number`	Indicates the max dimension for images in teacher instructions	`—`
`prompt`	`number`	Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified	`—`
`rationale`	`number`	Indicates the max dimension for images in rationale	`—`

ConfigureWithForceProp

Field	Type	Meaning	Default / values
`settings`	`boolean`	Indicates if the item has to be displayed in the Settings Panel	`—`
`label`	`string`	Indicates the label for the item that has to be displayed in the Settings Panel	`—`
`forceEnabled`	`boolean`	Indicates the value for the toggle; if true: - this property will not be visible in Settings Panel (settings will become automatically false) - the model property afferent to it will become automatically false	`—`

ConfigureMathMLProp

Field	Type	Meaning	Default / values
`mmlOutput`	`boolean`	Indicates if model should have mathML output instead of latex	`—`
`mmlEditing`	`boolean`	Indicates if mathML that's already in model should be editable	`—`

ConfigureLanguageOptions

Field	Type	Meaning	Default / values
`label`Required	`string`	See the named type or the example model.	`—`
`options`Required	`array`	See the named type or the example model.	`—`

ConfigureLanguageOptionsProp

Field	Type	Meaning	Default / values
`value`Required	`string`	Value of the language option	`—`
`label`Required	`string`	Label of the language option	`—`

ContentDimensions

Field	Type	Meaning	Default / values
`maxHeight`	`string \| number`	See the named type or the example model.	`—`
`maxWidth`	`string \| number`	See the named type or the example model.	`—`
`minHeight`	`string \| number`	See the named type or the example model.	`—`
`minWidth`	`string \| number`	See the named type or the example model.	`—`

Open the complete JSON Schema

session fields (5)

Field	Type	Meaning	Default / values
`id`	`string`	Identifier of the session	`—`
`element`	`string`	The element the session belongs to	`—`
`drawables`	`array`	The shapes the learner drew	`—`
`texts`	`array`	The text boxes the learner added	`—`
`width`	`number`	Width of the drawing area when the session was saved; delivery restores the drawing area to it	`—`

Named object types

DrawingResponseDrawable

Field	Type	Meaning	Default / values
`type`Required	`string`	The tool that drew the shape	`—`["FreePathDrawable","LineDrawable","RectangleDrawable","CircleDrawable","EraserDrawable"]
`startx`	`number`	x position where drawing started	`—`
`starty`	`number`	y position where drawing started	`—`
`createdAt`	`string`	ISO timestamp of when the shape was drawn; it orders undo	`—`
`fillColor`	`string`	Fill color of rectangles and circles	`—`
`outlineColor`	`string`	Outline color of rectangles and circles	`—`
`paintColor`	`string`	Color applied with the paint tool	`—`
`points`	`array`	Flat x, y coordinate list of free paths and eraser strokes	`—`
`posX`	`number`	x offset after the shape was dragged	`—`
`posY`	`number`	y offset after the shape was dragged	`—`
`x`	`number`	End x of lines and rectangles; center x of circles	`—`
`y`	`number`	End y of lines and rectangles; center y of circles	`—`
`width`	`number`	Width of rectangles	`—`
`height`	`number`	Height of rectangles	`—`
`radius`	`number`	Radius of circles	`—`

DrawingResponseText

Field	Type	Meaning	Default / values
`id`Required	`string`	Identifier of the text box	`—`
`type`	`string`	Always "text-entry"	`—`
`text`	`string`	The text shown on the canvas	`—`
`value`	`string`	The value of the text box's editor	`—`
`label`	`string`	Placeholder shown before the learner edits the text box	`—`
`isDefault`	`boolean`	Indicates the text box still shows its placeholder	`—`
`x`	`number`	x position	`—`
`y`	`number`	y position	`—`
`width`	`number`	Width of the text box	`—`
`createdAt`	`string`	ISO timestamp of when the text box was added; it orders undo	`—`
`textVisible`	`boolean`	Indicates the text node is shown	`—`
`transformerVisible`	`boolean`	Indicates the resize handles are shown	`—`
`textareaVisible`	`boolean`	Indicates the editor is shown	`—`

Open the complete JSON Schema

How to use the schemas →

Accessibility and content requirements

PIE targets WCAG 2.2 AA. Provide clear prompts and media alternatives, and test the question with a keyboard and assistive technology. Manual testing is still incomplete; see the coverage notes below.

Accessibility and evidence · Element evidence and manual checks(opens in new tab)

Element package source(opens in new tab) · Example source(opens in new tab) · Snapshot cb30a68f