GC.Spread.Sheets.CellTypes.FileUpload

类: FileUpload

Sheets.CellTypes.FileUpload

继承关系

Base

↳ FileUpload

构造方法

constructor

属性

方法

构造方法

constructor

• new FileUpload()

代表文件上传单元格类型

代码示例

// set a FileUpload celltype
const cellType1 = new GC.Spread.Sheets.CellTypes.FileUpload();
sheet.setCellType(1, 1, cellType1);
// FileUpload support the valuePath property, will parse the cell value with valuePath to GC.Spread.Sheets.CellTypes.IFileInfo
sheet.getCellType(1, 1).valuePath("blob");
sheet.setValue(1, 1, blob); // value path is "blob"
sheet.getCellType(2, 2).valuePath("dataUrl");
sheet.setValue(2, 2, dataUrl); // value path is "dataUrl"
sheet.getCellType(3, 3).valuePath(undefined);
sheet.setValue(3, 3, { name: 'test1.png', blob: blob }); // value path is undefined
sheet.setValue(3, 3, { name: 'test2.txt', dataUrl: dataUrl }); // value path is undefined

Overrides

Base.constructor

属性

previewCommand

• Optional previewCommand: string | (file: IFilePreviewInfo) => void

通过设置点击预览按钮后的事件回调或命令，自定义个性化预览逻辑和UI显示。

returns

代码示例

// This example creates a file upload cell.
// Customize your preview function.
fileUpload.previewCommand = function (fileInfo) {
   // Custom preview logic
}

// Customize your preview command.
fileUpload.previewCommand = 'openPreviewDialog';

activeSheet.getCell(1, 1).cellType(fileUpload);

typeName

• typeName: string

表示用于支持序列化的类型名称字符串。

继承自

Base.typeName

方法

accept

▸ accept(value?): string

获取或设置可以上传的文件类型。

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.accept('image/*');
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`string`	可以上传的文件类型

返回值

string

返回可以上传的文件类型。

activateEditor

▸ activateEditor(editorContext, cellStyle, cellRect, context?): void

激活编辑器，包括设置编辑器的属性或绑定编辑器的事件。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`cellStyle`	`Style`	单元格的实际样式
`cellRect`	`Rect`	单元格的布局信息
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

void

继承自

Base.activateEditor

createEditorElement

▸ createEditorElement(context?): HTMLElement

创建一个 DOM 元素然后返回它。

参数

属性名	类型	说明
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

HTMLElement

Returns a DOM element.

继承自

Base.createEditorElement

deactivateEditor

▸ deactivateEditor(editorContext, context?): void

停用编辑器，例如取消编辑器的绑定事件

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

void

继承自

Base.deactivateEditor

focus

▸ focus(editorContext, context?): void

聚焦编辑器 DOM 元素

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

void

继承自

Base.focus

format

▸ format(value, format, formattedData?, context?): string

将具有指定格式的值格式化为字符串

参数

属性名	类型	说明
`value`	`any`	The object value to format.
`format`	`string` \| `GeneralFormatter`	格式
`formattedData?`	`FormattedData`	格式化的数据
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

string

返回格式化的字符串

继承自

Base.format

fromJSON

▸ fromJSON(settings): void

从指定的 JSON 字符串加载对象状态

参数

属性名	类型	说明
`settings`	`any`	来自反序列化的单元格类型数据

返回值

void

继承自

Base.fromJSON

getAutoFitHeight

▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number

获取可用于处理行自动调整的单元格高度

参数

属性名	类型	说明
`value`	`any`	The cell's value.
`text`	`string`	The cell's text.
`cellStyle`	`Style`	单元格的实际值
`zoomFactor`	`number`	当前工作表的缩放系数
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

number

返回可用于处理行自动调整的单元格高度

继承自

Base.getAutoFitHeight

getAutoFitWidth

▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number

获取可用于处理列自动调整的单元格宽度

参数

属性名	类型	说明
`value`	`any`	单元格的值
`text`	`string`	单元格的文本
`cellStyle`	`Style`	单元格的实际值
`zoomFactor`	`number`	当前工作表的缩放系数
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

number

返回可用于处理列自动调整的单元格宽度

继承自

Base.getAutoFitWidth

getEditorValue

▸ getEditorValue(editorContext, context?): any

获取编辑器的值

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

any

返回编辑器的值

继承自

Base.getEditorValue

getHitInfo

▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo

获取单元格类型的命中信息

参数

属性名	类型	说明
`x`	`number`	x -指针当前位置相对于画布的坐标
`y`	`number`	y-指针当前位置相对于画布的坐标
`cellStyle`	`Style`	当前单元格的实际样式
`cellRect`	`Rect`	当前单元格的布局信息
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

IHitTestCellTypeHitInfo

返回一个包含 x、y、row、col、cellRect 的对象和 sheetArea 参数，以及指示 isReservedLocation 的值。如果命中测试位于单元类型需要处理的特殊区域，则 isReservedLocation 为“true”；否则，“false”。

继承自

Base.getHitInfo

isClearEnabled

▸ isClearEnabled(value?): boolean

获取或设置是否显示文件清除按钮。

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isClearEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`boolean`	是否显示文件清除按钮

返回值

boolean

返回当前显示的文件清除按钮。

isDownloadEnabled

▸ isDownloadEnabled(value?): boolean

获取或设置是否显示文件下载按钮

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isDownloadEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`boolean`	是否显示文件下载按钮

返回值

boolean

返回当前显示的文件下载按钮

isEditingValueChanged

▸ isEditingValueChanged(oldValue, newValue, context?): boolean

编辑值是否改变

参数

属性名	类型	说明
`oldValue`	`any`	旧的编辑值
`newValue`	`any`	新的编辑值
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

boolean

如果旧值等于新值则为“true”；否则，“false”。

继承自

Base.isEditingValueChanged

isImeAware

▸ isImeAware(context?): boolean

该单元格类型是否识别 IME。

参数

属性名	类型	说明
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

boolean

如果单元格类型支持 IME，则为“true”；否则，“false”。

继承自

Base.isImeAware

isPreviewEnabled

▸ isPreviewEnabled(value?): boolean

获取或设置是否显示文件预览按钮

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isPreviewEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`boolean`	是否显示文件预览按钮

返回值

boolean

返回当前显示的文件预览按钮

isReservedKey

▸ isReservedKey(e, context?): boolean

单元格类型本身是否处理键盘事件

参数

属性名	类型	说明
`e`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文。请参阅备注了解更多信息

返回值

boolean

如果单元格类型本身处理键盘事件，则返回“true”；否则，“false”。

继承自

Base.isReservedKey

marginBottom

▸ marginBottom(value?): number

获取或设置底部边距值。

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginBottom(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`number`	底部边距值

返回值

number

如果没有设置值，则返回当前底部边距

marginLeft

▸ marginLeft(value?): number

获取或设置左部边距值

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginLeft(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`number`	左部边距值

返回值

number

如果没有设置值，则返回当前左部边距

marginRight

▸ marginRight(value?): number

获取或设置右部边距值

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginRight(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`number`	右部边距值

返回值

number

如果没有设置值，则返回当前右部边距

marginTop

▸ marginTop(value?): number

获取或设置顶部边距值

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginTop(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`number`	顶部边距值

返回值

number

如果没有设置值，则返回当前顶部边距

maxSize

▸ maxSize(value?): number

获取或设置可以上传的最大文件大小

代码示例

// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.maxSize(10000);
activeSheet.getCell(1, 1).cellType(fileUpload);

参数

属性名	类型	说明
`value?`	`number`	可以上传的最大文件大小

返回值

number

返回可以上传的最大文件大小。

paint

▸ paint(ctx, value, x, y, w, h, style, context?): void

在画布上绘制一个单元格。

参数

属性名	类型	说明
`ctx`	`CanvasRenderingContext2D`	画布的二维环境
`value`	`any`	单元格的值
`x`	`number`	x-相对于画布的坐标
`y`	`number`	y-相对于画布的坐标
`w`	`number`	单元格的宽度
`h`	`number`	单元格的高度
`style`	`Style`	单元格的实际样式
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

void

继承自

Base.paint

paintContent

▸ paintContent(ctx, value, x, y, w, h, style, context?): void

在画布上绘制单元格内容区域。

参数

属性名	类型	说明
`ctx`	`CanvasRenderingContext2D`	画布的二维环境
`value`	`any`	单元格的值
`x`	`number`	x-相对于画布的坐标
`y`	`number`	y-相对于画布的坐标
`w`	`number`	单元格内容区域的宽度
`h`	`number`	单元格内容区域的高度
`style`	`Style`	单元格的实际样式
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

void

继承自

Base.paintContent

parse

▸ parse(text, formatStr, context?): any

将具有指定格式字符串的文本解析为对象

参数

属性名	类型	说明
`text`	`string`	解析文本字符串
`formatStr`	`string`	解析格式字符串
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

any

The parsed object.

继承自

Base.parse

processKeyDown

▸ processKeyDown(event, context?): boolean

在显示模式下处理按键按下。

参数

属性名	类型	说明
`event`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processKeyDown

processKeyUp

▸ processKeyUp(event, context?): boolean

在显示模式下处理按键

参数

属性名	类型	说明
`event`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processKeyUp

processMouseDown

▸ processMouseDown(hitInfo): boolean

在显示模式下处理鼠标按下。

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfo 方法返回的命中测试信息。请参阅备注以获取更多信息。

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processMouseDown

processMouseEnter

▸ processMouseEnter(hitInfo): boolean

在显示模式下处理鼠标输入。

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfo 方法返回的命中测试信息。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processMouseEnter

processMouseLeave

▸ processMouseLeave(hitInfo): boolean

处理鼠标离开显示模式。

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfo 方法返回的命中测试信息。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processMouseLeave

processMouseMove

▸ processMouseMove(hitInfo): boolean

在显示模式下处理鼠标移动。

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfo 方法返回的命中测试信息。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processMouseMove

processMouseUp

▸ processMouseUp(hitInfo): boolean

在显示模式下处理鼠标松开。

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfo 方法返回的命中测试信息。请参阅备注以获取更多信息

返回值

boolean

如果过程成功则返回“true”；否则，“false”。

继承自

Base.processMouseUp

selectAll

▸ selectAll(editorContext, context?): void

选择编辑器 DOM 元素中的所有文本。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

void

继承自

Base.selectAll

setEditorValue

▸ setEditorValue(editorContext, value, context?): void

设置编辑器的值。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`value`	`any`	从活动单元格返回的值
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

void

继承自

Base.setEditorValue

toJSON

▸ toJSON(): any

将对象状态保存到 JSON 字符串

返回值

any

单元格类型数据

继承自

Base.toJSON

updateEditor

▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect

更新编辑器的大小。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`cellStyle`	`Style`	单元格的实际样式
`cellRect`	`Rect`	单元格的布局信息
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

Rect

返回单元格包装元素的新大小，它应该包含两个属性“宽度”和“高度”。

继承自

Base.updateEditor

updateEditorContainer

▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void

更新单元格包装元素大小。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`editorBounds`	`Rect`	单元格包装元素的新大小
`cellStyle`	`Style`	单元格的实际样式

返回值

void

继承自

Base.updateEditorContainer

updateImeMode

▸ updateImeMode(editorContext, imeMode, context?): void

更新编辑器的 ime 模式。

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由 createEditorElement 方法创建的 DOM 元素
`imeMode`	`ImeMode`	来自单元格实际样式的 ime 模式
`context?`	`any`	与单元格类型相关的上下文。请参阅备注以获取更多信息

返回值

void

继承自

Base.updateImeMode

valuePath

▸ valuePath(value?): string

获取或设置 FileUpload 单元格类型的值路径，单元格将通过 fileInfo 中的 valuePath 获取值。

代码示例

// This example creates a file upload cell and setValue with dataUrl.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.valuePath("dataUrl"); // set valuePath dataUrl, default is dataUrl
activeSheet.getCell(1, 1).cellType(fileUpload);
activeSheet.setValue(1, 1, 'data:text/plain;base64,MQ==')

参数

属性名	类型	说明
`value?`	`string`	值路径值

返回值

string

如果没有设置值，则返回当前值路径，默认值路径为 dataUrl。

GC.Spread.Sheets.CellTypes.FileUpload

类: FileUpload

继承关系

Table of contents

构造方法

属性

方法

构造方法

constructor

Overrides

属性

previewCommand

typeName

继承自

方法

accept

参数

返回值

activateEditor

参数

返回值

继承自

createEditorElement

参数

返回值

继承自

deactivateEditor

参数

返回值

继承自

focus

参数

返回值

继承自

format

参数

返回值

继承自

fromJSON

参数

返回值

继承自

getAutoFitHeight

参数

返回值

继承自

getAutoFitWidth

参数

返回值

继承自

getEditorValue

参数

返回值

继承自

getHitInfo

参数

返回值

继承自

isClearEnabled

参数

返回值

isDownloadEnabled

参数

返回值

isEditingValueChanged

参数

返回值

继承自

isImeAware

参数

返回值

继承自

isPreviewEnabled

参数

返回值

isReservedKey

参数

返回值

继承自

marginBottom