[]
デモ ヘルプ APIリファレンス デザイナ
ダウンロード
(Showing Draft Content)

GC.Spread.Sheets

名前空間: Sheets

GC.Spread.Sheets

Table of contents

名前空間

列挙体

クラス

インターフェイス

型の別名

変数

関数

型の別名

CellValue

Ƭ CellValue: Object

プロパティ col - キーと値のコレクション。 キーは列番号、値は任意のタイプのセル値です。

Index signature

▪ [col: number]: any

ExportCsvOptions

Ƭ ExportCsvOptions: Object

プロパティ fileType - ファイルの種類。

プロパティ [encoding] - csv エンコーディング タイプ。デフォルトのエンコーディング タイプは「UTF-8」です。

プロパティ [rowDelimiter] - 行の最後に付加される行区切り文字。デフォルトの行区切り文字は '\r\n' です。

プロパティ [columnDelimiter] - 列の最後に付加される列区切り文字。デフォルトの列区切り文字は ',' です。

プロパティ [range] - 範囲の情報。

パラメータ sheetIndex - シートインデックス。デフォルトのシートインデックスは、アクティブなシートインデックスです。

パラメータ row - 開始行。デフォルトの行インデックスは 0 です。

パラメータ column - 開始列。デフォルトの列インデックスは 0 です。

パラメータ rowCount - 行数。デフォルトの行数は、アクティブなシートの行数です。

パラメータ columnCount - 列数。デフォルトの列数は、アクティブなシートの列数です。

型宣言

名前 型
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 - ファイルの種類。

プロパティ [includeBindingSource] - ワークブックをjsonに変換するときにバインディングソースを含めるかどうか。デフォルトは false です。

プロパティ [includeStyles] - ワークブックをjsonに変換するときにスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - ワークブックをjsonに変換するときに数式を含めるかどうか。デフォルトは true です。

プロパティ [saveAsView] - ワークブックを JSON に変換するときに、エクスポートする値に書式文字列を適用するかどうか。デフォルトは false です。

プロパティ [rowHeadersAsFrozenColumns] - ワークブックをjsonに変換するときに行ヘッダーを固定列として扱うかどうか。デフォルトは false です。

プロパティ [columnHeadersAsFrozenRows] - ワークブックをjsonに変換するときに列ヘッダーを固定行として扱うかどうか。デフォルトは false です。

プロパティ [includeAutoMergedCells] - ワークブックをjsonに変換するときに自動的に結合されたセルを含めるかどうか。デフォルトは false です。

型宣言

名前 型
columnHeadersAsFrozenRows? boolean
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeFormulas? boolean
includeStyles? boolean
rowHeadersAsFrozenColumns? boolean
saveAsView? boolean

ExportXlsxOptions

Ƭ ExportXlsxOptions: Object

プロパティ fileType - ファイルの種類。

プロパティ [includeBindingSource] - 保存時にバインディングソースを含めるかどうか。デフォルトは false です。

プロパティ [includeStyles] - 保存時にスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - 保存時に数式を含めるかどうか。デフォルトは true です。

プロパティ [saveAsView] - 保存時にエクスポートする値に書式文字列を適用するかどうか。デフォルトは false です。

プロパティ [rowHeadersAsFrozenColumns] - 保存時に行ヘッダーを固定列として扱うかどうか。デフォルトは false です。

プロパティ [columnHeadersAsFrozenRows] - 保存時に列ヘッダーを固定行として扱うかどうか。デフォルトは false です。

プロパティ [includeAutoMergedCells] - 保存時に自動的に結合されたセルを含めるかどうか。デフォルトは false です。

プロパティ [includeCalcModelCache] - 計算のキャッシュデータを含めるかどうか。それらのデータを含むファイルを開くと、より高速になる可能性があります。デフォルトは false です。

プロパティ [includeUnusedNames] - 保存時に未使用のカスタム名を含めるかどうか。デフォルトは true です。

プロパティ [includeEmptyRegionCells] - 使用されるデータ範囲外の空のセル(データがないセルまたはスタイルのみのセル) を含めるかどうか。デフォルトは true です。

プロパティ [password] - ワークブックを開くためのパスワードを設定します。

型宣言

名前 型
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 - ファイルの種類。

型宣言

名前 型 説明
fileType FileType ファイルの種類。

ImportCsvOptions

Ƭ ImportCsvOptions: Object

プロパティ fileType - ファイルの種類。

プロパティ [encoding] - csv エンコーディング タイプ。デフォルトのエンコーディング タイプは「UTF-8」です。

プロパティ [rowDelimiter] - 行の最後に付加される行区切り文字。デフォルトの行区切り文字は '\r\n' です。

プロパティ [columnDelimiter] - 列の最後に付加される列区切り文字。デフォルトの列区切り文字は ',' です。

型宣言

名前 型
columnDelimiter? string
encoding? string
rowDelimiter? string

ImportOptions

Ƭ ImportOptions: FileOptions & ImportCsvOptions | ImportSSJsonOptions | ImportXlsxOptions

ImportSSJsonOptions

Ƭ ImportSSJsonOptions: Object

プロパティ fileType - ファイルの種類。

プロパティ [includeStyles] - jsonをワークブックに変換するときにスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - jsonをワークブックに変換するときに数式を含めるかどうか。デフォルトは true です。

プロパティ [frozenColumnsAsRowHeaders] - jsonをワークブックに変換するときに固定列を行ヘッダーとして扱うかどうか。デフォルトは false です。

