SheetJS的通用电子表格对象简介和使用

news2024/12/29 11:03:44

简言

“通用电子表格格式”(CSF)是SheetJS使用的对象模型。
例如使用xlsx插件时,获得的excel文件数据对象就是依据这个模型设计的。
SheetJs通用电子表格对象

在这里插入图片描述

介绍

cdn导入:

  <script lang="javascript" src="https://cdn.sheetjs.com/xlsx-0.19.2/package/dist/xlsx.full.min.js"></script>

对象模型

首先我们整体的看一下这个通用电子表格对象模型。
在这里插入图片描述

  • workbook(工作簿对象):工作簿对象就是转换读取到的文件对象。里面包含了文件对象的相关属性和存储的工作表数据信息。
  • sheets(工作表对象):工作表是普通的JavaScript对象。每个不以!开头的键是A1样式的地址,其对应值为单元格对象。(A1样式表示的是列是字母顺序、行是数字顺序的二维表格)
  • cell(单元格对象):在工作表中,以A1样式开头的属性为单元格对象,里面用一系列定义好的属性保存相关数据信息。
  • 地址和范围: 地址表示单元格对象在工作表中的位置;范围表示工作表中的合并信息。

地址和范围(Addresses and Ranges)

地址

单元地址对象存储为{c:C, r:R},其中C和R分别是0索引的列号(col)和行号(row),js索引默认从0开始。例如,单元地址B5由对象{c:1, r:4}表示,A1由{c:0,r:0}表示。

范围

单元格范围对象存储为{s:S, e:E},其中S是范围中的第一个单元格,E是范围中的最后一个单元格。范围包括在内,闭区间。例如,范围A3:B7由对象{s:{c:0, r:2}, e:{c:1, r:6}}表示。

列范围(跨越每行)由起始行0和结束行1048575表示:

{ s: { c: 0, r: 0 }, e: { c: 0, r: 1048575 } } // A:A
{ s: { c: 1, r: 0 }, e: { c: 2, r: 1048575 } } // B:C

行范围(跨越每列)由起始列0和结束列16383表示:

{ s: { c: 0, r: 0 }, e: { c: 16383, r: 0 } } // 1:1
{ s: { c: 0, r: 1 }, e: { c: 16383, r: 2 } } // 2:3

相关接口

XLSX.utils对象提供了一些关于单元格地址和范围的函数:

  • encode_row / decode_row在0索引行和1索引行之间转换。
  • encode_col / decode_col在0索引列和列名之间转换。
  • encode_cell / decode_cell转换单元格地址。
  • encode_range / decode_range转换单元格范围。
    示例:
    // 在0索引行和1索引行之间转换
    let row_index = XLSX.utils.decode_row("4");
    let row_name = XLSX.utils.encode_row(3);
    console.log(row_index, row_name);
    //  列转换
    let col_index = XLSX.utils.decode_col("D");
    let col_name = XLSX.utils.encode_col(3);
    console.log(col_index, col_name);
    //  单元格地址转换
    let b2_addr = XLSX.utils.encode_cell({ c: 1, r: 1 })
    let b2_obj = XLSX.utils.decode_cell("B2")
    console.log(b2_addr, b2_obj);

    //  单元格范围转换
    let a1_range = XLSX.utils.encode_range({ s: { c: 0, r: 0 }, e: { c: 3, r: 2 } });
    let a1_obj = XLSX.utils.decode_range("A1:E5")
    console.log(a1_range, a1_obj);

如果要自定义数据,在处理单元格合并信息时可能会用到。

单元格对象(Cell Object)

单元格对象是普通的js对象,以以下格式定义:

属性描述
v单元格的值(数字、字符串、日期对象、布尔值)
t值类型:(b:布尔值、s:字符串、n:数字、d:日期、e:错误、z:存根)
数字相关
z与单元格关联的数字格式字符串
w数字格式化文本
公式相关
f编码为A1样式字符串的单元格公式(如果适用)
F如果公式是数组公式,则封闭数组的范围(如果适用)
D如果为true,则数组公式是动态的(如果适用)
其他单元格属性
l单元格超链接和工具提示
c单元格注释
r富文本编码(如适用)
h富文本的HTML呈现(如果适用)
s单元格的样式/主题(如果适用)

工作表对象(Sheet Objects)

工作表是普通的JavaScript对象。每个不以!开头的键是A1样式的地址,其对应值为单元格对象。

工作表中的数据信息

