Callbacks

The Callbacks object contains optional callback functions that allow detection of the 'ready' status of an Reports API instance and any errors encountered.

The readyListener callback in particular is very important for the correct functioning of Reports API. most of the methods provided by the returned object from window.LearnosityReports.init() will not be fully available until after the readyListener callback has triggered.

Properties

• cutScoreMutator function

  This callback can be used to manipulate or mutate the score values before the last score by item by user and last score by Activity by user reports are rendered on the page.

• dataListener function

  Function to be called when all report data has been loaded.

• displayNameListener function

  Callback function used in some reports (notably, Large Group Report) to map raw names and identifiers in the report data to friendly display names at runtime.

• errorListener function

  Function to be called on a Learnosity error event.

• readyListener function

  Function to be called when the API has been successfully initialised.

• scoreMutator function

  Callback function used in the learning outcomes report to mutate scores shown in each cell of the report.