`<when>`

Defines logical conditions within an `<award>`

<when> is an Evaluation component that is used for creating boolean conditions within an <award>.

Attributes and Properties

Attributes for `<when>`

Other (13)

allowedErrorInNumbers

number. Default value: 0. Maximum allowed numeric error when comparing numbers.

allowedErrorIsAbsolute

boolean. Default value: false. Whether allowedErrorInNumbers is interpreted as an absolute (rather than relative) tolerance.

caseInsensitiveMatch

boolean. Default value: false. Whether text comparisons ignore letter case.

expandOnCompare

boolean. Default value: false. Whether to expand math expressions before comparing.

includeErrorInNumberExponents

boolean. Default value: false. Whether the allowed numeric error also applies to numbers in exponents.

matchBlanks

boolean. Default value: false. Whether unfilled blanks in a math expression count as a match.

matchByExactPositions

boolean. Default value: false. Whether to match list values by exact position rather than by content.

matchPartial

boolean. Default value: false. Whether to match partial conditions for partial credit.

numPeriodicSetMatchesRequired

integer. Default value: 3. Number of consecutive elements of a periodic set required to count as a match.

numSignErrorsMatched

number. Default value: 0. Maximum number of sign errors that still count as a match.

simplifyOnCompare

keyword. Level of simplification applied to math expressions before comparing.

Value	Description
`none` (default)	No simplification is applied before comparing.
`full`	Fully simplify both expressions before comparing.
`numbers`	Simplify numeric subexpressions only, leaving symbolic structure intact.
`numbersPreserveOrder`	Like `numbers`, but does not reorder commutative operands.
`normalizeOrder`	Reorder commutative operands into a canonical form without simplifying values.

symbolicEquality

boolean. Default value: false. Whether children compared via this boolean use symbolic equality.

unorderedCompare

boolean. Default value: false. Whether order is ignored when comparing list-like values.

Common to all components (9)

copy

reference. Create an independent copy of another component by reference. Enter a references a $name.

disabled

boolean. Default value: false. Whether this component is disabled and cannot be interacted with.

extend

reference. Extend another component by reference, inheriting its children and attributes. Enter a reference as $name.

fixed

boolean. Default value: false. Whether this component's value is fixed and cannot be modified.

fixLocation

boolean. Default value: false. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

hide

boolean. Default value: false. Whether to hide this component from the rendered output.

isResponse

boolean. Default value: false. Whether this component is treated as a response for the purposes of assessment.

name

text. The name used to reference this component from elsewhere in the document.

styleNumber

integer. Default value: 1. The style number used to select this component's visual styling from the available style definitions.

Properties for `<when name="w">`

Other (21)

$w.allowedErrorInNumbers

number. Maximum allowed numeric error when comparing numbers.

$w.allowedErrorIsAbsolute

boolean. Whether allowedErrorInNumbers is interpreted as an absolute (rather than relative) tolerance.

$w.caseInsensitiveMatch

boolean. Whether text comparisons ignore letter case.

$w.conditionSatisfied

boolean. Whether the condition is currently satisfied; equivalent to value.

$w.disabled

boolean. Whether this component is disabled and cannot be interacted with.

$w.expandOnCompare

boolean. Whether to expand math expressions before comparing.

$w.fixed

boolean. Whether this component's value is fixed and cannot be modified.

$w.fixLocation

boolean. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

$w.fractionSatisfied

number. Fraction of the boolean condition that is satisfied (0 to 1).

$w.hidden

boolean. Whether this component is hidden from the rendered output.

$w.includeErrorInNumberExponents

boolean. Whether the allowed numeric error also applies to numbers in exponents.

$w.matchBlanks

boolean. Whether unfilled blanks in a math expression count as a match.

$w.matchByExactPositions

boolean. Whether to match list values by exact position rather than by content.

$w.matchPartial

boolean. Whether to match partial conditions for partial credit.

$w.numPeriodicSetMatchesRequired

integer. Number of consecutive elements of a periodic set required to count as a match.

$w.numSignErrorsMatched

number. Maximum number of sign errors that still count as a match.

$w.simplifyOnCompare

text. Level of simplification applied to math expressions before comparing.

$w.symbolicEquality

boolean. Whether children compared via this boolean use symbolic equality.

$w.text

text. The boolean rendered as a text string ("true" or "false").

$w.unorderedCompare

boolean. Whether order is ignored when comparing list-like values.

$w.value

boolean. Whether the condition is currently true.

Common to all components (4)

$w.doenetML

text. The DoenetML source code that produced this component.

$w.hide

boolean. Whether to hide this component from the rendered output.

$w.isResponse

boolean. Whether this component is treated as a response for the purposes of assessment.

$w.styleNumber

integer. The style number used to select this component's visual styling from the available style definitions.

Examples

Example: `<when>` in an `<award>` with `<mathInput/>`

<when> is used to specify the boolean condition within an <award>.

Example: `<when>` in an `<award>` with graphical input

<when> is used to specify the boolean condition within an <award>. In this case, the boolean is based on graphical interactions performed by the user to update the radius of the named <circle/>.

Example: `<when>` in an `<award>` with `<textInput/>`

<when> is used to specify the boolean condition within an <award>. In this case, the boolean is based on the value of a <textInput/>.

Attribute Examples

Attribute Example: matchPartial

The matchPartial attribute signifies that partial credit is to be awarded if any part of the enclosed boolean condition is true.

Property Examples

Property Example: value

The value property renders the value of the boolean condition enclosed by the <when> component.

Property Example: fractionSatisfied

The fractionSatisfied property renders the fractional value corresponding to which portion of the boolean condition enclosed by the <when> evaluates to true.

Property Example: conditionSatisfied

The conditionSatisfied property renders the boolean value corresponding to whether the <when> condition has been satisfied.

Property Example: matchPartial

The matchPartial attribute of the <when> component is also accessible as a property.

video wrapFunctionPeriodic

<when>