一般情况下,sheet[address]返回指定地址的单元格对象。
在解析文件时,如果选项有dense: true,将会使用dense-mode模式显示数据,数据格式为sheet[“! data”][R][C] , 其中单元格存储在数组的数组中。表![R][C]返回第R行和第C列的单元格对象(零索引值)。
官网给了一个标准的打印工作表数据代码,我贴在下面:

 const { decode_range, encode_cell } = XLSX.utils;

    function log_all_cells(ws) {
      let range = decode_range(ws["!ref"]);
      let dense = ws["!data"] != null; // test if sheet is dense
      for (let R = 0; R <= range.e.r; ++R) {
        for (let C = 0; C <= range.e.c; ++C) {
          let cell = dense ? ws["!data"]?.[R]?.[C] : ws[encode_cell({ r: R, c: C })];
          console.log(R, C, cell);
        }
      }
    }

log_all_cells(ws)的参数是工作表对象,获取对象时需要先从工作簿对象中获取工作表名,然后对象属性动态调用获取工作表对象。

工作表中的其他属性

每个键都以!开头。属性可作为sheet[key]访问。

  • sheet[‘!ref’]:基于A-1的范围,表示工作表范围。处理工作表的函数应使用此参数来确定范围。不处理分配在范围之外的单元格。特别是,当用手书写纸张时,不包括范围外的单元格
    处理表单的函数应测试是否存在!ref字段。如果!ref被省略或不是有效范围,函数可以自由将工作表视为空或尝试猜测范围。此库附带的标准实用程序将工作表视为空(例如,CSV输出为空字符串)。
    当读取设置了sheetRows属性的工作表时,ref参数将使用受限范围。原始范围设置为ws[‘!fullref’]

  • sheet[‘!margins’]:表示页边距的对象。默认值遵循Excel的“常规”预设。Excel也有“宽”和“窄”预设,但它们存储为原始测量值。

  • ws[‘!cols’]:列属性对象的数组。列宽实际上以规范化的方式存储在文件中,根据“最大数字宽度”(渲染数字的最大宽度0-9,以像素为单位)进行测量。解析时,列对象在wpx字段中存储像素宽度,在wch字段中存储字符宽度,在MDW字段中存储最大数字宽度。

  • ws[‘!rows’]:行属性对象的数组,如文档稍后所述。每个行对象编码属性,包括行高和可见性。

  • ws[‘!merges’]:与工作表中的合并单元格相对应的范围对象数组。纯文本格式不支持合并单元格。CSV导出将写入合并区域中的所有单元格(如果存在),因此请确保仅设置该区域中的第一个单元格(左上角)。

  • ws[‘!outline’]:配置轮廓的行为方式。选项默认为Excel 2019中的默认设置。

  • ws[‘!protect’]:写入工作表保护属性的对象。password键指定支持密码保护工作表(XLSX/XLSB/XLS)的格式的密码。

  • ws[‘!autofilter’]:模式后的自动筛选对象。

  • ws[‘!type’]:表示工作表类型,“chart”为图表工作表,“macro”为宏工作表,“dialog”对话框工作表。

相关接口

在XLSX.utils对象下面:

  • aoa_to_sheet将JS数据数组转换为工作表。
  • json_to_sheet将JS对象数组转换为工作表。
  • table_to_sheet将DOM表元素转换为工作表。
  • sheet_add_aoa将JS数据数组添加到现有工作表中。
  • sheet_add_json将JS对象数组添加到现有工作表中。
  • sheet_add_dom将DOM表元素中的数据添加到现有工作表中
  • sheet_to_json将工作表对象转换为JSON对象数组。
  • sheet_to_csv生成分隔符分隔的值输出。
  • sheet_to_txt生成UTF16格式的文本。
  • sheet_to_html生成HTML输出。
  • sheet_to_formulae生成公式列表(具有值回退)。

工作表的方法比较多,那是因为工作表是文件的主体。如果想自定义工作表或处理工作表信息请到官网浏览详情。

工作簿对象(Workbook Object)

工作簿是对excel文件的对象描述。其中一些属性描述如下:

  • workbook.SheetNames : 工作簿中工作表的有序列表,存储了工作表名。
  • wb.Sheets[sheetname] : 返回工作表对象。
  • wb.Props:是存储标准特性的对象。
  • wb.Custprops:存储自定义特性。
  • wb.Workbook: 存储工作簿级属性。

相关接口

  • book_new创建空工作簿
  • book_append_sheet将工作表添加到工作簿

除此之外,解析文件函数中,读取文件函数返回的是工作簿对象,导出文件函数的第一个参数是工作簿对象。例如:
XLSX.read(data, read_opts)尝试解析data,返回workbook、
XLSX.writeXLSX(wb, write_opts)尝试以XLSX格式编写工作簿。

示例:

