MtgAppLecteur

Methods

abort()

Description:

• Annule la pile des actions en cours (affichages et chargements)

Source:

• MtgAppLecteur.js, line 64

activateField(idDoc, nomCalcul) → {void}

Description:

• Fonction donnant le focus au premierr éditeur de formule asscoié au calcul ou à la fonction nommé nomCalcul dans le document d'id idDoc.

Source:

• MtgAppLecteur.js, line 368

Parameters:

Returns:

Type

void

activateFirstEmptyField(idDoc) → {void}

Description:

• Fonction donnant le focus au premier éditeur de formule qui ne contient rien dans le document d'id idDoc

Source:

• MtgAppLecteur.js, line 358

Parameters:

Returns:

Type

void

activateFirstInvalidField(idDoc) → {void}

Description:

• Fonction activant le premier éditeur de formule contenant une formule qui n'est pas correcte sur le plan syntaxique dans le document d'id idDoc.

Source:

• MtgAppLecteur.js, line 340

Parameters:

Returns:

Type

void

activateFirstInvalidOrEmptyField(idDoc) → {void}

Description:

• Fonction activant le premier éditeur de formule vide ou contenant une formule qui n'est pas correcte sur le plan syntaxique dans le document d'id idDoc

Source:

• MtgAppLecteur.js, line 349

Parameters:

Returns:

Type

void

addCallBackToSVGListener(idDoc, eventName, callBack) → {boolean}

Description:

• Ajoute un listener sur le doc (jamais utilisé dans notre code mais utilisé par des sections sesaparcours)

Source:

• MtgAppLecteur.js, line 838

Parameters:

Returns:

Type

boolean

addDoc(idDoc, chdoc, displayOnLoadopt, isActiveopt) → {void}

Description:

• Ajoute le document par son id représenté par une chaîne chdoc en dataBase64

Source:

• MtgAppLecteur.js, line 78

Parameters:

Returns:

Type

void

addEventListener(idDoc, ind, eventName, callBack) → {boolean}

Description:

• Associe un eventListener au svg Element représentant l'objet d'indice html ind dans la figure d'id idDoc

Source:

• MtgAppLecteur.js, line 745

Parameters:

Returns:

Type

boolean

addFunctionToQueue(f)

Description:

• Fonction destinée à mettre une fonction sur la pile des appels. A utiliser de façon externe pour être sûr qu'une action soit faite après les affichages en cours

Source:

• MtgAppLecteur.js, line 1769

Parameters:

addImplicitMult(idDoc, formula) → {string}

Description:

• Fonction renvoyant une chaîne de caractères correspondant à la formule contenue dans formula mais où les signes de multiplications implicites sont rajoutés en supposant que la formule ne contient pas de calculs ou de fonctions avace un nom de plus de un caractère.

Source:

• MtgAppLecteur.js, line 1698

Parameters:

Returns:

Type

string

afficheTout(svg, doc) → {void}

Description:

• Fonction de callback appelée lorsque MathJax a traité toues les formules en LaTeX et que la figure est prête pour affichage.

Source:

• MtgAppLecteur.js, line 299

Parameters:

Returns:

Type

void

calcVectOK(idDoc, chCalcul, tabNames) → {Object|boolean}

Description:

• Fonction renvoyant true si chCalcul représente un calcul complexe correct syntaxiquement dans le doc d'idDoc et si ce calcul représente un calcul pouvant être interprété comme un calcul vectoriel sachant que le tableau tabNames contient des chaînes de caractères représentant les noms de calculs complexes pouvant être considérés comme des vecteurs

Source:

• MtgAppLecteur.js, line 1722

Parameters:

Returns:

Type

Object | boolean

calculate(idDoc, brandom) → {void}

Description:

• Recalcule la figure d'identifiant idDoc

Source:

• MtgAppLecteur.js, line 1019

Parameters:

Returns:

Type

void

calculateAndDisplayAll(brandomopt) → {Promise.<boolean>}

Description:

• Recalcule toutes les figures et les affiche

Source:

• MtgAppLecteur.js, line 283

