Giter Site home page Giter Site logo

xuri / excelize-wasm Goto Github PK

View Code? Open in Web Editor NEW
163.0 8.0 29.0 369 KB

A WebAssembly build of the Go Excelize library for reading and writing Microsoft Excel™ (XLAM / XLSM / XLSX / XLTM / XLTX) spreadsheets

Home Page: https://xuri.me/excelize

License: BSD 3-Clause "New" or "Revised" License

JavaScript 7.85% Go 92.15%
ecma-376 excel excelize formula go golang javascript js microsoft npm

excelize-wasm's Introduction

excelize-wasm

excelize-wasm logo

NPM version Build Status Code Coverage Go Report Card go.dev Licenses Donate

Excelize-wasm is a pure WebAssembly / Javascript port of Go Excelize library that allow you to write to and read from XLAM / XLSM / XLSX / XLTM / XLTX files. Supports reading and writing spreadsheet documents generated by Microsoft Excel™ 2007 and later. Supports complex components by high compatibility. The full API docs can be found at docs reference.

Environment Compatibility

Browser Version
Chrome ≥57
Chrome for Android and Android Browser ≥105
Edge ≥16
Safari on macOS and iOS ≥11
Firefox ≥52
Firefox for Android ≥104
Opera ≥44
Opera Mobile ≥64
Samsung Internet ≥7.2
UC Browser for Android ≥13.4
QQ Browser ≥10.4
Node.js ≥12.0.0
Deno ≥1.0

Basic Usage

Installation

Node.js

npm install --save excelize-wasm

Browser

<script src="excelize-wasm/index.js"></script>

Create spreadsheet

Here is a minimal example usage that will create spreadsheet file.

const { init } = require('excelize-wasm');
const fs = require('fs');

init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize) => {
  const f = excelize.NewFile();
  if (f.error) {
    console.log(f.error);
    return;
  }
  // Create a new sheet.
  const { index } = f.NewSheet('Sheet2');
  // Set value of a cell.
  f.SetCellValue('Sheet2', 'A2', 'Hello world.');
  f.SetCellValue('Sheet1', 'B2', 100);
  // Set active sheet of the workbook.
  f.SetActiveSheet(index);
  // Save spreadsheet by the given path.
  const { buffer, error } = f.WriteToBuffer();
  if (error) {
    console.log(error);
    return;
  }
  fs.writeFile('Book1.xlsx', buffer, 'binary', (error) => {
    if (error) {
      console.log(error);
    }
  });
});

Create spreadsheet in browser:

View code
<html>
<head>
  <meta charset="utf-8">
  <script src="https://<your_hostname>/excelize-wasm/index.js"></script>
</head>
<body>
  <div>
    <button onclick="download()">Download</button>
  </div>
  <script>
  function download() {
    excelizeWASM
      .init('https://<your_hostname>/excelize-wasm/excelize.wasm.gz')
      .then((excelize) => {
        const f = excelize.NewFile();
        if (f.error) {
          console.log(f.error);
          return;
        }
        // Create a new sheet.
        const { index } = f.NewSheet('Sheet2');
        // Set value of a cell.
        f.SetCellValue('Sheet2', 'A2', 'Hello world.');
        f.SetCellValue('Sheet1', 'B2', 100);
        // Set active sheet of the workbook.
        f.SetActiveSheet(index);
        // Save spreadsheet by the given path.
        const { buffer, error } = f.WriteToBuffer();
        if (error) {
          console.log(error);
          return;
        }
        const link = document.createElement('a');
        link.download = 'Book1.xlsx';
        link.href = URL.createObjectURL(
          new Blob([buffer], {
            type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
          })
        );
        link.click();
      });
  }
  </script>
</body>

Reading spreadsheet

The following constitutes the bare to read a spreadsheet document.

const { init } = require('excelize-wasm');
const fs = require('fs');

init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize) => {
  const f = excelize.OpenReader(fs.readFileSync('Book1.xlsx'));
  if (f.error) {
    console.log(f.error);
    return;
  }
  // Set value of a cell.
  const ret1 = f.GetCellValue('Sheet1', 'B2');
  if (ret1.error) {
    console.log(ret1.error);
    return;
  }
  console.log(ret1.value);
  // Get all the rows in the Sheet1.
  const ret2 = f.GetRows('Sheet1');
  if (ret2.error) {
    console.log(ret2.error);
    return;
  }
  ret2.result.forEach((row) => {
    row.forEach((colCell) => {
      process.stdout.write(`${colCell}\t`);
    });
    console.log();
  });
});

Add chart to spreadsheet file

With excelize-wasm chart generation and management is as easy as a few lines of code. You can build charts based on data in your worksheet or generate charts without any data in your worksheet at all.

Create chart by excelize-wasm

const { init } = require('excelize-wasm');
const fs = require('fs');

init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize) => {
  const f = excelize.NewFile();
  if (f.error) {
    console.log(f.error);
    return;
  }
  [
    [null, 'Apple', 'Orange', 'Pear'],
    ['Small', 2, 3, 3],
    ['Normal', 5, 2, 4],
    ['Large', 6, 7, 8],
  ].forEach((row, idx) => {
    const ret1 = excelize.CoordinatesToCellName(1, idx + 1);
    if (ret1.error) {
      console.log(ret1.error);
      return;
    }
    const res2 = f.SetSheetRow('Sheet1', ret1.cell, row);
    if (res2.error) {
      console.log(res2.error);
      return;
    }
  });
  const ret3 = f.AddChart('Sheet1', 'E1', {
    Type: excelize.Col3DClustered,
    Series: [
      {
        Name: 'Sheet1!$A$2',
        Categories: 'Sheet1!$B$1:$D$1',
        Values: 'Sheet1!$B$2:$D$2',
      },
      {
        Name: 'Sheet1!$A$3',
        Categories: 'Sheet1!$B$1:$D$1',
        Values: 'Sheet1!$B$3:$D$3',
      },
      {
        Name: 'Sheet1!$A$4',
        Categories: 'Sheet1!$B$1:$D$1',
        Values: 'Sheet1!$B$4:$D$4',
      },
    ],
    Title: [{
      Text: 'Fruit 3D Clustered Column Chart',
    }],
  });
  if (ret3.error) {
    console.log(ret3.error);
    return;
  }
  // Save spreadsheet by the given path.
  const { buffer, error } = f.WriteToBuffer();
  if (error) {
    console.log(error);
    return;
  }
  fs.writeFile('Book1.xlsx', buffer, 'binary', (error) => {
    if (error) {
      console.log(error);
    }
  });
});

Add picture to spreadsheet file

const { init } = require('excelize-wasm');
const fs = require('fs');

init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize) => {
  const f = excelize.OpenReader(fs.readFileSync('Book1.xlsx'));
  if (f.error) {
    console.log(f.error);
    return;
  }
  // Insert a picture.
  const ret1 = f.AddPictureFromBytes('Sheet1', 'A2', {
    Extension: '.png',
    File: fs.readFileSync('image.png'),
    Format: { AltText: 'Picture 1' },
  });
  if (ret1.error) {
    console.log(ret1.error);
    return;
  }
  // Insert a picture to worksheet with scaling.
  const ret2 = f.AddPictureFromBytes('Sheet1', 'D2', {
    Extension: '.jpg',
    File: fs.readFileSync('image.jpg'),
    Format: { AltText: 'Picture 2', ScaleX: 0.5, ScaleY: 0.5 },
  });
  if (ret2.error) {
    console.log(ret2.error);
    return;
  }
  // Insert a picture offset in the cell with printing support.
  const ret3 = f.AddPictureFromBytes('Sheet1', 'H2', {
    Extension: '.gif',
    File: fs.readFileSync('image.gif'),
    Format: {
      AltText: 'Picture 3',
      OffsetX: 15,
      OffsetY: 10,
      PrintObject: true,
      LockAspectRatio: false,
      Locked: false,
    },
  });
  if (ret3.error) {
    console.log(ret3.error);
    return;
  }
  // Save spreadsheet by the given path.
  const { buffer, error } = f.WriteToBuffer();
  if (error) {
    console.log(error);
    return;
  }
  fs.writeFile('Book1.xlsx', buffer, 'binary', (error) => {
    if (error) {
      console.log(error);
    }
  });
});

Contributing

Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.

Licenses

This program is under the terms of the BSD 3-Clause License. See https://opensource.org/licenses/BSD-3-Clause.

The Excel logo is a trademark of Microsoft Corporation. This artwork is an adaptation.

gopher.{ai,svg,png} was created by Takuya Ueda. Licensed under the Creative Commons 3.0 Attributions license.

excelize-wasm's People

Contributors