// 创建工作簿
    const wb = new XLSX.utils.book_new()
    //  json数据转成工作表对象
    let ws = XLSX.utils.json_to_sheet([
      { A: "S1", B: "h1", C: "e1", D: "e1", E: "t1", F: "J1", G: "S1" },
      { A: "S2", B: "h2", C: "e2", D: "e2", E: "t2", F: "J2", G: "S2" }

    ], { header: ["A", "B", "C", "D", "E", "F", "G"], skipHeader: true });
    //  更新对应地址的值,不存在添加,存在替换
    XLSX.utils.sheet_add_json(ws, [
      { A: 1, B: 2 }, { A: 2, B: 3 }, { A: 3, B: 4 }
    ], { skipHeader: true, origin: "A2" });

    //  将工作表对象追加到工作簿中
    XLSX.utils.book_append_sheet(wb, ws, '数据表1')
    XLSX.utils.book_append_sheet(wb, ws, '数据表2')

    console.log(wb);
    //  导出
    XLSX.writeFile(wb, '新的excel.xlsx')

结语

结束了。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/350433.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

uprobe 实战

观测数据源 目前按照我的理解&#xff0c;和trace相关的常用数据源–探针 大致分为四类。 内核 Trace point kprobe 用户程序 USDT uprobe 在用户程序中&#xff0c;USDT是所谓的静态Tracepoint。和内核代码中的Trace point类似。实现方式是在代码开发时&#xff0c;使用USDT…

Visual Studio开启clang-tidy代码检查

在CLion中有针对C的静态代码检查工具clang-tidy&#xff0c;感觉非常好用&#xff0c;能养成好的编码习惯&#xff0c;后来写Qt转入了VS平台&#xff0c;想要继续使用功能一致的clang-tidy体验&#xff0c;所以研究出来在VS中开启clang-tidy的方法。 版本&#xff1a;Visual S…

XML 基础知识 XXE 漏洞原理解析及实验(基础篇)

XML 介绍 XXE全称XML外部实体注入&#xff0c;所以在介绍XXE漏洞之前&#xff0c;先来说一说什么是XML以及为什么使用XML进而再介绍一下XML的结构。 XML全称 可拓展标记语言&#xff0c;与HTML相互配合后&#xff1a; HMTL用来显示数据 HTML的焦点在于数据的外观&#xff08;…

双网卡(有线和wifi)同时连接内网和外网

双网卡&#xff08;有线和wifi&#xff09;同时连接内网和外网 Win10技巧&#xff1a;如何修改有线/WiFi网络优先级&#xff1a;https://www.ithome.com/html/win10/253612.htm双网卡实现两个网络的自由访问&#xff1a;https://blog.51cto.com/ghostlan/1299090Linux服务器安…

【Linux】网络编程 - 基础概念

目录 一.OSI七层模型vsTCP/IP五层模型 1.一些周边概念 2.OSI七层模型 3.TCP/IP五层模型 4.网络传输流程图 二.什么是MAC地址 三.什么是IP/IP地址 1.什么是IP 2.什么是IP地址 四.什么是端口号 一.OSI七层模型vsTCP/IP五层模型 1.一些周边概念 局域网vs广域网 网络互…

LeetCode——2341. 数组能形成多少数对

一、题目 给你一个下标从 0 开始的整数数组 nums 。在一步操作中&#xff0c;你可以执行以下步骤&#xff1a; 从 nums 选出 两个 相等的 整数 从 nums 中移除这两个整数&#xff0c;形成一个 数对 请你在 nums 上多次执行此操作直到无法继续执行。 返回一个下标从 0 开始、…

亚马逊云科技重磅发布《亚马逊云科技汽车行业解决方案》

当今&#xff0c;随着万物智联、云计算等领域的高速发展&#xff0c;创新智能网联汽车和车路协同技术正在成为车企加速发展的关键途径&#xff0c;推动着汽车产品从出行代步工具向着“超级智能移动终端”快速转变。挑战无处不在&#xff0c;如何抢先预判&#xff1f;随着近年来…

31-Golang中的二维数组

二维数组的使用方式 使用方式一&#xff1a;先声明/定义再赋值 1.语法&#xff1a;var数组名 [大小] [大小]类型2.比如&#xff1a;var arr [2] [3]int,再赋值 package main import ("fmt" )func main() {//定义/声明数组var arr [4][6]int//赋初值arr[1][2] 1ar…

volatile,内存屏障

volatile的特性可见性: 对于其他线程是可见,假设线程1修改了volatile修饰的变量,那么线程2是可见的,并且是线程安全的重排序: 由于CPU执行的时候,指令在后面的会先执行,在指令层级的时候我们晓得volatile的特性后,我们就要去volatile是如何实现的,这个很重要&#xff01;&#…

