Class MtgAppLecteurApi

constructor

• new MtgAppLecteurApi(
      zoomOnWheel?: boolean,
      decimalDot?: boolean,
      translatable?: boolean,
      useLens?: boolean,
  ): MtgAppLecteurApi

  Parameters

  • OptionalzoomOnWheel: boolean
  • OptionaldecimalDot: boolean
  • Optionaltranslatable: boolean
  • OptionaluseLens: boolean

  Returns MtgAppLecteurApi

docs

abort

• abort(): void

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

  Returns void

activateField

• activateField(idDoc: string, nomCalcul: string): void

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

  Parameters

  • idDoc: string
  • nomCalcul: string

  Returns void

activateFirstEmptyField

• activateFirstEmptyField(idDoc: string): void

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

  Parameters

  • idDoc: string

  Returns void

activateFirstInvalidField

• activateFirstInvalidField(idDoc: string): void

  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

  • idDoc: string

  Returns void

activateFirstInvalidOrEmptyField

• activateFirstInvalidOrEmptyField(idDoc: string): void

  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

  • idDoc: string

  Returns void

activateTraceMode

• activateTraceMode(bActivate: boolean): void

  activates or deactivates trace mode on the figure syntax activates(true|false) is also allowed

  Parameters

  • bActivate: boolean

    true to activate trace mode, false to deactivate trace mode

  Returns void

addAbsMeasure

• addAbsMeasure(
      options: {
          a: string | CPt;
          b: string | CPt;
          nameCalc: string;
          o: string | CPt;
      },
  ): CMesureAbscisse

  Adds the abscissa measure of point b in (o, a) (the three points must be aligned) syntax addAbsMeasure(b, o, a, nameCalc) is also allowed

  Parameters

  • options: { a: string | CPt; b: string | CPt; nameCalc: string; o: string | CPt }

    • a: string | CPt

      extremity (abscissa of b in (O, a))

    • b: string | CPt

      point b the abscissa is wanted from

    • nameCalc: string

      Name of the created calculation (the x-coordinate measure))

    • o: string | CPt

      origin (abscissa of b in (O, a))

  Returns CMesureAbscisse

  the created measure

addActionButton

• addActionButton(
      options: {
          callBack: (...params: any[]) => any;
          tag?: string;
          text: string;
          x?: string | number | CValDyn;
          y?: string | number | CValDyn;
      },
  ): void

  adds a button on the figure launching function callBack when clicked on syntaxes addActionButton(text, callBack), addActionButton(text, callBack, x, y) and addActionButton(text, callBack, x, y, tag) are allowed too where callBack is the launched function when the button is clicked

  Parameters

  • options: {
        callBack: (...params: any[]) => any;
        tag?: string;
        text: string;
        x?: string | number | CValDyn;
        y?: string | number | CValDyn;
    }

    • callBack: (...params: any[]) => any

      function to be called when clicked on the button

    • Optionaltag?: string

      Tag to be applied on the created text display (if present) returns {CCommentaire}

    • text: string

      The text displayed by the button

    • Optionalx?: string | number | CValDyn

      x coordinate of the top button zoom in svg coordinates or 10 if absent

    • Optionaly?: string | number | CValDyn

      y coordinate of the top button zoom in svg coordinates or 50 if absent

  Returns void

addAngleMark

• addAngleMark(
      options: {
          a: string | CPt;
          angleMarkStyle?: string;
          b: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          r: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>

  Adds an angle mark syntaxes addAngleMark(o, a, b, r), addAngleMark(o, a, b, r, color), addAngleMark(o, a, b, r, color, angleMarkStyle) and addAngleMark(o, a, b, r, color, angleMarkStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        angleMarkStyle?: string;
        b: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        r: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      a point of arc oab (name or tag if name is empty)

    • OptionalangleMarkStyle?: string

      Angle mark style (simple|simple-|simple--|simple---|simplex|full|full-|full--|full---|fullx)

    • b: string | CPt

      b point of arc oab (name or tag if name is empty)

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the angle mark masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      o point of arc oab (name or tag if name is empty)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • r: number

      arc radius in pixels

    • Optionaltag?: string

      Tag to be applied on the angle mark (if present)

    • Optionalthickness?: number

      Thickness of the stroke

  Returns Promise<undefined>

addArcDirectOAB

• addArcDirectOAB(
      options: {
          a: string | CPt;
          b: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CArcDeCercleDirect

  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 syntaxes addArcDirectOAB(o, a, b), addArcDirectOAB(o, a, b, color), addArcDirectOAB(o, a, b, color, lineStyle) and addArcDirectOAB(o, a, b, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        b: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • b: string | CPt

      Point or point name of the point providing the final extremity of the arc (by intersection of a ray of origin o with the circle)

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center point of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CArcDeCercleDirect

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addArcIndirectOAB

• addArcIndirectOAB(
      options: {
          a: string | CPt;
          b: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CArcDeCercleIndirect

  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 syntaxes addArcIndirectOAB(o, a, b), addArcIndirectOAB(o, a, b, color), addArcIndirectOAB(o, a, b, color, lineStyle) and addArcIndirectOAB(o, a, b, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        b: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • b: string | CPt

      Point or point name of the point providing the final extremity of the arc (by intersection of a ray of origin o with the circle)

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center point of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CArcDeCercleIndirect

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addArcMajorOAB

• addArcMajorOAB(
      options: {
          a: string | CPt;
          b: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CGrandArcDeCercle

  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 syntaxes addArcMajorOAB(o, a, b), addArcMajorOAB(o, a, b, color), addArcMajorOAB(o, a, b, coland, lineStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        b: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • b: string | CPt

      Point or point name of the point providing the final extremity of the arc (by intersection of ray of origin o with the circle)

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center point of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CGrandArcDeCercle

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addArcMajorOAx

• addArcMajorOAx(
      options: {
          a: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
          x: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CGrandArcDeCercle

  Adds the major circle arc of center o starting from point a and angle x syntaxes addArcMajorOAx(o, a, x), addArcMajorOAx(o, a, x, color), addArcMajorOAx(o, a, x, color, and addArcMajorOAx(o, a, x, color, lineStyle, thickness)` are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
        x: string | number | CValDyn;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center point of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

    • x: string | number | CValDyn

      Angle of the arc in the unity angle of the figure (number or valid formula)

  Returns Promise<undefined> | CGrandArcDeCercle

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addArcOAB

• addArcOAB(
      options: {
          a: string | CPt;
          b: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CArcDeCercle

  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 syntaxes addArcOAB(o, a, b), addArcOAB(o, a, b, color), addArcOAB(o, a, b, color, lineStyle) and addArcOAB(o, a, b, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        b: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • b: string | CPt

      Point or point name of the point providing the final extremity of the arc (by intersection of ray of origin o with the circle)

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CArcDeCercle

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addArcOAx

• addArcOAx(
      options: {
          a: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
          x: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CArcDeCercle

  Adds the minor circle arc of center o, starting from a and angle x syntaxes addArcOAx(o, a, x), addArcOAx(o, a, x, color), addArcOAx(o, a, x, color, ineStyle) and addArcOAx(o, a, x, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
        x: string | number | CValDyn;
    }

    • a: string | CPt

      Point or point name of the starting point of the arc

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created arc masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center point of the arc

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created arc (if present)

    • Optionalthickness?: number

      Stroke thickness

    • x: string | number | CValDyn

      Angle of the arc in the unity angle of the figure (number or valid formula)

  Returns Promise<undefined> | CArcDeCercle

  The created arc if isPromiseMode is false or promise that will be resolved when the arc is displayed

addBrokenLine

• addBrokenLine(
      options: {
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          opacity?: number;
          points: string[];
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CLigneBrisee

  Adds a broken line vertexes of which are given in the array points (array of the vertexes points names) syntaxes addBrokenLine(points), addBrokenLine(points, color), addBrokenLine(points, color, lineStyle) and addBrokenLine(points, color, lineStyle, thickness) are allowed too, where points is an array of points or name of points

  Parameters

  • options: {
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        opacity?: number;
        points: string[];
        tag?: string;
        thickness?: number;
    }

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the polygon masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • points: string[]

      array of the vertexes points names of the polygon

    • Optionaltag?: string

      Tag to be applied on the created broken line (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CLigneBrisee

  the created polygon if isPromiseMode is false else promise that will be resolved when the object is displayed

addCalc

• addCalc(options: { formula: string; nameCalc: string }): CCalcul

  Adds a real calculation of name nameCalc from formula contained in string formula syntax addCalc(nameCalc, fandmula) is also allowed

  Parameters

  • options: { formula: string; nameCalc: string }

    • formula: string

      Formula of the calculation to be created

    • nameCalc: string

      Name of the real calculation to be created

  Returns CCalcul

  the created measure

addCalcComp

• addCalcComp(options: { formula: string; nameCalc: string }): CCalculComplexe

  Adds a complex calculation of name nameCalc from formula contained in string formula syntax addCalcComp(nameCalc, formula) is also allowed

  Parameters

  • options: { formula: string; nameCalc: string }

    • formula: string

      Formula of the complex calculation to be created

    • nameCalc: string

      Name of the complex calculation to be created

  Returns CCalculComplexe

  the created measure

addCalcMat

• addCalcMat(options: { formula: string; nameCalc: string }): CCalcul

  Adds a matricial calculation of name nameCalc from formula contained in string formula syntax addCalcMat(nameCalc, formula) is also allowed

  Parameters

  • options: { formula: string; nameCalc: string }

    • formula: string

      Formula of the matricial calculation to be created

    • nameCalc: string

      Name of the matricial calculation to be created

  Returns CCalcul

  the created measure

addCallBackToSVGListener

• addCallBackToSVGListener(
      idDoc: string,
      eventName: string,
      callBack: (...params: any[]) => any,
  ): boolean

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

  Parameters

  • idDoc: string
  • eventName: string
  • callBack: (...params: any[]) => any

  Returns boolean

addCircleIm

• addCircleIm(
      options: {
          c: CCercle;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          lineStyle?: string;
          opacity?: number;
          tag?: string;
          thickness?: number;
          transf: CTransformation;
      },
  ): Promise<undefined>
  | CDroiteAB

  adds the image of circle (or circle arc) c by transformation transf syntaxes addCircleIm(c, transf), addCircleIm(c, transf, name), addCircleIm(c, transf, name, color), addCircleIm(c, transf, name, color, lineStyle) and addCircleIm(c, transf, name, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        c: CCercle;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        lineStyle?: string;
        opacity?: number;
        tag?: string;
        thickness?: number;
        transf: CTransformation;
    }

    • c: CCercle

      the circle (or circle arc) that is to be transformed

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created line masked

    • OptionalhiddenName?: boolean

      true to get the created line name masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created line (if present)

    • Optionalthickness?: number

      Stroke thickness

    • transf: CTransformation

      the transformation to aplly on line d

  Returns Promise<undefined> | CDroiteAB

  The created line if isPromiseMode is false or promise that will be resolved when the line is displayed

addCircleOA

• addCircleOA(
      options: {
          a: string | CPt;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CCercleOA

  Adds the circle of center o and going through a syntaxes addCircleOA(o, a), addCircleOA(o, a, color), addCircleOA(o, a, color, lineStyle) and addCircleOA(o, a, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        tag?: string;
        thickness?: number;
    }

    • a: string | CPt

      Point or point name of the point the circle is going through

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the created circle masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Point or point name of the center

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionaltag?: string

      Tag to be applied on the created circle (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CCercleOA

  The created circle if isPromiseMode is false or promise that will be resolved when the circle is displayed

addCircleOr

• addCircleOr(
      options: {
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          o: string | CPt;
          opacity?: number;
          r: string | number;
          tag?: string;
          thickness?: number;
      },
  ): Promise<undefined>
  | CCercleOR

  Adds the circle of center o and radius r The figure must have a unity length syntaxes addCircleOr(o, r), addCircleOr(o, r, color), addCircleOr(o, r, color, lineStyle) and addCircleOr(o, r, color, lineStyle, thickness) are allowed too

  Parameters

  • options: {
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        o: string | CPt;
        opacity?: number;
        r: string | number;
        tag?: string;
        thickness?: number;
    }

    • Optionalcolor?: string

      Color, blck by default

    • Optionalhidden?: boolean

      true to get the created circle masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • o: string | CPt

      Name (or tag if name is empty) of the center

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • r: string | number

      Radius of the circle or string giving a valid formula for the radius

    • Optionaltag?: string

      Tag to be applied on the created circle (if present)

    • Optionalthickness?: number

      Stroke thickness

  Returns Promise<undefined> | CCercleOR

  The created circle if isPromiseMode is false or promise that will be resolved when the circle is displayed

addCurve

• addCurve(
      options: {
          calc: CFonc;
          closed?: boolean;
          color?: string;
          hidden?: boolean;
          lineStyle?: string;
          opacity?: number;
          thickness?: number;
          x: number;
      },
  ): void

  Adds the curve of a function in the system of axis frame syntaxes addCurve(calc, x), addCurve(calc, x, color), addCurve(calc, x, color, lineStyle), addCurve(calc, x, color, lineStyle, thickness) and addCurve(calc, x, color, lineStyle, thickness, rep) are allowed too

  Parameters

  • options: {
        calc: CFonc;
        closed?: boolean;
        color?: string;
        hidden?: boolean;
        lineStyle?: string;
        opacity?: number;
        thickness?: number;
        x: number;
    }

    • calc: CFonc

      name of the function of function curve is to be created of

    • Optionalclosed?: boolean

      true to set the point locus closed

    • Optionalcolor?: string

      Color, black by default

    • Optionalhidden?: boolean

      true to get the point locus masked

    • OptionallineStyle?: string

      Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • Optionalthickness?: number

      Thickness of the stroke

    • x: number

      number of points used to create the curve (point locus)

  Returns void

addDerivative

• addDerivative(options: { calc: string; nameCalc: string }): CCalcul

  Adds the derivative function of function calc (function name or function) syntax addDerivative(calc, nameCalc) is also allowed

  Parameters

  • options: { calc: string; nameCalc: string }

    • calc: string

      Name of the function to be derivated

    • nameCalc: string

      Name of the derivative function to be created

  Returns CCalcul

  the created measure

addDilation

• addDilation(
      options: { o: string | CPt; x: string | number | CValDyn },
  ): CHomothetie

  adds the dilation of center o and ratio x syntax addDilation(o, x) is also allowed

  Parameters

  • options: { o: string | CPt; x: string | number | CValDyn }

    • o: string | CPt

      center of the dilation

    • x: string | number | CValDyn

      the ratio of the dilation (number, object or string containing a valid formula)

  Returns CHomothetie

addDoc

• addDoc(
      idDoc: string,
      chdoc: string,
      displayOnLoad?: boolean,
      isActive?: boolean,
  ): void

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

  Parameters

  • idDoc: string

    L'id du document qui 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)

  • OptionaldisplayOnLoad: boolean

    true si la figure doit être affichée dès le démarrage de la page.

  • OptionalisActive: boolean

    true si la figure répond dès le démarrage aux actions souris et clavier.

  Returns void

addDuplicatedObject

• addDuplicatedObject(
      options: { elt: string; hidden?: boolean },
  ): Promise<undefined> | CObjetDuplique

  Adds the duplicated object of object elt syntax addDuplicatedObject(elt) is also allowed

  Parameters

  • options: { elt: string; hidden?: boolean }

    • elt: string

      Tag of the object to be duplicated

    • Optionalhidden?: boolean

      true to get the duplicated object masked

  Returns Promise<undefined> | CObjetDuplique

  the created object if isPromiseMode is false else promise that will be resolved when the duplicated object is displayed

addEltListener

• addEltListener(
      options: { callBack: EventSvgCallback; elt: string; eventName: string },
  ): void

  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) is also allowed

  Parameters

  • options: { callBack: EventSvgCallback; elt: string; eventName: string }

    • callBack: EventSvgCallback

      function to be launched when the event is triggered.

    • elt: string

      Tag of the graphical object the listener is to be added on

    • eventName: string

      Name of the event to be listened to

  Returns void

addEventListener

• addEventListener(
      idDoc: string,
      ind: string | number,
      eventName: string,
      callBack: (...params: any[]) => any,
  ): boolean

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

  Parameters

  • 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: (...params: any[]) => any

    La fonction de callBack de paramètre l'événement appelant

  Returns boolean

  : true si tout s'est bien passé, false sinon

addFreePoint

• addFreePoint(
      options: {
          absCoord?: boolean;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          rep?: string;
          tag?: string;
          x: string | number | CValDyn;
          y: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CPointBase

  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

  • options: {
        absCoord?: boolean;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        rep?: string;
        tag?: string;
        x: string | number | CValDyn;
        y: string | number | CValDyn;
    }

    • OptionalabsCoord?: boolean

      set to true if x,y should be considered absolute in the svg (in that case rep is ignored), useless if there is no frame (in that case x,y will be considered absolute regardless of this property)

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the point masked

    • OptionalhiddenName?: boolean

      true to get the name point masked

    • Optionalname?: string

      Name of the point (if present)

    • OptionaloffsetX?: number

      x-shift of the name

    • OptionaloffsetY?: number

      y-shift of the name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionalrep?: string

      tag of the frame (system of coordinates), mandatory only if the figure contains several frames

    • Optionaltag?: string

      Tag to be applied on the point (if present)

    • x: string | number | CValDyn

      starting x-coordinate when the point is created

    • y: string | number | CValDyn

      starting y-coordinate when the point is created

  Returns Promise<undefined> | CPointBase

  The created point if isPromiseMode is false else promise that will be resolved when the point is displayed

addFunc

• addFunc(
      options: { formula: string; nameCalc: string; varName: string },
  ): CCalcul

  Adds a real fonction of variable x named nameCalc from formula contained in string formula syntaxes addFunc(nameCalc, formula) or addFunc(nameCalc, formula, varName) are allowed too

  Parameters

  • options: { formula: string; nameCalc: string; varName: string }

    • formula: string

      Formula of the function to be created (with x as variable)

    • nameCalc: string

      Name of the function to be created

    • varName: string

      Formal variable name used in the formula of the function. 'x' by default.

  Returns CCalcul

  the created measure

addFuncComp

• addFuncComp(
      options: { formula: string; nameCalc: string; varName: string },
  ): CCalcul

  Adds a real fonction of variable z named nameCalc from formula contained in string formula syntaxes addFuncComp(nameCalc, fandmula) are allowed too

  Parameters

  • options: { formula: string; nameCalc: string; varName: string }

    • formula: string

      Formula of the calculation to be created (with z as variable)

    • nameCalc: string

      Name of the complex function to be created

    • varName: string

      Formal variable name used in the formula of the function. 'z' by default.

  Returns CCalcul

  the created measure

addFunctionToQueue

• addFunctionToQueue(f: (...params: any[]) => any): void

  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

  • f: (...params: any[]) => any

  Returns void

addImplicitMult

• addImplicitMult(idDoc: string, formula: string): string

  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

  • idDoc: string

    L'id du comument à traiter

  • formula: string

    La formule à traiter

  Returns string

addImPointDilation

• addImPointDilation(
      options: {
          a: string | CPt;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          o: string | CPt;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          tag?: string;
          x: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CPointImage

  Adds an image point of a through a dilation of center o and ratio x syntaxes addImPointDilation(a, o, x), addImPointDilation(a, o, x, name), addImPointDilation(a, o, x, name, color), addImPointDilation(a, o, x, name, coland, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        o: string | CPt;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        tag?: string;
        x: string | number | CValDyn;
    }

    • a: string | CPt

      point that is to be transformed by the dilation (or point name)

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created

    • o: string | CPt

      center point of the dilation (or point name)

    • OptionaloffsetX?: number

      x-shift of the name

    • OptionaloffsetY?: number

      y-shift of the name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

    • x: string | number | CValDyn

      Ratio of the dilation : number or vaid formula

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addImPointRotation

• addImPointRotation(
      options: {
          a: string | CPt;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          o: string | CPt;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          tag?: string;
          x: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CPointImage

  Adds the image point of a through a rotation of center o and angle x syntaxes addImPointRotation(a, o, x), addImPointRotation(a, o, x, name), addImPointRotation(a, o, x, name, color) and addImPointRotation(a, o, x, name, color, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        o: string | CPt;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        tag?: string;
        x: string | number | CValDyn;
    }

    • a: string | CPt

      point that is to be transformed by the rotation

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created

    • o: string | CPt

      The rotation center (or point name)

    • OptionaloffsetX?: number

      x-shift of the name

    • OptionaloffsetY?: number

      y-shift of the name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

    • x: string | number | CValDyn

      Angle of rotation : number or valid formula

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addImPointSymAx

• addImPointSymAx(
      options: {
          a: string | CPt;
          color?: string;
          d: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          tag?: string;
      },
  ): Promise<undefined>
  | CPointImage

  Adds an image point of a through an axial symmetry of axis d syntaxes addImPointSymAx(a, d), addImPointSymAx(a, d, name), addImPointSymAx(a, d, name, color) and addImPointSymAx(a, d, name, color, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        d: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        tag?: string;
    }

    • a: string | CPt

      point that is to be transformed by the symmetry (or point name)

    • Optionalcolor?: string

      Color, black by default

    • d: string

      The symmetry axis (line, segment or ray)

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created

    • OptionaloffsetX?: number

      x-shift of the name

    • OptionaloffsetY?: number

      y-shift of the name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addImPointSymCent

• addImPointSymCent(
      options: {
          a: string | CPt;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          o: string | CPt;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          tag?: string;
      },
  ): Promise<undefined>
  | CPointImage

  Adds an image point of a through the central symmetry of center o syntaxes addImPointSymCent(a, o), addImPointSymCent(a, o, name), addImPointSymCent(a, o, name, color) and addImPointSymCent(a, o, name, color, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        o: string | CPt;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        tag?: string;
    }

    • a: string | CPt

      point that is to be transformed by the dilation (or point name)

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created

    • o: string | CPt

      center of the symmetry (or point name)

    • OptionaloffsetX?: number

      x-shift of the name

    • OptionaloffsetY?: number

      y-shift of the name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addImPointTranslation

• addImPointTranslation(
      options: {
          a: string | CPt;
          b: string | CPt;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          o: string | CPt;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          tag?: string;
      },
  ): Promise<undefined>
  | CPointImage

  Adds an image point of o through a translation of vector ab syntaxes addImPointTranslation(o, a, b), addImPointTranslation(o, a, b, name), addImPointTranslation(o, a, b, name, color) and addImPointTranslation(o, a, b, name, color, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        b: string | CPt;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        o: string | CPt;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        tag?: string;
    }

    • a: string | CPt

      Point (or point name) origin of the translation vector

    • b: string | CPt

      Point (or point name) extremity of the translation vector

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created (image point)

    • o: string | CPt

      Point (or point name) that is to be transformed by the translation

    • OptionaloffsetX?: number

      x-shift of the point name

    • OptionaloffsetY?: number

      y-shift of the point name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addImPointTranslationxy

• addImPointTranslationxy(
      options: {
          a: string | CPt;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          offsetX?: number;
          offsetY?: number;
          opacity?: number;
          pointStyle?: string;
          rep?: string;
          tag?: string;
          x: string | number | CValDyn;
          y: string | number | CValDyn;
      },
  ): Promise<undefined>
  | CPointImage

  Adds an image point of a through a translation of vector with coordinates (x, y) syntaxes addImPointTranslation(a, x, y), addImPointTranslation(a, x, y, name), addImPointTranslation(a, x, y, name, color) and addImPointTranslation(a, x, y, name, color, pointStyle) are allowed too

  Parameters

  • options: {
        a: string | CPt;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        offsetX?: number;
        offsetY?: number;
        opacity?: number;
        pointStyle?: string;
        rep?: string;
        tag?: string;
        x: string | number | CValDyn;
        y: string | number | CValDyn;
    }

    • a: string | CPt

      Point (or point name) that is to be transformed by the translation

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Font size of the name

    • Optionalhidden?: boolean

      true to get the created point masked

    • OptionalhiddenName?: boolean

      true to get the created point name masked

    • Optionalname?: string

      The name of the point to be created (image point)

    • OptionaloffsetX?: number

      x-shift of the point name

    • OptionaloffsetY?: number

      y-shift of the point name

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (o|O|OO|x|X|+|<>|[]|.) or (littleround|round|biground|mult|bigmult|cross|diamond|square|pixel|)

    • Optionalrep?: string

      tag of the frame (system of coordinates), mandatory only if the figure contains several frames

    • Optionaltag?: string

      Tag to be applied on the created point (if present)

    • x: string | number | CValDyn

      the first coordinate of the translation vector

    • y: string | number | CValDyn

      the second coordinate of the translation vector

  Returns Promise<undefined> | CPointImage

  The created point if isPromiseMode is false or promise that will be resolved when the point is displayed

addIntCircleCircle

• addIntCircleCircle(
      options: {
          c: string;
          c2: string;
          color?: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          name2?: string;
          opacity?: number;
          pointStyle?: string;
          smartIntersect?: boolean;
      },
  ): Promise<undefined>
  | CPointLieBipoint[]

  Adds the intersection between two circles without re-creating an intersection point already created syntaxes addIntCircleCircle(c, c2), addIntCircleCircle(c, c2, name), addIntCircleCircle(c, c2, name, name2), addIntCircleCircle(c, c2, name, name2, color) and addIntCircleCircle(c, c2, name, name2, color, pointStyle) are allowed too

  Parameters

  • options: {
        c: string;
        c2: string;
        color?: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        name2?: string;
        opacity?: number;
        pointStyle?: string;
        smartIntersect?: boolean;
    }

    • c: string

      Tag of the first intersection circle (or circle arc)

    • c2: string

      Tag of the second intersection circle (or circle arc)

    • Optionalcolor?: string

      Color, black by default

    • OptionalfontSize?: number

      Size of the font used for the created intersection points

    • Optionalhidden?: boolean

      true to get the intersection points masked

    • OptionalhiddenName?: boolean

      true to get the intersection points name hidden

    • Optionalname?: string

      Name of the first intersection point created

    • Optionalname2?: string

      Name of the second intersection point created (if not already present in the figure)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (square|round|cross|mult|littleround|diamond|pixel|biground|bigmult)

    • OptionalsmartIntersect?: boolean

      Set to false to re-create points seen as already existing in circle intersection (with circle or line)

  Returns Promise<undefined> | CPointLieBipoint[]

  [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

addIntLineCircle

• addIntLineCircle(
      options: {
          c: string;
          color?: string;
          d: string;
          fontSize?: number;
          hidden?: boolean;
          hiddenName?: boolean;
          name?: string;
          name2?: string;
          opacity?: number;
          pointStyle?: string;
          smartIntersect?: boolean;
      },
  ): Promise<undefined>
  | CPointLieBipoint[]

  Adds the intersection between a line and a circle without re-creating an intersection point already created syntaxes addIntLineCircle(d, c), addIntLineCircle(d, c, name), addIntLineCircle(d, c, name, name2), addIntLineCircle(d, c, name, name2, color) and addIntLineCircle(d, c, name, name2, color, pointStyle) are allowed too

  Parameters

  • options: {
        c: string;
        color?: string;
        d: string;
        fontSize?: number;
        hidden?: boolean;
        hiddenName?: boolean;
        name?: string;
        name2?: string;
        opacity?: number;
        pointStyle?: string;
        smartIntersect?: boolean;
    }

    • c: string

      Tag of the intersection circle (or circle arc)

    • Optionalcolor?: string

      Color, black by default

    • d: string

      Tag of the first intersection line (or ray or segment)

    • OptionalfontSize?: number

      Size of the font used for the created intersection points

    • Optionalhidden?: boolean

      true to get the intersection points masked

    • OptionalhiddenName?: boolean

      true to get the intersection points name hidden

    • Optionalname?: string

      Name of the first intersection point created

    • Optionalname2?: string

      Name of the second intersection point created (if not already present in the figure)

    • Optionalopacity?: number

      opacity (0 to 1), 1 by default

    • OptionalpointStyle?: string

      Point style (square|round|cross|mult|littleround|diamond|pixel|biground|bigmult)

    • OptionalsmartIntersect?: boolean

      Set to false to re-create points seen as already existing in circle intersection (with circle or line)

  Returns Promise<undefined> | CPointLieBipoint[]

  [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