[]
↳ FileUpload
• new FileUpload()
Represents a file upload cell type.
example
// 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
• Optional
previewCommand: string
| (file
: IFilePreviewInfo
) => void
Customize personalized preview logic and UI display by setting event callbacks or SJS commands after clicking the preview button.
returns
example
// 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: string
Represents the type name string used for supporting serialization.
▸ accept(value?
): string
Gets or sets the file types that can be uploaded.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.accept('image/*');
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
string |
The file types that can be uploaded. |
string
Returns the file types that can be uploaded.
▸ activateEditor(editorContext
, cellStyle
, cellRect
, context?
): void
Activates the editor, including setting properties or attributes for the editor and binding events for the editor.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
cellStyle |
Style |
The cell's actual style. |
cellRect |
Rect |
The cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ createEditorElement(context?
): HTMLElement
Creates a DOM element then returns it.
Name | Type | Description |
---|---|---|
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
HTMLElement
Returns a DOM element.
▸ deactivateEditor(editorContext
, context?
): void
Deactivates the editor, such as unbinding events for editor.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ focus(editorContext
, context?
): void
Focuses the editor DOM element.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ format(value
, format
, formattedData?
, context?
): string
Formats a value with the specified format to a string.
Name | Type | Description |
---|---|---|
value |
any |
The object value to format. |
format |
string | GeneralFormatter |
The format. |
formattedData? |
FormattedData |
the formatted data. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
string
Returns the formatted string.
▸ fromJSON(settings
): void
Loads the object state from the specified JSON string.
Name | Type | Description |
---|---|---|
settings |
any |
The cell type data from deserialization. |
void
▸ getAutoFitHeight(value
, text
, cellStyle
, zoomFactor
, context?
): number
Gets a cell's height that can be used to handle the row's automatic fit.
Name | Type | Description |
---|---|---|
value |
any |
The cell's value. |
text |
string |
The cell's text. |
cellStyle |
Style |
The cell's actual value. |
zoomFactor |
number |
The current sheet's zoom factor. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
number
Returns the cell's height that can be used to handle the row's automatic fit.
▸ getAutoFitWidth(value
, text
, cellStyle
, zoomFactor
, context?
): number
Gets a cell's width that can be used to handle the column's automatic fit.
Name | Type | Description |
---|---|---|
value |
any |
The cell's value. |
text |
string |
The cell's text. |
cellStyle |
Style |
The cell's actual value. |
zoomFactor |
number |
The current sheet's zoom factor. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
number
Returns the cell's width that can be used to handle the column's automatic fit.
▸ getEditorValue(editorContext
, context?
): any
Gets the editor's value.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
any
Returns the editor's value.
▸ getHitInfo(x
, y
, cellStyle
, cellRect
, context?
): IHitTestCellTypeHitInfo
Gets the cell type's hit information.
Name | Type | Description |
---|---|---|
x |
number |
x-coordinate of pointer's current location relative to the canvas. |
y |
number |
y-coordinate of pointer's current location relative to the canvas. |
cellStyle |
Style |
The current cell's actual style. |
cellRect |
Rect |
The current cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns an object that contains the x, y, row, col, cellRect, and sheetArea parameters, and a value to indicate isReservedLocation.
isReservedLocation is true
if the hit test is in a special area that the cell type needs to handle; otherwise, false
.
▸ isClearEnabled(value?
): boolean
Gets or sets whether to display the file clear button.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isClearEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
boolean |
Whether to display the file clear button. |
boolean
Returns the currently displayed file clear button.
▸ isDownloadEnabled(value?
): boolean
Gets or sets whether to display the file download button.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isDownloadEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
boolean |
Whether to display the file download button. |
boolean
Returns the currently displayed file download button.
▸ isEditingValueChanged(oldValue
, newValue
, context?
): boolean
Whether the editing value has changed.
Name | Type | Description |
---|---|---|
oldValue |
any |
Old editing value. |
newValue |
any |
New editing value. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
boolean
true
if oldValue equals newValue; otherwise, false
.
▸ isImeAware(context?
): boolean
Whether this cell type is aware of IME.
Name | Type | Description |
---|---|---|
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
boolean
true
if the cell type is aware of IME; otherwise, false
.
▸ isPreviewEnabled(value?
): boolean
Gets or sets whether to display the file preview button.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isPreviewEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
boolean |
Whether to display the file preview button. |
boolean
Returns the currently displayed file preview button.
▸ isReservedKey(e
, context?
): boolean
Whether the cell type handles the keyboard event itself.
Name | Type | Description |
---|---|---|
e |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
boolean
Returns true
if the cell type handles the keyboard event itself; otherwise, false
.
▸ marginBottom(value?
): number
Gets or sets the margin bottom value.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginBottom(10);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
number |
The margin bottom value. |
number
If no value is set, return current margin bottom.
▸ marginLeft(value?
): number
Gets or sets the margin left value.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginLeft(10);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
number |
The margin left value. |
number
If no value is set, return current margin left.
▸ marginRight(value?
): number
Gets or sets the margin right value.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginRight(10);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
number |
The margin right value. |
number
If no value is set, return current margin right.
▸ marginTop(value?
): number
Gets or sets the margin top value.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginTop(10);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
number |
The margin top value. |
number
If no value is set, return current margin top.
▸ maxSize(value?
): number
Gets or sets the maximum file size that can be uploaded.
example
// This example creates a file upload cell.
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.maxSize(10000);
activeSheet.getCell(1, 1).cellType(fileUpload);
Name | Type | Description |
---|---|---|
value? |
number |
The maximum file size that can be uploaded. |
number
Returns the maximum file size that can be uploaded.
▸ paint(ctx
, value
, x
, y
, w
, h
, style
, context?
): void
Paints a cell on the canvas.
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D |
The canvas's two-dimensional context. |
value |
any |
The cell's value. |
x |
number |
x-coordinate relative to the canvas. |
y |
number |
y-coordinate relative to the canvas. |
w |
number |
The cell's width. |
h |
number |
The cell's height. |
style |
Style |
The cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ paintContent(ctx
, value
, x
, y
, w
, h
, style
, context?
): void
Paints the cell content area on the canvas.
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D |
The canvas's two-dimensional context. |
value |
any |
The cell's value. |
x |
number |
x-coordinate relative to the canvas. |
y |
number |
y-coordinate relative to the canvas. |
w |
number |
The cell content area's width. |
h |
number |
The cell content area's height. |
style |
Style |
The cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ parse(text
, formatStr
, context?
): any
Parses the text with the specified format string to an object.
Name | Type | Description |
---|---|---|
text |
string |
The parse text string. |
formatStr |
string |
The parse format string. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
any
The parsed object.
▸ processKeyDown(event
, context?
): boolean
Processes key down in display mode.
Name | Type | Description |
---|---|---|
event |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processKeyUp(event
, context?
): boolean
Processes key up in display mode.
Name | Type | Description |
---|---|---|
event |
KeyboardEvent |
The KeyboardEvent. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processMouseDown(hitInfo
): boolean
Processes mouse down in display mode.
Name | Type | Description |
---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processMouseEnter(hitInfo
): boolean
Processes mouse enter in display mode.
Name | Type | Description |
---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processMouseLeave(hitInfo
): boolean
Processes mouse leave in display mode.
Name | Type | Description |
---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processMouseMove(hitInfo
): boolean
Processes mouse move in display mode.
Name | Type | Description |
---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ processMouseUp(hitInfo
): boolean
Processes mouse up in display mode.
Name | Type | Description |
---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
The hit test information returned by the getHitInfo method. See the Remarks for more information. |
boolean
Returns true
if the process is successful; otherwise, false
.
▸ selectAll(editorContext
, context?
): void
Selects all the text in the editor DOM element.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ setEditorValue(editorContext
, value
, context?
): void
Sets the editor's value.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
value |
any |
The value returned from the active cell. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ toJSON(): any
Saves the object state to a JSON string.
any
The cell type data.
▸ updateEditor(editorContext
, cellStyle
, cellRect
, context?
): Rect
Updates the editor's size.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
cellStyle |
Style |
The cell's actual style. |
cellRect |
Rect |
The cell's layout information. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
Returns the new size for cell wrapper element, it should contain two properties 'width' and 'height'.
▸ updateEditorContainer(editorContext
, editorBounds
, cellStyle
): void
Updates the cell wrapper element size.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
editorBounds |
Rect |
The cell wrapper element's new size. |
cellStyle |
Style |
The cell's actual style. |
void
▸ updateImeMode(editorContext
, imeMode
, context?
): void
Updates the editor's ime-mode.
Name | Type | Description |
---|---|---|
editorContext |
HTMLElement |
The DOM element that was created by the createEditorElement method. |
imeMode |
ImeMode |
The ime-mode from cell's actual style. |
context? |
any |
The context associated with the cell type. See the Remarks for more information. |
void
▸ valuePath(value?
): string
Gets or sets the value path for fileUpload cellType, the cell will get vale by the valuePath from the cell fileInfo.
example
// 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==')
Name | Type | Description |
---|---|---|
value? |
string |
The value path value. |
string
If no value is set, return current value path, the default value path is dataUrl.