金三银四面试必备的软件测试八股文,看完拿捏面试官

1、问&#xff1a;你在测试中发现了一个 bug&#xff0c;但是开发经理认为这不是一个 bug&#xff0c;你应该怎样解决&#xff1f;首先&#xff0c;将问题提交到缺陷管理库里面进行备案。然后&#xff0c;要获取判断的依据和标准&#xff1a; 根据需求说明书、产品说明、设计文…

蓝屏怎么办电脑蓝屏怎么办?蓝屏问题详细分析

蓝屏怎么办电脑蓝屏怎么办&#xff1f;最近很多小伙伴在咨询这个问题&#xff0c;其实电脑蓝屏了进不去&#xff0c;我们可以重新启动电脑&#xff0c;如果进入系统后还是直接蓝屏&#xff0c;那么你可以尝试一下&#xff0c;关机重启&#xff0c;然后在进入系统的时候&#xf…

路肩石水渠机在施工公路项目中工艺特点的匹配

新建公路路肩项目在目前公路项目中的技术手段和实现方式,大多数依靠机械设备来机械来进行,还有一部分通过人工传统的预制作业和安装模式来进行,两种工艺特点的对比来说对于补充完善建设手段和效果实现有很重要的意义. 其中采用了机械设备进行一次成型制作的过程,按照设计需求匹…

useRef 几种使用场景

图修改自 dev.to Demystifying React Hooks: useRef useRef神奇的地方除了可以在不重新渲染的状态下更有价值,也可以直接获取D加粗样式OM 进入而控制DOM的行为 Ref 有什么用? useRef返回一个可变的 ref 对象,其 .current 属性被初始化为传递的参数 ( initialValue)。返回…

常用vim命令和vim基本使用及Linux用户的管理,用户和组相关文件

常用vim命令和vim基本使用及Linux用户的管理&#xff0c;用户和组相关文件1. vim 的基本介绍和使用1.1 vim的三种模式1.2 常用vim命令【小白】1.3 Vim键盘图&#xff1a;2. Linux用户管理2.1 添加用户2.2 删除用户2.3 修改账号3. Linux系统用户组的管理4. 用户和组相关文件4.1 …

RuoYi-Vue部署(Nginx+Tomcat)

环境搭建RuoYi-Vue搭建、Linux安装Nginx、Linux安装JDK8、Linux安装MySql8、Linux安装Redis、Linux安装Tomcat9前端打包 1.ruoyi-ui鼠标右键-->打开于终端2.安装依赖&#xff1a;npm install --registryhttps://registry.npm.taobao.org-->node_modules3.编译打包&#x…

中国天气——西风带环流和寒潮

中国天气——西风带环流和寒潮 一. 西风环流概述 1. 概念 西风带&#xff1a;中高纬度地区平均水平环流在对流层盛行西风&#xff0c;称之为西风带西风带波动&#xff1a;西风带围绕极涡沿纬圈运动&#xff0c;平均而言表现为冬季三槽三脊&#xff0c;夏季四槽四脊&#xff…

盘点八个简单易上手的前端低代码框架项目

低代码近年来做为前端市场上火爆到不行的项目&#xff0c;其热度也是长久不衰&#xff0c;本文就为大家盘点了8个简单易上手的前端低代码框架项目&#xff0c;并各自都附上了体验链接&#xff0c;欢迎大家前往体验哦&#xff5e;&#xff5e;&#xff5e;&#xff5e; 1. Appsm…

elementUI-plus虚拟表el-table-v2 checkbox删除后,下一个复选框又被选中且无法删除

虚拟表种设置了checkbox&#xff0c;但是删除时&#xff0c;发现删除后&#xff0c;下一个checkbox自动被选中&#xff0c;且删除时&#xff0c;报错找不到id没有设置row-key每行的 key 值&#xff0c;如果不提供&#xff0c;将使用索引 index 代替2.row-key值设置成什么值&…

openwrt开发板与ubuntu nfs挂载

1.ubuntu需要安装nfs服务 sudo apt-get install nfs-common nfs-kernel-server2.修改 /etc/exports文件&#xff1a; /home/test *(rw,nohide,insecure,no_subtree_check,async,no_root_squash) 前面是挂载的目录&#xff0c;后边是相应权限 rw&#xff1a;读写 insecure&am…

Is ChatGPT a general-purpose natural language processing task solver?

声明&#xff1a;平时看些文章做些笔记分享出来&#xff0c;文章中难免存在错误的地方&#xff0c;还望大家海涵。搜集一些资料&#xff0c;方便查阅学习&#xff1a;http://yqli.tech/page/speech.html。语音合成领域论文列表请访问http://yqli.tech/page/tts_paper.html&…