@ngoctay/nodejs-pptx/lib/text-box.js

Generate PPTX files on the server-side with JavaScript.

let { ElementProperties, ShapeClass } = require('./element-properties');
const { Xml } = require('./xmlnode');

class TextBox extends ElementProperties {
    constructor() {
        super();

        this.x(10);
        this.y(10);
        this.cx(200);
        this.cy(30);

        this.textValue = '';
    }

    value(text) {
        this.textValue = text;
        return this;
    }

    bulletPoints(values) {
        this.bulletPoints = values;
        return this;
    }

    href(destinationUrl) {
        this.options.url = destinationUrl;
        return this;
    }

    applyHrefOnShapeOnly(value) {
        this.options.applyHrefOnShapeOnly = value;
        return this;
    }

    fontFace(value) {
        this.options.fontFace = value;
        return this;
    }

    fontSize(value) {
        this.options.fontSize = value;
        return this;
    }

    fontBold(value) {
        this.options.fontBold = value;
        return this;
    }

    fontItalic(value) {
        this.options.fontItalic = value;
        return this;
    }

    fontUnderline(value) {
        this.options.fontUnderline = value;
        return this;
    }

    fontSubscript(value) {
        this.options.fontSubscript = value;
        return this;
    }

    fontSuperscript(value) {
        this.options.fontSuperscript = value;
        return this;
    }

    textColor(value) {
        this.options.textColor = value;
        return this;
    }

    textWrap(value) {
        this.options.textWrap = value;
        return this;
    }

    textAlign(value) {
        this.options.textAlign = value;
        return this;
    }

    textVerticalAlign(value) {
        this.options.textVerticalAlign = value;
        return this;
    }

    line(lineOptions) {
        this.options.line = lineOptions;
        return this;
    }

    // margin value can be a plain number that applies to left, right, top, and bottom margins;
    // or an object, like: { top: 0, bottom: 0, left: 0, right: 0 }
    margin(value) {
        this.options.margin = value;
        return this;
    }

    // true/false: auto-size textbox or shape to fit text contents (too much text will make it grow and too little will shrink it)
    autoFit(value) {
        this.options.autoFit = value;
        return this;
    }

    // true/false: if the text contents are too long to fit the shape, automatically shrink the text to fit
    // note: autoFit and shrinkText are mutually exclusive - doesn't make sense for both to be true (either one is true, or both are false)
    shrinkText(value) {
        // FIXME: TODO: for some strange reason PowerPoint doens't auto-shrink/fit the text in a shape when you first open the pptx. You must click
        // on the properties of any shape, change any "fit" property (Format Shape->Text Box->Autofit), and then ALL shapes get their auto-fit
        // attributes applied. Not sure if all PowerPoint versions have this bug. Will need to investigate later...
        this.options.shrinkText = value;
        return this;
    }

    backgroundColor(value) {
        this.options.backgroundColor = value;
        return this;
    }

    // value is in degrees you want the textbox or shape rotated in the clockwise direction (if value is a positive number)
    // if value is a negative number, the code will assume you want the object rotated counter-clockwise by abs(value) number of degrees
    // (ex: -90 would == a 90 degree counter-clockwise rotation, which is the same as a 270 degree clockwise rotation)
    rotation(value) {
        if (typeof value !== 'number' || isNaN(Number(value)) || !Number.isFinite(value)) {
            return;
        }

        let finalDegreeRot = value.mod(360); // this should handle negative rotations automatically (ex: -90 MOD 360 = 270) and over-rotations (ex: 370 MOD 360 = 10)
        this.options.rotation = Math.floor(finalDegreeRot); // see my notes in the Number.mod() function for why I wrote a custom modulo operation instead of using "%"

        return this;
    }

    setContent(content) {
        this.content = content;
        super.setPropertyContent(this.content.get('p:spPr/a:xfrm'));
    }
}

class RenderedTextBox extends ElementProperties {
    constructor(content, index, namespace = "p") {
        super();
        this.content = content;
        this.index = index;
        this.namespace = namespace;
        this.properties = this.content.get(`${namespace}:spPr/a:xfrm`);
    }

    class() {
        return ShapeClass.Text;
    }

    textCount() {
        return this.content.get(`${this.namespace}:txBody`).filter((child) => child.name() === 'a:p')?.length;
    }

    text(index) {
        index = index || 0;
        return this.content.get(`${this.namespace}:txBody`).filter((child) => child.name() === 'a:p')?.[index]?.get('a:r/a:t')?.text();
    }

    setText(text, index) {
        index = index || 0;
        this.content.get(`${this.namespace}:txBody`).filter((child) => child.name() === 'a:p')?.[index]?.get('a:r/a:t')?.setText(text);
    }

    addHyperlink(rId, index) {
        index = index || 0;
        this.content.get(`${this.namespace}:txBody`).filter((child) => child.name() === 'a:p')?.[index]?.get('a:r/a:rPr')?.push(Xml.create('a:hlinkClick', null, { 'r:id': rId }));
    }
}

module.exports.TextBox = TextBox;
module.exports.RenderedTextBox = RenderedTextBox;