Jump to navigation

Class: Part

Numbas.parts.Part

new Part(index, pathopt, question, parentPart, storeopt)

Base question part object.

Parameters:
Name Type Attributes Default Description
index number

The index of the part's definition.
path Numbas.parts.partpath <optional>
 'p0'
question Numbas.Question
parentPart Numbas.parts.Part
store Numbas.storage.BlankStorage <optional>
Properties:
Name Type Description
isStep boolean

Is this part a step?
isGap boolean

Is this part a gap?
full_path string

A globally-unique path to this part, including the parent question's number.
Source:
See:

Members

alternativeFeedbackMessage :string

Feedback message shown if this part is used as an alternative.

Type:
Source:

alternatives :Array.<Numbas.parts.Part>

Child alternative parts.

Type:
Source:

answered :boolean

Has this part been answered?

Type:
Source:

creditFraction :Numbas.math.Fraction

Credit as a fraction. Used to avoid simple floating point errors.

Type:
Source:

customName :string

Custom name for this part, or null if none. Variables will be substituted into this string from the part's scope.

Type:
Source:

display :Numbas.display.PartDisplay

Associated display object. It is not safe to assume this is always present - in the editor, parts have no display.

Type:
Source:

doesMarking :boolean

Does this mark do any marking? False for information only parts.

Type:
Source:

finalised_result :Numbas.marking.finalised_state

The result of the last marking run.

Type:
Source:

gaps :Array.<Numbas.parts.Part>

Child gapfill parts.

Type:
Source:

isDirty :boolean

Has the student changed their answer since last submitting?

Type:
Source:

json :object

JSON defining this part.

Type:
Source:

locked :boolean

Is this part locked? If false, the student can change and submit their answer.

Type:
Source:

markingFeedback :Array.<Numbas.parts.feedbackmessage>

Messages explaining how marks were awarded.

Type:
Source:

markingScript :Numbas.marking.MarkingScript

The script to mark this part - assign credit, and give messages and feedback.

Type:
Source:

marks :number

Maximum marks available for this part.

Type:
Source:

name :string

A readable name for this part, to show to the student. Change it with Numbas.parts.Part#setName.

Type:
Source:

parentPart :Numbas.parts.Part

Reference to parent of this part, if this is a gap or a step.

Type:
Source:

path :Numbas.parts.partpath

A question-wide unique 'address' for this part.

Type:
Source:

question :Numbas.Question

The question this part belongs to.

Type:
Source:

revealed :boolean

Has the answer to this part been revealed?

Type:
Source:

score :number

Student's score on this part.

Type:
Source:

settings :object

Properties set when the part is generated.

Type:
Properties:
Name Type Description
stepsPenalty number

Number of marks to deduct when the steps are shown.
enableMinimumMarks boolean

Is there a lower limit on the score the student can be awarded for this part?
minimumMarks number

Lower limit on the score the student can be awarded for this part.
showCorrectAnswer boolean

Show the correct answer on reveal?
showFeedbackIcon boolean

Show the tick/cross feedback symbol after this part is submitted?
hasVariableReplacements boolean

Does this part have any variable replacement rules?
variableReplacementStrategy string

'originalfirst' or 'alwaysreplace'.
exploreObjective string

Name of the objective that this part's score counts towards.
suggestGoingBack string

In explore mode, suggest to the student to go back to the previous part after completing this one?
adaptiveMarkingPenalty number

Number of marks to deduct when adaptive marking is used.
useAlternativeFeedback boolean

Show all feedback from an alternative answer? If false, only the alternative feedback message is shown.
errorCarriedForwardReplacements Array.<Numbas.parts.adaptive_variable_replacement_definition>

Variable replacements to make during adaptive marking.
Source:

shouldResubmit :boolean

True if this part should be resubmitted because another part it depended on has changed.

Type:
Source:

signals :Numbas.schedule.SignalBox

Signals produced while loading this part.

Type:
Source:

stagedAnswer :Array.<string>

Student's answers as visible on the screen (not necessarily yet submitted).

Type:
Source:

steps :Array.<Numbas.parts.Part>

Child step parts.

Type:
Source:

stepsMarks :number

Marks available for the steps, if any.

Type:
Source:

stepsOpen :boolean

Is the steps display open?

Type:
Source:

stepsShown :boolean

Have the steps been show for this part?

Type:
Source:

store :Numbas.storage.BlankStorage

Storage engine.

Type:
Source:

type :string

This part's type, e.g. "jme", "numberentry", ...

Type:
Source:

useCustomName :boolean

Should a custom name be used?

Type:
Source:

warnings :Array.<string>

Warnings shown next to the student's answer.

Type:
Source:

xml :Element

XML defining this part.

Type:
Source:

Methods

addAlternative(alternative, index)

Add an alternative to this part.

Parameters:
Name Type Description
alternative Numbas.parts.Part
index number

Position of the alternative.
Fires:
  • Numbas.Part#event:addAlternative
Source:

addCredit(credit, message)

Add an absolute value to credit.

Parameters:
Name Type Description
credit number

Amount to add.
message string

Message to show in feedback to explain this action.
Fires:
  • Numbas.Part#event:addCredit
Source:

addStep(step, index)

Add a step to this part.

Parameters:
Name Type Description
step Numbas.parts.Part
index number

Position of the step.
Fires:
  • Numbas.Part#event:addStep
Source:

addVariableReplacement(variable, part, must_go_first)

Add a variable replacement for this part's adaptive marking.

Parameters:
Name Type Description
variable string

The name of the variable to replace.
part string

The path of the part to use.
must_go_first boolean

Must the referred part be answered before this part can be marked?
Fires:
  • Numbas.Part#event:addVariableReplacement
Source:

allChildren() → {Array.<Numbas.jme.parts.Part>}

All children of this part: all gaps and steps, but not alternatives.

Returns:
Type Description
Array.<Numbas.jme.parts.Part>
Source:

applyScoreLimits()

Make sure the awarded score is between the minimum and maximum available.

Source:

apply_feedback(feedback)

Apply a finalised list of feedback states to this part.

Parameters:
Name Type Description
feedback Array.<Numbas.marking.feedback_item>
Source:
See:

assignName(index, siblings) → {boolean}

Assign a name to this part, and then assign names to its children.

Parameters:
Name Type Description
index number

The number of parts before this one that have names.
siblings number

The number of siblings this part has.
Fires:
  • Numbas.Part#event:assignName
Returns:
Type Description
boolean

true if this part has a name that should increment the label counter.
Source:

availableMarks() → {number}

The total marks available for this part, after applying adaptive marking and steps penalties.

Returns:
Type Description
number
Source:

availableNextParts() → {Array.<Numbas.parts.NextPart>}

Currently available next parts.

Returns:
Type Description
Array.<Numbas.parts.NextPart>
Source:

(abstract) baseMarkingScript() → {Numbas.marking.MarkingScript}

The base marking script for this part.

Returns:
Type Description
Numbas.marking.MarkingScript
Source:

calculateScore()

Calculate the student's score based on their submitted answers.

Calls the parent part's calculateScore method at the end.

Fires:
  • Numbas.Part#event:calculateScore
Source:

do_pre_submit_tasks(studentAnswer, scope, exec_path) → {object}

Do all of the pre-submit tasks before marking an answer. Results are cached by exec_path and studentAnswer.

Parameters:
Name Type Description
studentAnswer Numbas.jme.token
scope Numbas.jme.Scope
exec_path string
Fires:
  • Numbas.Part#event:do_pre_submit_tasks
Returns:
Type Description
object
Source:

error(message, args, originalErroropt)

Throw an error, with the part's identifier prepended to the message.

Parameters:
Name Type Attributes Description
message string
args object

Arguments for the error message.
originalError Error <optional>

If this is a re-thrown error, the original error object.
Fires:
  • Numbas.Part#event:error
Throws:
Numbas.Error
Source:

errorCarriedForwardScope() → {Numbas.jme.Scope}

Replace variables with student's answers to previous parts.

Returns:
Type Description
Numbas.jme.Scope
Source:

finaliseLoad()

Perform any tidying up or processing that needs to happen once the part's definition has been loaded.

Source:

(abstract) getCorrectAnswer(scope)

Compute the correct answer, based on the given scope. Anything to do with marking that depends on the scope should be in this method, and calling it with a new scope should update all the settings used by the marking algorithm.

Parameters:
Name Type Description
scope Numbas.jme.Scope
Source:

getErrorCarriedForwardReplacements() → {Array.<Numbas.parts.adaptive_variable_replacement_definition>}

Return the list of variable replacements to make for adaptive marking. For alternatives, the parent part is used, otherwise this part is used.

Returns:
Type Description
Array.<Numbas.parts.adaptive_variable_replacement_definition>
Source:

getScope() → {Numbas.jme.Scope}

Get a JME scope for this part. If this.question is set, use the question's scope. Otherwise, use Numbas.jme.builtinScope.

Returns:
Type Description
Numbas.jme.Scope
Source:

giveWarning(warning)

Give the student a warning about this part.

Parameters:
Name Type Description
warning string
Fires:
  • Numbas.Part#event:giveWarning
Source:
See:

hasStagedAnswer() → {boolean}

Has the student entered an answer to this part?

Returns:
Type Description
boolean
Source:
See:

hideSteps()

