Math
Fraction Model
Shade parts of a model to show a fraction.
Delivery
Respond, review and evaluate
Authoring
Visual editor available
No print view in this package

Try the interaction
Live example: @pie-element/fraction-model@7.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": {
"fraction-model": "@pie-element/fraction-model@7.0.4"
},
"markup": "<fraction-model id=\"example\"></fraction-model>",
"models": [
{
"id": "example",
"element": "fraction-model",
"title": "Understanding Halves",
"prompt": "<p>Shade the model to show <strong>1/2</strong> (one half).</p>",
"modelTypeSelected": "bar",
"maxModelSelected": 1,
"partsPerModel": 2,
"allowedStudentConfig": false,
"showGraphLabels": false,
"correctResponse": [
{
"id": 1,
"value": 1
}
]
}
]
} Responses and scoring
The controller defines scoring for this element. Browser scoring returns one outcome per element. Your application combines those outcomes into an item score and handles trusted server scoring.
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/fraction-model@7.0.6. Example version: 7.0.4. Use the schema matching your content. Schema checks cover data structure; controller validation checks authoring rules.
model fields (15)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | string | Identifier to identify the Pie Element in html markup, Must be unique within a pie item config. | — |
elementRequired | 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` | — |
correctResponse | array | Array of ResponseObject for correct response | [] |
title | string | The title prompt of the item | "" |
prompt | string | The question prompt or item stem | "" |
modelTypeSelected | string | Indicates if the model type should be Bar or Pie model | "bar"["bar","pie"] |
maxModelSelected | number | Indicates max no of models to be selected | 1 |
partsPerModel | number | Indicates parts per model to be selected | 5 |
allowedStudentConfig | boolean | Indicates if student can configure no of models and parts per model | false |
showGraphLabels | boolean | Determines if graph labels visible or not | false |
language | string | Indicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX | — |
spellCheckEnabled | boolean | Indicates if spellcheck is enabled for the author's title and prompt editors | — |
toolbarEditorPosition | string | Indicates the editor's toolbar position which can be 'bottom' or 'top' | "bottom"["bottom","top"] |
extraCSSRules | ExtraCSSRules | Host-supplied CSS scoped to the element | — |
Named object types
AccessibilityCatalog
| Field | Type | Meaning | Default / values |
|---|---|---|---|
identifierRequired | string | See the named type or the example model. | — |
cardsRequired | array | See the named type or the example model. | — |
CatalogCard
| Field | Type | Meaning | Default / values |
|---|---|---|---|
catalogRequired | 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. | — |
mediaRequired | 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 |
|---|---|---|---|
versionRequired | number | See the named type or the example model. | — |
idRequired | string | See the named type or the example model. | — |
kindRequired | MediaKind | See the named type or the example model. | — |
sourcesRequired | 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 |
|---|---|---|---|
srcRequired | 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 |
|---|---|---|---|
srcRequired | string | See the named type or the example model. | — |
kindRequired | string | See the named type or the example model. | —["captions","subtitles","descriptions","chapters","metadata"] |
langRequired | string | See the named type or the example model. | — |
labelRequired | 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 |
|---|---|---|---|
startSecondsRequired | 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 |
|---|---|---|---|
mediaRequired | MediaAssetRef | See the named type or the example model. | — |
fragment | MediaFragmentRange | See the named type or the example model. | — |
FractionModelResponse
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | number | Indicates the response id for bar or pie model: the model's 1-based position | — |
valueRequired | number | Indicates the selected response sector for model value: the number of parts selected in the model | — |
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. | — |
configuration fields (14)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
baseInputConfiguration | EditableHtmlConfigureProp | Base editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image | — |
title | FractionModelFieldConfiguration | Configuration for html input configuration regarding plugins that are enabled/disabled on item title E.g. audio, video, image | — |
prompt | FractionModelFieldConfiguration | Configuration for html input configuration regarding plugins that are enabled/disabled on question stem E.g. audio, video, image | — |
modelOptions | FractionModelOptionsConfiguration | Configuration for model options selection like Parts per model, max no. of models etc | — |
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 | — |
spellCheck | ConfigurePropWithEnabled | Not read by this element: the model's `spellCheckEnabled` sets spellcheck | — |
settingsPanelDisabled | boolean | Not read by this element: the settings panel is always hidden | — |
feedback | ConfigureProp | Not read by this element: it has no feedback | — |
showPrompt | boolean | Not read by this element: the prompt is always shown | — |
promptLabel | string | Not read by this element: `prompt.label` labels the prompt | — |
settingsPartialScoring | boolean | Not read by this element: it has no partial scoring | — |
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 |
|---|---|---|---|
eventRequired | 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. | — |
iconAltRequired | string | The alt for the custom button icon | — |
iconTypeRequired | string | The icon type. Currently, only "SVG" is supported. | — |
iconRequired | string | The icon string. Currently, only SVG is supported, so it needs to be a valid svg. | — |
FractionModelFieldConfiguration
| Field | Type | Meaning | Default / values |
|---|---|---|---|
settings | boolean | Not read by this element: it has no settings panel | — |
label | string | Indicates the label of the field | — |
enabled | boolean | Not read by this element: the field is always shown | — |
inputConfiguration | EditableHtmlConfigureProp | Configuration for editable-html | — |
FractionModelOptionsConfiguration
| Field | Type | Meaning | Default / values |
|---|---|---|---|
maxOfModel | FractionModelNumberOption | Indicates the max number of models for item | — |
partsPerModel | FractionModelNumberOption | Indicates the parts per model for item | — |
modelTypeChoices | array | Indicates the model types of item | — |
FractionModelNumberOption
| Field | Type | Meaning | Default / values |
|---|---|---|---|
min | number | Indicates the min value for number model | — |
max | number | Indicates the max value for number model | — |
default | number | Not read by this element: the controller defaults set the starting value | — |
FractionModelTypeChoice
| Field | Type | Meaning | Default / values |
|---|---|---|---|
valueRequired | string | Indicates the value for model choice | —["bar","pie"] |
labelRequired | string | Indicates the label for model choice | — |
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 | — |
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) | — |
ConfigureLanguageOptions
| Field | Type | Meaning | Default / values |
|---|---|---|---|
labelRequired | string | See the named type or the example model. | — |
optionsRequired | array | See the named type or the example model. | — |
ConfigureLanguageOptionsProp
| Field | Type | Meaning | Default / values |
|---|---|---|---|
valueRequired | string | Value of the language option | — |
labelRequired | 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. | — |
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 | — |
session fields (3)
| Field | Type | Meaning | Default / values |
|---|---|---|---|
id | string | Identifier of the session | — |
element | string | The element the session belongs to | — |
answers | FractionModelAnswers | What the student entered; absent until the element first renders | — |
Named object types
FractionModelAnswers
| Field | Type | Meaning | Default / values |
|---|---|---|---|
responseRequired | array | The parts the student selected, one entry per model with a selection | — |
noOfModel | union | The number of models the student chose; written only when the model's `allowedStudentConfig` is set, and empty until the student enters one | — |
partsPerModel | union | The parts per model the student chose; written only when the model's `allowedStudentConfig` is set, and empty until the student enters one | — |
FractionModelResponse
| Field | Type | Meaning | Default / values |
|---|---|---|---|
idRequired | number | Indicates the response id for bar or pie model: the model's 1-based position | — |
valueRequired | number | Indicates the selected response sector for model value: the number of parts selected in the model | — |
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