sellquiz/docs/modules.md

An open source domain-specific language for online assessment

[sellquiz](README.md) / Exports

# sellquiz

## Table of contents

### Functions

- [\_\_ideCreationFuntion](modules.md#__idecreationfuntion)
- [autoCreateQuiz](modules.md#autocreatequiz)
- [autoEvaluateQuiz](modules.md#autoevaluatequiz)
- [backupQuestion](modules.md#backupquestion)
- [createQuestion](modules.md#createquestion)
- [createQuestionFromBackup](modules.md#createquestionfrombackup)
- [disableInputFields](modules.md#disableinputfields)
- [enableInputFields](modules.md#enableinputfields)
- [evaluateQuestion](modules.md#evaluatequestion)
- [getErrorLog](modules.md#geterrorlog)
- [getFeedbackText](modules.md#getfeedbacktext)
- [getQuestionBody](modules.md#getquestionbody)
- [getQuestionHighLevelHTML](modules.md#getquestionhighlevelhtml)
- [getQuestionInputFields](modules.md#getquestioninputfields)
- [getQuestionSource](modules.md#getquestionsource)
- [getQuestionTitle](modules.md#getquestiontitle)
- [getScore](modules.md#getscore)
- [readStudentAnswersFromHtmlElements](modules.md#readstudentanswersfromhtmlelements)
- [refreshMatrixDimensions](modules.md#refreshmatrixdimensions)
- [refreshQuestion](modules.md#refreshquestion)
- [reset](modules.md#reset)
- [setGenerateInputFieldHtmlCode](modules.md#setgenerateinputfieldhtmlcode)
- [setLanguage](modules.md#setlanguage)
- [setQuestionHtmlElement](modules.md#setquestionhtmlelement)
- [setServicePath](modules.md#setservicepath)
- [setStudentAnswerManually](modules.md#setstudentanswermanually)
- [writeFeedbackToHtmlElements](modules.md#writefeedbacktohtmlelements)

## Functions

### \_\_ideCreationFuntion

▸ **__ideCreationFuntion**(`fct`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `fct` | `any` |

#### Returns

`void`

#### Defined in

[index.ts:326](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L326)

___

### autoCreateQuiz

▸ **autoCreateQuiz**(`sellCode`, `htmlDivElement`, `editButton?`): `boolean`

Creates a quiz including HTML control elements. This function can be used for a trivial integration of a stand-alone SELL quiz into a website. WARNING: do not mix using this high-level function and low-level functions.

#### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `sellCode` | `string` | `undefined` | SELL source code of one or multiple questions (divided by a line equal to %%%). |
| `htmlDivElement` | `HTMLElement` | `undefined` | HTML element that will contain all questions. |
| `editButton` | `boolean` | `false` | Renders a button with label "Edit" right to the "Evaluate" button. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:41](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L41)

___

### autoEvaluateQuiz

▸ **autoEvaluateQuiz**(`questionID`, `htmlQuestionElementID`): `boolean`

Evaluates a quiz that has been created by autoCreateQuiz(..). This function is called automatically.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |
| `htmlQuestionElementID` | `string` | Identifier of the (global) HTML element that contains all questions. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:63](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L63)

___

### backupQuestion

▸ **backupQuestion**(`questionID`): `string`

Creates a backup of a question which includes internal states (for example random variables).

**`resturns`** Stringified JSON object of the question state or null in case that an error occourred.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`string`

#### Defined in

[index.ts:151](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L151)

___

### createQuestion

▸ **createQuestion**(`sellCode`): `number`

Creates a new question.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `sellCode` | `string` | SELL source code of a single question. |

#### Returns

`number`

Question index or -1 in case of errors.

#### Defined in

[index.ts:130](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L130)

___

### createQuestionFromBackup

▸ **createQuestionFromBackup**(`questionBackupStr`): `number`

Creates a new question from a question backup (refer to function backupQuestion(..)).

#### Parameters

| Name | Type |
| :------ | :------ |
| `questionBackupStr` | `string` |

#### Returns

`number`

Question index or -1 in case of errors.

#### Defined in

[index.ts:142](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L142)

___

### disableInputFields

▸ **disableInputFields**(`questionID`): `boolean`

Disables all input field HTML elements for editing.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:296](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L296)

___

### enableInputFields

▸ **enableInputFields**(`questionID`): `boolean`

Enables all input field HTML elements for editing.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:287](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L287)

___

### evaluateQuestion

▸ **evaluateQuestion**(`questionID`): `boolean`

Evaluates the student answers of a question. This function does NOT read and write HTML elements. Also refer to functions "readStudentAnswersFromHtmlElements" and "writeFeedbackToHtmlElements".

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:227](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L227)

___

### getErrorLog

▸ **getErrorLog**(): `string`

Gets the error log for the last created question.

#### Returns

`string`

Error log.

#### Defined in

[index.ts:168](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L168)

___

### getFeedbackText

▸ **getFeedbackText**(`questionID`): `string`

Gets the feedback text of an already evaluated question.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question Index. |

#### Returns

`string`

Success.

#### Defined in

[index.ts:266](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L266)

___

### getQuestionBody

▸ **getQuestionBody**(`questionID`): `string`

Gets the question body.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`string`

Body as HTML code or an empty string, if the question does not exist.

#### Defined in

[index.ts:189](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L189)

___

### getQuestionHighLevelHTML

▸ **getQuestionHighLevelHTML**(`questionID`): `string`

Gets question high-level HTML, i.e. question-title and qustion-body in a Boostrap-Card element with evaluation button.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`string`

Qustion HTML code or an empty string, if the question does not exist.

#### Defined in

[index.ts:201](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L201)

___

### getQuestionInputFields

▸ **getQuestionInputFields**(`questionID`): [{ [id: string]: `string`;  }]

Gets the input fields of a question. *

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

[{ [id: string]: `string`;  }]

Array of dictionaries with entries "element_id" for the HTML element identifier, "element_type" for the HTML element type (refer to enum SellInputElementType in file quiz.js) and "solution_variable_id" the identifier of the corresponding soluion variable.

#### Defined in

[index.ts:160](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L160)

___

### getQuestionSource

▸ **getQuestionSource**(`questionID`): `string`

Returns the SELL code of a given question ID.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`string`

SELL code of question given by ID, or empty string in case that the question is invalid.

#### Defined in

[index.ts:94](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L94)

___

### getQuestionTitle

▸ **getQuestionTitle**(`questionID`): `string`

Gets the question title.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`string`

Title as HTML code or an empty string, if the question does not exist.

#### Defined in

[index.ts:177](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L177)

___

### getScore

▸ **getScore**(`questionID`): `number`

Gets the evaluation score of an already evaluted question.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question Index. |

#### Returns

`number`

Score in range [0, 1]

#### Defined in

[index.ts:278](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L278)

___

### readStudentAnswersFromHtmlElements

▸ **readStudentAnswersFromHtmlElements**(`questionID`): `boolean`

Reads student answers from HTML elements. Also refer to functions "evaluateQuestion" and "writeFeedbackToHtmlElements".

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:236](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L236)

___

### refreshMatrixDimensions

▸ **refreshMatrixDimensions**(`questionID`, `matrixId`, `deltaRows`, `deltaCols`): `boolean`

Updates the number of rows and columns of a matrix input. Thes function is mainly called internally.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |
| `matrixId` | `string` | - |
| `deltaRows` | `number` | Number of rows added (subtracted). |
| `deltaCols` | `number` | Number of columns added (subtracted). |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:321](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L321)

___

### refreshQuestion

▸ **refreshQuestion**(`questionID`): `boolean`

Refreshes the HTML elements of a questions. This is mainly required for matrices that can be resized by students. This function is mainly called internally.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:305](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L305)

___

### reset

▸ **reset**(): `void`

Remove all questions.

#### Returns

`void`

#### Defined in

[index.ts:28](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L28)

___

### setGenerateInputFieldHtmlCode

▸ **setGenerateInputFieldHtmlCode**(`enable?`): `void`

Enables (or disables) the generation of HTML code for input and feedback element.

#### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `enable` | `boolean` | `true` | If false, then getQuestionBody() returns HTML code that includes only placeholders for input and feedback fields. Placeholders have the form '$$ID', where ID can be obtained by calling getQuestionInputFields(). |

#### Returns

`void`

#### Defined in

[index.ts:121](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L121)

___

### setLanguage

▸ **setLanguage**(`langID`): `void`

Sets the language for text outputs. Default is "en" := English.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `langID` | `string` | Language identifier (one of {"en", "de"}). |

#### Returns

`void`

#### Defined in

[index.ts:105](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L105)

___

### setQuestionHtmlElement

▸ **setQuestionHtmlElement**(`questionID`, `element`): `boolean`

Sets the HTML element that contains the question body (Alternatively, the element can also be a parent element of the question body). This function must be called once before calling "readStudentAnswersFromHtmlElements" or "writeFeedbackToHtmlElements".

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |
| `element` | `HTMLElement` | HTML element that contains the question body. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:214](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L214)

___

### setServicePath

▸ **setServicePath**(`path`): `void`

Sets the path for "services/" (only required, if programming tasks are used)

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `path` | `string` | path to directory "service/" |

#### Returns

`void`

#### Defined in

[index.ts:113](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L113)

___

### setStudentAnswerManually

▸ **setStudentAnswerManually**(`questionID`, `solutionVariableID`, `answerStr`): `boolean`

Sets a student answer string manually. Also refer to functions "getInputElements" and "backupQuestion"

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |
| `solutionVariableID` | `string` | - |
| `answerStr` | `string` | Answer string in ASCII-math encoding (e.g. "a+bi" for complex numbers, "[a,b,c]" for vectors, "[[a,b],[c,d]]" for matrices). |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:247](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L247)

___

### writeFeedbackToHtmlElements

▸ **writeFeedbackToHtmlElements**(`questionID`): `boolean`

Writes feedback to HTML elements. Also refer to functions "evaluateQuestion" and "readStudentAnswersFromHtmlElements".

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `questionID` | `number` | Question index. |

#### Returns

`boolean`

Success.

#### Defined in

[index.ts:256](https://github.com/sellquiz/sellquiz/blob/4397825/src/index.ts#L256)