[]
产品首页 在线 Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GC.Spread.Sheets

命名空间: Sheets

GC.Spread.Sheets

Table of contents

命名空间

枚举

类

接口

类型别名

变量

函数

Type aliases

CellValue

Ƭ CellValue: Object

  • 属性 col - 键值集合，其键为列编号，值为任何类型的单元格值

Index signature

▪ [col: number]: any

CustomDocumentPropertyValueType

Ƭ CustomDocumentPropertyValueType: string | number | boolean | Date

description Custom Document property type.

ExportCsvOptions

Ƭ ExportCsvOptions: Object

属性 fileType - 文件类型。

property [encoding] - 已弃用：目前仅支持以 UTF-8 编码导出，设置 encoding 属性不会生效。

property [rowDelimiter] - 附加到行末尾的行分隔符，默认行分隔符是“\r\n”。

property [columnDelimiter] - 附加到列末尾的列分隔符，默认列分隔符是“,”。

property [range] - 范围信息。

param 工作表索引，默认工作表索引是当前活动工作表索引。

param 起始行，默认行索引为0。

param 起始列，默认列索引为0。

param 行数，默认行数是当前活动工作表的行数。

param 列数，默认列数是当前活动工作表的列数。

Type declaration

属性名 类型
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

Ƭ ExportOptions: FileOptions & ExportCsvOptions | ExportSSJsonOptions | ExportXlsxOptions

ExportSSJsonOptions

Ƭ ExportSSJsonOptions: Object

属性 fileType - 文件类型。

property [includeBindingSource] - 将工作簿转换为json时是否包含绑定源，默认false。

property [includeStyles] - 工作簿转json时是否包含样式，默认true。

property [includeFormulas] - 工作簿转json时是否包含公式，默认true。

property [saveAsView] - 将工作簿转换为 json 时是否将格式字符串应用于导出值，默认 false。

property [rowHeadersAsFrozenColumns] - 将工作簿转换为 json 时是否将行标题视为冻结列，默认 false。

property [columnHeadersAsFrozenRows] - 将工作簿转换为 json 时是否将列标题视为冻结行，默认 false。

property [includeAutoMergedCells] - 工作簿转json时是否包含自动合并的单元格，默认false。

Type declaration

属性名 类型
columnHeadersAsFrozenRows? boolean
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeFormulas? boolean
includeStyles? boolean
rowHeadersAsFrozenColumns? boolean
saveAsView? boolean
saveR1C1Formula? boolean

ExportXlsxOptions

Ƭ ExportXlsxOptions: Object

属性 fileType - 文件类型。

property [includeBindingSource] - 保存时是否包含绑定源，默认 false。

property [includeStyles] - 保存时是否包含样式，默认true。

property [includeFormulas] - 保存时是否包含公式，默认true。

property [saveAsView] - 保存时是否将格式字符串应用于导出值，默认 false。

property [rowHeadersAsFrozenColumns] - 保存时是否将行标题视为冻结列，默认 false。

property [columnHeadersAsFrozenRows] - 保存时是否将列标题视为冻结行，默认 false。

property [includeAutoMergedCells] - 保存时是否包含自动合并的单元格，默认 false。

property [includeCalcModelCache] - [deprecated] 是否包含计算的额外数据。打开包含这些数据的文件时可以更快，默认 false。

property [includeUnusedNames] - 保存时是否包含未使用的自定义名称，默认 true。

property [includeEmptyRegionCells] - 是否包含使用数据范围之外的任何空单元格（没有数据或只有样式的单元格），默认 true。

property [password] - 设置打开工作簿的密码。

Type declaration

属性名 类型
columnHeadersAsFrozenRows? boolean
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeCalcModelCache? boolean
includeEmptyRegionCells? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedNames? boolean
password? string
rowHeadersAsFrozenColumns? boolean
saveAsView? boolean

ExternalPartialValues

Ƭ ExternalPartialValues: Object