Parameters:

Returns:

Type

Promise.<boolean>

calculateFirstTime(idDoc, brandom)

Description:

• Fonction devant être appelée quand on calcule la figure pour la première fois avant de l'afficher Dans le cas où la figure contient une macro de démarrage qui doit elle même construire des objets supplémentaires, cette macro est d'abord exécutée

Source:

• MtgAppLecteur.js, line 1034

Parameters:

createList(code) → {CListeObjets}

Description:

• Renvoie un objet de type CListeObjets créé à partir d'une chaîne base64 d'une figure. Sert à gérer des objets de type calcul sans gérer une figure.

Source:

• MtgAppLecteur.js, line 1646

Since:

• 4.9.7

Parameters:

Returns:

Type

CListeObjets

display(idDoc) → {Promise.<boolean>}

Description:

• Fonction affichant la figure d'identifiant idDoc après avoir retiré tous les éléments graphiques du svg de la figure.

Source:

• MtgAppLecteur.js, line 1069

Parameters:

Returns:

Type

Promise.<boolean>

executeMacro(idDoc, nameMacro) → {void}

Description:

• Fonction exécutant la macro d'intitulé nameMacro dans la figure d'id idDoc.

Source:

• MtgAppLecteur.js, line 1130

Parameters:

Returns:

Type

void

fieldValidation(idDoc, nomCalcul) → {boolean}

Description:

• Fonction renvoyant true si le premier champ d'édition de la figure associée au document d'id idDoc associé au calcul nomCalcul est non vide.

Source:

• MtgAppLecteur.js, line 321

Parameters:

Returns:

Type

boolean

fieldsValidation(idDoc) → {boolean}

Description:

• Fonction demandant la validation de tous les éditeurs de formule de la figure associée au document d'id idDoc. Si la formule qu'ils contiennent est incorrecte ils se trouvent encadrés de rouge. Renvoie true uniquement si aucun éditeur de formule ne contient de faute de syntaxe.

Source:

• MtgAppLecteur.js, line 311

Parameters:

Returns:

Type

boolean

getDoc(idDoc) → {CMathGraphDoc|null}

Description:

• Renvoie le document d'id idDoc du tableau this.docs. S'il n'y en a pas, renvoie null.

Source:

• MtgAppLecteur.js, line 1140

Parameters:

Returns:

Type

CMathGraphDoc | null

getDocsIds() → {Array.<string>}

Description:

• Retourne la liste des ids des documents

Source:

• MtgAppLecteur.js, line 1709

Returns:

Type

Array.<string>

getFieldValue(idDoc, nomCalcul) → {string}

Description:

• Fonction renvoyant le contenu du premier éditeur de formule asssocié au calcul nomCalcul dans le dcument d'id idDoc.

Source:

• MtgAppLecteur.js, line 331

Parameters:

Returns:

Type

string

getFormula(idDoc, nomCalcul, bNocaseopt) → {string}

Description:

• Renvoie la formule en ligne (avec des *) du calcul ou de la fonction nommé nomCalcul contenue dans le document d'id idDoc.

Source:

• MtgAppLecteur.js, line 956

Parameters:

Returns:

Type

string

getIdDocFromEvent(evt) → {string}

Description:

• Retourne l'id du SVG de la figure à partir d'un événement déclenché sur un des éléments SVG de la figure ou sur le svg de la figure lui-même

Source:

• MtgAppLecteur.js, line 1744

Parameters:

Returns:

Type

string

getLatex(idDoc, startString) → {string}

Description:

• Fonction utilisée pour les exercices en ligne et qui, s'il existe un affichage LaTeX commençant par la chaîne startString renvoie le contenu cette chaîne tronqué de startString

Source:

• MtgAppLecteur.js, line 1173

Parameters:

Returns:

Type

string

getLatexCode(idDoc, ind) → {string}

Description:

• Fonction renvoyant le code LaTeX de l'affichage LaTex d'indice ind dans la liste des objets créés (les indices commençant à zéro) dans le document d'id idDoc

Source:

