Skip to content

k.utils.office ​

Office 文档处理(Excel)

概述 ​

k.utils.office 当前暴露 excel 子对象,读写 .xls / .xlsx(站点文件或字节)。

ts
const names = k.utils.office.excel.readSheetNames("data/report.xlsx")
const rows = k.utils.office.excel.readAsObjects("data/report.xlsx", "Sheet1")

excel 常用方法 ​

方法说明
getWorkBook(fileName)打开工作簿对象
getWorkBookFromBytes(buffer, extension)从字节打开
createNewWorkbook(extension)新建 .xls 或 .xlsx
readSheetNames / readSheetNamesFromBytes工作表名称列表
readAsObjects / readAsObjectsFromBytes读为对象数组(首行作字段名)
readAsArrays / readAsArraysFromBytes读为二维数组
参数类型必填说明
fileNamestring是站点 Excel 文件路径
buffernumber[]是Excel 文件字节
extensionstring是扩展名,.xls 或 .xlsx
sheetNamestring否工作表名称;不传时读取第一个工作表
rangeKExcelReadRange否读取范围
方法返回
getWorkBook(fileName)KWorkBook
getWorkBookFromBytes(buffer, extension)KWorkBook
createNewWorkbook(extension?)KWorkBook
readSheetNames(fileName) / readSheetNamesFromBytes(buffer, extension)string[]
readAsObjects(...) / readAsObjectsFromBytes(...)Record<string, any>[]
readAsArrays(...) / readAsArraysFromBytes(...)any[][]

可选 KExcelReadRange:firstRowIndex、lastRowIndex、firstColumnIndex、lastColumnIndex。

ts
const names = k.utils.office.excel.readSheetNames("data/report.xlsx")
const rows = k.utils.office.excel.readAsObjects("data/report.xlsx", names[0], {
    firstRowIndex: 0,
    firstColumnIndex: 0,
    lastColumnIndex: 3
})

从上传文件字节读取:

ts
const file = k.request.files[0]
const rows = k.utils.office.excel.readAsArraysFromBytes(file.bytes, ".xlsx", "Sheet1")

KWorkBook / KSheet ​

工作簿:sheets、createSheet(name)、write(fileName)、readAsBytes()。

工作表:getObjectData(range)、fillObjectData(json)、fillArrayData(arrays)、rows 等。

成员 / 方法返回说明
book.sheetsKSheet[]工作表列表
book.numberOfSheetsnumber工作表数量
book.createSheet(name)KSheet新建工作表
book.write(fileName)void保存到站点文件
book.readAsBytes()number[]读取工作簿字节
sheet.getObjectData(range?)Record<string, any>[]读取对象数组
sheet.getArrayData(range?)any[][]读取二维数组
sheet.fillObjectData(json)void用对象数组 JSON 填充
sheet.fillArrayData(arrays)void用二维数组填充
ts
const book = k.utils.office.excel.createNewWorkbook(".xlsx")
const sheet = book.createSheet("Orders")
sheet.fillArrayData([
    ["OrderNo", "Amount"],
    ["SO20260702001", 129.00]
])

book.write("exports/orders.xlsx")
return k.file.get("exports/orders.xlsx")

相关文档 ​