ImageComponent

Defined in: parser/types.ts:645

The ImageComponent interface is used to define the properties of an image component. This component is used to render an image with optional styling.

For example, to render an image with a path of path/to/study/assets/image.jpg and a max width of 50%, you would use the following snippet:

{
 "type": "image",
 "path": "<study-name>/assets/image.jpg",
 "style": {
 "maxWidth": "50%"
 }
}

Extends

• BaseIndividualComponent

Properties

Property	Type	Description	Inherited from	Defined in
allowFailedTraining?	boolean	Controls whether the component should allow failed training. If not provided, the default is true.	BaseIndividualComponent.allowFailedTraining	parser/types.ts:546
correctAnswer?	Answer[]	The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.	BaseIndividualComponent.correctAnswer	parser/types.ts:540
description?	string	The description of the component. This is used to identify and provide additional information for the component in the admin panel.	BaseIndividualComponent.description	parser/types.ts:550
instruction?	string	The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.	BaseIndividualComponent.instruction	parser/types.ts:552
instructionLocation?	"sidebar" | "aboveStimulus" | "belowStimulus"	The location of the instructions.	BaseIndividualComponent.instructionLocation	parser/types.ts:538
meta?	Record<string, unknown>	The meta data for the component. This is used to identify and provide additional information for the component in the admin panel.	BaseIndividualComponent.meta	parser/types.ts:548
nextButtonDisableTime?	number	A timeout (in ms) after which the next button will be disabled.	BaseIndividualComponent.nextButtonDisableTime	parser/types.ts:556
nextButtonEnableTime?	number	A timer (in ms) after which the next button will be enabled.	BaseIndividualComponent.nextButtonEnableTime	parser/types.ts:558
nextButtonLocation?	"sidebar" | "aboveStimulus" | "belowStimulus"	The location of the next button.	BaseIndividualComponent.nextButtonLocation	parser/types.ts:536
nextButtonText?	string	The text that is displayed on the next button.	BaseIndividualComponent.nextButtonText	parser/types.ts:534
path	string	The path to the image. This should be a relative path from the public folder.	-	parser/types.ts:648
provideFeedback?	boolean	Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.	BaseIndividualComponent.provideFeedback	parser/types.ts:542
recordAudio?	boolean	Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.	BaseIndividualComponent.recordAudio	parser/types.ts:554
response	Response[]	The responses to the component	BaseIndividualComponent.response	parser/types.ts:530
responseDividers?	boolean	Whether to show the response dividers. Defaults to false.	BaseIndividualComponent.responseDividers	parser/types.ts:560
style?	Record<string, string>	The style of the image. This is an object with css properties as keys and css values as values.	-	parser/types.ts:650
trainingAttempts?	number	The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user.	BaseIndividualComponent.trainingAttempts	parser/types.ts:544
type	"image"	-	-	parser/types.ts:646