new MtgAppLecteurApi()
- Source:
- Mixes In:
MtgAppLecteur avec les méthodes de l'api ajoutées
Extends
Members
divDlg :HTMLDivElement
- Source:
- Inherited From:
div centré sur l'écran pour les boîtes de dialogue
Type:
- HTMLDivElement
Methods
abort()
- Source:
- Inherited From:
Annule la pile des actions en cours (affichages et chargements)
activateField(idDoc, nomCalcul) → {void}
- Source:
- Inherited From:
Fonction donnant le focus au premierr éditeur de formule asscoié au calcul ou à la fonction nommé nomCalcul dans le document d'id idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string |
Returns:
- Type
- void
activateFirstEmptyField(idDoc) → {void}
- Source:
- Inherited From:
Fonction donnant le focus au premier éditeur de formule qui ne contient rien dans le document d'id idDoc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- void
activateFirstInvalidField(idDoc) → {void}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- void
activateFirstInvalidOrEmptyField(idDoc) → {void}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- void
activateTraceMode(bActivate)
- Source:
- Mixes In:
activates or deactivates trace mode on the figure
syntax activates(true|false) allowed
Parameters:
| Name | Type | Description |
|---|---|---|
bActivate |
boolean | true to activate trace mode, false to deactivate trace mode |
addAbsMeasure(options) → {CMesureAbscisse}
- Source:
- Mixes In:
Adds the measure of length measure of point b in (o, a) (the three points must be aligned)
syntax addAbsMeasure(b, o, a) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CMesureAbscisse
addAngleMark(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Adds an angle mark
syntax allowed addAngleMark(o, a, b, r, addAngleMark(o, a, b, r, color), addAngleMark(o, a, b, r, color, angleMarkStyle) or addAngleMark(o, a, b, r, color, angleMarkStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<undefined>
addArcDirectOAB(options) → {Promise.<undefined>|CArcDeCercleDirect}
- Source:
- Mixes In:
Adds the direct circle arc of center o starting from point a and ending at the intersection point of ray [o;b) and the circle
syntax addArcDirectOAB(o, a, b), addArcDirectOAB(o, a, b, color), addArcDirectOAB(o, a, b, color, lineStyle) or addArcDirectOAB(o, a, b, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CArcDeCercleDirect
addArcIndirectOAB(options) → {Promise.<undefined>|CArcDeCercleIndirect}
- Source:
- Mixes In:
Adds the indirect circle arc of center o starting from point a and ending at the intersection point of ray [o;b) and the circle
syntax addArcIndirectOAB(o, a, b), addArcIndirectOAB(o, a, b, color), addArcIndirectOAB(o, a, b, color, lineStyle) or addArcIndirectOAB(o, a, b, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CArcDeCercleIndirect
addArcMajorOAB(options) → {Promise.<undefined>|CGrandArcDeCercle}
- Source:
- Mixes In:
Adds the major circle arc of center o starting from point a and ending at the intersection point of ray [o;b) and the circle
syntax addArcMajorOAB(o, a, b), addArcMajorOAB(o, a, b, color), addArcMajorOAB(o, a, b, color, lineStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CGrandArcDeCercle
addArcMajorOAx(options) → {Promise.<undefined>|CGrandArcDeCercle}
- Source:
- Mixes In:
Adds the major circle arc of center o starting from point a and angle x
syntax addArcMajorOAx(o, a, x), addArcMajorOAx(o, a, x, color), addArcMajorOAx(o, a, x, color, or addArcMajorOAx(o, a, x, color, lineStyle, thickness)` allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CGrandArcDeCercle
addArcOAB(options) → {Promise.<undefined>|CArcDeCercle}
- Source:
- Mixes In:
Adds the minor circle arc of center o starting from point a and ending at the intersection point of ray [o;b) and the circle
syntax addArcOAB(o, a, b), addArcOAB(o, a, b, color), addArcOAB(o, a, b, color, lineStyle) or addArcOAB(o, a, b, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CArcDeCercle
addArcOAx(options) → {Promise.<undefined>|CArcDeCercle}
- Source:
- Mixes In:
Adds the minor circle arc of center o, starting from a and angle x
syntax addArcOAx(o, a, x), addArcOAx(o, a, x, color), addArcOAx(o, a, x, color, ineStyle) or addArcOAx(o, a, x, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed
- Type
- Promise.<undefined> | CArcDeCercle
addBrokenLine(args) → {Promise.<undefined>|CLigneBrisee}
- Source:
- Mixes In:
Adds a broken line vertexes of which are given in the array points (array of the vertexes points names)
syntax addBrokenLine(points), addBrokenLine(points, color), addBrokenLine(points, color, lineStyle) or addBrokenLine(points, color, lineStyle, thickness) is allowed where points is an array of points or name of points
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Object |
Properties
|
Returns:
the created polygon if isPromiseMode is false else promise that will be resolved when the object is displayed
- Type
- Promise.<undefined> | CLigneBrisee
addCalc(options) → {CCalcul}
- Source:
- Mixes In:
Adds a real calculation of name nameCalc from formula contained in string formula
syntax addCalc(nameCalc, formula) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalcul
addCalcComp(options) → {CCalculComplexe}
- Source:
- Mixes In:
Adds a complex calculation of name nameCalc from formula contained in string formula
syntax addCalcComp(nameCalc, formula) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalculComplexe
addCalcMat(options) → {CCalcul}
- Source:
- Mixes In:
Adds a matricial calculation of name nameCalc from formula contained in string formula
syntax addCalcMat(nameCalc, formula) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalcul
addCallBackToSVGListener(idDoc, eventName, callBack) → {boolean}
- Source:
- Inherited From:
Ajoute un listener sur le doc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
eventName |
string | |
callBack |
function |
Returns:
- Type
- boolean
addCircleIm(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
adds the image of circle (or circle arc) c by transformation transf
syntax addCircleIm(c, transf), addCircleIm(c, transf, name), addCircleIm(c, transf, name, color), addCircleIm(c, transf, name, color, lineStyle) or addCircleIm(c, transf, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addCircleOA(options) → {Promise.<undefined>|CCercleOA}
- Source:
- Mixes In:
Adds the circle of center o and going through a
syntax addCircleOA(o, a), addCircleOA(o, a, color), addCircleOA(o, a, color, lineStyle) or addCircleOA(o, a, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created circle if isPromiseMode is false or promise that will be resolved when the circle is displayed
- Type
- Promise.<undefined> | CCercleOA
addCircleOr(options) → {Promise.<undefined>|CCercleOR}
- Source:
- Mixes In:
Adds the circle of center o and radius r
The figure must have a unity length
syntax addCircleOr(o, r), addCircleOr(o, r, color), addCircleOr(o, r, color, lineStyle) or addCircleOr(o, r, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created circle if isPromiseMode is false or promise that will be resolved when the circle is displayed
- Type
- Promise.<undefined> | CCercleOR
addDerivative(options) → {CCalcul}
- Source:
- Mixes In:
Adds the derivative function of function calc (function name or function)
syntax addDerivative(calc, nameCalc) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalcul
addDilation(options) → {CHomothetie}
- Source:
- Mixes In:
adds the dilation of center o and ratio x
syntax addDilation(o, x) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CHomothetie
addDoc(idDoc, chdoc, displayOnLoadopt, isActiveopt) → {void}
- Source:
- Inherited From:
Ajoute le document par son id représenté par une chaîne chdoc en dataBase64
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
idDoc |
string | L'id du comument ui sera celle du svg contenant la figure. |
||
chdoc |
string | Chaine base64 décrivant la figure (obtenue via MathGraph32 par le menu Edition - Copier le code de la figure (pour html) |
||
displayOnLoad |
boolean |
<optional> |
true
|
true si la figure doit être affichée dès le démarrage de la page. |
isActive |
boolean |
<optional> |
true
|
true si la figure répond dès le démarrage aux actions souris et clavier. |
Returns:
- Type
- void
addDuplicatedObject(options) → {Promise.<undefined>|CObjetDuplique}
- Source:
- Mixes In:
Adds the duplicated object of object elt
syntax addDuplicatedObject(elt) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created object if isPromiseMode is false else promise that will be resolved when the duplicated object is displayed
- Type
- Promise.<undefined> | CObjetDuplique
addEltListener(options)
- Source:
- Mixes In:
Adds an event listener to a graphical object of the figure
The callBack function accepts three parameters (event, x, y) where x and y are the coordinates of the event relative to the svg containing the figure
syntax addEltListener(elt, eventName, callBack) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
addEventListener(idDoc, ind, eventName, callBack) → {boolean}
- Source:
- Inherited From:
Associe un eventListener au svg Element représentant l'objet d'indice html ind dans la figure d'id idDoc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id de la figure |
ind |
string | number | N° d'identification html de l'élément (entier) ou chaîne de caractères commençant par # et suivie du tag de l'élément |
eventName |
string | Le nom de l'événement (par exemple mousemove) |
callBack |
function | La fonction de callBack de paramètre l'événement appelant |
Returns:
: true si tout s'est bien passé, false sinon
- Type
- boolean
addFreePoint(options) → {Promise.<undefined>|CPointBase}
- Source:
- Mixes In:
Add a free point
Syntax addFreePoint(x, y), addFreePoint(x, y, name), addFreePoint(x, y, name, color), addFreePoint(x, y, name, color, pointStyle) or addFreePoint(x, y, name, color, pointStyle, rep) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false else promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointBase
addFunc(options) → {CCalcul}
- Source:
- Mixes In:
Adds a real fonction of variable x named nameCalc from formula contained in string formula
syntax addFunc(nameCalc, formula) or addFunc(nameCalc, formula, varName) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalcul
addFuncComp(options) → {CCalcul}
- Source:
- Mixes In:
Adds a real fonction of variable z named nameCalc from formula contained in string formula
syntax addFuncComp(nameCalc, formula) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CCalcul
addFunctionToQueue(f)
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
f |
function |
addImplicitMult(idDoc, formula) → {string}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id du comument à traiter |
formula |
string | La formule à traiter |
Returns:
- Type
- string
addImPointDilation(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds an image point of a through a dilation of center o and ratio x
syntax addImPointDilation(a, o, x), addImPointDilation(a, o, x, name), addImPointDilation(a, o, x, name, color), addImPointDilation(a, o, x, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addImPointRotation(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds the image point of a through a rotation of center o and angle x
syntax addImPointRotation(a, o, x), addImPointRotation(a, o, x, name), addImPointRotation(a, o, x, name, color) or addImPointRotation(a, o, x, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addImPointSymAx(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds an image point of a through an axial symmetry of axis d
syntax addImPointSymAx(a, d), addImPointSymAx(a, d, name), addImPointSymAx(a, d, name, color) or addImPointSymAx(a, d, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addImPointSymCent(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds an image point of a through the central symmetry of center o
syntax addImPointSymCent(a, o), addImPointSymCent(a, o, name), addImPointSymCent(a, o, name, color) or addImPointSymCent(a, o, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addImPointTranslation(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds an image point of o through a translation of vector ab
syntax addImPointTranslation(o, a, b), addImPointTranslation(o, a, b, name), addImPointTranslation(o, a, b, name, color) or addImPointTranslation(o, a, b, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addImPointTranslationxy(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
Adds an image point of a through a translation of vector with coordinates (x, y)
syntax addImPointTranslation(a, x, y), addImPointTranslation(a, x, y, name), addImPointTranslation(a, x, y, name, color) or addImPointTranslation(a, x, y, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addIntCircleCircle(options) → {Promise.<undefined>|Array.<CPointLieBipoint, CPointLieBipoint>}
- Source:
- Mixes In:
Adds the intersection between two circles without re-creating an intersection point already created
syntax addIntCircleCircle(c, c2), addIntCircleCircle(c, c2, name), addIntCircleCircle(c, c2, name, name2), addIntCircleCircle(c, c2, name, name2, color) or addIntCircleCircle(c, c2, name, name2, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
[point1, point2] where point1 and point2 are the intersection points if isPromiseMode is false or promise that will be resolved when the intersection points are displayed. If one of the intersection point exists, point1 is the new created point
- Type
- Promise.<undefined> | Array.<CPointLieBipoint, CPointLieBipoint>
addIntLineCircle(options) → {Promise.<undefined>|Array.<CPointLieBipoint, CPointLieBipoint>}
- Source:
- Mixes In:
Adds the intersection between a line and a circle without re-creating an intersection point already created
syntax addIntLineCircle(d, c), addIntLineCircle(d, c, name), addIntLineCircle(d, c, name, name2), addIntLineCircle(d, c, name, name2, color) or addIntLineCircle(d, c, name, name2, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
[point1, point2] where point1 and point2 are the intersection points if isPromiseMode is false or promise that will be resolved when the intersection points are displayed. If one of the intersection point exists, point1 is the new created point
- Type
- Promise.<undefined> | Array.<CPointLieBipoint, CPointLieBipoint>
addIntLineLine(options) → {Promise.<undefined>|CIntDroiteDroite}
- Source:
- Mixes In:
Adds the intersection of 2 lines
syntax addIntLineLine(d, d2), addIntLineLine(d, d2, name), addIntLineLine(d, d2, name, color) or addIntLineLine(d, d2, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the intersection point is displayed
- Type
- Promise.<undefined> | CIntDroiteDroite
addLatex(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Adds a LaTeX diplay located at [x,y]
syntax addLatex(latex, x, y) or addLatex(latex, x, y, color) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
Promise that will be resolved when the LaTeX is displayed
- Type
- Promise.<undefined>
addLengthMeasure(options) → {CLongueur}
- Source:
- Mixes In:
Adds the measure of length measure ab (distance between two points a and b)
For this, the figure must have a unity length
syntax addLengthMeasure(a, b) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CLongueur
addLineAB(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
Adds the line going through points a and b
syntax addLineAB(a, b), addLineAB(a, b, name), addLineAB(a, b, name, color), addLineAB(a, b, name, color, lineStyle) or addLineAB(a, b, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addLineAx(options) → {Promise.<undefined>|CDroiteOm}
- Source:
- Mixes In:
Adds the line going through points a and with line slope x
syntax addLineAx(a, x), addLineAx(a, x, name), addLineAx(a, x, name, color), addLineAx(a, x, name, color, lineStyle) or addLineAx(a, x, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteOm
addLineBisAOB(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
Adds the bisector line of angle a o b
syntax addLineBisAOB(a, o, b), addLineBisAOB(a, o, b, name), addLineBisAOB(a, o, b, name, color), addLineBisAOB(a, o, b, name, color, lineStyle) or addLineBisAOB(a, o, b, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addLineIm(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
adds the image of line d by transformation transf
syntax addLineIm(d, transf), addLineIm(d, transf, name), addLineIm(d, transf, name, color), addLineIm(d, transf, name, color, lineStyle) or addLineIm(d, transf, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addLineMedAB(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
Adds the mediator line of segment [a, b]
syntax addLineMedAB(a, b), addLineMedAB(a, b, name), addLineMedAB(a, b, name, color), addLineMedAB(a, b, name, color, lineStyle) or addLineMedAB(a, b, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addLinePar(options) → {Promise.<undefined>|CDroiteParallele}
- Source:
- Mixes In:
Adds the parallel line to d going through a
syntax addLinePar(a, d), addLinePar(a, d, name), addLinePar(a, d, name, color), addLinePar(a, d, name, color, lineStyle) and addLinePar(a, d, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or promise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteParallele
addLinePerp(options) → {Promise.<undefined>|CDroitePerpendiculaire}
- Source:
- Mixes In:
Adds the line perpendicular to d going through a
syntax addLinePerp(a, d), addLinePerp(a, d, name), addLinePerp(a, d, name, color), addLinePerp(a, d, name, color, lineStyle), addLinePerp(a, d, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or promise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroitePerpendiculaire
addLinkedLatex(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Adds a LaTeX display linked to a point a
syntax addLinkedLatex(latex, a) or addLinkedLatex(latex, a, color) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
Promise that will be resolved when the LaTeX is displayed
- Type
- Promise.<undefined>
addLinkedPointCircle(options) → {Promise.<undefined>|CPointLieCercle}
- Source:
- Mixes In:
Adds a point linked to a circle (or a circle arc)
syntax addLinkedPointCircle(c, x, y), addLinkedPointCircle(c, x, y, name), addLinkedPointCircle(c, x, y, name, color), addLinkedPointCircle(c, x, y, name, color, pointStyle) or addLinkedPointCircle(c, x, y, name, color, pointStyle, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointLieCercle
addLinkedPointLine(options) → {Promise.<undefined>|CPointLieCercle}
- Source:
- Mixes In:
Adds a point linked to a line (or ray or segment)
syntax addLinkedPointLine(d, x, y), addLinkedPointLine(d, x, y, name), addLinkedPointLine(d, x, y, name, color), addLinkedPointLine(d, x, y, name, color, pointStyle) or addLinkedPointLine(d, x, y, name, color, pointStyle, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointLieCercle
addLinkedPointLocus(options) → {Promise.<undefined>|CPointLieCercle}
- Source:
- Mixes In:
Adds a point linked to a line (or ray or segment)
syntax addLinkedPointLocus(elt, x, y), addLinkedPointLocus(elt, x, y, name), addLinkedPointLocus(elt, x, y, name, color) , addLinkedPointLocus(elt, x, y, name, color, pointStyle) or addLinkedPointLocus(elt, x, y, name, color, pointStyle, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointLieCercle
addLinkedText(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Adds a text display linked to a point a
syntax addLinkedText(text, a) or addLinkedText(text, a, color) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
Promise that will be resolved when the text is displayed
- Type
- Promise.<undefined>
addMatrix(options) → {CMatrice}
- Source:
- Mixes In:
adds a real matrix of name calc
syntax addMatrix(nameCalc, mat) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CMatrice
addMidpoint(options) → {Promise.<undefined>|CMilieu}
- Source:
- Mixes In:
Adds the midpoint of [a; b]
syntax addMidpoint(a, b), addMidpoint(a, b, name), addMidpoint(a, b, name, color) or addMidpoint(a, b, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CMilieu
addObjectLocus(options, options) → {Promise.<undefined>|CLieuObjetParPtLie}
- Source:
- Mixes In:
Adds the oject locus of elt generated by the positions of linked point a
syntax addObjectLocus(elt, a, x) or addObjectLocus(elt, a, x, color) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions | |||||||||||||||||||||
options |
Properties
|
Returns:
- Type
- Promise.<undefined> | CLieuObjetParPtLie
addPointIm(options) → {Promise.<undefined>|CPointImage}
- Source:
- Mixes In:
adds the image of point a by transformation transf
syntax addPointIm(a, transf), addPointIm(a, transf, name), addPointIm(a, transf, name, color) or addPointIm(a, transf, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointImage
addPointLocus(options) → {Promise.<undefined>|CLieuDePoints}
- Source:
- Mixes In:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
tag |
string |
<optional> |
Tag to be associated to the object created |
Adds the point locus of point a generated by the positions of linked point b
syntax addPointLocus(a, b, x), addPointLocus(a, b, x, color), addPointLocus(a, b, x, color, lineStyle) or addPointLocus(a, b, x, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created object locus if isPromiseMode is false else promise that will be resolved when the duplicated object is displayed
- Type
- Promise.<undefined> | CLieuDePoints
addPointXY(options) → {Promise.<undefined>|CPointDansRepere}
- Source:
- Mixes In:
Adds a point defined by (x; y) coordinates in a frame rep (system of axis). For a free point use addFreePoint and specify options.rep)
syntax addPointXY(x, y), addPointXY(x, y, name), addPointXY(x, y, name, color), addPointXY(x, y, name, color, pointStyle) or addPointXY(x, y, name, color, pointStyle, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false else promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointDansRepere
addPointZ(options) → {Promise.<undefined>|CPointParAffixe}
- Source:
- Mixes In:
Adds a point defined by its complex affix in a frame rep (system of axis).
syntax addPointZ(z), addPointZ(z, name), addPointZ(z, name, color) and addPointZ(z, name, color, pointStyle) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if mtgOptions.isPromiseMode is false else promise that will be resolved when the point is displayed
- Type
- Promise.<undefined> | CPointParAffixe
addPolygon(args) → {Promise.<undefined>|CPolygone}
- Source:
- Mixes In:
Adds a polygon vertexes of which are given in the array points (array of the vertexes points names)
syntax addPolygon(points), addPolygon(points, color), addPolygon(points, color, lineStyle) or addPolygon(points, color, lineStyle, thickness) is allowed where points is an array of points or name of points
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Object |
Properties
|
Returns:
the created polygon if isPromiseMode is false else promise that will be resolved when the object is displayed
- Type
- Promise.<undefined> | CPolygone
addRay(options) → {Promise.<undefined>|CDemiDroite}
- Source:
- Mixes In:
Adds the ray [o,a)
syntax addRay(o, a), addRay(o, a, color), addRay(o, a, color, lineStyle) or addRay(o, a, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created ray if isPromiseMode is false or promise that will be resolved when the ray is displayed
- Type
- Promise.<undefined> | CDemiDroite
addRayIm(options) → {Promise.<undefined>|CDroiteAB}
- Source:
- Mixes In:
adds the image of ray d by transformation transf
syntax addRayIm(d, transf), addRayIm(d, transf, name), addRayIm(d, transf, name, color), addRayIm(d, transf, name, color, lineStyle) or addRayIm(d, transf, name, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created line if isPromiseMode is false or romise that will be resolved when the line is displayed
- Type
- Promise.<undefined> | CDroiteAB
addRotation(options) → {CRotation}
- Source:
- Mixes In:
adds the rotation of center o and angle x
syntax addRotation(o, x) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CRotation
addSegment(options) → {Promise.<undefined>|CSegment}
- Source:
- Mixes In:
Adds the segment of extremities a et b
syntax addSegment(a, b), addSegment(a, b, color), addSegment(a, b, color, lineStyle) or addSegment(a, b, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created segment if isPromiseMode is false or promise that will be resolved when the segment is displayed
- Type
- Promise.<undefined> | CSegment
addSegmentMark(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Add a segment mark
syntax addSegmentMark(elt, color), addSegmentMark(elt, color, segmentMarkStyle) or addSegmentMark(elt, color, segmentMarkStyle, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false else promise that will be resolved when the mark is displayed
- Type
- Promise.<undefined>
addSimilitude(options) → {CSimilitude}
- Source:
- Mixes In:
adds the direct similitude of center o, angle x and ratio y
syntax addSimilitude(o, x, y) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CSimilitude
addSurface(options) → {Promise.<undefined>|CSurfacePolygone}
- Source:
- Mixes In:
Adds a surface delimited by a polygon, a circle or an arc of circle
syntax addSurface(edge), addSurface(edge, color) or addSurface(edge, color, fillStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created surface if isPromiseMode is false else promise that will be resolved when the object is displayed
- Type
- Promise.<undefined> | CSurfacePolygone
addSurfaceCircle(options) → {Promise.<undefined>|CSurfaceDisque|CSurfaceSecteurCirculaire}
- Source:
- Mixes In:
Adds a surface delimited by a circle or a circle arc (slice of pie)
syntax addSurfaceCircle(c) or addSurfaceCircle(c, color) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created surface if isPromiseMode is false else promise that will be resolved when the object is displayed
- Type
- Promise.<undefined> | CSurfaceDisque | CSurfaceSecteurCirculaire
addSurfacePoly(options) → {Promise.<undefined>|CSurfacePolygone}
- Source:
- Mixes In:
Adds a surface delimited by a polygon
syntax addSurfacePoly(poly) or addSurfacePoly(poly, color) allowed
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created surface if isPromiseMode is false else promise that will be resolved when the object is displayed
- Type
- Promise.<undefined> | CSurfacePolygone
addSvgListener(options)
- Source:
- Mixes In:
Adds a listener on the doc (svg) owning the figure
The callBack function accepts three parameters (event, x, y) where x and y are the coordinates of the event relative to the svg containing the figure
syntax addSvgListener(eventName, callBack) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
addSymAx(options) → {CSymetrieAxiale}
- Source:
- Mixes In:
adds the axial symmetry of center o
syntax addSymAx(d) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CSymetrieAxiale
addSymCent(options) → {CSymetrieCentrale}
- Source:
- Mixes In:
adds the central symmetry of center o
syntax addSymCent(o) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CSymetrieCentrale
addSystemOfAxis(options) → {Promise.<undefined>|CRepere}
- Source:
- Mixes In:
Adds a system of axis defined by points o, a and b (the origin will be o)
syntax addSystemOfAxis(o, a, b), addSystemOfAxis(o, a, b, color), addSystemOfAxis(o, a, b, color, lineStyle), addSystemOfAxis(o, a, b, color, lineStyle, verticalGrid), addSystemOfAxis(o, a, b, color, lineStyle, verticalGrid, horizontalGrid), addSystemOfAxis(o, a, b, , color, lineStyle, verticalGrid, horizontalGrid, hidden), allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created object if isPromiseMode is false else promise that will be resolved when the duplicated object is displayed
- Type
- Promise.<undefined> | CRepere
addTest(options) → {CTestExistence}
- Source:
- Mixes In:
Adds a existence test of a MathGraph32 dynamic real value x. This object will return 1 if x exists and 0 otherwise
syntax addTest(nameCalc, x) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CTestExistence
addTestComp(options) → {CTestExistence}
- Source:
- Mixes In:
Adds a existence test of a MathGraph32 dynamic real value x. This object will return 1 if x exists and 0 otherwise
syntax addTest(nameCalc, z) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CTestExistence
addText(options) → {Promise.<undefined>}
- Source:
- Mixes In:
Adds a text diplay located at [x,y]
syntax addText(text, x, y) or addText(text, x, y, color) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
Promise that will be resolved when the text is displayed
- Type
- Promise.<undefined>
addTimerButton(options)
- Source:
- Mixes In:
adds to the top right corner of the figure two zoom buttons
syntax addTimerButton(callBack, k) or addTimerButton(callBack, k, x, y) allowed where k is the increase ratio (k > 1) and callBack the used function
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
addTranslation(options) → {CTranslation}
- Source:
- Mixes In:
adds the translation of vector a b
syntax addTranslation(a, b) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CTranslation
addTranslationxy(options) → {CTranslation}
- Source:
- Mixes In:
adds the translation of vector with coordinates (x, y)
syntax addTranslation(x, y) or addTranslation(x, y, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- CTranslation
addVector(options) → {Promise.<undefined>|CVecteur}
- Source:
- Mixes In:
Adds vector ab
syntax addVector(a, b), addVector(a, b, color), addVector(a, b, color, lineStyle) or addVector(a, b, color, lineStyle, thickness) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
The created point if isPromiseMode is false or promise that will be resolved when the vector is displayed
- Type
- Promise.<undefined> | CVecteur
addXMeasure(options) → {CMesureX}
- Source:
- Mixes In:
Adds the x-coordinate measure of point a in frame rep (system of coordinates)
syntax addXMeasure(a, nameCalc) or addXMeasure(a, nameCalc, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CMesureX
addYMeasure(options) → {CMesureY}
- Source:
- Mixes In:
Adds the y-coordinate measure of point a in frame rep (system of coordinates)
syntax addYMeasure(a, nameCalc) or addYMeasure(a, nameCalc, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CMesureY
addZMeasure(options) → {CMesureAffixe}
- Source:
- Mixes In:
Adds the affix measure of point a in frame rep (system of coordinates)
syntax addZMeasure(a, nameCalc) or addZMeasure(a, nameCalc, rep) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the created measure
- Type
- CMesureAffixe
addZoomButtons(options)
- Source:
- Mixes In:
adds to the top right corner of the figure two zoom buttons
syntax addZoomButtons(k) allowed where k is the increase ratio (k > 1)
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
afficheTout(svg, doc) → {void}
- Source:
- Inherited From:
Fonction de callback appelée lorsque MathJax a traité toues les formules en LaTeX et que la figure est prête pour affichage.
Parameters:
| Name | Type | Description |
|---|---|---|
svg |
SVGElement | Le svg contenant la figure. |
doc |
CMathGraphDoc | le document à afficher. |
Returns:
- Type
- void
calculate(idDoc, brandom) → {void}
- Source:
- Inherited From:
Recalcule la figure d'identifiant idDoc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
brandom |
boolean |
Returns:
- Type
- void
calculateAndDisplayAll(brandomopt) → {Promise.<boolean>}
- Source:
- Inherited From:
Recalcule toutes les figures et les affiche
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
brandom |
boolean |
<optional> |
false
|
Passer true pour relancer les calculs aléatoires avec rand() |
Returns:
Résoud toujours avec true (les erreurs éventuelles sont en console)
- Type
- Promise.<boolean>
calculateFirstTime(idDoc, brandom)
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
brandom |
boolean |
calcVectOK(idDoc, chCalcul, tabNames) → {Object|boolean}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
chCalcul |
string | |
tabNames |
array |
Returns:
- Type
- Object | boolean
createList(code) → {CListeObjets}
- Source:
- Since:
- 4.9.7
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
code |
string | Le code Base64 de la figure obtenu dans mtg32 par Edition - Copier le code de la figure. |
Returns:
- Type
- CListeObjets
deleteAfter(options) → {Promise.<undefined>|void}
- Source:
- Mixes In:
Destroys all objets form elt, including display of the destroyed objects
syntax deleteAfter(elt) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<undefined> | void
deleteElt(options)
- Source:
- Mixes In:
Destroys the graphical object of tag elt (along with objects depending on it)
syntax deleteElt(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
deleteObj(obj)
- Source:
- Mixes In:
destroys object obj alons with its dependant objects and their graphical implementation
syntax deleteObj(obj) allowed
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
the ojject to be destroyed (an object created via MathGraph32 API) |
display(idDoc) → {Promise.<boolean>}
- Source:
- Inherited From:
Fonction affichant la figure d'identifiant idDoc après avoir retiré tous les éléments graphiques du svg de la figure.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
promesse qui sera résolue lorsque l'affichage sera terminé
- Type
- Promise.<boolean>
displayOnTop(options) → {Promise.<void>}
- Source:
- Mixes In:
Reclasses the graphic representation on elt at the top of the displayed elements
syntax displayOnTop(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<void>
executeMacro(idDoc, nameMacro) → {void}
- Source:
- Inherited From:
Fonction exécutant la macro d'intitulé nameMacro dans la figure d'id idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nameMacro |
string |
Returns:
- Type
- void
fieldsValidation(idDoc) → {boolean}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- boolean
fieldValidation(idDoc, nomCalcul) → {boolean}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | l'id du document contenant la figure interrogée. |
nomCalcul |
string | Le nom du calcul auquel est associé l'éditeur. |
Returns:
- Type
- boolean
fixPoint(options)
- Source:
- Mixes In:
Pins (fixes) point a so that this point is no longer movable with the mouse
syntax fixPoint(a) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
getBase64Code() → {string}
- Source:
- Mixes In:
Returns the Base 64 code of the current figure For the player use setApiDoc if more than one figure is used
Returns:
- Type
- string
getCalcName() → {string}
- Source:
- Mixes In:
returns the nale of calculation, measure or function calc
syntax getCalcName(nameCalc) allowed
Parameters:
| Name | Type | Description |
|---|---|---|
calc. |
Object | The object (not a string) the name is required from. |
Returns:
the name of the calculation, measure or function
- Type
- string
getDoc(idDoc) → {CMathGraphDoc|null}
- Source:
- Inherited From:
Renvoie le document d'id idDoc du tableau this.docs. S'il n'y en a pas, renvoie null.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- CMathGraphDoc | null
getDocsIds() → {Array.<string>}
- Source:
- Inherited From:
Retourne la liste des ids des documents
Returns:
- Type
- Array.<string>
getFieldValue(idDoc, nomCalcul) → {string}
- Source:
- Inherited From:
Fonction renvoyant le contenu du premier éditeur de formule asssocié au calcul nomCalcul dans le dcument d'id idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string |
Returns:
- Type
- string
getFormula(idDoc, nomCalcul, bNocaseopt) → {string}
- Source:
- Inherited From:
Renvoie la formule en ligne (avec des *) du calcul ou de la fonction nommé nomCalcul contenue dans le document d'id idDoc.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
idDoc |
string | ||
nomCalcul |
string | ||
bNocase |
boolean |
<optional> |
passer true pour ne pas tenir compte de la casse (majuscule ou minuscule) dans la recherche de nomCalcul |
Returns:
- Type
- string
getFuncImage(options) → {number}
- Source:
- Mixes In:
Returns the image of number x through function calc
syntax getFuncImage(calc, x) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the iage of x through function calc
- Type
- number
getIdDocFromEvent(evt) → {string}
- Source:
- Inherited From:
Fonction renvoyant l'id du SVG de la figure lorsqu'une evt esr renvoyé sur un element SVG de la figure ou sur le svg de la figure lui-même
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | TouchEvent |
Returns:
- Type
- string
getLatex(idDoc, startString) → {string}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
startString |
string |
Returns:
- Type
- string
getLatexCode(idDoc, ind) → {string}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
ind |
number |
Returns:
- Type
- string
getLatexFormula(idDoc, nomCalcul) → {string}
- Source:
- Inherited From:
Fonction renvoyant la formule LaTeX représentant le calcul ou la fonction dont le nom est nomCalcul dans le document d'id idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string |
Returns:
- Type
- string
getList(idDoc) → {CListeObjets}
- Source:
- Inherited From:
Renvoie la liste CListeObjets contenant les objets du document d'id idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- CListeObjets
getMatValue(mat)
- Source:
- Mixes In:
syntax getValue(x) allowed
Parameters:
| Name | Type | Description |
|---|---|---|
mat |
a MathGraph32 matrix object |
Returns:
getPointPosition(options) → {Point}
- Source:
- Overrides:
- Mixes In:
returns (sync) the coordinates of point a in the frame rep (system of coordinates) if provided, otherwise in the svg coordinate system
syntax getPointPosition(a) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Point
getSimplifiedLatexFormula(idDoc, nomCalcul) → {string}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string |
Returns:
- Type
- string
getSVGElement(idDoc, ind) → {null|SVGElement}
- Source:
- Inherited From:
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é
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
ind |
string | number | N° d'identification html de l'élément (entier) ou chaîne de caractères commençant par # et suivie du tag de l'élément |
Returns:
C:\Users\yvesb.gradle C:\Projets_JavaScript\MathGraphJS\mathgraph_js C:\Users\yvesb.WebStorm2019.2\system
- Type
- null | SVGElement
getValue(options) → {number}
- Source:
- Mixes In:
returns the value of the real value x (calculation or measure or other real value of the figure)
syntax getValue(x) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- number
giveFormula2(idDoc, nomCalcul, formule) → {void}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string | |
formule |
string |
Returns:
- Type
- void
giveFormulaTo(options) → {promise}
- Source:
- Mixes In:
give to the calculation (or function) of name nameCalc the formula formula
syntax giveFormulaTo(calc, formula) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
the promis executed once the objects dependant on the calculation are redisplayed
- Type
- promise
mousemove(evt, id, doc) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements mouseMove.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
id |
string | L'id du document sur lequel agit l'événement |
doc |
CMathGraphDoc | Le document sur lequel agit la figure |
Returns:
- Type
- void
ondeviceup(evt) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements mouseUp.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
onmousedown(evt) → {void}
- Source:
- Inherited From:
Fonction appelée lors des événements mouseDown sur la figure.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
onmousemove(evt) → {void}
- Source:
- Inherited From:
Fonction appelée lors des événements mouseMove sur la figure.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | evt.id conteint l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
ontouchcancel(evt) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements touchCancel.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
ontouchend(evt) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements touchEnd.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
ontouchmove(evt) → {void}
- Source:
- Inherited From:
Fonction appelée lors des événements touchMove sur la figure.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | evt.id conteint l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
ontouchstart(evt) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements touchStart.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | evt.id contient l'id de la figure sur laquelle agit l'événement. |
Returns:
- Type
- void
prepareTracesEtImageFond(svg, doc)
- Source:
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
svg |
SVGElement | |
doc |
CMathGraphDoc |
ready(cbopt) → {Promise|undefined}
- Source:
- Inherited From:
Appellera cb quand tous les rendus seront terminés
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
cb |
function |
<optional> |
Si non fourni, ça retourne une promesse qui sera résolue quand l'appli est prête (tous les rendus lancés terminés) |
Returns:
- Type
- Promise | undefined
recalculate(bRandomopt)
- Source:
- Mixes In:
Recalculates the figure
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
bRandom |
boolean |
<optional> |
false
|
if true random calculations are reset |
reclassAfter(options) → {Promise.<unknown>}
- Source:
- Mixes In:
Reclasses object elt after object elt2 (if the reclassement is possible)
elt must be defined before elt2
syntax reclassAfter(elt, elt2) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<unknown>
reclassBefore(options) → {Promise.<unknown>}
- Source:
- Mixes In:
Reclasses object elt before object elt2 (if the reclassement is possible)
elt must be defined after elt2
syntax reclassBefore(elt, elt2) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<unknown>
reclassMax(options) → {Promise.<unknown>}
- Source:
- Mixes In:
Reclasses object of tag elt as far as possible towards the end of the list of created objects
syntax reclassMax(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<unknown>
reclassMin(options) → {Promise.<unknown>}
- Source:
- Mixes In:
Reclasses object of tag elt as far as possible towards the beginning of the list of created objects
syntax reclassMin(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
Returns:
- Type
- Promise.<unknown>
releasePoint(options)
- Source:
- Mixes In:
Unpin a point that was pinned before (so the point can be captured with the mouse)
syntax releasePoint(a) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
removeAllDoc() → {void}
- Source:
- Inherited From:
Fonction retirant tous les documents et effaçant le contenu de tous les svg contenant des figures.
Returns:
- Type
- void
removeDoc(idDoc) → {void}
- Source:
- Inherited From:
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é
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id du document à retirer. |
Returns:
- Type
- void
removeEltListener(options)
- Source:
- Mixes In:
Removes an event listener from a graphical object of the figure
syntax removeEltListener(elt, eventName) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
removeEventListener(idDoc, ind, eventName) → {boolean}
- Source:
- Inherited From:
Fonction retirant l'eventListener associé à svg element représentant l'objet d'indice html ind dans le document d'id idDoc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id du document |
ind |
string | number | N° d'identification html de l'élément (entier) ou chaîne de caractères commençant par # et suivie du tag de l'élément |
eventName |
string | Le nom de l'événement (par exemple mousemove) |
Returns:
: true si tout s'est bien passé, false sinon
- Type
- boolean
removePointLink(options)
- Source:
- Mixes In:
Withdraw the link of linked point a (thus a become a free point)
syntax removePointLink(a) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
removeSvgListener(options)
- Source:
- Mixes In:
Removes a listener from the doc (svg) owning the figure
syntax removeSvgListener(eventName) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
rename(idDoc, oldName, newName)
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id du svg contenant la figure |
oldName |
string | Le nom du point ou la droite à renommer |
newName |
string | Le nouveau nom |
setActive(idDoc, ba) → {void}
- Source:
- Inherited From:
Rend la figure d'id idDoc réactive ou inactive aux événements souris et clavier suivant la valeur du boolean ba.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
ba |
boolean | passer true pour activer et false pour désactiver |
Returns:
- Type
- void
setApiDoc(idDocopt) → {void}
- Source:
- Mixes In:
Change the current figure (the figure the following api methods will apply on), only for the MtgAppLecteurApi
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
idDoc |
string |
<optional> |
If idDoc is not given, the first doc is taken |
Returns:
- Type
- void
setBackgroundColor(options, options)
- Source:
- Mixes In:
Assigns a background color to a text or LaTeX display
syntax setBackgroundColor(elt, backgroundColor) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
|||||||||
options |
setColor(options)
- Source:
- Overrides:
- Mixes In:
Assigns a color to an object
syntax setColor(elt, color) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setEditorCallBackOK(idDoc, nomCalcul, f) → {void}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string | |
f |
function | La fonction de callBack |
Returns:
- Type
- void
setEditorCharset(idDoc, nomCalcul, st) → {void}
- Source:
- Inherited From:
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.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string | |
st |
string |
Returns:
- Type
- void
setEditorsEmpty(idDoc) → {void}
- Source:
- Inherited From:
Fonction vidant tous les éditeurs de formule de la figure d'id idDoc
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- void
setEditorsSize(idDoc, size) → {void}
- Source:
- Inherited From:
Fonction donnant à tous les éditeur de formule de la fiure d'id idDoc la taille size. Utilisé dans j3p.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
size |
string |
Returns:
- Type
- void
setEditorValue(idDoc, nomCalcul, st) → {void}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | |
nomCalcul |
string | |
st |
string |
Returns:
- Type
- void
setFig(optionsopt) → {Promise.<void>}
- Source:
- Mixes In:
Load a new figure (empty if not provided)
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Properties
|
Returns:
Promise that will be resolved when the new figure is displayed
- Type
- Promise.<void>
setFormula4Prosca(idDoc, nomCalcul, tabNames)
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | Le nom du document contenant du calcul |
nomCalcul |
string | Le nom du calcul |
tabNames |
array | : Tableau contenant les noms des calculs complexes considérés comme des vecteurs |
setFreePointPosition(options)
- Source:
- Mixes In:
Gives to the free point named a the coordinates x, y
syntax setFreePointPosition(a, x, y) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setHidden(options)
- Source:
- Mixes In:
Set the object of tag elt masked (if not already masked)
syntax setHidden(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setLineStyle(options)
- Source:
- Overrides:
- Mixes In:
Assigns a line style to an object
syntax setLineStyle(elt, lineStyle) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setLinkPointPoint(options)
- Source:
- Mixes In:
Replaces a free point by a point linked to another existing point
syntax setLinkPointPoint(a, b) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setMarked(options)
- Source:
- Mixes In:
once executed, point a will leave a trace of its positions (if trace mode is acivated)
syntax setMarked(a) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setPointNameOffset(options)
- Source:
- Mixes In:
modify the name position of point a (the default position is under the point, the right and under the point
syntax setPointNameOffset(a, offsetX, offsetY) allowed
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setPointPosition(idDoc, name, x, y, bImmediatopt) → {boolean|Promise.<undefined>}
- Source:
- Inherited From:
Fonction déplaçant un point libre aux coordonnées (x;y) dans le svg du document d'id idDoc
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
idDoc |
string | ||
name |
string | number | Le nom du point ou # suivi du tag du point ou son indice html (entier) |
|
x |
number | Nouvelle abscisse à donner au point |
|
y |
number | Nouvelle ordonnée à donner au point |
|
bImmediat |
boolean |
<optional> |
Si true la figure est réaffichée (et cette fct retourne une promesse) |
Returns:
false en cas de pb, une promesse si bImmediat vaut true
- Type
- boolean | Promise.<undefined>
setPointStyle(options)
- Source:
- Mixes In:
gives to point a the point style point style
syntax setPointStyle(a, pointStyle) allowed
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setText(idDoc, ind, txt, bImmediatopt) → {boolean}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
idDoc |
string | |||
ind |
string | number | N° d'identification html de l'élément (entier) ou chaîne de caractères commençant par # et suivie du tag de l'élément |
||
txt |
string | |||
bImmediat |
boolean |
<optional> |
true
|
Passer false pour ne pas réafficher idDoc |
Returns:
true si tout s'est bien passé, false sinon
- Type
- boolean
setThickness(options)
- Source:
- Mixes In:
Assigns a stroke thickness to an object
syntax setThickness(elt, thickness) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setUnity(options)
- Source:
- Mixes In:
Adds a unity length to the figure (throws an error if a unity length is already present in the figure)
Once a unity length is present in the figure, you can create length measures, circles by radius
syntax setUnity(a, b) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
setVisible(options)
- Source:
- Overrides:
- Mixes In:
Set the object of tag elt visible (if not already visible)
syntax setVisible(elt) allowed
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
syntaxValidation(idDoc, calcName, formula, bSignesMultImplicitopt) → {boolean}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
idDoc |
string | ||
calcName |
string | ||
formula |
string | ||
bSignesMultImplicit |
<optional> |
true si la formule a des signes de multiplication implicite (et donc n'utilise que des variables et calculs à 1 caractère) et false sinon |
Returns:
- Type
- boolean
touchmove(evt, id, doc) → {void}
- Source:
- Inherited From:
Fonction de callBack appelée lors des événements touchMove.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | |
id |
string | L'id du document dur lequel agit l'événement |
doc |
CMathGraphDoc | Le document sur lequel agit la figure |
Returns:
- Type
- void
translate(idDoc, decx, decy, bImmediatopt) → {boolean}
- Source:
- Inherited From:
Fonction translatant tous les objets de la figure d'id idDoc d'un vecteur (decx, decy)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
idDoc |
string | L'id de la figure |
||
decx |
number | Première coordonnnée du vecteur de la translation |
||
decy |
number | Deuxième coordonnnée du vecteur de la translation |
||
bImmediat |
boolean |
<optional> |
true
|
Passer false pour ne pas lancer le réaffichage de l'objet dont on a changé la couleur (attention, c'est async, utiliser app.ready() pour savoir quand c'est fini) |
Returns:
: true si tout s'est bien passé, false sinon
- Type
- boolean
translateFig(options)
- Source:
- Mixes In:
Translates all the figure with a vector of coordinates (x; y)
syntax translateFig(x, y) allowed
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|
translatePoint(idDoc, name, deltax, deltay, bImmediatopt) → {boolean}
- Source:
- Inherited From:
Fonction translatant un point libre du vecteur de coordonnées (deltax; deltay) dans le svg du document d'id idDoc
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
idDoc |
string | ||
name |
string | number | Le nom du point ou # suivi du tag du point ou son indice html (entier) |
|
deltax |
number | Valeur à ajouter à l'abscisse du point |
|
deltay |
number | Valeur à ajouter à l'ordonnée du point |
|
bImmediat |
boolean |
<optional> |
Si true la figure est tout de suite réaffichée |
Returns:
: true si tout s'est bien passé, false sinon
- Type
- boolean
updateDependantDisplay(obj)
- Source:
- Mixes In:
Re-displays the figure elements depending on elt
syntax updateDependantDisplay(elt) allowed
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
CElementBase |
updateDisplay(idDoc) → {void}
- Source:
- Inherited From:
Fonction mettant à jour les éléments graphiques de la figure d'idDoc.
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string |
Returns:
- Type
- void
updateFigDisplay()
- Source:
- Mixes In:
Re-displays the elements of the figure.
updateFigure(idDoc) → {boolean}
- Source:
- Inherited From:
Remet à jour la figure du document idDoc après avoir modifié certains de ses objets directement (par exemple en utilisant translatePoint()
Parameters:
| Name | Type | Description |
|---|---|---|
idDoc |
string | L'id du document à réafficher |
Returns:
: true si tout s'est bien passé, false sinon
- Type
- boolean
valueOf(idDoc, nomCalcul, bNoCaseopt) → {number}
- Source:
- Inherited From:
Renvoie la valeur actuelle du calcul réel nommé nomCalcul dans le document d'id idDoc. Renvoie -1 si le calcul n'existe pas.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
idDoc |
string | |||
nomCalcul |
string | |||
bNoCase |
boolean |
<optional> |
false
|
passer true pour ne pas tenir compte de la casse (majuscule ou minuscule) dans la recherche de nomCalcul |
Returns:
- Type
- number
zoom(idDoc, x, y, ratio, bImmediatopt) → {boolean}
- Source:
- Inherited From:
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
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
idDoc |
string | L'id de la figure |
||
x |
number | abscisse du centre du zoom |
||
y |
number | ordonnée du centre du zomm |
||
ratio |
number | rapport du zoom |
||
bImmediat |
boolean |
<optional> |
true
|
Passer false pour ne pas lancer le réaffichage de l'objet dont on a changé la couleur (attention, c'est async, utiliser app.ready() pour savoir quand c'est fini) |
Returns:
true si tout s'est bien passé, false sinon
- Type
- boolean
zoomFig(options)
- Source:
- Mixes In:
Modifies the framing of the figure (by zooming from a point with a given ratio)
syntax zoom(x, y, k) allowed
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
ApiOptions |
Properties
|