mqFunctions

Members

(static, constant) mqCommandes

Description:

  • La liste des commandes mathquill connues (clé nom de la commande et valeur la fonction, utile lorsque la commande est une variable)

Source:

La liste des commandes mathquill connues (clé nom de la commande et valeur la fonction, utile lorsque la commande est une variable)

Methods

(static) cleanLatexForMq(strLatex, optionsopt) → {string}

Description:

  • Nettoie une chaîne latex pour mathquill, remplace les \n par
    , vire les \displaystyle \left[ \right], S’il y a du \text, ils seront isolés, un par ligne (et ce qui précède le premier ou suit le dernier est ignoré) et \lim_{… \to …} transformés en \limite{}{}

Source:
Parameters:
Name Type Attributes Description
strLatex string
options Object <optional>
Properties
Name Type Attributes Default Description
keepText boolean <optional>
 false

passer true pour conserver les \text dans la chaîne retournée
Returns:
Type
string

(static) getMqValue(inputMq) → {string}

Description:

  • Retourne la string latex d’un input mathquill (la passer à unLatexify pour la nettoyer)

Source:
Parameters:
Name Type Description
inputMq HTMLElement
Returns:
Type
string

(static) isInputMathquill(elt) → {boolean}

Description:

  • Retourne true si elt est un input Mathquill (mais pas forcément dans le dom)

Source:
Parameters:
Name Type Description
elt
Returns:
Type
boolean

(static) j3pAffiche(conteneur, idopt, contenu, optionsopt, positionopt) → {ResultatAffichage}

