JavaScript API: addBreak

CONTENTS

addBreak
addCell
addFunction
addImage
addLink
addSheet
getCell
removeCell
setCellValue

LAYOUTS

getActiveSheet
getCellPositions
setActiveSheet
setRtl

SETTINGS

addProperties
setColumnSettings
setRowSettings
setSheetSettings
setWorkbookSettings

TEMPLATES

getTemplateVariables
openTemplate
removeVariableImage
removeVariableText
replaceVariableImage
replaceVariableText
setTemplateSymbols

OTHERS

convertMeasuringUnit
save

addBreak

PREMIUM

TRIAL / ADVANCED

Adds break.

Note

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

Description

addBreak (position: number, type: "col" | "row" = "row"): this

Code samples

Example #1

import { CreateXlsx, OptionsCellContents } from "build";
import * as fs from "fs";

const xlsx = new CreateXlsx();

let content: OptionsCellContents = {
    text: "First content.",
};
xlsx.addCell(content, "A1");

content = {
    text: "Next content.",
};
xlsx.addCell(content, "A5");

content = {
    text: "Other content.",
};
xlsx.addCell(content, "F10");

xlsx.addBreak(2, "row");

xlsx.addBreak(4, "row");

xlsx.addBreak(5, "col");

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.