Members
waitingDiv :HTMLDivElement
- Source:
Type:
- HTMLDivElement
Methods
mtgLoad(container, svgOptions, mtgOptions, cbopt) → {undefined|Promise.<(MtgApp|MtgAppLecteur)>}
- Description:
Charge MtgApp ou MtgAppLecteur (si mtgOptions.isEditable ou mtgOptions.loadCoreOnly ou mtgOptions.loadCoreWithMathJax) Renverra l'instance de l'application à la callback ou dans une promesse Voir les tutoriels Chargement de l’éditeur Mathgraph, Chargement du lecteur Mathgraph, Chargement du moteur Mathgraph pour quelques exemples Attention, l'appel sans callback qui retourne une promesse ne fonctionne que si on importe cette fonction, la fct globale window.mtgLoad ne le fait pas (c'est un preloader sans gestion de promesse pour cause de compatibilité legacy)
- Source:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
container |
HTMLElement | string | Le conteneur pour y mettre le SVG (interface de l'appli), ou son id |
|||||||||||||||||||||
svgOptions |
Object | Pour le svg à créer dans le dom Properties
|
|||||||||||||||||||||
mtgOptions |
MtgOptions | Les informations pour l'initialisation de l'application |
|||||||||||||||||||||
cb |
mtgLoadCallback |
<optional> |
Il vaut mieux ne pas la fournir, mtgLoad retournera alors une promesse qui sera résolue avec l'instance de l'appli |
Throws:
-
si cb est fournie et n'est pas une fct
- Type
- Error
Returns:
- Type
- undefined | Promise.<(MtgApp|MtgAppLecteur)>
Type Definitions
FigDef
- Description:
Définition d'une figure, il faut fournir fig ou figRef
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | Le nom de la figure |
|
fig |
string |
<optional> |
Le code base64 de la figure |
figRef |
string |
<optional> |
La référence à une figure prééxistante dans mathgraph (cf kernel/figures.js) |
Définition d'une figure, il faut fournir fig ou figRef
MtgOptions
- Description:
Options pour initialiser l'application
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
fig |
string | NewFigOptions |
<optional> |
La figure base64 à afficher au chargement |
|
level |
number | string | entier de 0 à 3 pour le niveau de fonctionnement du logiciel (ou une chaine de caractères Base64 donnant les outils permis ou interdits, mais cette option est plutôt à usage interne) 0 : sélection d'outils pour le niveau élémentaire 1 : collège 2 : lycée (sans nombres complexes) 3 : lycée avec nombres complexes |
||
local |
boolean | string |
<optional> |
false
|
Si l'application fonctionne en local hors-ligne, passer true ou une chaîne de caractères donnant le chemin relatif de mtgLoad.js par rapport à la page qui a lancé l'application |
displayOnLoad |
boolean |
<optional> |
true
|
Passer false pour ne pas afficher la figure automatiquement dès qu'elle est prête (il faudra utiliser les méthodes du player pour l'afficher plus tard) |
displayMeasures |
boolean |
<optional> |
true
|
Passer false pour ne pas afficher automatiquement les mesures de longueur et d'angles (éditeur only) |
isInteractive |
boolean |
<optional> |
true
|
Passer false pour ne pas permettre de bouger les points (player only) |
isEditable |
boolean |
<optional> |
true
|
Passer false pour afficher la figure avec le player (ni menu ni bouton) |
loadApi |
boolean |
<optional> |
false
|
Passer true pour ajouter les méthodes de l'api à l'application qui sera retournée |
isPromiseMode |
boolean |
<optional> |
false
|
Passer true pour que les méthodes de l'api retournent des promesses (résolues lorsque l'affichage est fait) plutôt que les objets créés en synchrone |
loadCoreOnly |
boolean |
<optional> |
false
|
Passer true pour ne charger que le core (ça retourne un mtgAppLecteur instancié sans figure, pas de svg créé ni de MathJax chargé) |
loadCoreWithMathJax |
boolean |
<optional> |
false
|
Passer true pour ne charger que le core et MathJax (ça retourne un mtgAppLecteur instancié sans figure ni de svg créé), pour faire ensuite des addDoc dans des svg que l'appelant devra créer |
mathjax3Base |
string |
<optional> |
Url du dossier MathJax3 où prendre mathjax3 (sinon ce sera sur le site mathgraph32.org) |
|
loadJavascript |
boolean |
<optional> |
false
|
Passer true pour ajouter une console javascript (impliquera loadApi, param commandsContainer facultatif) |
loadPython |
boolean |
<optional> |
false
|
Passer true pour ajouter une console javascript (impliquera loadApi, param commandsContainer facultatif) |
preview |
boolean |
<optional> |
false
|
Ce param est à true lorsque la bibli affiche une ressource mathgraph editable (voir ou apercevoir, pour distinguer de la modification) |
pythonCode |
string |
<optional> |
Pour passer du code python à lancer au démarrage |
|
pythonCodeId |
string |
<optional> |
Passer l'id d'un tag <script> (ou textarea ou autre) contenant le code python à lancer au démarrage |
|
javascriptCode |
string |
<optional> |
Pour passer du code javascript à lancer au démarrage |
|
javascriptCodeId |
string |
<optional> |
Passer l'id d'un tag <script> (ou textarea ou autre) contenant le code javascript à lancer au démarrage |
|
pointsAuto |
boolean |
<optional> |
false
|
Passer true pour créer automatiquement un point quand on clique sur un endroit vide (avec certains outils) |
randomOnInit |
boolean |
<optional> |
false
|
passer true pour lancer l'aléatoire à l'initialisation de la figure (lecteur seulement) |
stylePointCroix |
boolean |
<optional> |
false
|
Passer true pour que le style de point au démarrage soit la grande croix (éditeur seulement). |
open |
boolean |
<optional> |
true
|
Passer false pour retirer l'outil permettant d'ouvrir une figure |
commandsFigs |
Array.<FigDef> |
<optional> |
Une liste de figures à proposer dans l'éditeur de commandes |
|
commandsContainer |
HTMLElement | string |
<optional> |
Conteneur pour la console de commandes (facultatif si non fourni avec loadPython|loadJavascript on en créera un à coté de la figure) |
|
mtgContainer |
HTMLElement |
<optional> |
À ne pas fournir, il sera affecté par mtgLoad |
|
hideCommands |
boolean |
<optional> |
false
|
Passer true pour cacher la console de commande (ignoré s'il n'y a pas de code de départ fourni) |
save |
boolean |
<optional> |
true
|
Passer false pour retirer l'outil permettant de sauvegarder une figure |
newFig |
boolean |
<optional> |
true
|
Passer false pour retirer l'outil permettant de créer une nouvelle figure |
options |
boolean |
<optional> |
true
|
Passer false pour retirer l'outil permettant de changer les options de la figure (ajouter ou retirer des outils) |
onlyPoints |
boolean |
<optional> |
false
|
Passer true pour que les outils de transformation ne s'appliquent qu'à des points |
dys |
boolean |
<optional> |
false
|
Passer true pour démarrer l'interface avec un affichage adapté aux utilisateurs "dys" (traits épais, points en grande croix, taille des noms plus grande) |
functionOnSave |
functionOnSave |
<optional> |
callBack appelée au clic sur le bouton d'enregistrement (sera appelée avec {figure, result}, pour le moment sans arguments) |
|
avertOnSave |
boolean |
<optional> |
true
|
si functionOnSave est présent et si avertOnSave est false, il n'y aura pas de message d'avertissement quand on clique sur le bouton d'enregistrement (true par défaut) |
callBackAfterReady |
function |
<optional> |
callBack appelée lorsque la figure est chargée, les méthodes de MtgApp peuvent alors être utilisées (inutile pour player et coreOnly) |
|
bplayer |
boolean |
<optional> |
false
|
Passer true pour ajouter une propriété player (de type MtgAppLecteur) à l'objet MtgApp retourné (utile pour les exercices de construction) |
language |
string |
<optional> |
''
|
Passer fr|en|es pour forcer la langue (sinon détection automatique d'après les headers envoyés par le navigateur) |
electron |
boolean |
<optional> |
false
|
Editeur only: passer true si destiné à fonctionner avec la version electron |
editionConstruction |
boolean |
<optional> |
false
|
Si on édite un exercice de construction il faut que ce paramètre soit true pour le prof, qui doit pouvoir modifier l'exo de construction lui-même, sinon ne pas le préciser pour l'élève (qui ne pourra pas modifier l'existant, seulement ajouter des objets) |
zoomOnWheel |
boolean |
<optional> |
true
|
Si on utilise la molette de la souris sur le svg de la figure, on zoome ou dézoome automatiquement |
decimalDot |
boolean |
<optional> |
true
|
true Si le séparateur décimal est le point décimal, sinon c'est la virgule |
useLens |
boolean |
<optional> |
true
|
true si, quand on capture un point avec un écran tactile, uen loupe apparaît |
translatable |
boolean |
<optional> |
false
|
true si on veut qu'on puisse faire glisser la figure entière. |
autoComplete |
boolean |
<optional> |
false
|
true si on veut que des marques de segments soient automatiquement ajoutées, par exemple pour une médiatrice. Pour le mtgAppLecteur, si translatable est undefined la figure n'est pas translatable Pour la version application, si translatable est undefined on le met à true (comportement par défaut de l'appli) |
noShortcuts |
boolean |
<optional> |
false
|
Passer true pour ne pas ajouter de raccourcis clavier (si l'on ne veut pas interférer avec d'autres applis dans le même DOM) |
Options pour initialiser l'application
NewFigOptions
- Description:
L'objet à passer à la place du code base64 d'une figure pour initialiser une figure vide
- Source:
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type |
string |
<optional> |
unity
|
simple|unity|orthonormal|orthogonal simple pour une figure sans longueur unité sans repère unity pour une figure avec segment longueur unité et sans repère orthonormal pour une figure avec repère orthonormal orthogonal pour un figure avec repère orthogonal |
||||||||||||||||||
datarep |
Object | objet pour initialiser le repère Properties
|
L'objet à passer à la place du code base64 d'une figure pour initialiser une figure vide
SvgOptions
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
width |
number |
<optional> |
900
|
Largeur du SVG contenant l'appli |
height |
number |
<optional> |
650
|
Hauteur du SVG contenant l'appli |
idSvg |
string |
<optional> |
svgMtg
|
id html du svg à créer (ou à prendre dans le DOM s'il y est déjà) |
addQ(fn) → {Promise}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
fn |
function |
Returns:
- Type
- Promise
functionOnSave(result)
- Description:
Callback functionOnSave (passée via MtgOptions)
- Source:
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
result |
Object |
Properties
|
mtgLoadCallback(error, mtgAppopt)
- Source:
- Deprecated:
- Yes
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null | ||
mtgApp |
MtgApp | MtgAppLecteur | MtgAppApi | MtgAppLecteurApi |
<optional> |
L'appli instanciée (mais le rendu de la figure peut être en cours) |