• MtgAppLecteur.js, line 1160

Parameters:

Returns:

Type

string

getLatexFormula(idDoc, nomCalcul) → {string}

Description:

• Fonction renvoyant la formule LaTeX représentant le calcul ou la fonction dont le nom est nomCalcul dans le document d'id idDoc.

Source:

• MtgAppLecteur.js, line 969

Parameters:

Returns:

Type

string

getList(idDoc) → {CListeObjets}

Description:

• Renvoie la liste CListeObjets contenant les objets du document d'id idDoc.

Source:

• MtgAppLecteur.js, line 1148

Parameters:

Returns:

Type

CListeObjets

getPointPosition(idDoc, name) → {null|Point}

Description:

• Fonction renvoyant les coordonnées actuelles du point nommé name relativement au SVG du document d'id idDoc

Source:

• MtgAppLecteur.js, line 643

Parameters:

Returns:

Type

null | Point

getSVGElement(idDoc, ind) → {null|SVGElement}

Description:

• Fonction renvoyant le composant SVG de l'élément d'id ind dans le document d'id idDoc Renvoie null s'il n'y a pas d'élément d'indice ind ou s'il n'existe pas où n'est pas affiché

Source:

• MtgAppLecteur.js, line 727

Parameters:

Returns:

Type

null | SVGElement

getSimplifiedLatexFormula(idDoc, nomCalcul) → {string}

Description:

• Fonction renvoyant la formule LaTeX représentant le calcul ou la fonction dont le nom est nomCalcul dans le document d'id idDoc, mais avec une formule simplifiée comme elle le serait dans un appel de \ForSimp{nomCalcul} dans un affichage LaTeX

Source:

• MtgAppLecteur.js, line 983

Parameters:

Returns:

Type

string

giveFormula2(idDoc, nomCalcul, formule) → {void}

Description:

• Fonction changeant, dans le document d'id idDoc, la formule du calcul ou de la fonction (réelle ou complexe) de nom nomCalcul. La nouvelle formule est contenue dans la chaîne de caractères formule. Renvoie true si la formule était valide et false sinon.

Source:

• MtgAppLecteur.js, line 932

Parameters:

Returns:

Type

void

mousemove(evt, id, doc) → {void}

Description:

• Fonction de callBack appelée lors des événements mouseMove.

Source:

• MtgAppLecteur.js, line 1378

Parameters:

Returns:

Type

void

ondeviceup(evt) → {void}

Description:

• Fonction de callBack appelée lors des événements mouseUp.

Source:

• MtgAppLecteur.js, line 1434

Parameters:

Returns:

Type

void

onmousedown(evt) → {void}

Description:

• Fonction appelée lors des événements mouseDown sur la figure.

Source:

• MtgAppLecteur.js, line 1273

Parameters:

Returns:

Type

void

onmousemove(evt) → {void}

Description:

• Fonction appelée lors des événements mouseMove sur la figure.

Source:

• MtgAppLecteur.js, line 1220

Parameters:

Returns:

Type

void

ontouchcancel(evt) → {void}

Description:

• Fonction de callBack appelée lors des événements touchCancel.

Source:

• MtgAppLecteur.js, line 1616

Parameters:

Returns:

Type

void

ontouchend(evt) → {void}

Description:

• Fonction de callBack appelée lors des événements touchEnd.

Source:

• MtgAppLecteur.js, line 1600

Parameters:

Returns:

Type

void

ontouchmove(evt) → {void}

Description:

• Fonction appelée lors des événements touchMove sur la figure.

Source:

• MtgAppLecteur.js, line 1250

Parameters:

Returns:

Type

void

ontouchstart(evt) → {void}

Description:

• listener des événements touchStart (actif, il faut préciser {passive: false} au addEventListener)

Source:

• MtgAppLecteur.js, line 1453

Parameters:

Returns:

Type

void

prepareTracesEtImageFond(svg, doc)

Source:

• MtgAppLecteur.js, line 195

Parameters:

ready(cbopt) → {Promise|undefined}

Description:

• Appellera cb quand tous les rendus seront terminés

Source:

• MtgAppLecteur.js, line 261

Parameters:

Returns:

Type

Promise | undefined

removeAllDoc() → {void}

Description:

• Fonction retirant tous les documents et effaçant le contenu de tous les svg contenant des figures.

Source:

• MtgAppLecteur.js, line 270

Returns:

Type

void

removeCallBackToSVGListener(idDoc, eventName) → {boolean}

Description:

• Retire un listener sur le doc (jamais utilisé dans notre code mais utilisé par des sections sesaparcours)

Source:

• MtgAppLecteur.js, line 857

Parameters:

Returns:

Type

boolean

removeDoc(idDoc) → {void}

Description:

• Fonction retirant le document d'id idDoc, retirant les gestionnaires d'événements qui lui sont associés et effaçant touts les éléments graphiques du svg associé

Source:

• MtgAppLecteur.js, line 229

Parameters:

Returns:

Type

void

removeEventListener(idDoc, ind, eventName) → {boolean}

Description:

• Fonction retirant l'eventListener associé à svg element représentant l'objet d'indice html ind dans le document d'id idDoc

Source:

• MtgAppLecteur.js, line 805

Parameters:

Returns:

Type

boolean

rename(idDoc, oldName, newName)

Description:

• Fonction destinée à être appelée de façon externe et remplaçant le nom du point ou de la droite nommé oldName par newName, à condition qu'aucun point n'ait déjà le nom newName

Source:

• MtgAppLecteur.js, line 1662

Parameters:

setActive(idDoc, ba) → {void}

Description:

• Rend la figure d'id idDoc réactive ou inactive aux événements souris et clavier suivant la valeur du boolean ba.

Source:

• MtgAppLecteur.js, line 1194

Parameters:

Returns:

Type

void

setColor(idDoc, ind, r, v, b, bImmediatopt, opacityopt) → {boolean}

Description:

• Fonction donnant à l'élément d'id ind dans le document d'id idDoc la couleur de composantes r, v, b style et l'épaisseur thickness

Source:

• MtgAppLecteur.js, line 702

Parameters:

Returns:

Type

boolean

setEditorCallBackOK(idDoc, nomCalcul, f) → {void}

Description:

• Fonction associant, dans le document d'id idDoc, au premier éditeur associé à nomCalcul une fonction de callBack qui sera appelée quand l'utilisateur valide par OK le contenu de l'éditeur.

Source:

• MtgAppLecteur.js, line 908

Parameters:

Returns:

Type

void

setEditorCharset(idDoc, nomCalcul, st) → {void}

Description:

• Fonction attribuant à un éditeur de formule une chaîne de caractères contenant les caractères autorisés. Si cette chaîne est vide, tous les caractères seront autorisés.

Source:

• MtgAppLecteur.js, line 891

Parameters:

Returns:

Type

void

setEditorValue(idDoc, nomCalcul, st) → {void}

Description:

• Fonction mettant dans l'éditeur la chaîne de caractères st et mettant à jour en conséquence l'affichage de formule LaTeX s'il est activé, dans le document d'id idDoc

Source:

• MtgAppLecteur.js, line 879

Parameters:

Returns:

Type

void

setEditorsEmpty(idDoc) → {void}

Description:

• Fonction vidant tous les éditeurs de formule de la figure d'id idDoc

Source:

• MtgAppLecteur.js, line 868

Parameters:

Returns:

Type

void

setEditorsSize(idDoc, size) → {void}

Description:

• Fonction donnant à tous les éditeur de formule de la fiure d'id idDoc la taille size. Utilisé dans j3p.

Source:

• MtgAppLecteur.js, line 996

Parameters:

Returns:

Type

void

setFormula4Prosca(idDoc, nomCalcul, tabNames)

Description:

• Change l'arbre de calcul du calcul complexe nomCalcul pour le remplacer par un calcul dans lequel les carrés de vecteurs sont remplacés par des carrés scalaires. Ce remplacement de formule doit être fait une fois que la figure a déjà été calculée

