Hotspot hotspot

Hotspot (hotspot)

The hotspot Question is referenced by its Question type in the code, which is hotspot. This Question allows students to answer Questions by clicking on target region(s) defined within the boundaries of an image.

Attributes

  • is_math boolean

    Set to true to have LaTeX or MathML contents to be rendered with mathjax.

    Default: false

  • metadata object

    Object containing additional information about the question.

  • metadata.distractor_rationale string

    Used to display individual response feedback/rationale to the student.

  • metadata.rubric_reference string

    A unique identifier for the rubric to be used with the question - defaults to course rubric if assigned in activity

  • metadata.sample_answer string

    A sample answer to be displayed on the Learnosity Reports API. HTML is supported.

  • metadata.acknowledgements string

    References for any text passages, documents, images etc. used in the question.

  • stimulus string

    The question stimulus. This can include text, tables, images, resources and LaTeX entered via the Math Editor.

  • stimulus_review string

    HTML/Text content displayed only in review state rendered above the response area. Supports embedded Feature <span> tags. Will override stimulus in review state.

  • instructor_stimulus string

    HTML/Text content displayed when showInstructorStimulus is set to true on the activity. Supports embedded Feature <span> tags.

  • type string

    Type of question being asked, e.g. 'association'

    Default: "hotspot"

  • ui_style object

    Object used to control different aspects of the UI

  • ui_style.fontsize string

    Controls the size of base font for this question. Options are among 'small', 'normal', 'large', 'xlarge' and 'xxlarge'.

    Default: "normal"

  • ui_style.validation_stem_numeration string

    Numeration character to be displayed to the left of the validation label.

    Default: "number"

  • feedback_attempts number

    If instant_feedback is true, this field determines how many times the user can click on the 'Check Answer' button. 0 means unlimited.

    Default: 0

  • instant_feedback boolean

    Flag to determine whether to display a 'Check Answer' button to provide instant feedback to the user.

    Default: false

  • validation object

    In this section, configure the correct answer(s) for the question.

  • validation.allow_negative_scores boolean

    Negative scores will be normalised to zero by default. Allowing negative scores, on the other hand, means that the score can drop below zero when penalties are applied.

    Default: false

  • validation.penalty number

    Value indicating the marks deducted for an incorrect response.

    Default: 0

  • validation.min_score_if_attempted number

    Positive value indicating the minimum score if a student attempted the question.

    Default: 0

  • validation.scoring_type string

    Defines the scoring approach used. Possible options:
    'exactMatch': Exact Match - Entire response must match exactly
    'partialMatchV2': Partial Match - A relative part of the score will be given for each correct response area
    'partialMatch': Partial Match Per Response - Cumulative Score value will be given for each correct response area

    Default: "exactMatch"

  • validation.unscored boolean

    When enabled, this option will remove all scoring from the question. This is useful for creating practice questions.

    Default: false

  • validation.valid_response object

    An object containing the valid response score and value.

  • validation.valid_response.score number

    Score awarded for the correct response(s).

    Default: 1

  • validation.valid_response.value array

  • validation.automarkable boolean

    Defines whether the question will be marked automatically, or must be marked manually.

    Default: true

  • validation.alt_responses array

    Add an alternate response if there is more than one correct overall solution to a question.

  • validation.alt_responses[ ].score number

    Score if the alternative response is correct.

    Default: 1

  • validation.alt_responses[ ].value array

  • validation.alt_responses[ ][ ].score number

    Score if the alternative response is correct.

    Default: 1

  • validation.alt_responses[ ][ ].value array

  • image imageObject

    Define an image to be annotated.

  • image.source string

    The image that should be displayed.

  • image.alt textarea

    The alternative text of the image.

    Default: ""

  • image.width number

    Enter a numeric value for the width of the image. This value should be a pixel (px) value, but you do not need to type px into the field.

  • image.height number

    Enter a numeric value for the height of the image. This value should be a pixel (px) value, but you do not need to type px into the field.

  • image.preview hidden

    Preview of the chosen image

  • areas array

    An array of validation areas for the stimulus image.

  • areas[ ][ ].x number

  • areas[ ][ ].y number

  • areas[ ][ ][ ].x number

  • areas[ ][ ][ ].y number

  • area_attributes object

  • area_attributes.global object

    Attributes for all hotspots.

  • area_attributes.global.fill string

    An RGBA string defining the fill for all hotspots.

  • area_attributes.global.stroke string

    An RGBA string defining the stroke for all hotspots.

  • area_attributes.global.selected_fill string

    An RGBA string defining the fill for selected hotspots.

  • area_attributes.global.selected_stroke string

    An RGBA string defining the stroke for selected hotspots.

  • area_attributes.global.focus_stroke string

    An RGBA string defining the stroke for focused hotspots.

  • area_attributes.individual array

    Individual attributes per hotspot that have precedence over the global hotspot attributes.

  • area_attributes.individual[ ].area string

  • area_attributes.individual[ ].label string

    A label for the hotspot that is not shown to the student (unless they are checking answers), but is useful when reviewing student responses.

  • area_attributes.individual[ ].aria_label string

    A description of the hotspot that will be available to screen readers.

  • area_attributes.individual[ ].fill string

    An RGBA string defining the fill for the hotspot

  • area_attributes.individual[ ].stroke string

    An RGBA string defining the stroke for the hotspot

  • area_attributes.individual[ ].selected_fill string

    An RGBA string defining the fill for the hotspot when selected

  • area_attributes.individual[ ].selected_stroke string

    An RGBA string defining the stroke for the hotspot when selected

  • area_attributes.individual[ ].focus_stroke string

    An RGBA string defining the stroke for focused hotspots.

  • area_attributes.individual[ ][ ].area string

  • area_attributes.individual[ ][ ].label string

    A label for the hotspot that is not shown to the student (unless they are checking answers), but is useful when reviewing student responses.

  • area_attributes.individual[ ][ ].aria_label string

    A description of the hotspot that will be available to screen readers.

  • area_attributes.individual[ ][ ].fill string

    An RGBA string defining the fill for the hotspot

  • area_attributes.individual[ ][ ].stroke string

    An RGBA string defining the stroke for the hotspot

  • area_attributes.individual[ ][ ].selected_fill string

    An RGBA string defining the fill for the hotspot when selected

  • area_attributes.individual[ ][ ].selected_stroke string

    An RGBA string defining the stroke for the hotspot when selected

  • area_attributes.individual[ ][ ].focus_stroke string

    An RGBA string defining the stroke for focused hotspots.

  • max_width stringUnits

    Max width of response area. Define in em, px; or set to 'none' to stretch to full width of container.

  • multiple_responses boolean

    If multiple_responses is true the user will be able to select multiple hotspots.

    Default: false

Response format

The data returned in the response format for this Question is the region(s) inside the image where the student clicked to answer the Question.

Response format examples

{
    "value": [
        "2"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Response attributes

  • value array

    The region(s) inside the image where the student clicked to answer the Question.

  • type string

    Informs the scoring engine about what kind of data to expect in the values entered by the student. For this Question type, you must always supply a string for this attribute with the value "array".

  • apiVersion string

    The version of the Questions API that returned this response.

  • revision numeric

    Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.

  • feedbackAttemptsCount numeric

    Keeps track of the number of feedback attempts.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.