JavaScript API: getCell

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

getCell

PREMIUM

TRIAL / ADVANCED

Gets information from a cell.

Note

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

Description

getCell (position: string): CellInformation | null

interface CellInformation {
    func?: string;
    sharedString?: string;
    styleIndex?: string;
    type?: string;
    value?: string;
}

Code samples

Example #1

import { CreateXlsx, OptionsCellContents } from "build";

const xlsx = new CreateXlsx();

// add sample contents
let content: OptionsCellContents = {
    text: "Lorem ipsum dolor sit amet",
};
xlsx.addCell(content, "A1");

content = {
    text: 100,
};
xlsx.addCell(content, "B1");
content = {
    text: 10.5,
};
xlsx.addCell(content, "B2");
xlsx.addFunction("=SUM(B1:B2)", "B3");

content = {
    text: 10.5,
};
xlsx.addCell(content, "C1");

// get cell information
console.log(xlsx.getCell("A1"));

// return empty because the position doesn't exist in the sheet
console.log(xlsx.getCell("A2"));

// get cell information
console.log(xlsx.getCell("B1"));

// get cell information
console.log(xlsx.getCell("B3"));

// get cell information
console.log(xlsx.getCell("C1"));

Release notes

phpxlsx 5.0:
- new method.