属性 filePath - 键值集合，该键是文件路径字符串，值是 GC.Spread.Sheets.PartialValues 的类型

Index signature

▪ [filePath: string]: PartialValues

FileOptions

Ƭ FileOptions: Object

属性 fileType - 文件类型

Type declaration

属性名 类型 说明
fileType FileType 文件类型

ImportCsvOptions

Ƭ ImportCsvOptions: Object

  • 属性 fileType - 文件类型
  • property [encoding] - csv编码类型，默认编码类型为'UTF-8'
  • property [rowDelimiter] - 附加到行尾的行分隔符，默认行分隔符为'\r\n'
  • property [columnDelimiter] - 附加到列末尾的列分隔符，默认列分隔符为','

Type declaration

属性名 类型
columnDelimiter? string
encoding? string
rowDelimiter? string

ImportOptions

Ƭ ImportOptions: FileOptions & ImportCsvOptions | ImportSSJsonOptions | ImportXlsxOptions

ImportSSJsonOptions

Ƭ ImportSSJsonOptions: Object

属性 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 增量加载完成时的回调。

Type declaration

属性名 类型
frozenColumnsAsRowHeaders? boolean
frozenRowsAsColumnHeaders? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
incrementalLoad? any

ImportXlsxOptions

Ƭ ImportXlsxOptions: Object

属性 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 [password] - 打开工作簿的密码。

property [openMode] - 正常、惰性、增量的打开方式。默认情况下是正常的。

property [progress] - 每种打开模式的进度回调函数。

Type declaration

属性名 类型
calcOnDemand? boolean
dynamicReferences? boolean
frozenColumnsAsRowHeaders? boolean
frozenRowsAsColumnHeaders? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedStyles? boolean
incrementalCalculation? boolean
openMode? OpenMode
password? string
progress? ProgressFunctionType

OpenOptions

Ƭ 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] - 正常、惰性、增量的打开方式。默认情况下是正常的。

property [progress] - 每种打开模式的进度回调函数。

Type declaration

属性名 类型
calcOnDemand? boolean
dynamicReferences? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedStyles? boolean
incrementalCalculation? boolean
openMode? OpenMode
progress? ProgressFunctionType

PartialValues

Ƭ PartialValues: Object

  • 属性 row - 键值集合，它是行号，值是GC.Spread.Sheets.CellValue的类型

Index signature

▪ [row: number]: CellValue

ProgressArgs

Ƭ ProgressArgs: Object

  • 属性 sheetName - 当前加载表的名称
  • 属性 step - 当前加载步骤
  • 属性 progress - 当前加载进度，从0 ~ 1

Type declaration

属性名 类型 说明
progress number 当前加载进度，从0 ~ 1
sheetName? string 当前加载表的名称
step string 当前加载步骤

ProgressFunctionType

Ƭ ProgressFunctionType: (progressArgs: ProgressArgs) => void

Type declaration

▸ (progressArgs): void

description 当加载过程递增时的回调

Parameters
属性名 类型 说明
progressArgs ProgressArgs the progress arguments.
Returns

void

SaveOptions

Ƭ 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。

Type declaration

属性名 类型
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeCalcModelCache? boolean
includeEmptyRegionCells? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedNames? boolean
saveAsView? boolean
saveR1C1Formula? boolean

SheetTabStyles

Ƭ SheetTabStyles: { [sheetTabState in SheetTabState]?: ISheetTabStyle }

属性 sheetTabState

Variables

LicenseKey

• LicenseKey: string

设计器授权

Functions

findControl

▸ findControl(host): Workbook

通过宿主元素获取工作簿实例

参数

属性名 类型 说明
host string | HTMLElement 宿主元素或宿主元素id

返回值

Workbook

工作簿实例

getTypeFromString

▸ getTypeFromString(typeString): any

从类型字符串中获取类型此方法支持自定义对象的序列化

参数

属性名 类型 说明
typeString string 字符串类型

返回值

any

类型