Global

Members

(constant) externalModules

En attendant la gestion du load async avec es6, on utilise loadjs,
on garde ici un mapping vers les modules tiers que l'on utilise

Source:

Methods

addBoutonVu(onClickCb) → {Element}

Affiche le bouton vu, ajoute son comportement au clic et le retourne

Parameters:
Name Type Description
onClickCb function

sera appelée à chaque clic sur le bouton
Source:
Returns:

undefined si #boutonVu n'existait pas dans la page

Type
Element

addError(error, delayopt)

Ajoute un texte d'erreur dans errorsContainer (#errors ou #error ou #warnings) ET dans console.error (si ça existe)
L'existence de cette fonction est testée par init.js pour savoir si on doit être chargé.

Parameters:
Name Type Attributes Description
error string | Error

Le message à afficher
delay number <optional>

Un éventuel délai d'affichage en secondes
Source:

alertIfError(error)

Callback pour l'envoi au unload

Parameters:
Name Type Description
error Error
Source:

hideTitle()

Cache le #titre (en global pour que les plugins puissent le faire)

Source:

init(options, nextopt)

Complète les options si besoin avec base, container, errorsContainer qui seront créés si besoin,
et ajoute aux options 'urlResultatCallback', 'userOrigine', 'userId' si elles n'y sont pas et sont dans l'url

Parameters:
Name Type Attributes Description
options initOptions
next errorCallback <optional>
Source:

loadAsync(moduleNames, parallelLoadopt, callback)

Pour charger des modules référencé ici en async, avec loadjs

Parameters:
Name Type Attributes Default Description
moduleNames Array
parallelLoad boolean <optional>
 true
callback
Source:

logIfError(error)

Log en console.error si error

Parameters:
Name Type Description
error Error
Source:

notifyBugsnag(error)

Notifie busgnag (si on a un client) et sort l'erreur en console

Parameters:
Name Type Description
error Error
Source:

printIfError(error)

page.addError si error (inclue console.error)

Parameters:
Name Type Description
error Error
Source:

sendResultatMessage()

Envoie le résultat au dom parent (à priori sesalab) avec un postMessage mais ne gère pas de feedback
(faudrait passer dans le message une action de retour et un id, et ajouter un écouteur dessus)
c'est le parent qui affichera le feedback

Source:

setBase(newBase)

Change la base (pour la mettre absolue après chargement de ce module en cross domain)

Parameters:
Name Type Description
newBase
Source:

showNotification(htmlString, delayopt)

Affiche une notification

Parameters:
Name Type Attributes Default Description
htmlString string
delay number <optional>
 5

délai en s avant fermeture auto
Source:

Type Definitions

displayOptions

Options à passer à display (celles de initOptions plus d'autres)
display ajoutera une propriété pluginBase pour appeler les méthodes display des plugins

Type:
  • Object
Properties:
Name Type Attributes Default Description
base string <optional>
 /

Le préfixe de chemin vers la racine de la sésathèque.
Si ce module est utilisé sur un autre domaine que la sésathèque
il faut passer une baseId connue de sesatheque-client
ou un chemin http://… complet
container Element <optional>

L'élément html qui servira de conteneur au plugin pour afficher sa ressource, créé si non fourni
errorsContainer Element <optional>

L'élément html pour afficher des erreurs éventuelles, créé si non fourni
verbose boolean <optional>
 false

Passer true pour ajouter des log en console
isDev boolean <optional>
 false

Passer true pour initialiser le dom source en sesamath.dev (pour certains plugins)
urlResultatCallback string <optional>

Une url vers laquelle poster le résultat
(idem si la page de la ressource contient ?urlScoreCallback=http…)
resultatMessageAction string <optional>

Un nom d'action pour passer le résultat en postMessage
resultatCallback resultatCallback <optional>

Une fonction pour recevoir un objet Resultat (si y'a pas de urlScoreCallback)
sesatheque string <optional>

Sera ajoutée en propriété du résultat (peut être passé en param du GET de la page),
le nom de la sésathèque pour un client qui récupère des résultats de plusieurs sésatheques
showTitle boolean <optional>
 true

Passer '0' ou 'false' via l'url ou false via options pour cacher le titre
userOrigine string <optional>

Sera ajoutée en propriété du résultat (peut être passé en param du GET de la page)
userId string <optional>

Sera ajoutée en propriété du résultat (peut être passé en param du GET de la page)
flashvars object <optional>

Pour les plugins qui chargent du swf, sera passé en flashvars en plus
lastResultat Resultat <optional>

Un éventuel Resultat
Source:

Element

Un élément du Dom HTML

Type:
  • Object
Source:
See:

feedbackArg

Type:
  • object
Source:

feedbackCallback(retour)

Parameters:
Name Type Description
retour feedbackArg

Le retour de resultatCallback (pour confirmer une sauvegarde)
Source:

initOptions

Options à passer à init() ou à display(), les autres propriétés seront laissées intactes

Type:
  • Object
Properties:
Name Type Attributes Default Description
base string <optional>
 /

Le préfixe de chemin vers la racine de la sésathèque.
Il faut passer un chemin http://… complet si ce module est utilisé sur un autre domaine que la sésathèque
container Element <optional>

L'élément html qui servira de conteneur au plugin pour afficher sa ressource, créé si non fourni
showTitle boolean <optional>
 true

Passer false pour ne pas afficher le titre
errorsContainer Element <optional>

L'élément html pour afficher des erreurs éventuelles, créé si non fourni
verbose boolean <optional>
 false

Passer true pour ajouter des log en console
Source:

resultatCallback(Un)

Parameters:
Name Type Description
Un Resultat

objet Resultat (en cas d'erreur la callback n'est pas appelée)
feedbackCallback
Source: