excel4node/source/lib/style/classes/font.js

Library to create Formatted Excel Files.

const xmlbuilder = require('xmlbuilder');
const types = require('../../types/index.js');

class Font {
    /**
     * @class Font
     * @desc Instance of Font with properties
     * @param {Object} opts Options for Font
     * @param {String} opts.color HEX color of font
     * @param {String} opts.name Name of Font. i.e. Calibri
     * @param {String} opts.scheme Font Scheme. defaults to major
     * @param {Number} opts.size Pt size of Font
     * @param {String} opts.family Font Family. defaults to roman
     * @param {String} opts.vertAlign Specifies font as subscript or superscript
     * @param {Number} opts.charset Character set of font as defined in §18.4.1 charset (Character Set) or standard
     * @param {Boolean} opts.condense Macintosh compatibility settings to squeeze text together when rendering
     * @param {Boolean} opts.extend Stretches out the text when rendering
     * @param {Boolean} opts.bold States whether font should be bold
     * @param {Boolean} opts.italics States whether font should be in italics
     * @param {Boolean} opts.outline States whether font should be outlined
     * @param {Boolean} opts.shadow States whether font should have a shadow
     * @param {Boolean} opts.strike States whether font should have a strikethrough
     * @param {Boolean} opts.underline States whether font should be underlined
     * @retuns {Font}
     */
    constructor(opts) {
        opts = opts ? opts : {};

        typeof opts.color === 'string' ? this.color = types.excelColor.getColor(opts.color) : null;
        typeof opts.name === 'string' ? this.name = opts.name : null;
        typeof opts.scheme === 'string' ? this.scheme = opts.scheme : null;
        typeof opts.size === 'number' ? this.size = opts.size : null;
        typeof opts.family === 'string' && types.fontFamily.validate(opts.family) === true ? this.family = opts.family : null;

        typeof opts.vertAlign === 'string' ? this.vertAlign = opts.vertAlign : null;
        typeof opts.charset === 'number' ? this.charset = opts.charset : null;

        typeof opts.condense === 'boolean' ? this.condense = opts.condense : null;
        typeof opts.extend === 'boolean' ? this.extend = opts.extend : null;
        typeof opts.bold === 'boolean' ? this.bold = opts.bold : null;
        typeof opts.italics === 'boolean' ? this.italics = opts.italics : null;
        typeof opts.outline === 'boolean' ? this.outline = opts.outline : null;
        typeof opts.shadow === 'boolean' ? this.shadow = opts.shadow : null;
        typeof opts.strike === 'boolean' ? this.strike = opts.strike : null;
        typeof opts.underline === 'boolean' ? this.underline = opts.underline : null;
    }

    /** 
     * @func Font.toObject
     * @desc Converts the Font instance to a javascript object
     * @returns {Object}
     */
    toObject() {
        let obj = {};

        typeof this.charset === 'number' ? obj.charset = this.charset : null;
        typeof this.color === 'string' ? obj.color = this.color : null;
        typeof this.family === 'string' ? obj.family = this.family : null;
        typeof this.name === 'string' ? obj.name = this.name : null;
        typeof this.scheme === 'string' ? obj.scheme = this.scheme : null;
        typeof this.size === 'number' ? obj.size = this.size : null;
        typeof this.vertAlign === 'string' ? obj.vertAlign = this.vertAlign : null;

        typeof this.condense === 'boolean' ? obj.condense = this.condense : null;
        typeof this.extend === 'boolean' ? obj.extend = this.extend : null;
        typeof this.bold === 'boolean' ? obj.bold = this.bold : null;
        typeof this.italics === 'boolean' ? obj.italics = this.italics : null;
        typeof this.outline === 'boolean' ? obj.outline = this.outline : null;
        typeof this.shadow === 'boolean' ? obj.shadow = this.shadow : null;
        typeof this.strike === 'boolean' ? obj.strike = this.strike : null;
        typeof this.underline === 'boolean' ? obj.underline = this.underline : null;

        return obj;
    }

    /**
     * @alias Font.addToXMLele
     * @desc When generating Workbook output, attaches style to the styles xml file
     * @func Font.addToXMLele
     * @param {xmlbuilder.Element} ele Element object of the xmlbuilder module
     */
    addToXMLele(fontXML) {
        let fEle = fontXML.ele('font');

        // Place styling elements first to avoid validation errors with .NET validator
        this.condense === true ? fEle.ele('condense') : null;
        this.extend === true ? fEle.ele('extend') : null;
        this.bold === true ? fEle.ele('b') : null;
        this.italics === true ? fEle.ele('i') : null;
        this.outline === true ? fEle.ele('outline') : null;
        this.shadow === true ? fEle.ele('shadow') : null;
        this.strike === true ? fEle.ele('strike') : null;
        this.underline === true ? fEle.ele('u') : null;
        this.vertAlign === true ? fEle.ele('vertAlign') : null;

        fEle.ele('sz').att('val', this.size !== undefined ? this.size : 12);
        fEle.ele('color').att('rgb', this.color !== undefined ? this.color : 'FF000000');
        fEle.ele('name').att('val', this.name !== undefined ? this.name : 'Calibri');
        if (this.family !== undefined) {
            fEle.ele('family').att('val', types.fontFamily[this.family.toLowerCase()]);
        }
        if (this.scheme !== undefined) {
            fEle.ele('scheme').att('val', this.scheme);
        }


        return true;
    }


}

module.exports = Font;