Source:

• MtgAppLecteur.js, line 944

Parameters:

setLineStyle(idDoc, ind, style, thicknessopt, bImmediatopt) → {boolean}

Description:

• Fonction donnant à l'élément d'id ind dans le document d'id idDoc le style de trait style et l'épaisseur thickness

Source:

• MtgAppLecteur.js, line 675

Parameters:

Returns:

Type

boolean

setPointPosition(idDoc, name, x, y, bImmediatopt) → {boolean|Promise.<undefined>}

Description:

• Fonction déplaçant un point libre aux coordonnées (x;y) dans le svg du document d'id idDoc

Source:

• MtgAppLecteur.js, line 549

Parameters:

Returns:

Type

boolean | Promise.<undefined>

setTag(idDoc, id, tag) → {CElementBase|null}

Description:

• Fonction donnant, dans le doc d'id idDoc, à l'élément d'id html id le tag tag

Source:

• MtgAppLecteur.js, line 1786

Parameters:

Returns:

Type

CElementBase | null

setText(idDoc, ind, txt, bImmediatopt) → {boolean}

Description:

• Fonction donnant à l'élément d'indice html ind dans le document d'id idDoc le texte txt. Cet élément peut être soit un CLatex soit un CCommentaire

Source:

• MtgAppLecteur.js, line 412

Parameters:

Returns:

Type

boolean

setVisible(idDoc, ind, bVisibleopt, bImmediatopt) → {boolean}

Description:

• Fonction servant à rendre visible ou masquer l'élément graphique du document d'id idDoc et dont le n° d'identification html est ind

Source:

• MtgAppLecteur.js, line 382

Parameters:

Returns:

Type

boolean

syntaxValidation(idDoc, calcName, formula, bSignesMultImplicitopt) → {boolean}

Description:

• Fonction vérifiant si, dans le document d'id idDoc on peut affecter au calcul (ou à la fonction) nommée calcName la formule contenue dans la chaîne de caractères formula

Source:

• MtgAppLecteur.js, line 1682

Parameters:

Returns:

Type

boolean

touchmove(evt, id, doc) → {void}

Description:

• Fonction de callBack appelée lors des événements touchMove.

Source:

• MtgAppLecteur.js, line 1556

Parameters:

Returns:

Type

void

translate(idDoc, decx, decy, bImmediatopt) → {boolean}

Description:

• Fonction translatant tous les objets de la figure d'id idDoc d'un vecteur (decx, decy)

Source:

• MtgAppLecteur.js, line 492

Parameters:

Returns:

Type

boolean

translatePoint(idDoc, name, deltax, deltay, bImmediatopt) → {boolean}

Description:

• Fonction translatant un point libre du vecteur de coordonnées (deltax; deltay) dans le svg du document d'id idDoc

Source:

• MtgAppLecteur.js, line 608

Parameters:

Returns:

Type

boolean

updateDisplay(idDoc) → {void}

Description:

• Fonction mettant à jour les éléments graphiques de la figure d'idDoc.

Source:

• MtgAppLecteur.js, line 1111

Parameters:

Returns:

Type

void

updateFigure(idDoc) → {boolean}

Description:

• Remet à jour la figure du document idDoc après avoir modifié certains de ses objets directement (par exemple en utilisant translatePoint()

Source:

• MtgAppLecteur.js, line 518

Parameters:

Returns:

Type

boolean

valueOf(idDoc, nomCalcul, bNoCaseopt) → {number}

Description:

• Renvoie la valeur actuelle du calcul réel nommé nomCalcul dans le document d'id idDoc. Renvoie -1 si le calcul n'existe pas.

Source:

• MtgAppLecteur.js, line 919

Parameters:

Returns:

Type

number

zoom(idDoc, x, y, ratio, bImmediatopt) → {boolean}

Description:

• Fonction zoomant tous les éléments de la figure d'id idDoc par rapport au point de coordonnées (x; y) avec le rapport de zoom ratio

Source:

• MtgAppLecteur.js, line 464

Parameters:

Returns:

Type

boolean