← Element library

Math

Fraction Model

Shade parts of a model to show a fraction.

Delivery

Respond, review and evaluate

Authoring

Visual editor available

Print

No print view in this package

The title "Representing Improper Fractions" with the prompt "Shade the pie models to represent 7/4 (seven fourths)." and the hint "This is more than one whole!" above two unshaded circles, each divided into four numbered parts.
Fraction Model example

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
        }
      ]
    }
  ]
}

Embed an item · Embed authoring · Print integration

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.

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/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)
FieldTypeMeaningDefault / values
idRequiredstringIdentifier to identify the Pie Element in html markup, Must be unique within a pie item config.—
elementRequiredstringThe html Element tag name: the key in the item config's `elements` map, e.g. "multiple-choice"—
accessibilityCatalogsarrayQTI-aligned accessibility catalogs whose cards dock to content nodes by `data-catalog-idref`—
correctResponsearrayArray of ResponseObject for correct response[]
titlestringThe title prompt of the item""
promptstringThe question prompt or item stem""
modelTypeSelectedstringIndicates if the model type should be Bar or Pie model"bar"["bar","pie"]
maxModelSelectednumberIndicates max no of models to be selected1
partsPerModelnumberIndicates parts per model to be selected5
allowedStudentConfigbooleanIndicates if student can configure no of models and parts per modelfalse
showGraphLabelsbooleanDetermines if graph labels visible or notfalse
languagestringIndicates the language of the component Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX—
spellCheckEnabledbooleanIndicates if spellcheck is enabled for the author's title and prompt editors—
toolbarEditorPositionstringIndicates the editor's toolbar position which can be 'bottom' or 'top'"bottom"["bottom","top"]
extraCSSRulesExtraCSSRulesHost-supplied CSS scoped to the element—

Named object types

AccessibilityCatalog
FieldTypeMeaningDefault / values
identifierRequiredstringSee the named type or the example model.—
cardsRequiredarraySee the named type or the example model.—
CatalogCard
FieldTypeMeaningDefault / values
catalogRequiredstringSee the named type or the example model.—
languagestringSee the named type or the example model.—
contentstringSee the named type or the example model.—
payloadCatalogCardPayloadSee the named type or the example model.—
SignLanguageCardPayload
FieldTypeMeaningDefault / values
signLangstringLanguage 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.—
mediaRequiredMediaAssetRefSee the named type or the example model.—
fragmentMediaFragmentRangeSee the named type or the example model.—
MediaAssetRef
FieldTypeMeaningDefault / values
versionRequirednumberSee the named type or the example model.—
idRequiredstringSee the named type or the example model.—
kindRequiredMediaKindSee the named type or the example model.—
sourcesRequiredarraySee the named type or the example model.—
posterstringSee the named type or the example model.—
thumbnailstringSee the named type or the example model.—
durationSecondsnumberSee the named type or the example model.—
tracksarraySee the named type or the example model.—
transcriptTranscriptRefSee the named type or the example model.—
labelstringSee the named type or the example model.—
descriptionstringSee the named type or the example model.—
langstringLanguage 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
FieldTypeMeaningDefault / values
srcRequiredstringSee the named type or the example model.—
typestringMIME type, e.g. "video/mp4".—
widthnumberSee the named type or the example model.—
heightnumberSee the named type or the example model.—
bitratenumberSee the named type or the example model.—
TextTrackRef
FieldTypeMeaningDefault / values
srcRequiredstringSee the named type or the example model.—
kindRequiredstringSee the named type or the example model.—["captions","subtitles","descriptions","chapters","metadata"]
langRequiredstringSee the named type or the example model.—
labelRequiredstringSee the named type or the example model.—
defaultbooleanSee the named type or the example model.—
TranscriptRef
FieldTypeMeaningDefault / values
srcstringSee the named type or the example model.—
htmlstringSee the named type or the example model.—
plainTextstringSee the named type or the example model.—
langstringSee the named type or the example model.—
MediaFragmentRange
FieldTypeMeaningDefault / values
startSecondsRequirednumberSee the named type or the example model.—
endSecondsnumberSee the named type or the example model.—
SpokenAudioCardPayload
FieldTypeMeaningDefault / values
mediaRequiredMediaAssetRefSee the named type or the example model.—
fragmentMediaFragmentRangeSee the named type or the example model.—
FractionModelResponse
FieldTypeMeaningDefault / values
idRequirednumberIndicates the response id for bar or pie model: the model's 1-based position—
valueRequirednumberIndicates the selected response sector for model value: the number of parts selected in the model—
ExtraCSSRules
FieldTypeMeaningDefault / values
namesarraySee the named type or the example model.—
rulesstringSee the named type or the example model.—
Open the complete JSON Schema
configuration fields (14)
FieldTypeMeaningDefault / values
baseInputConfigurationEditableHtmlConfigurePropBase editable html input configuration regarding plugins that are enabled/disabled E.g. audio, video, image—
titleFractionModelFieldConfigurationConfiguration for html input configuration regarding plugins that are enabled/disabled on item title E.g. audio, video, image—
promptFractionModelFieldConfigurationConfiguration for html input configuration regarding plugins that are enabled/disabled on question stem E.g. audio, video, image—
modelOptionsFractionModelOptionsConfigurationConfiguration for model options selection like Parts per model, max no. of models etc—
mathMlOptionsConfigureMathMLPropConfiguration for editable-html—
languageConfigurePropWithEnabledLanguage configuration—
languageChoicesConfigureLanguageOptionsLanguage choices configuration Only available if language is enabled—
contentDimensionsContentDimensionsDimensions of the authoring container—
spellCheckConfigurePropWithEnabledNot read by this element: the model's `spellCheckEnabled` sets spellcheck—
settingsPanelDisabledbooleanNot read by this element: the settings panel is always hidden—
feedbackConfigurePropNot read by this element: it has no feedback—
showPromptbooleanNot read by this element: the prompt is always shown—
promptLabelstringNot read by this element: `prompt.label` labels the prompt—
settingsPartialScoringbooleanNot read by this element: it has no partial scoring—