Close the steps box. This doesn't affect the steps penalty.

Fires:
  • Numbas.Part#event:hideSteps
Source:

initDisplay()

Initialise this part's display object. Only called if the question this part belongs to has a display.

Source:

input_options() → {object}

Options for this part's input widget.

Returns:
Type Description
object
Source:

input_widget() → {string}

The name of the input widget this part uses, if any.

Returns:
Type Description
string
Source:

loadFromJSON(data)

Load the part's settings from a JSON object.

Parameters:
Name Type Description
data object
Source:

loadFromXML(xml)

Load the part's settings from an XML <part> node.

Parameters:
Name Type Description
xml Element
Source:

lock()

Lock this part.

Fires:
  • Numbas.Part#event:lock
Source:

makeNextPart(np, indexopt)

Make an instance of the selected next part.

Parameters:
Name Type Attributes Description
np Numbas.parts.NextPart
index number <optional>

The position of the part in the question's parts list (added to the end if not given).
Fires:
  • Numbas.Part#event:makeNextPart
Source:

makeScope(parentScopeopt) → {Numbas.jme.Scope}

Make the scope for this part.

Parameters:
Name Type Attributes Description
parentScope Numbas.jme.Scope <optional>

An optional parent scope. If not given, the following are tried: a parent part, the question this part belongs to, Numbas.jme.builtinScope.
Fires:
  • Numbas.Part#event:makeScope
Returns:
Type Description
Numbas.jme.Scope
Source:

mark(scope, exec_path) → {Numbas.parts.mark_result}

Function which marks the student's answer: run this.settings.markingScript, which sets the credit for the student's answer to a number between 0 and 1 and produces a list of feedback messages and warnings. If the question has been answered in a way that can be marked, this.answered should be set to true.

Parameters:
Name Type Description
scope Numbas.jme.Scope
exec_path string

A description of the path of execution, for caching pre-submit tasks.
Fires:
  • Numbas.Part#event:pre-mark
  • Numbas.Part#event:post-mark
Returns:
Type Description
Numbas.parts.mark_result
Source:
See:

markAdaptive() → {Numbas.parts.marking_results}

Mark this part, using adaptive marking when appropriate.

Fires:
  • Numbas.Part#event:pre-markAdaptive
  • Numbas.Part#event:post-markAdaptive
Returns:
Type Description
Numbas.parts.marking_results
Source:

markAgainstScope(scope, feedback, exec_path) → {Numbas.parts.marking_results}

Mark the student's answer against the given scope.

Parameters:
Name Type Description
scope Numbas.jme.Scope

Scope in which to calculate the correct answer.
feedback Object.<Array.<string>>

Dictionary of existing warnings and markingFeedback lists, to add to - copies of these are returned with any additional feedback appended.
exec_path string

A description of the path of execution, for caching pre-submit tasks.
Fires:
  • Numbas.Part#event:markAgainstScope
Returns:
Type Description
Numbas.parts.marking_results
Source:

markAlternatives(scope, feedback, exec_path) → {Numbas.parts.markAlternatives_result}

Mark the student's answer against this part and its alternatives, and return the feedback corresponding to the alternative awarding the most credit.

Parameters:
Name Type Description
scope Numbas.jme.Scope

Scope in which to calculate the correct answer.
feedback Object.<Array.<string>>

Dictionary of existing warnings and markingFeedback lists, to add to - copies of these are returned with any additional feedback appended.
exec_path string

A description of the path of execution, for caching pre-submit tasks.
Returns:
Type Description
Numbas.parts.markAlternatives_result
Source:

mark_answer(studentAnswer, scope, exec_path) → {Numbas.marking.marking_script_result}

Run the marking script against the given answer. This does NOT apply the feedback and credit to the part object, it just returns it.

Parameters:
Name Type Description
studentAnswer Numbas.jme.token
scope Numbas.jme.Scope
exec_path string

A description of the path of execution, for caching pre-submit tasks.
Fires:
  • Numbas.Part#event:pre-mark_answer
  • Numbas.Part#event:post-mark_answer
Returns:
Type Description
Numbas.marking.marking_script_result
Source:
See:

markingComment(message, reason, format)

Add a comment to the marking feedback.

Parameters:
Name Type Description
message string
reason string
format string

The format of the message: "html" or "string".
Fires:
  • Numbas.Part#event:markingComment
Source:

marking_parameters(studentAnswer, pre_submit_parameters, exec_path) → {Object.<Numbas.jme.token>}

Get JME parameters to pass to the marking script.

Parameters:
Name Type Description
studentAnswer Numbas.jme.token

The student's answer to the part.
pre_submit_parameters Array.<Object.<Numbas.jme.token>>
exec_path string
Returns:
Type Description
Object.<Numbas.jme.token>
Source:

multCredit(factor, message)

Multiply credit by the given amount - use to apply penalties.

Parameters:
Name Type Description
factor number
message string

Message to show in feedback to explain this action.
Fires:
  • Numbas.Part#event:multCredit
Source:

openSteps()

Open the steps, either because the student asked or the answers to the question are being revealed. This doesn't affect the steps penalty.

Fires:
  • Numbas.Part#event:openSteps
Source:

pleaseResubmit()

Called by another part when its marking means that the marking for this part might change (i.e., when this part replaces a variable with the answer from the other part). Sets this part as dirty, and gives a warning explaining why the student must resubmit.

Source:

(abstract) rawStudentAnswerAsJME() → {Numbas.jme.token}

Get the student's answer as it was entered as a JME data type, to be used in the marking script.

Returns:
Type Description
Numbas.jme.token
Source:

removeNextPart(np)

Remove the existing instance of the given next part.

Parameters:
Name Type Description
np Numbas.parts.NextPart
Fires:
  • Numbas.Part#event:removeNextPart
Source:

removeWarnings()

Remove all warnings.

Source:
See:

restore_feedback(feedback)

Restore a set of feedback messages.

Parameters:
Name Type Description
feedback Object.<Array.<string>>

Dictionary of existing warnings and markingFeedback lists, to add to - copies of these are returned with any additional feedback appended.
Source:

resume()

Load saved data about this part from storage. The part is not resubmitted - you must do this afterwards, once any steps or gaps have been resumed.

Fires:
  • Numbas.Part#event:resume
Source:

revealAnswer(dontStore)

Reveal the correct answer to this part.

Parameters:
Name Type Description
dontStore boolean

Don't tell the storage that this is happening - use when loading from storage to avoid callback loops.
Fires:
  • Numbas.Part#event:revealAnswer
Source:

setCredit(credit, message, reason)

Set the credit to an absolute value.

Parameters:
Name Type Description
credit number
message string

Message to show in feedback to explain this action.
reason string

Why was the credit set to this value? If given, either 'correct' or 'incorrect'.
Fires:
  • Numbas.Part#event:setCredit
Source:

setDirty(dirty)

Call when the student changes their answer, or submits - update Numbas.parts.Part.isDirty.

Parameters:
Name Type Description
dirty boolean
Fires:
  • Numbas.Part#event:setDirty
Source:

setMarkingScript(markingScriptString, extend_base)

Set this part's JME marking script.

Parameters:
Name Type Description
markingScriptString string
extend_base boolean

Does this script extend the built-in script?
Source:

setScript(name, order, script)

Set a custom JavaScript script.

Parameters:
Name Type Description
name string

The name of the method to override.
order string

When should the script run? 'instead', 'before' or 'after'.
script string

The source code of the script.
Source:
See:

(abstract) setStudentAnswer()

Save an answer entered by the student, for use in marking.

Source:

setWarnings(warnings)

Set the list of warnings.

Parameters:
Name Type Description
warnings Array.<string>
Source:
See:

showSteps(dontStore)

Show the steps, as a result of the student asking to show them. If the answers have not been revealed, we should apply the steps penalty.

Parameters:
Name Type Description
dontStore boolean

Don't tell the storage that this is happening - use when loading from storage to avoid callback loops.
Fires:
  • Numbas.Part#event:showSteps
Source:

storeAnswer(answer, dontStore)

Update the stored answer from the student (called when the student changes their answer, but before submitting).

Parameters:
Name Type Description
answer *
dontStore boolean

Don't tell the storage that this is happening - use when loading from storage to avoid callback loops.
Fires:
  • Numbas.Part#event:storeAnswer
Source:
See:
  • {Numbas.parts.Part.stagedAnswer}

studentAnswerAsJME() → {Numbas.jme.token}

Get the student's answer as a JME data type, to be used in error-carried-forward calculations.

Returns:
Type Description
Numbas.jme.token
Source:

subCredit(credit, message)

Subtract an absolute value from credit.

Parameters:
Name Type Description
credit number

Amount to subtract.
message string

Message to show in feedback to explain this action.
Fires:
  • Numbas.Part#event:subCredit
Source:

submit()

Submit the student's answers to this part - remove warnings. save answer, calculate marks, update scores.

Fires:
  • Numbas.Part#event:pre-submit
  • Numbas.Part#event:post-submit
Source:

submit_no_staged_answer()

Called when this part is submitted but it has no staged answer.

Source:

wait_for_pre_submit(promise)

Wait for a promise to resolve before submitting.

Parameters:
Name Type Description
promise Promise
Fires:
  • Numbas.Part#event:waiting_for_pre_submit
  • Numbas.Part#event:completed_pre_submit
Source: