[]
产品首页 在线 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

ExportCsvOptions

Ƭ ExportCsvOptions: Object

  • 属性 fileType - 文件类型
  • property [encoding] - csv编码类型，默认编码类型为'UTF-8'
  • 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

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] - 是否包括额外的计算数据。使用这些数据打开文件时可能会更快，默认为false
  • property [includeUnusedNames] - 保存时是否包含未使用的自定义名称，默认为true
  • property [includeEmptyRegionCells] - 是否在使用的数据范围之外包括任何空单元格（无数据的单元格或仅样式的单元格）,默认为true

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 [includeUnusedStyles] - 在将excel xml转换为json时是否包括未使用的名称样式，默认为true
  • property [openMode] - 正常、懒加载和增量的打开模式。默认情况下是正常的
  • property [password] - 密码
  • property [progress] - 打开时的回调函数

Type declaration

属性名 类型
calcOnDemand? boolean
dynamicReferences? boolean
frozenColumnsAsRowHeaders? boolean
frozenRowsAsColumnHeaders? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedStyles? 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 [includeUnusedStyles] - 在将excel xml转换为json时是否包括未使用的名称样式，默认为true
  • property [openMode] - 正常、懒加载和增量的打开模式。默认情况下是正常的
  • property [progress] - 打开时的回调函数

Type declaration

属性名 类型
calcOnDemand? boolean
dynamicReferences? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedStyles? 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

Type declaration

属性名 类型
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeCalcModelCache? boolean
includeEmptyRegionCells? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedNames? boolean
saveAsView? 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

类型