sesaparcours
    Preparing search index...
    • Adds a text diplay located at [x,y] syntaxes addText(text, x, y) and addText(text, x, y, color) are allowed too

      Parameters

      • options: {
            absCoord?: boolean;
            backgroundColor?: string;
            border?: string;
            color?: string;
            fontSize?: number;
            hAlign?: string;
            hidden?: boolean;
            offsetX?: number;
            offsetY?: number;
            opacity?: number;
            opaque?: boolean;
            rep?: string;
            tag?: string;
            text: string;
            textAlign?: string;
            vAlign?: string;
            x: number;
            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)

        • OptionalbackgroundColor?: string

          Background color, white by default

        • Optionalborder?: string

          The border style (none|simple|3D)

        • Optionalcolor?: string

          Color, black by default

        • OptionalfontSize?: number

          Size of the font used for the display (in pixels)

        • OptionalhAlign?: string

          Horizontal alignment left|center|right to the linked point (if any)

        • Optionalhidden?: boolean

          true to get the created text display masked

        • OptionaloffsetX?: number

          x-shift oof the text display

        • OptionaloffsetY?: number

          y-shift oof the text display

        • Optionalopacity?: number

          opacity (0 to 1), 1 by default

        • Optionalopaque?: boolean

          true if the text or LaTeX displays erases its background. If true the color used to erase the background is the backgroundColor if present, else the background color of the figure

        • 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 text display (if present)

        • text: string

          The text to be displayed

        • OptionaltextAlign?: string

          Horizontal alignment of the text (if it contains several lines)

        • OptionalvAlign?: string

          Vertical alignement top|middle|bottom to the linked point (if any)

        • x: number

          x-coordinate of the location the text is to be displayed at

        • y: string | number | CValDyn

          y-coordinate of the location the text is to be displayed at

      Returns Promise<undefined>

      Promise that will be resolved when the text is displayed