You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/typedoc/interfaces/Answer.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Answer
2
2
3
-
Defined in: [parser/types.ts:975](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L975)
3
+
Defined in: [parser/types.ts:975](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L975)
4
4
5
5
The Answer interface is used to define the properties of an answer. Answers are used to define the correct answer for a task. These are generally used in training tasks or if skip logic is required based on the answer.
6
6
@@ -33,7 +33,7 @@ In this example, the correct answer to the question "What is 2 + 2?" is 4. If th
33
33
34
34
| Property | Type | Description | Defined in |
35
35
| ------ | ------ | ------ | ------ |
36
-
| <aid="acceptablehigh"></a> `acceptableHigh?`|`number`| The acceptable high value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:984](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L984)|
37
-
| <aid="acceptablelow"></a> `acceptableLow?`|`number`| The acceptable low value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:982](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L982)|
38
-
| <aid="answer"></a> `answer`|`any`| The correct answer to the question. |[parser/types.ts:980](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L980)|
39
-
| <aid="id"></a> `id`|`string`| The id of the answer. This is used to identify the answer in the data file. |[parser/types.ts:977](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L977)|
36
+
| <aid="acceptablehigh"></a> `acceptableHigh?`|`number`| The acceptable high value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:984](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L984)|
37
+
| <aid="acceptablelow"></a> `acceptableLow?`|`number`| The acceptable low value for the answer. This is used to define a range of acceptable answers. |[parser/types.ts:982](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L982)|
38
+
| <aid="answer"></a> `answer`|`any`| The correct answer to the question. |[parser/types.ts:980](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L980)|
39
+
| <aid="id"></a> `id`|`string`| The id of the answer. This is used to identify the answer in the data file. |[parser/types.ts:977](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L977)|
Copy file name to clipboardExpand all lines: docs/typedoc/interfaces/BaseResponse.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# BaseResponse
2
2
3
-
Defined in: [parser/types.ts:360](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L360)
3
+
Defined in: [parser/types.ts:360](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L360)
4
4
5
5
The BaseResponse interface is used to define the required fields for all responses.
6
6
Other Response interfaces inherit properties from the BaseResponse interface.
@@ -25,18 +25,18 @@ Therefore, all responses must include these properties.
25
25
26
26
| Property | Type | Description | Defined in |
27
27
| ------ | ------ | ------ | ------ |
28
-
| <aid="excludefromrandomization"></a> `excludeFromRandomization?`|`boolean`| Exclude response from randomization. If present, will override the `responseOrder` randomization setting in the components. Defaults to false. |[parser/types.ts:390](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L390)|
29
-
| <aid="hidden"></a> `hidden?`|`boolean`| Controls whether the response is hidden. |[parser/types.ts:380](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L380)|
30
-
| <aid="id"></a> `id`|`string`| The id of the response. This is used to identify the response in the data file. |[parser/types.ts:362](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L362)|
31
-
| <aid="infotext"></a> `infoText?`|`string`| The description that is displayed when the participant hovers over the response. This does not accept markdown. |[parser/types.ts:368](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L368)|
32
-
| <aid="location"></a> `location?`|[`ConfigResponseBlockLocation`](../type-aliases/ConfigResponseBlockLocation.md)| Controls the response location. These might be the same for all responses, or differ across responses. Defaults to `belowStimulus`|[parser/types.ts:372](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L372)|
33
-
| <aid="paramcapture"></a> `paramCapture?`|`string`| Use to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer `uiConfig.urlParticipantIdParam` if you are capturing a participant ID. |[parser/types.ts:378](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L378)|
34
-
| <aid="prompt"></a> `prompt`|`string`| The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. |[parser/types.ts:364](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L364)|
35
-
| <aid="required"></a> `required?`|`boolean`| Controls whether the response is required to be answered. Defaults to true. |[parser/types.ts:370](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L370)|
36
-
| <aid="requiredlabel"></a> `requiredLabel?`|`string`| You can provide a required label, which makes it so a participant has to answer with a response that matches label. |[parser/types.ts:376](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L376)|
37
-
| <aid="requiredvalue"></a> `requiredValue?`|`unknown`| You can provide a required value, which makes it so a participant has to answer with that value. |[parser/types.ts:374](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L374)|
38
-
| <aid="secondarytext"></a> `secondaryText?`|`string`| The secondary text that is displayed to the participant under the prompt. This does not accept markdown. |[parser/types.ts:366](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L366)|
39
-
| <aid="style"></a> `style?`|[`Styles`](../type-aliases/Styles.md)| You can set styles here, using React CSSProperties, for example: `{"width": 100}` or `{"width": "50%"}`|[parser/types.ts:388](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L388)|
40
-
| <aid="stylesheetpath"></a> `stylesheetPath?`|`string`| The path to the external stylesheet file. |[parser/types.ts:386](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L386)|
41
-
| <aid="withdivider"></a> `withDivider?`|`boolean`| Renders the response with a trailing divider. If present, will override the divider setting in the components or `uiConfig`. |[parser/types.ts:382](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L382)|
42
-
| <aid="withdontknow"></a> `withDontKnow?`|`boolean`| Renders the response with an option for "I don't know". This counts as a completed answer for the validation. |[parser/types.ts:384](https://github.com/revisit-studies/study/blob/1342408885dd25e64fbef15c6478d0a8d7cedb45/src/parser/types.ts#L384)|
28
+
| <aid="excludefromrandomization"></a> `excludeFromRandomization?`|`boolean`| Exclude response from randomization. If present, will override the `responseOrder` randomization setting in the components. Defaults to false. |[parser/types.ts:390](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L390)|
29
+
| <aid="hidden"></a> `hidden?`|`boolean`| Controls whether the response is hidden. |[parser/types.ts:380](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L380)|
30
+
| <aid="id"></a> `id`|`string`| The id of the response. This is used to identify the response in the data file. |[parser/types.ts:362](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L362)|
31
+
| <aid="infotext"></a> `infoText?`|`string`| The description that is displayed when the participant hovers over the response. This does not accept markdown. |[parser/types.ts:368](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L368)|
32
+
| <aid="location"></a> `location?`|[`ConfigResponseBlockLocation`](../type-aliases/ConfigResponseBlockLocation.md)| Controls the response location. These might be the same for all responses, or differ across responses. Defaults to `belowStimulus`|[parser/types.ts:372](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L372)|
33
+
| <aid="paramcapture"></a> `paramCapture?`|`string`| Use to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer `uiConfig.urlParticipantIdParam` if you are capturing a participant ID. |[parser/types.ts:378](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L378)|
34
+
| <aid="prompt"></a> `prompt`|`string`| The prompt that is displayed to the participant. You can use markdown here to render images, links, etc. |[parser/types.ts:364](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L364)|
35
+
| <aid="required"></a> `required?`|`boolean`| Controls whether the response is required to be answered. Defaults to true. |[parser/types.ts:370](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L370)|
36
+
| <aid="requiredlabel"></a> `requiredLabel?`|`string`| You can provide a required label, which makes it so a participant has to answer with a response that matches label. |[parser/types.ts:376](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L376)|
37
+
| <aid="requiredvalue"></a> `requiredValue?`|`unknown`| You can provide a required value, which makes it so a participant has to answer with that value. |[parser/types.ts:374](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L374)|
38
+
| <aid="secondarytext"></a> `secondaryText?`|`string`| The secondary text that is displayed to the participant under the prompt. This does not accept markdown. |[parser/types.ts:366](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L366)|
39
+
| <aid="style"></a> `style?`|[`Styles`](../type-aliases/Styles.md)| You can set styles here, using React CSSProperties, for example: `{"width": 100}` or `{"width": "50%"}`|[parser/types.ts:388](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L388)|
40
+
| <aid="stylesheetpath"></a> `stylesheetPath?`|`string`| The path to the external stylesheet file. |[parser/types.ts:386](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L386)|
41
+
| <aid="withdivider"></a> `withDivider?`|`boolean`| Renders the response with a trailing divider. If present, will override the divider setting in the components or `uiConfig`. |[parser/types.ts:382](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L382)|
42
+
| <aid="withdontknow"></a> `withDontKnow?`|`boolean`| Renders the response with an option for "I don't know". This counts as a completed answer for the validation. |[parser/types.ts:384](https://github.com/revisit-studies/study/blob/72b8e5c4fa403736be782c35d94c86b3f785e056/src/parser/types.ts#L384)|
0 commit comments