JavaScript API: createTableStyle

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

createTableStyle

PREMIUM

TRIAL / ADVANCED

Creates table style.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to createTableStyle.

Description

createTableStyle (name: string, styles: OptionsTblPr): this

interface OptionsTblStylePr {
    /** Background color: HEX value  */
    backgroundColor?: string;
    /** Border */
    border?: {
        bottom?: Border;
        insideH?: Border;
        insideV?: Border;
        left?: Border;
        right?: Border;
        top?: Border;
    };
    /** Paragraph styles applied to string cell contents */
    pprStyles?: OptionsParagraph;
    /** Character styles applied to string cell contents */
    rprStyles?: OptionsRpr;
    /** Vertical alignment */
    verticalAlign?: "both" | "bottom" | "center" | "top";
}

interface OptionsTblPr {
    /** Based on style. Default as TableNormal */
    basedOn?: string;
    /** Border */
    border?: {
        bottom?: Border;
        insideH?: Border;
        insideV?: Border;
        left?: Border;
        right?: Border;
        top?: Border;
    };
    /** Cell background color: HEX value  */
    cellBackgroundColor?: string;
    /** Cell margins: twips value */
    cellMargin?: {
        top?: number;
        right?: number;
        bottom?: number;
        left?: number;
    };
    /** Cell vertical alignment */
    cellVerticalAlign?: "both" | "bottom" | "center" | "top";
    /** Column banded style */
    colBandSize?: boolean;
    /** Contional formatting  */
    conditionalFormatting?: {
        /** First column. Default as true */
        firstColumn?: boolean;
        /** First row.  Default as true */
        firstRow?: boolean;
        /** Last column.  Default as false */
        lastColumn?: boolean;
        /** Last row.  Default as false */
        lastRow?: boolean;
        /** Horizontal banding. Default as false */
        noHBand?: boolean;
        /** Vertical banding.  Default as true */
        noVBand?: boolean;
    };
    /** Indentation: twips value */
    indentation?: number;
    /** Paragraph style to be automatically applied to the next paragraph with the current style applied */
    next?: string;
    /** Paragraph styles applied to string cell contents */
    pprStyles?: OptionsParagraph;
    /** Row banded style */
    rowBandSize?: boolean;
    /** Character styles applied to string cell contents */
    rprStyles?: OptionsRpr;
    /** tblStylePr styles */
    tblPrStyles?: {
        band1Horz?: OptionsTblStylePr;
        band1Vert?: OptionsTblStylePr;
        band2Horz?: OptionsTblStylePr;
        band2Vert?: OptionsTblStylePr;
        firstCol?: OptionsTblStylePr;
        firstRow?: OptionsTblStylePr;
        lastCol?: OptionsTblStylePr;
        lastRow?: OptionsTblStylePr;
        neCell?: OptionsTblStylePr;
        nwCell?: OptionsTblStylePr;
        seCell?: OptionsTblStylePr;
        swCell?: OptionsTblStylePr;
    };
}

Code samples

Example #1

import { CreateDocx, OptionsTable, OptionsTblPr } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// create a custom table style
const tableStyle: OptionsTblPr = {
    border: {
        top: {
            color: "00FF00",
            width: 24,
        },
        right: {
            color: "0000FF",
        },
        bottom: {
            color: "00FF00",
            width: 24,
        },
        left: {
            color: "0000FF",
        },
        insideH: {
            color: "FF0000",
        },
        insideV: {
            color: "FF0000",
            style: "dashed",
        },
    },
    cellMargin: {
        top: 400,
        left: 150,
    },
};
docx.createTableStyle("myTableStyle", tableStyle);

// add a table content with the new custom table style
const items = [
    ["11", "12", "13", "14"],
    ["21", "22", "23", "24"],
    ["31", "32", "33", "34"],
];
const optionsTable: OptionsTable = {
    tblStyle: "myTableStyle",
};

docx.addTable(items, [], optionsTable);

docx.save().then(contents => {
    fs.writeFileSync("createTableStyle_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 16.0:
- new method.