プロパティ [frozenRowsAsColumnHeaders] - jsonをワークブックに変換するときに固定行を列ヘッダーとして扱うかどうか。デフォルトは false です。

プロパティ [fullRecalc] - json データの読み込み後に完全な再計算を行うかどうか。デフォルトは true です。

プロパティ {boolean | object} [incrementalLoad] - jsonをワークブックに変換するときに、増分読み込みを使用するか、増分読み込みのコールバックを使用するか。デフォルトは false です。

パラメータ 増分読み込みが進行したときのコールバック。

パラメータ 増分読み込みが完了したときのコールバック。

型宣言

名前 型
frozenColumnsAsRowHeaders? boolean
frozenRowsAsColumnHeaders? boolean
fullRecalc? boolean
includeFormulas? boolean
includeStyles? boolean
incrementalLoad? any

ImportXlsxOptions

Ƭ ImportXlsxOptions: Object

プロパティ fileType - ファイルの種類。

プロパティ [includeStyles] - 読み込み時にスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - 読み込み時に数式を含めるかどうか。デフォルトは true です。

プロパティ [frozenColumnsAsRowHeaders] - 読み込み時に固定列を行ヘッダーとして扱うかどうか。デフォルトは false です。

プロパティ [frozenRowsAsColumnHeaders] - 読み込み時に固定行を列ヘッダーとして扱うかどうか。デフォルトは false です。

プロパティ [fullRecalc] - データの読み込み後に計算を行うかどうか。デフォルトは false です。

プロパティ [dynamicReferences] - 動的参照を使用して関数を計算するかどうか。デフォルトは true です。

プロパティ [calcOnDemand] - 数式が要求されたときにのみ計算するかどうか。デフォルトは false です。

プロパティ [includeUnusedStyles] - 読み込み時に未使用の名前スタイルを含めるかどうか。デフォルトは true です。

プロパティ [password] - ワークブックを開くためのパスワード。

プロパティ [openMode] - normal、lazy、incrementalのオープンモード。 デフォルトはnormalです。

プロパティ [progress] - 各オープンモードの進行状況コールバック関数。

型宣言

名前 型
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

プロパティ [includeStyles] - 読み込み時にスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - 読み込み時に数式を含めるかどうか。デフォルトは true です。

プロパティ [fullRecalc] - データの読み込み後に計算を行うかどうか。デフォルトは false です。

プロパティ [dynamicReferences] - 動的参照を使用して関数を計算するかどうか。デフォルトは true です。

プロパティ [calcOnDemand] - 数式が要求されたときにのみ計算するかどうか。デフォルトは false です。

プロパティ [includeUnusedStyles] - 読み込み時に未使用の名前スタイルを含めるかどうか。デフォルトは true です。

プロパティ [openMode] - normal、lazy、incrementalのオープンモード。 デフォルトはnormalです。

プロパティ [progress] - 各オープンモードの進行状況コールバック関数。

型宣言

名前 型
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)。

型宣言

名前 型 説明
progress number 現在の読み込みの進行状況 (0 ~ 1)。
sheetName? string 現在の読み込みシートの名前。
step string 現在の読み込みステップ。

ProgressFunctionType

Ƭ ProgressFunctionType: (progressArgs: ProgressArgs) => void

型宣言

▸ (progressArgs): void

説明 増分読み込みが進行したときのコールバック。

パラメータ
名前 型 説明
progressArgs ProgressArgs progress引数。
Returns

void

SaveOptions

Ƭ SaveOptions: Object

プロパティ [includeBindingSource] - 保存時にバインディングソースを含めるかどうか。デフォルトは false です。

プロパティ [includeStyles] - 保存時にスタイルを含めるかどうか。デフォルトは true です。

プロパティ [includeFormulas] - 保存時に数式を含めるかどうか。デフォルトは true です。

プロパティ [saveAsView] - 保存時にエクスポートする値に書式文字列を適用するかどうか。デフォルトは false です。

プロパティ [includeAutoMergedCells] - 保存時に自動的に結合されたセルを含めるかどうか。デフォルトは false です。

プロパティ [includeCalcModelCache] - 計算のキャッシュデータを含めるかどうか。それらのデータを含むファイルを開くと、より高速になる可能性があります。デフォルトは false です。

プロパティ [includeUnusedNames] - 保存時に未使用のカスタム名を含めるかどうか。デフォルトは true です。

プロパティ [includeEmptyRegionCells] - 使用されるデータ範囲外の空のセル(データがないセルまたはスタイルのみのセル) を含めるかどうか。デフォルトは true です。

型宣言

名前 型
includeAutoMergedCells? boolean
includeBindingSource? boolean
includeCalcModelCache? boolean
includeEmptyRegionCells? boolean
includeFormulas? boolean
includeStyles? boolean
includeUnusedNames? boolean
saveAsView? boolean

SheetTabStyles

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

プロパティ sheetTabState

変数

LicenseKey

• LicenseKey: string

評価版および製品版のライセンスキーを表します。

関数

findControl

▸ findControl(host): Workbook

ホスト要素によってWorkbookインスタンスを取得します。

パラメータ

名前 型 説明
host string | HTMLElement ホスト要素またはホスト要素ID。

戻り値

Workbook

Workbookインスタンス。

getTypeFromString

▸ getTypeFromString(typeString): any

型の文字列から型を取得します。このメソッドはカスタムオブジェクトのシリアル化をサポートするために使用します。

パラメータ

名前 型 説明
typeString string 型の文字列。

戻り値

any

種類。