This is the JavaScript API documentation for Numbas.
Numbas is an open-source system for creating online exams which run entirely in the browser, developed by Newcastle University's School of Mathematics, Statistics and Physics.
More general documentation for Numbas is at docs.numbas.org.uk.
This documentation is intended to help Numbas developers, authors of Numbas extensions, or question authors using some of the more advanced features which involve writing JavaScript.
Wrappers for the various navigation actions the user can do.
The assumption is that these should only be called in response to some event the user triggers, by clicking or whatever.
Provides Numbas.controls
Functions related to the download and interpretation of student results, and interaction with the results page, usually for outside-LTI contexts.
Functions related to creating files to download and encrypting them.
The Numbas.parts.CustomPart constructor.
Defines the Numbas.Exam object.
Sets up JME built-in functions.
Provides Numbas.jme
Code to do with differentiation and integration
Provides Numbas.jme.calculus
Stuff to do with displaying JME expressions - convert to TeX, simplify, or convert syntax trees back to JME
Provides Numbas.jme.display
Code to do with JME pattern-matching rules.
Provides Numbas.jme.rules
Stuff to do with making new functions from JME or JavaScript code, generating question variables, and substituting variables into maths or the DOM.
Provides Numbas.jme.variables
Sets up the JME compiler and evaluator.
Provides Numbas.jme
Stuff to do with loading from JSON objects. Provides Numbas.json.
Mathematical functions, providing stuff that the built-in Math object doesn't, as well as vector and matrix math operations.
Provides Numbas.math, Numbas.vectormath and Numbas.matrixmath
Contains code to load in the other script files, and initialise the exam.
Creates the global Numbas object, inside which everything else is stored, so as not to conflict with anything else that might be running in the page.
Numbas.parts, Numbas.partConstructors, Numbas.createPart and the generic Numbas.parts.Part object
The Numbas.parts.CustomPart constructor.
The Numbas.parts. object
The Numbas.parts.GapFillPart object
The Numbas.parts. object
The Numbas.parts.JMEPart object
The Numbas.parts.MatrixEntryPart object
The Numbas.parts.NumberEntryPart object
The Numbas.parts.PatternMatchPart object
The Numbas.Question object
Provides Numbas.schedule
Provides a storage API Numbas.storage.SCORMStorage which interfaces with SCORM
Start the exam
A few functions to do with time and date, and also performance timing. Provides Numbas.timing.
Convenience functions, extensions to javascript built-ins, etc. Provides Numbas.util. Includes es5-shim.js
Stuff to do with loading XML, and getting data out of XML. Provides Numbas.xml.
Display code. Provides Numbas.display