Named object types

EditableHtmlConfigureProp
FieldTypeMeaningDefault / values
mathEditableHtmlButtonConfigureSee the named type or the example model.—
audioEditableHtmlButtonConfigureSee the named type or the example model.—
videoEditableHtmlButtonConfigureSee the named type or the example model.—
imageEditableHtmlButtonConfigureSee the named type or the example model.—
customPluginsarrayAn 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).—
blockquoteEditableHtmlButtonConfigureSee the named type or the example model.—
h3EditableHtmlButtonConfigureSee the named type or the example model.—
charactersEditableHtmlButtonConfigureSee the named type or the example model.—
boldEditableHtmlButtonConfigureSee the named type or the example model.—
htmlEditableHtmlButtonConfigureSee the named type or the example model.—
italicEditableHtmlButtonConfigureSee the named type or the example model.—
ol_listEditableHtmlButtonConfigureSee the named type or the example model.—
redoEditableHtmlButtonConfigureSee the named type or the example model.—
strikethroughEditableHtmlButtonConfigureSee the named type or the example model.—
subEditableHtmlButtonConfigureSee the named type or the example model.—
supEditableHtmlButtonConfigureSee the named type or the example model.—
tableEditableHtmlButtonConfigureSee the named type or the example model.—
ul_listEditableHtmlButtonConfigureSee the named type or the example model.—
underlineEditableHtmlButtonConfigureSee the named type or the example model.—
undoEditableHtmlButtonConfigureSee the named type or the example model.—
textAlignEditableHtmlButtonConfigureSee the named type or the example model.—
showParagraphsEditableHtmlButtonConfigureSee the named type or the example model.—
separateParagraphsEditableHtmlButtonConfigureSee the named type or the example model.—
pasteFormattingEditableHtmlButtonConfigureSee the named type or the example model.—
superscriptEditableHtmlButtonConfigureSee the named type or the example model.—
subscriptEditableHtmlButtonConfigureSee the named type or the example model.—
languageCharactersEditableHtmlButtonConfigureSee the named type or the example model.—
responseAreaEditableHtmlButtonConfigureSee the named type or the example model.—
EditableHtmlButtonConfigure
FieldTypeMeaningDefault / values
disabledbooleanIndicates if the plugin is disabled or not—
CustomPlugin
FieldTypeMeaningDefault / values
eventRequiredstringThe 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.—
iconAltRequiredstringThe alt for the custom button icon—
iconTypeRequiredstringThe icon type. Currently, only "SVG" is supported.—
iconRequiredstringThe icon string. Currently, only SVG is supported, so it needs to be a valid svg.—
FractionModelFieldConfiguration
FieldTypeMeaningDefault / values
settingsbooleanNot read by this element: it has no settings panel—
labelstringIndicates the label of the field—
enabledbooleanNot read by this element: the field is always shown—
inputConfigurationEditableHtmlConfigurePropConfiguration for editable-html—
FractionModelOptionsConfiguration
FieldTypeMeaningDefault / values
maxOfModelFractionModelNumberOptionIndicates the max number of models for item—
partsPerModelFractionModelNumberOptionIndicates the parts per model for item—
modelTypeChoicesarrayIndicates the model types of item—
FractionModelNumberOption
FieldTypeMeaningDefault / values
minnumberIndicates the min value for number model—
maxnumberIndicates the max value for number model—
defaultnumberNot read by this element: the controller defaults set the starting value—
FractionModelTypeChoice
FieldTypeMeaningDefault / values
valueRequiredstringIndicates the value for model choice—["bar","pie"]
labelRequiredstringIndicates the label for model choice—
ConfigureMathMLProp
FieldTypeMeaningDefault / values
mmlOutputbooleanIndicates if model should have mathML output instead of latex—
mmlEditingbooleanIndicates if mathML that's already in model should be editable—
ConfigurePropWithEnabled
FieldTypeMeaningDefault / values
settingsbooleanIndicates if the item has to be displayed in the Settings Panel—
labelstringIndicates the label for the item that has to be displayed in the Settings Panel—
enabledbooleanIndicates 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
FieldTypeMeaningDefault / values
labelRequiredstringSee the named type or the example model.—
optionsRequiredarraySee the named type or the example model.—
ConfigureLanguageOptionsProp
FieldTypeMeaningDefault / values
valueRequiredstringValue of the language option—
labelRequiredstringLabel of the language option—
ContentDimensions
FieldTypeMeaningDefault / values
maxHeightstring | numberSee the named type or the example model.—
maxWidthstring | numberSee the named type or the example model.—
minHeightstring | numberSee the named type or the example model.—
minWidthstring | numberSee the named type or the example model.—
ConfigureProp
FieldTypeMeaningDefault / values
settingsbooleanIndicates if the item has to be displayed in the Settings Panel—
labelstringIndicates the label for the item that has to be displayed in the Settings Panel—
Open the complete JSON Schema
session fields (3)
FieldTypeMeaningDefault / values
idstringIdentifier of the session—
elementstringThe element the session belongs to—
answersFractionModelAnswersWhat the student entered; absent until the element first renders—

Named object types

FractionModelAnswers
FieldTypeMeaningDefault / values
responseRequiredarrayThe parts the student selected, one entry per model with a selection—
noOfModelunionThe number of models the student chose; written only when the model's `allowedStudentConfig` is set, and empty until the student enters one—
partsPerModelunionThe parts per model the student chose; written only when the model's `allowedStudentConfig` is set, and empty until the student enters one—
FractionModelResponse
FieldTypeMeaningDefault / values
idRequirednumberIndicates the response id for bar or pie model: the model's 1-based position—
valueRequirednumberIndicates the selected response sector for model value: the number of parts selected in the model—
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