Skip to main content
Version: v2.3.0

VegaComponentConfig

Defined in: parser/types.ts:1052

The VegaComponentConfig interface is used to define the properties of a Vega Component. This component is used to render a Vega/Vega-Lite Component by adding Vega/Vega-Lite specs within the reVISit config itself.

To do this, would use the following snippet:

{
"type": "vega",
"config": { ... vega specs here ...},
}

IIf you are using Vega, you can use signals with `revisitAnswer` to send the user's responses back to the reVISit. For example, you can use the following snippet in your Vega spec's signals section:
```js
{
"signals": [
{
"name": "revisitAnswer",
"value": {},
"on": [
{
"events": "rect:click",
"update": "{responseId: 'vegaDemoResponse1', response: datum.category}"
}
]
}
]
}
In this example, when a user clicks on a rectangle in the Vega chart, the `revisitAnswer` signal is updated with the responseId and response.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
allowFailedTraining?booleanControls whether the component should allow failed training. If present, will override the allow failed training setting in the uiConfig.BaseIndividualComponent.allowFailedTrainingparser/types.ts:791
configobjectThe vega or vega-lite configuration.-parser/types.ts:1055
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.correctAnswerparser/types.ts:751
description?stringThe description of the component. This is used to identify and provide additional information for the component in the admin panel.BaseIndividualComponent.descriptionparser/types.ts:755
enumerateQuestions?booleanWhether to prepend questions with their index (+ 1). This should only be used when all questions are in the same location, e.g. all are in the side bar. If present, will override the enumeration of questions setting in the uiConfig.BaseIndividualComponent.enumerateQuestionsparser/types.ts:797
helpTextPath?stringThe path to the help text file. This is displayed when a participant clicks help. Markdown is supported. If present, will override the help text path set in the uiConfig.BaseIndividualComponent.helpTextPathparser/types.ts:771
instruction?stringThe instruction of the component. This is used to identify and provide additional information for the component in the admin panel.BaseIndividualComponent.instructionparser/types.ts:767
instructionLocation?ConfigResponseBlockLocationThe location of the instructions. If present, will override the instruction location setting in the uiConfig.BaseIndividualComponent.instructionLocationparser/types.ts:769
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.metaparser/types.ts:753
nextButtonDisableTime?numberThe time in milliseconds to wait before the next button is disabled. If present, will override the next button disable time setting in the uiConfig.BaseIndividualComponent.nextButtonDisableTimeparser/types.ts:781
nextButtonEnableTime?numberThe time in milliseconds to wait before the next button is enabled. If present, will override the next button enable time setting in the uiConfig.BaseIndividualComponent.nextButtonEnableTimeparser/types.ts:779
nextButtonLocation?ConfigResponseBlockLocationThe location of the next button. If present, will override the next button location setting in the uiConfig.BaseIndividualComponent.nextButtonLocationparser/types.ts:777
nextButtonText?stringThe text to display on the next button. If present, will override the next button text setting in the uiConfig.BaseIndividualComponent.nextButtonTextparser/types.ts:775
nextOnEnter?booleanWhether enter key should move to the next question. If present, will override the enter key setting in the uiConfig.BaseIndividualComponent.nextOnEnterparser/types.ts:773
previousButton?booleanWhether to show the previous button. If present, will override the previous button setting in the uiConfig.BaseIndividualComponent.previousButtonparser/types.ts:783
previousButtonText?stringThe text that is displayed on the previous button. If present, will override the previous button text setting in the uiConfig.BaseIndividualComponent.previousButtonTextparser/types.ts:785
provideFeedback?booleanControls whether the component should provide feedback to the participant, such as in a training trial. If present, will override the provide feedback setting in the uiConfig.BaseIndividualComponent.provideFeedbackparser/types.ts:787
recordAudio?booleanWhether or not we want to utilize think-aloud features. If present, will override the record audio setting in the uiConfig.BaseIndividualComponent.recordAudioparser/types.ts:793
recordScreen?booleanWhether or not we want to utilize screen recording feature. If present, will override the record screen setting in the uiConfig. If true, the uiConfig must have recordScreen set to true or the screen will not be captured. It's also required that the library component, $screen-recording.co.screenRecordingPermission, be included in the study at some point before this component to ensure permissions are granted and screen capture has started.BaseIndividualComponent.recordScreenparser/types.ts:795
responseResponse[]The responses to the componentBaseIndividualComponent.responseparser/types.ts:747
responseDividers?booleanWhether to show the response dividers. If present, will override the response dividers setting in the uiConfig.BaseIndividualComponent.responseDividersparser/types.ts:799
responseOrder?"fixed" | "random"The order of the responses. Defaults to 'fixed'.BaseIndividualComponent.responseOrderparser/types.ts:803
showTitle?booleanControls whether the title should be hidden in the study. If present, will override the title setting in the uiConfig.BaseIndividualComponent.showTitleparser/types.ts:763
showTitleBar?booleanControls whether the title bar should be hidden in the study. If present, will override the title bar setting in the uiConfig.BaseIndividualComponent.showTitleBarparser/types.ts:765
sidebarWidth?numberThe width of the left sidebar. If present, will override the sidebar width setting in the uiConfig.BaseIndividualComponent.sidebarWidthparser/types.ts:761
style?StylesYou can set styles here, using React CSSProperties, for example: {"width": 100} or {"width": "50%"}BaseIndividualComponent.styleparser/types.ts:807
stylesheetPath?stringThe path to the external stylesheet file.BaseIndividualComponent.stylesheetPathparser/types.ts:805
trainingAttempts?numberThe number of training attempts allowed for the component. If present, will override the training attempts setting in the uiConfig.BaseIndividualComponent.trainingAttemptsparser/types.ts:789
type"vega"--parser/types.ts:1053
windowEventDebounceTime?numberDebounce time in milliseconds for automatically tracked window events. If present, will override the window event debounce time setting in the uiConfig.BaseIndividualComponent.windowEventDebounceTimeparser/types.ts:801
withActions?booleanWhether to include vega actions. Defaults to true.-parser/types.ts:1057
withProgressBar?booleanControls whether the progress bar is rendered. If present, will override the progress bar setting in the uiConfig.BaseIndividualComponent.withProgressBarparser/types.ts:757
withSidebar?booleanControls whether the left sidebar is rendered at all. Required to be true if your response's location is set to sidebar for any question. If present, will override the sidebar setting in the uiConfig.BaseIndividualComponent.withSidebarparser/types.ts:759