[]
Ƭ CellValue: Object
property col - 一个键值集合，其中键是列号，值是任意类型的单元格值。
▪ [col: number]: any
Ƭ CustomDocumentPropertyValueType: string | number | boolean | Date
description 自定义文档属性类型。
Ƭ ExcelFileType: "XLSX" | "XLSM" | "XLTM" | "XLTX"
description 表示 Excel 的文件类型。
Ƭ ExportCsvOptions: Object
property fileType - 文件类型。
property [encoding] - 已弃用：目前仅支持以 UTF-8 编码导出，设置 encoding 属性将不会生效。
property [rowDelimiter] - 添加到行末尾的行分隔符，默认行分隔符为 '\r\n'。
property [columnDelimiter] - 添加到列末尾的列分隔符，默认列分隔符为 ','。
property [range] - 范围信息。
param 工作表索引，默认工作表索引为当前活动工作表索引。
param 起始行，默认行索引为 0。
param 起始列，默认列索引为 0。
param 行数，默认行数为当前活动工作表的行数。
param 列数，默认列数为当前活动工作表的列数。
| Name | Type |
|---|---|
columnDelimiter? |
string |
encoding? |
string |
range? |
{ column: number ; columnCount: number ; row: number ; rowCount: number ; sheetIndex: number } |
range.column |
number |
range.columnCount |
number |
range.row |
number |
range.rowCount |
number |
range.sheetIndex |
number |
rowDelimiter? |
string |
Ƭ ExportOptions: FileOptions & ExportCsvOptions | ExportSSJsonOptions | ExportXlsxOptions
Ƭ ExportSSJsonOptions: Object
property fileType - 文件类型。
property [includeBindingSource] - 是否包含绑定源，默认为 false.
property [includeStyles] - 是否包含样式，默认为 true.
property [includeFormulas] - 是否包含公式，默认为 true.
property [saveAsView] - 是否将格式字符串应用到导出值，默认为 false.
property [rowHeadersAsFrozenColumns] - 是否将行标题视为冻结列，默认为 false.
property [columnHeadersAsFrozenRows] - 是否将列标题视为冻结行，默认为 false.
property [includeAutoMergedCells] - 是否包含自动合并的单元格，默认为 false.
| Name | Type |
|---|---|
columnHeadersAsFrozenRows? |
boolean |
includeAutoMergedCells? |
boolean |
includeBindingSource? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
rowHeadersAsFrozenColumns? |
boolean |
saveAsView? |
boolean |
saveR1C1Formula? |
boolean |
Ƭ ExportXlsxOptions: Object
property fileType - 文件类型。
property [includeBindingSource] - 是否包含绑定源，默认为 false.
property [includeStyles] - 是否包含样式，默认为 true.
property [includeFormulas] - 是否包含公式，默认为 true.
property [saveAsView] - 保存时是否将格式字符串应用到导出值，默认为 false.
property [rowHeadersAsFrozenColumns] - 保存时是否将行标题视为冻结列，默认为 false.
property [columnHeadersAsFrozenRows] - 保存时是否将列标题视为冻结行，默认为 false.
property [includeAutoMergedCells] - 保存时是否包含自动合并的单元格，默认为 false.
property [includeCalcModelCache] - [已弃用] 是否包含计算的额外数据。包含这些数据时打开文件可能会更快，默认为 false.
property [includeUnusedNames] - 保存时是否包含未使用的自定义名称，默认为 true.
property [exportSharedFormula] - 保存时是否包含共享公式，默认为 true.
property [includeEmptyRegionCells] - 是否包含已使用数据范围之外的任何空单元格（没有数据或只有样式的单元格），默认为 true.
property [losslessEditing] - 是否包含无损编辑内容，默认值为 true.
property [password] - 设置打开工作簿的密码。
property [excelFileType] - 导出的 Excel 文件类型 ('XLSX' | 'XLSM' | 'XLTM')，默认值为 XLSX。
| Name | Type |
|---|---|
columnHeadersAsFrozenRows? |
boolean |
excelFileType? |
ExcelFileType |
exportSharedFormula? |
boolean |
includeAutoMergedCells? |
boolean |
includeBindingSource? |
boolean |
includeCalcModelCache? |
boolean |
includeEmptyRegionCells? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
includeUnusedNames? |
boolean |
losslessEditing? |
boolean |
password? |
string |
rowHeadersAsFrozenColumns? |
boolean |
saveAsView? |
boolean |
Ƭ ExternalPartialValues: Object
property filePath - 一个键值集合，其中键是文件路径字符串，值是类型为 GC.Spread.Sheets.PartialValues 的集合。
▪ [filePath: string]: PartialValues
Ƭ FileOptions: Object
property fileType - 文件类型。
| Name | Type | Description |
|---|---|---|
fileType |
FileType |
文件类型。 |
Ƭ ImportCsvOptions: Object
property fileType - 文件类型。
property [encoding] - 编码类型，默认编码类型为 'UTF-8'。
property [rowDelimiter] - 行分隔符，默认行分隔符为 '\r\n'。
property [columnDelimiter] - 列分隔符，默认列分隔符为 ','。
| Name | Type |
|---|---|
columnDelimiter? |
string |
encoding? |
string |
rowDelimiter? |
string |
Ƭ ImportOptions: FileOptions & ImportCsvOptions | ImportSSJsonOptions | ImportXlsxOptions
Ƭ ImportSSJsonOptions: Object
property fileType - 文件类型。
property [includeStyles] - 是否在将 json 转换为工作簿时包含样式，默认为 true.
property [includeFormulas] - 是否在将 json 转换为工作簿时包含公式，默认为 true.
property [frozenColumnsAsRowHeaders] - 是否在将 json 转换为工作簿时将冻结列视为行标题，默认为 false.
property [frozenRowsAsColumnHeaders] - 是否在将 json 转换为工作簿时将冻结行视为列标题，默认为 false.
property [fullRecalc] - 是否在加载 json 数据后进行完全重新计算，默认为 true.
property {boolean | object} [incrementalLoad] - 是否在将 json 转换为工作簿时使用增量加载或增量加载的回调，默认为 false.
param 增量加载进度的回调。
param 增量加载完成的回调。
| Name | Type |
|---|---|
frozenColumnsAsRowHeaders? |
boolean |
frozenRowsAsColumnHeaders? |
boolean |
fullRecalc? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
incrementalLoad? |
any |
Ƭ ImportXlsxOptions: Object
property fileType - 文件类型。
property [includeStyles] - 加载时是否包含样式，默认为 true.
property [includeFormulas] - 加载时是否包含公式，默认为 true.
property [frozenColumnsAsRowHeaders] - 加载时是否将冻结列视为行标题，默认为 false.
property [frozenRowsAsColumnHeaders] - 加载时是否将冻结行视为列标题，默认为 false.
property [fullRecalc] - 加载 json 数据后是否进行计算，默认为 false.
property [dynamicReferences] - 是否计算具有动态引用的函数，默认为 true.
property [calcOnDemand] - 是否仅在需要时计算公式，默认为 false.
property [incrementalCalculation] - 是否在不阻塞 UI 的情况下增量计算公式，默认为 false.
property [includeUnusedStyles] - 将 excel xml 转换为 json 时是否包含未使用的命名样式，默认为 true.
property [convertSheetTableToDataTable] - 是否将工作表表格转换为数据管理器表格，默认为 false.
property [password] - 打开工作簿的密码。
property [openMode] - 打开模式，包括 normal、lazy 和 incremental，默认为 normal。
property [progress] - 每种打开模式的进度回调函数。
property [excelFileType] - 导入的 Excel 文件类型 ('XLSX' | 'XLSM' | 'XLTM')，默认为 XLSX。
| Name | Type |
|---|---|
calcOnDemand? |
boolean |
convertSheetTableToDataTable? |
boolean |
dynamicReferences? |
boolean |
excelFileType? |
ExcelFileType |
frozenColumnsAsRowHeaders? |
boolean |
frozenRowsAsColumnHeaders? |
boolean |
fullRecalc? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
includeUnusedStyles? |
boolean |
incrementalCalculation? |
boolean |
openMode? |
OpenMode |
password? |
string |
progress? |
ProgressFunctionType |
Ƭ OpenOptions: Object
property [includeStyles] - 加载时是否包含样式，默认为 true.
property [includeFormulas] - 加载时是否包含公式，默认为 true.
property [fullRecalc] - 加载 json 数据后是否进行计算，默认为 false.
property [dynamicReferences] - 是否计算具有动态引用的函数，默认为 true.
property [calcOnDemand] - 是否仅在需要时计算公式，默认为 false.
property [incrementalCalculation] - 是否在不阻塞 UI 的情况下增量计算公式，默认为 false.
property [includeUnusedStyles] - 将 excel xml 转换为 json 时是否包含未使用的命名样式，默认为 true.
property [openMode] - 打开模式，包括 normal、lazy 和 incremental，默认为 normal。
property [progress] - 每种打开模式的进度回调函数。
| Name | Type |
|---|---|
calcOnDemand? |
boolean |
dynamicReferences? |
boolean |
fullRecalc? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
includeUnusedStyles? |
boolean |
incrementalCalculation? |
boolean |
openMode? |
OpenMode |
progress? |
ProgressFunctionType |
Ƭ PartialValues: Object
property row - 一个键值集合，其中键是行号，值是 GC.Spread.Sheets.CellValue 类型。
▪ [row: number]: CellValue
Ƭ ProgressArgs: Object
property sheetName - 当前正在加载的工作表名称。
property step - 当前加载步骤。
property progress - 当前加载进度，范围从 0 到 1。
| Name | Type | Description |
|---|---|---|
progress |
number |
当前加载进度，范围从 0 到 1。 |
sheetName? |
string |
当前正在加载的工作表名称。 |
step |
string |
当前加载步骤。 |
Ƭ ProgressFunctionType: (progressArgs: ProgressArgs) => void
▸ (progressArgs): void
description 增量加载进度的回调函数。
| Name | Type | Description |
|---|---|---|
progressArgs |
ProgressArgs |
进度参数。 |
void
Ƭ SaveOptions: Object
property [includeBindingSource] - 保存时是否包含绑定源，默认为 false.
property [includeStyles] - 保存时是否包含样式，默认为 true.
property [includeFormulas] - 保存时是否包含公式，默认为 true.
property [saveAsView] - 保存时是否将格式字符串应用于导出值，默认为 false.
property [includeAutoMergedCells] - 保存时是否包含自动合并的单元格，默认为 false.
property [includeCalcModelCache] - 是否包含计算的额外数据。包含这些数据可以加快文件打开速度，默认为 false.
property [includeUnusedNames] - 保存时是否包含未使用的自定义名称，默认为 true.
property [includeEmptyRegionCells] - 是否包含已使用数据范围之外的任何空单元格（没有数据或只有样式的单元格），默认为 true.
property [saveR1C1Formula] - 是否在文件中保存 r1c1 公式，仅在 sjs 文件类型中有效，默认为 false.
| Name | Type |
|---|---|
includeAutoMergedCells? |
boolean |
includeBindingSource? |
boolean |
includeCalcModelCache? |
boolean |
includeEmptyRegionCells? |
boolean |
includeFormulas? |
boolean |
includeStyles? |
boolean |
includeUnusedNames? |
boolean |
saveAsView? |
boolean |
saveR1C1Formula? |
boolean |
Ƭ SheetTabStyles: { [sheetTabState in SheetTabState]?: ISheetTabStyle }
property sheetTabState
• LicenseKey: string
表示评估版本和生产版本的许可证密钥。
▸ findControl(host): Workbook
通过主机元素获取 Workbook 实例。
| Name | Type | Description |
|---|---|---|
host |
string | HTMLElement |
主机元素或主机元素 id。 |
Workbook 实例。
▸ getTypeFromString(typeString): any
从类型字符串获取类型。此方法用于支持自定义对象的序列化。
| Name | Type | Description |
|---|---|---|
typeString |
string |
类型字符串。 |
any
类型。