Description:

  • Affiche contenu dans conteneur (créera un span du contenu), avec bcp de traitements !!! contenu est en effet traitée pour

    • substituer les £x ou £{x}
    • gérer du $code LaTeX$
    • gérer du contenu mathquill substituable
    • gérer des input mathquill
    • gérer de la substitution dynamique (les valeurs à substituer peuvent contenir des opérations comme calcule[…], signe[…], pgcd[…] Voir le détail sur Contenu paramétrable Si vous voulez simplement afficher une chaîne sans avoir besoin de traitement particulier, utiliser j3pAddElt(conteneur, options)
Source:
Parameters:
Name Type Attributes Default Description
conteneur HTMLElement | string
id string | null <optional>

si fourni sera mis sur le span qu’on va créer dans conteneur
contenu string

Le texte à afficher (les caractères spéciaux $@&# seront interprétés à la mode j3p : $\frac{3}{2}$ : affiché comme du LaTeX
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
style Object <optional>

Objet style qui sera passé au span, pour ceux qui préfèrent style.fontSize (en string avec unité px ou autre) plutôt que styletexte.taillepolice (number sans unité)
styletexte Object <optional>

des infos pour le style à mettre sur le span qu’on va créer autour du contenu

Properties
Name Type Attributes Description
couleur string <optional>
taillepolice number <optional>
x string | number <optional>

pour le remplacement d’un £x ou £{x} qui serait dans contenu
inputN object <optional>

pour les @N@ @todo à documenter
inputmqN object <optional>

pour les &N& (édition mathquill) @todo à documenter
listeN object <optional>

pour les #N# (le

listeN Array.<string> <optional>

les

tag string <optional>
 span

Le tag à créer pour y mettre le contenu
position Object <optional>

Si fourni, doit avoir les propriétés top & left en number (sinon ce sera ignoré)

Properties
Name Type Attributes Description
top number <optional>
left number <optional>
Returns:

Les éléments créés dans le DOM, parent est le span englobant, les autres propriétés sont toutes des array d’éléments (ces listes sont donc souvent vides), mqList pour les span créés par $text$, inputList pour les input créés par @N@, selectList pour les listes créées par #N# (parcourir sa propriété childNodes pour avoir les options), inputmqList pour les input mathquill créés avec &N& et inputmqefList pour les champs éditables créés par mathquill si y’a du \editable{} dans le latex fourni

Type
ResultatAffichage

(static) j3pDesactive(elt)

Description:

  • Désactive un input (en général à la correction, pour rendre l’input non modifiable en conservant son contenu à l’écran)

Source:
Parameters:
Name Type Description
elt HTMLElement | string

(static) j3pMathsAjouteDans(conteneur, options) → {HTMLElement|void}

Description:

  • Crée un texte mathématique, les parties entre $ seront affichées par mathquill et leurs éventuels £x substitués Variante de syntaxe : j3pMathsAjouteDans(conteneur, id, content, parametres, pos)

Source:
Parameters:
Name Type Description
conteneur string | HTMLElement

L’élément (ou son id) dans lequel ajouter le texte
options Object
Properties
Name Type Attributes Default Description
id string <optional>

Si fourni mis sur l’élément créé et utilisé comme préfixe sur les id des zones mathquill (qui n’auront pas d’id sinon)
content string

Le texte à afficher par ex "$z_1=£x+i£y$"
parametres Object <optional>

Les remplacements pour les £xx (entre $) dans content, de la forme { nomVariable: valeur }
pos Object <optional>

pour positionnement absolu du texte (avec top & left) ou taille de police

Properties
Name Type Attributes Description
top number | string <optional>
left number | string <optional>
taillepolice number | string <optional>

sera mis en style.fontSize, c’est un vieux comportement, il vaut mieux passer par options.style.fontSize
tag string <optional>
 span

Le tag à utiliser pour envelopper la formule
style Object <optional>

Le style qui sera sera mis sur le tag enveloppe (éventuellement surchargé par pos pour le positionnement)
Returns:

L’élément créé (de type options.tag, span par défaut), ou undefined si on a pas pu l’ajouter

Type
HTMLElement | void

(static) lazyMqProcess(cb)

Description:

  • Exécute cb en sync si mathquill est chargé, en async après chargement sinon

Source:
Parameters:
Name Type Description
cb function

(static) mqAjoute(cmd, elt, focusopt)

Description:

  • Ajoute la commande mathquill à l’input mathquill

Source:
Parameters:
Name Type Attributes Default Description
cmd string

Chaîne qui sera affichée telle quelle dans l’input
elt string | HTMLElement

L’input mathquill ou son id
focus boolean <optional>
 true

passer false pour ne pas donner le focus à l’input ajouté

(static) mqRestriction(inputMq, restriction, optionsopt)

Description:

  • Ajoute une restriction et un clavier virtuel à un input mathquill. Peut s’utiliser en remplacement direct de j3pRestriction (même s’il offre des options supplémentaires)

Source:
Parameters:
Name Type Attributes Description
inputMq HTMLElement | string

L’input mathquill (le span.mq-editable-field)
restriction string | RegExp

La restriction appliquée au keypress (pour ne pas en mettre laisser null). Si c’est une string, elle sera contrôlée / nettoyée (cf convertRestriction), privilégier le format RegExp.
options Object <optional>
Properties
Name Type Attributes Description
virtualKeyboardRestriction RegExp <optional>

Une regexp qui serait différente de celle appliqué au keypress (si non fournie ce sera restriction)
commandes Array.<string> <optional>

Une liste de commandes mathquill (racine, fraction, etc.)
boundingContainer HTMLElement <optional>

Un parent dans lequel il faut essayer de rester (que le clavier ne déborde pas), si non fourni on prendra le premier parent .divZone

(static) unLatexify(latex) → {string}

Description:

  • Remplace les commandes LaTeX (venant de $().mathquill('latex') ou d’un input mathlive) par leur équivalent texte (\times par *, etc.) Attention, il y a quelques partis pris :

    • toute fct latex a deux arguments est supposée \frac
    • il n’y a pas d’exposant à deux chiffres (seul le premier est conservé en exposant, les suivants sont pris comme multiplicateurs)
Source:
Parameters:
Name Type Description
latex string
Returns:

La chaîne prête pour être passée à mtgAppLecteur.addImplicitMult() par exemple

Type
string

(inner) getFirstCharSpe(ch) → {string}

Description:

  • renvoie le premier caractere special de la chaîne ou ''

Source:
Parameters:
Name Type Description
ch string
Returns:
Type
string

(inner) mqAjouteFct(cmd, elt, focus)

Description:

  • Ajoute une fonction dans l’input avec la parenthèse ouvrante

Source:
Parameters:
Name Type Description
cmd string
elt HTMLElement

L’input mathquill
focus boolean

(inner) renderStaticMath(elt)

Description:

  • Assure le rendu latex StaticMath dans elt Si MathQuill n'a pas fini de charger on attend que ça se termine

Source:
Parameters:
Name Type Description
elt

(inner) restricTaille(event)

Description:

  • Limite la taille des inputMQ Attention, MathQuill doit exister avant d'appeler cette fonction

Source:
Parameters:
Name Type Description
event

Type Definitions

ResultatAffichage

Description:

  • Le retour d’un j3pAffiche, avec le span parent et les listes d’éléments mis dedans (en général une seule liste est non vide)

Source:
Properties:
Name Type Description
parent HTMLSpanElement
inputList Array.<HTMLElement>

liste d’input créés par les @N@
inputmqList Array.<HTMLElement>

input mathquill créés par les &N&
inputmqefList Array.<HTMLElement>

les input mathquill créés avec du \editable{} dans le latex fourni
mqList Array.<HTMLElement>

liste de span mathquill créés par les $text$
selectList Array.<HTMLElement>

liste de select créées par #N# (parcourir sa propriété childNodes pour avoir les options)

Le retour d’un j3pAffiche, avec le span parent et les listes d’éléments mis dedans (en général une seule liste est non vide)