GC.Spread.Sheets.CellTypes.FileUpload

クラス: FileUpload

Sheets.CellTypes.FileUpload

階層

Base

↳ FileUpload

コンストラクタ

constructor

プロパティ

メソッド

コンストラクタ

constructor

• new FileUpload()

ファイルアップロード型セルを表します。

実例

// ファイルアップロード型セルを設定します。
const cellType1 = new GC.Spread.Sheets.CellTypes.FileUpload();
sheet.setCellType(1, 1, cellType1);
// FileUpload は valuePath プロパティをサポートし、valuePath を含むセル値を GC.Spread.Sheets.CellTypes.IFileInfo に解析します。
sheet.getCellType(1, 1).valuePath("blob");
sheet.setValue(1, 1, blob); // 値のパスは「blob」です。
sheet.getCellType(2, 2).valuePath("dataUrl");
sheet.setValue(2, 2, dataUrl); // 値のパスは「dataUrl」です。
sheet.getCellType(3, 3).valuePath(undefined);
sheet.setValue(3, 3, { name: 'test1.png', blob: blob }); // 値のパスは「undefined」です。
sheet.setValue(3, 3, { name: 'test2.txt', dataUrl: dataUrl }); // 値のパスは「undefined」です。

オーバーライド

Base.constructor

プロパティ

previewCommand

• オプション previewCommand: string | (file: IFilePreviewInfo) => void

プレビューボタンをクリックした後にイベントコールバックまたは SJS コマンドを設定して、プレビューロジックと UI 表示をカスタマイズします。

returns

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
// プレビュー関数をカスタマイズします。
fileUpload.previewCommand = function (fileInfo) {
   // カスタムプレビューロジック。
}

// プレビューコマンドをカスタマイズします。
fileUpload.previewCommand = 'openPreviewDialog';

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

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

継承元

Base.typeName

メソッド

accept

▸ accept(value?): string

アップロードするファイルの種類を取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
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

DOM要素を返します。

継承元

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`	書式設定するオブジェクト値。
`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`	セルの値。
`text`	`string`	セルのテキスト。
`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

ファイルのクリアボタンを表示するかどうかを取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.isClearEnabled(false);
activeSheet.getCell(1, 1).cellType(fileUpload);

パラメータ

名前	型	説明
`value?`	`boolean`	ファイルのクリアボタンを表示するかどうか。

戻り値

boolean

ファイルのクリアボタンが表示されているかどうかを返します。

isDownloadEnabled

▸ isDownloadEnabled(value?): boolean

ファイルのダウンロードボタンを表示するかどうかを取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
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

oldValueがnewValueと等しい場合はtrue、それ以外の場合はfalse。

継承元

Base.isEditingValueChanged

isImeAware

▸ isImeAware(context?): boolean

このセル型がIMEを認識するかどうか。

パラメータ

名前	型	説明
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がIMEを認識する場合はtrue、それ以外の場合はfalse。

継承元

Base.isImeAware

isPreviewEnabled

▸ isPreviewEnabled(value?): boolean

ファイルのプレビューボタンを表示するかどうかを取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
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`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がキーボードイベントを自分で処理する場合はtrue、それ以外の場合はfalseを返します。

継承元

Base.isReservedKey

marginBottom

▸ marginBottom(value?): number

下余白の値を取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginBottom(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

パラメータ

名前	型	説明
`value?`	`number`	下余白の値。

戻り値

number

値が設定されていない場合は、現在の下余白を返します。

marginLeft

▸ marginLeft(value?): number

左余白の値を取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginLeft(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

パラメータ

名前	型	説明
`value?`	`number`	左余白の値。

戻り値

number

値が設定されていない場合は、現在の左余白を返します。

marginRight

▸ marginRight(value?): number

右余白の値を取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginRight(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

パラメータ

名前	型	説明
`value?`	`number`	右余白の値。

戻り値

number

値が設定されていない場合は、現在の右余白を返します。

marginTop

▸ marginTop(value?): number

上余白の値を取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.marginTop(10);
activeSheet.getCell(1, 1).cellType(fileUpload);

パラメータ

名前	型	説明
`value?`	`number`	上余白の値。

戻り値

number

値が設定されていない場合は、現在の上余白を返します。

maxSize

▸ maxSize(value?): number

アップロードを許可するファイルの最大サイズを取得または設定します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
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`	キャンバスの2次元コンテキスト。
`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`	キャンバスの2次元コンテキスト。
`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

解析されたオブジェクト。

継承元

Base.parse

processKeyDown

▸ processKeyDown(event, context?): boolean

表示モードでキーダウンを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

継承元

Base.processKeyDown

processKeyUp

▸ processKeyUp(event, context?): boolean

表示モードでキーアップを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	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

セルラッパー要素の新しいサイズを返します。これには'width'と'height'の2つのプロパティが含まれます。

継承元

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

ファイルアップロード型セルの値パスを取得または設定します。セルはセルの fileInfo から valuePath で値を取得します。

実例

// 次のサンプルコードは、ファイルアップロード型セルを作成します。
const fileUpload = new GC.Spread.Sheets.CellTypes.FileUpload();
fileUpload.valuePath("dataUrl"); // valuePath をdataUrl」に設定します。デフォルト値は 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

オーバーライド

プロパティ

previewCommand

typeName

継承元

メソッド

accept

パラメータ

戻り値

activateEditor

パラメータ

戻り値

継承元

createEditorElement

パラメータ

戻り値

継承元

deactivateEditor

パラメータ

戻り値

継承元

focus

パラメータ

戻り値

継承元

format

パラメータ

戻り値

継承元

fromJSON

パラメータ

戻り値

継承元

getAutoFitHeight

パラメータ

戻り値

継承元

getAutoFitWidth

パラメータ

戻り値

継承元

getEditorValue

パラメータ

戻り値

継承元

getHitInfo

パラメータ

戻り値

継承元

isClearEnabled

パラメータ

戻り値

isDownloadEnabled

パラメータ

戻り値

isEditingValueChanged

パラメータ

戻り値

継承元

isImeAware

パラメータ

戻り値

継承元

isPreviewEnabled

パラメータ

戻り値

isReservedKey

パラメータ

戻り値

継承元

marginBottom