Settings

Settings allow you to control the generic way that the player works. Change the settings using the addSettings function. The first argument to the function is always the name of the setting, the second argument is the setting values. In case the setting is an object, subsequent objects will extend each other so that settings may be progressively added.

All the functions within settings are invoked using angular. This means that you have access to any service you like, as well as some specific assets. In order to access the services simply use arguments with the appropriate name. For instance, this is how you would access $rootScope:

function onEnd($rootScope){
    $rootScope.$emit('end!!');
}

canvas

canvas takes an object that describes the style of the task environment. Each property of the object changes a different style element.

API.addSettings('canvas', {
    fontSize: '2em'
});

In case you need to fine tune the styles even further you can add css rules into the raw HTML. Support for dynamically adding CSS is planned but not yet supported.

injectStyle

Injects a string of css into the page.

API.addSettings('injectStyle', '[pi-quest] label {font-size:1.2em; font-weight:normal;}');

onPreTask

onPreTask is a function to be called before each task is called.

API.addSettings('onPreTask', function(currentTask){
    doSomethingWith(currentTask);
});

onEnd

onEnd is a function to be called as soon as the task sequence ends.

API.addSettings('onEnd', function(){
    // Do something: for instance, redirect to 'my/url.js'
    location.href = 'my/url.js';
});

title

title is a string to be used as the page title (the name displayed on the tag).

API.addSettings('title', 'My Manager Title');

preloadImages

Accepts an array of image urls to preload. The manager will not wait until all images are loaded, but it will make images displayed later in the manager sequence be displayed significantly faster.

API.addSettings('preloadImages', ['my/image/url/imageName.png', 'my/other/url/otherImage.jpg']);

skip

Whether to activate the skip and refresh option. If activated, clicking ctrl r reloads the current task (this feature may not be supported on older browsers), clicking escape and then the right or left arrows skips to the next or previous tasks.

API.addSettings('skip', true);

skin

Add a skin to your project. Skins change the way that your tasks look. Currently the only skins that we support are simple and demo.

API.addSettings('skin', 'demo');

rtl

Setting rtl to true will change the layout of the player to right to left in order to ocomodate right to left languages such as arabic and hebrew.

API.addSettings('rtl', true);

logger

The logger allows control of logging activities. See full details in the core section.

API.addSettings('logger', {
    type:'debug',
});

DEBUG

The DEBUG settings allows you to control the debug messages produced by the player. In the development environment (when window.DEBUG is set to true) you have access to a development console. The console will hold messages describing the process of your studies.

At the top of the console window you will see a dropdown that allows you to select the level of logging you would like to see. For example, you may want to be alerted only of errors, or of every possible activity of the player. In addition you have a button that allows you to close and open the console.

API.addSettings('DEBUG', { hideConsole: true});