cnmlgbgithub avatar covv avatar fsfsx avatar lidp20 avatar peng avatar spearmootz avatar taomin597715379 avatar tianaiyouqing avatar tvso avatar xuri avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

excelize-wasm's Issues

Argument type Buffer is not assignable to parameter type Uint8Array[]

const { readFile } = require('fs/promises')

excelize.OpenReader(await readFile('./file.xlsx'))

Why is the first parameter of OpenReader() Uint8Array[] instead of Uint8Array ?

Argument type Buffer is not assignable to parameter type Uint8Array[]

/**
* OpenReader read data stream from buffer and return a populated spreadsheet
* file.
* @param r The contents buffer of the file
* @param opts The options for open and reading spreadsheet
*/
export function OpenReader(r: Uint8Array[], opts?: Options): NewFile;

Does not run on Node 20+

Description

excelize-wasm 0.0.4 does not run on Node 20 or later due to following code trying to patch global.crypto if window is undefined:

if (typeof window === 'undefined') {
global.crypto = {
async getRandomValues(b) {
const { randomFillSync } = await import('crypto');
randomFillSync(b);
}
};
global.performance = {
now() {
const [sec, nsec] = process.hrtime();
return sec * 1000 + nsec / 1000000;
}
};
}
:

require('excelize-wasm'); throws to the following error:

TypeError: Cannot set property crypto of #<Object> which has only a getter
    at Module.<anonymous> (…/node_modules/excelize-wasm/main.cjs:1:46588)

because global.crypto is now a getter without a setter.

Node already has crypto.getRandomValues and performance.now available by default, so this patching is not even needed, i.e. should be skipped if these properties already exist.

Output of node -v: v20.11.1

Excelize version or commit ID: v0.0.4

how to read excel in browser?

Description

Steps to reproduce the issue:
how to read excel in browser?

Describe the results you received:

Describe the results you expected:

Output of node -v:

Output of npm -v:

Output of go version:

(paste your output here)

Excelize version or commit ID:

(paste here)

Environment details (OS, Microsoft Excel™ version, Browser version, physical, etc.):

Document / implement a formalized release process

Description

This is a tooling feature request. I think it would be a nice addition to use tooling to aid in the package publishing and release process.

In the past, I have used release-it which makes bumping version number, publishing on npm, creating github release, and git tagging the release a really pleasant and simple process.

All of the other feature request template is N/A in this case

memory running out

hello,

i am running node with 4GB of memory.

when i create an excel containing around 64k records with 58 columns of uuids i run out of memory.

i tried to play with the importObject and added mem, and memory into various keys but it didnt work :( otherwise i would be making a PR

exports: {
    mem: new WebAssembly.Memory({ initial: 100, maximum: 62500, shared: true }),
    memory: new WebAssembly.Memory({
      initial: 100,
      maximum: 62500,
      shared: true,
    }),
  },
  env: {
    memory: new WebAssembly.Memory({
      initial: 100,
      maximum: 62500,
      shared: true,
    }),
    mem: new WebAssembly.Memory({ initial: 100, maximum: 62500, shared: true }),
  },
  js: {
    mem: new WebAssembly.Memory({ initial: 100, maximum: 62500, shared: true }),
    memory: new WebAssembly.Memory({
      initial: 100,
      maximum: 62500,
      shared: true,
    }),
  },
  go: {
    memory: new WebAssembly.Memory({
      initial: 100,
      maximum: 62500,
      shared: true,
    }),
    mem: new WebAssembly.Memory({ initial: 100, maximum: 62500, shared: true }),

[Feature request] Provide options for data validation drop list

Description

I am trying to replicate the official dependent drop list example with excelize-wasm but I can't provide items for the drop list.

In the type definition of DataValidation it can be seen that there's no place for list options -- none of the types are arrays.

According to the documentation, the correct way of providing options in Go is .SetSqrefDropList method but I cannot find its counterpart in JavaScript.

Is it not implemented yet or have I missed something?

Steps to reproduce the issue:

  1. N/A

Describe the results you received: There is no way to provide drop list options.

Describe the results you expected: There is a way to provide drop list options.

Output of node -v: v20.1.0

Output of npm -v: 9.6.4

Output of go version: go version go1.20.4 darwin/amd64

Excelize version or commit ID: [email protected]

Environment details (OS, Microsoft Excel™ version, Browser version, physical, etc.):

OS: macOS 13.3.1 (22E261)
Excel version: 16.73 (23050701)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.