docs.sheetjs.com/docz/docs/07-csf/index.md

1.6 KiB

pagination_next hide_table_of_contents title
api/index true Common Spreadsheet Format

import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

The "Common Spreadsheet Format" is the object model used by SheetJS. The library includes a number of API functions for common operations, but some features are only accessible by inspecting and modifying the objects directly.

This section covers the JS representation of workbooks, worksheets, cells, ranges, addresses and other features.

:::info Historical Context

Web Workers, a popular API for parallelism in the web browser, uses message passing. The "structured clone algorithm"1 is used to pass data between the main renderer thread and Worker instances.

The structured clone algorithm does not preserve functions or prototypes.

In the SheetJS data model, each structure is a simple object. There are no classes or prototype methods.

:::

Contents

    {useCurrentSidebarCategory().items.map(globalThis.lambda = (item, index) => { const listyle = (item.customProps?.icon) ? { listStyleImage: `url("${item.customProps.icon}")` } : {}; return (
  • {item.label}{item.customProps?.summary && (" - " + item.customProps.summary)}
      {item.items && item.items.map(lambda)}
  • ); })}

  1. See the HTML Living Standard for more details on the "structured clone algorithm". ↩︎