{{warning}}

General Options

The player options determine the player mode and the item or session to load and with which settings. Options can be passed when instantiating the player in javascript or in the player token which is always passed to the player when loading the player javascript source. Options defined in the player token will take precedence over any options defined in javascript.

itemId / sessionId

The player may be loaded to view (or edit) an existing response to an item or to ask a user to enter a new response.

  • itemId - If only an itemId is provided, the player will create a new Item Session and send the id to the callback onItemSessionCreated(sessionId)
  • sessionId - To view or edit a previous response, provide the sessionId for the response.

mode

There are four main modes or states in which the player can display an item or item session:

  • gather - the gather a response mode allows a user (e.g., a student) to enter a new response or continue editing an existing saved response.
  • view - the view a response mode allows the review of a completed response, it is not editable.
  • evaluate - the view an evaluated response mode allows the review of a completed response, with feedback about the answers. Like the view mode, an evaluated response is no longer editable..
  • instructor - the instructor mode allows the review of the correct answer of an item, and optionally
    additional information (like teacher instructions, rationales) for the instructor evaluating the item

Passing the mode option is not required. If no mode is provided in the options object used when creating the player, the mode will default to 'gather' when itemId is set and 'view' when sessionId is set.

width

By default the player takes up all available width of its parent container element. Specify the width of the player explicitly by passing the width option. The width parameter is a number, representing the width of the player in terms of pixels.

scrollContainer

As the player is inside an iframe, scrolling is affected by the structure of the DOM it is taking place in. By default the 'body' element will get scrolled when scrolling is needed (eg. dragging a choice outside the visible area) but in certain cases you may want to specify the holder element you want to use for scrolling. For example if the player is inside a fixed position modal window, it will need to be set as the scroll container.

The scrollContainer option takes a DOM element reference or a jQuery object.