GC.Spread.Sheets.Workbook

クラス: Workbook

Spread.Sheets.Workbook

コンストラクタ

constructor

プロパティ

メソッド

コンストラクタ

constructor

• new Workbook(host?, options?)

指定したホストDOM要素やDOM IDとオプション設定を持つスプレッドシートを表します。

実例

var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, font:"12pt Arial"});
var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, newTabVisible:false});
var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 3, tabEditable: false });
var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, tabStripVisible:false});
var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, allowUserResize:false});
var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 3, allowUserZoom: false});

パラメータ

名前	型	説明
`host?`	`string` \| `HTMLElement`	ホストDOM要素やDOM ID。
`options?`	`IWorkBookDefaultOptions`	-

プロパティ

contextMenu

• contextMenu: ContextMenu

ContextMenu for the spread.

実例

// 次のサンプルコードは、contextMenuのmenuDataを取得する方法を示しています。
var menuData = spread.contextMenu.menuData;

name

• name: string

Spreadコントロールの名前を表します。

実例

spread.name = "Spread1";

options

• options: IWorkbookOptions

Spreadコントロールのオプションを表します。

プロパティ allowUserDragMerge - ユーザーがセルをドラッグしてマージできるかどうか。

プロパティ allowUserDragDrop - ユーザーが範囲データをドラッグ＆ドロップできるかどうか。

プロパティ allowUserDragFill - ユーザーが範囲をドラッグフィルできるかどうか。

プロパティ allowUserZoom - ［Ctrl］キーを押しながらマウスホイールを回すことによって表示をズームできるかどうか。

プロパティ allowUserResize - ユーザーが行および列のサイズを変更できるかどうか。

プロパティ allowUndo - ユーザーが編集をアンドゥできるかどうか。

プロパティ allowSheetReorder - ユーザーがSpreadコンポーネントのシートの順序を変更できるかどうか。

プロパティ allowContextMenu - ユーザーが組み込みのコンテキストメニューを開くことができるかどうか。

プロパティ allowUserDeselect - ユーザーが選択範囲内の選択を解除できるかどうか。

プロパティ defaultDragFillType - デフォルトのフィルタイプ。

プロパティ showDragFillSmartTag - ドラッグフィルダイアログを表示するかどうか。

プロパティ showHorizontalScrollbar - 水平スクロールバーを表示するかどうか。

プロパティ showVerticalScrollbar - 垂直スクロールバーを表示するかどうか。

プロパティ scrollbarShowMax - 表示されるスクロールバーがシートの全体の列数と行数に基づくかどうか。

プロパティ scrollbarMaxAlign - スクロールバーがアクティブシートの最後の行および列に揃うかどうか。

プロパティ tabStripVisible - シートタブストリップを表示するかどうか。

プロパティ tabStripRatio - 水平スクロールバーの幅全体に対する割合として表されたタブストリップの幅。

プロパティ tabStripWidth - 左側または右側の位置にあるときのタブストリップの幅。デフォルトおよび最小値は80です。

プロパティ tabEditable - ユーザーがシートタブストリップを編集できるかどうか。

プロパティ tabStripPosition - タブストリップの位置。デフォルトは下です。

プロパティ newTabVisible - ユーザーが新しいシートを挿入するための特殊なタブをスプレッドシートに表示するかどうか。

プロパティ allSheetsListVisible - スプレッドシートには、ユーザーがダイアログを開いてすべてのシートを表示できるように特別なタブが表示されているかどうか。

プロパティ tabNavigationVisible - シートタブを表示するかどうか。

プロパティ cutCopyIndicatorVisible - 選択した項目をコピーまたは切り取るときにインジケーターを表示するかどうか。

プロパティ cutCopyIndicatorBorderColor - ユーザーが選択した項目をコピーまたは切り取るときに表示されるインジケーターの境界線の色。

プロパティ backColor - Spreadコンポーネントの背景色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。

プロパティ backgroundImage - Spreadコンポーネントの背景画像。

プロパティ backgroundImageLayout - Spreadコンポーネントの背景画像レイアウト。

プロパティ grayAreaBackColor - 灰色領域の背景色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。

プロパティ showResizeTip - サイズ変更チップの表示方法。

プロパティ showDragDropTip - ドラッグ＆ドロップチップを表示するかどうか。

プロパティ showDragFillTip - ドラッグフィルチップを表示するかどうか。

プロパティ showScrollTip - スクロールチップの表示方法。

プロパティ scrollIgnoreHidden - スクロールバーが非表示の行または列を無視するかどうか。

プロパティ highlightInvalidData - 無効なデータを強調表示するかどうか。

プロパティ useTouchLayout - Spreadコンポーネントを表示するためにタッチレイアウトを使用するかどうか。

プロパティ hideSelection - Spreadコンポーネントがフォーカスを持たないときに選択範囲をハイライト表示するかどうか。

プロパティ resizeZeroIndicator - 行または列のサイズがゼロに変更されたときの描画ポリシー。

プロパティ allowUserEditFormula - ユーザーがスプレッドシートのセルに設定された数式を編集できるかどうか。

プロパティ enableFormulaTextbox - スプレッドシートで数式テキストボックスを有効にするかどうか。

プロパティ autoFitType - セル内またはセルおよびヘッダ内に収まるように内容を書式設定するかどうか。

プロパティ referenceStyle - このシートのセルに含まれる数式で使用される、セルと範囲の参照のスタイル。

プロパティ allowDynamicArray - 動的配列を有効にするかどうか。

プロパティ iterativeCalculation - 反復計算を有効にするかどうか。

プロパティ iterativeCalculationMaximumIterations - 反復計算時の最大反復。

プロパティ iterativeCalculationMaximumChange - 反復計算時の最大変化。

プロパティ calcOnDemand - 数式が要求されたときにのみ計算するかどうか。

プロパティ dynamicReferences - 動的参照を使用して関数を計算するかどうか。

プロパティ allowCopyPasteExcelStyle - ユーザーがSpread SheetsのスタイルをコピーしてExcelに貼り付ける、またはExcelのスタイルをコピーしてSpread Sheetsに貼り付けることができるかどうか。

プロパティ allowExtendPasteRange - 貼り付け範囲が足りない場合に貼り付け範囲を拡張するかどうか。

プロパティ copyPasteHeaderOptions - データをコピーまたは貼り付けるときに含めるヘッダ。

プロパティ calculationMode - ワークブックの再計算動作。デフォルト値は「auto」です。

プロパティ scrollByPixel - ピクセル単位による正確なスクロールを有効にするかどうか。

プロパティ scrollPixel - scrollByPixelがtrueの場合、一度にそのピクセル数でスクロールを決定します。最終的なスクロールピクセルは、スクロールデルタ乗算scrollPixelの結果です。たとえば、スクロールデルタは3、scrollPixelは5、最終スクロールピクセルは15です。

プロパティ enableAccessibility - スプレッドシートでアクセシビリティサポートを有効にするかどうか。

プロパティ allowAutoCreateHyperlink - シートでハイパーリンクの自動作成を有効にするかどうか。

プロパティ columnResizeMode - 列のサイズを変更する方法を指定します。

プロパティ rowResizeMode - 行のサイズを変更する方法を指定します。

プロパティ customList - ユーザーがドラッグアンドフィルをカスタマイズするためのリスト。各フィル処理でこのリストが優先されます。各配列型項目は、文字列配列です。

プロパティ scrollbarAppearance - skinとmobileの2つの列挙型を含むスクロールバーの外観。デフォルトはスキンです。

プロパティ pasteSkipInvisibleRange - 非表示の範囲を貼り付けるかスキップするか。デフォルトはfalseです。

プロパティ allowAutoExtendFilterRange - Excelのようにフィルター処理する範囲を自動拡張できるかどうか。デフォルトでfalseに設定されます。

プロパティ allowInvalidFormula - 無効な数式文字列の入力を許可するかどうか。デフォルトは false です。

プロパティ formulaFormatHint - 数式を入力する時に形式を自動的に生成するかどうか。デフォルトは true です。

プロパティ pivotAreaReference - ピボットテーブル領域を選択したときに、getPivotData 数式またはセル参照を自動的に生成するかどうかを指定します。デフォルトは getPivotData です。

実例

// var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:5,showHorizontalScrollbar:false});
var workbook = new GC.Spread.Sheets.Workbook("ss",{sheetCount:5,showHorizontalScrollbar:false});
workbook.options.allowUserDragDrop = false;
workbook.options.allowUserZoom = false;

sheets

• sheets: Worksheet[]

シートコレクションを表します。

touchToolStrip

• touchToolStrip: TouchToolStrip

タッチツールストリップを表します。

メソッド

addCustomFunction

▸ addCustomFunction(fn): void

カスタム関数を追加します。

パラメータ

名前	型	説明
`fn`	`Function`	追加する関数。

戻り値

void

addCustomName

▸ addCustomName(name, formula, baseRow, baseCol, comment?, isReadOnly?): void

カスタム名を追加します。

パラメータ

名前	型	説明
`name`	`string`	カスタム名前。
`formula`	`string`	数式
`baseRow`	`number`	行インデックス。
`baseCol`	`number`	列インデックス。
`comment?`	`string`	-
`isReadOnly?`	`boolean`	-

戻り値

void

addNamedStyle

▸ addNamedStyle(style): void

Workbookの名前付きスタイルコレクションにスタイルを追加します。

パラメータ

名前	型	説明
`style`	`Style`	追加するスタイル。

戻り値

void

addSheet

▸ addSheet(index, sheet?): void

指定したインデックスにシートを挿入します。

実例

// のサンプルコードは、スプレッドシートにシートを追加します。
spread.addSheet(0,new GC.Spread.Sheets.Worksheet("custom"));

パラメータ

名前	型	説明
`index`	`number`	シートを追加するインデックス。
`sheet?`	`Worksheet`	追加するシート。

戻り値

void

addSheetTab

▸ addSheetTab(index, name, type): any

特定のインデックスにシートタブを挿入します。

パラメータ

名前	型	説明
`index`	`number`	シートタブを追加するインデックス。
`name`	`string`	追加するシートタブの名前。
`type`	`SheetType`	追加するシートタブの種類。

戻り値

any

追加されたシートタブ。

addSparklineEx

▸ addSparklineEx(sparklineEx): void

SparklineExをSparklineExコレクションに追加します。

パラメータ

名前	型	説明
`sparklineEx`	`SparklineEx`	The SparklineEx to be added. window.MySparklineEx = function(color) { GC.Spread.Sheets.Sparklines.SparklineEx.apply(this, arguments); this.typeName = 'MySparklineEx'; this.color = color; } MySparklineEx.prototype = new GC.Spread.Sheets.Sparklines.SparklineEx(); MySparklineEx.prototype.createFunction = function () { var func = new GC.Spread.CalcEngine.Functions.Function('CIRCLE', 0, 0); func.evaluate = function (args) { return ; }; return func; }; MySparklineEx.prototype.paint = function (context, value, x, y, width, height) { context.beginPath(); context.arc(x + width / 2, y + height / 2, (Math.min(width, height) - 6) / 2, 0, Math.PI * 2); context.strokeStyle = this.color; context.stroke(); }; spread.addSparklineEx(new MySparklineEx('green'));

戻り値

void

bind

▸ bind(type, data?, fn?): void

イベントをWorkbookに連結します。

実例

// 次のサンプルコードは、イベントを関数に連結します。
sheet.setActiveCell(5,5);
alert(sheet.getActiveColumnIndex());
alert(sheet.getActiveRowIndex());
spread.bind(GC.Spread.Sheets.Events.EnterCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });
spread.bind(GC.Spread.Sheets.Events.LeaveCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });

パラメータ

名前	型	説明
`type`	`string`	イベントタイプ。
`data?`	`any`	関数に渡す追加データを指定します。
`fn?`	`Function`	イベントが発生したときに実行する関数を指定します。

戻り値

void

calculate

▸ calculate(type?, address?): void

再構築し、ダーティとしてマークし、ダーティとしてブロードキャストし、数式を再計算します。最初に再構築し、計算タイプによってアドレス内のダーティをマークします。次に、ダーティをブロードキャストすると、ワークブック内のダーティなセルの依存関係が再帰的にダーティに設定されます。自動モードでは、すべてのダーティなセルが計算されます。手動モードでは、アドレス内のセルのみが計算され、他のセルはダーティ状態を保持します。CalcServiceが一時停止されている場合、再計算はスキップされます。

実例

spread.sheets[0].setFormula(0,0,"RAND()");
spread.sheets[0].setFormula(1,0,"=Sheet2!A1");
spread.sheets[0].setFormula(2,0,"=1+2");
spread.sheets[1].setFormula(0,0,"RAND()");
spread.sheets[1].setFormula(1,0,"=Sheet1!A1");

// すべてのセルが再計算されます。
spread.calculate();
spread.calculate(GC.Spread.Sheets.CalculationType.regular);

// Sheet1!A1 と Sheet2!A2 は新しい数値に評価され、Sheet1!A2 と Sheet1!A3 は評価されます。
spread.calculate(GC.Spread.Sheets.CalculationType.all, "Sheet1");

// Sheet1!A1 と Sheet2!A2 は新しい数値に評価されます。
spread.calculate(GC.Spread.Sheets.CalculationType.regular, "Sheet1!A1");

// セルは評価されません。
spread.calculate(GC.Spread.Sheets.CalculationType.regular, "Sheet1!A2");

spread.options.calculationMode = GC.Spread.Sheets.CalculationMode.manual; // 手動モードに切り替えます。

// Sheet1!A1 が新しい値に計算され、Sheet1!A2 および Sheet1!A3 も計算されますが、変更されません。一方、Sheet2!A2 は手動モードでダーティな状態に設定されます。
spread.calculate(GC.Spread.Sheets.CalculationType.all, "Sheet1");

// Sheet1!A1 は新しい数値に評価され、Sheet2!A2 は手動モードでダーティな状態になります。
spread.calculate(GC.Spread.Sheets.CalculationType.regular, "Sheet1");

// Sheet2!A2は、ダーティであるため評価されます。
spread.calculate(GC.Spread.Sheets.CalculationType.minimal);

パラメータ

名前	型	説明
`type?`	`CalculationType`	再構築およびダーティとしてマークする計算タイプを定義します。
`address?`	`string`	ダーティとしてマークして計算するシートまたは範囲を指定します。省略した場合はワークブックになります。メモ：範囲外のダーティな依存関係は自動モードで計算されます。

戻り値

void

changeSheetIndex

▸ changeSheetIndex(sheetName, targetIndex): boolean

シートのインデックスを変更し、シートを並べ替えます。

実例

// 次のサンプルコードは、シートのインデックスを変更する方法を示します。
var spread = GC.Spread.Sheets.findControl(ss);
spread.setSheetCount(5); // シートの順序は、「Sheet1」、「Sheet2」、「Sheet3」、「Sheet4」、「Sheet5」である必要があります。
spread.changeSheetIndex("Sheet1", 3); // シートの順序は、「Sheet1」、「Sheet2」、「Sheet3」、「Sheet4」、「Sheet5」である必要があります。

パラメータ

名前	型	説明
`sheetName`	`string`	シート名。
`targetIndex`	`number`	対象インデックス。

戻り値

boolean

changeSheetPosition

▸ changeSheetPosition(sheetName, targetPosition): boolean

シートの位置を変更し、シートを並べ替えます。

実例

// 次のサンプルコードは、シートの位置を変更する方法を示します。
var spread = GC.Spread.Sheets.findControl(ss);
spread.setSheetCount(5);
spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet); // シートの順序は、「Sheet1」、「Sheet2」、「Sheet3」、「Sheet4」、「Sheet5」、「tableSheet1」である必要があります。
spread.changeSheetPosition("tableSheet1", 3); // シートの順序は、「Sheet1」、「Sheet2」、「Sheet3」、「tableSheet1」、「Sheet4」、「Sheet5」である必要があります。

パラメータ

名前	型	説明
`sheetName`	`string`	シート名。
`targetPosition`	`number`	ターゲット位置。

戻り値

boolean

clearCustomFunctions

▸ clearCustomFunctions(): void

すべてのカスタム関数をクリアします。

戻り値

void

clearCustomNames

▸ clearCustomNames(): void

カスタム名をクリアします。

戻り値

void

clearSheetTabs

▸ clearSheetTabs(): void

コントロール内のすべてのシートタブをクリアします。

戻り値

void

clearSheets

▸ clearSheets(): void

コントロールのすべてのシートをクリアします。

実例

// 次のサンプルコードは、clearSheetsメソッドを使用します。
spread.clearSheets();

戻り値

void

commandManager

▸ commandManager(): CommandManager

コマンドマネージャを取得します。

実例

// 次のサンプルコードは、指定したアクションを行うコマンドを実行します。
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineRow", sheetName: "Sheet1", index: 3, count: 5});

戻り値

CommandManager

コマンドマネージャ。

dataManager

▸ dataManager(): DataManager

データマネージャを取得します。

戻り値

DataManager

データマネージャを返します。

destroy

▸ destroy(): void

ワークブックと、ワークブックに含まれるすべてのシートを破棄します。

実例

// 次のサンプルコードは、ワークブックのインスタンスを破棄します。
spread.destroy();

戻り値

void

export

▸ export(successCallBack?, errorCallBack?, exportOptions?): void

オブジェクトの状態を Excel、ssjson または csv ファイルにエクスポートします。

実例

spread.export(function (blob) {
   // blob をファイルに保存します。
   saveAs(blob, fileName);
}, function (e) {
   console.log(e);
}, {
   fileType: GC.Spread.Sheets.FileType.excel,
   includeBindingSource: true
});

パラメータ

名前	型
`successCallBack?`	`Function`
`errorCallBack?`	`Function`
`exportOptions?`	`ExportOptions`

戻り値

void

focus

▸ focus(focusIn?): void

Workbookコンポーネントにフォーカスを設定するか、Workbookコンポーネントからフォーカスを移動します。

実例

// 次のサンプルコードは、Spreadコントロールにフォーカスを設定します。
$("#button1").click(function () {
spread.focus(true);
   });

パラメータ

名前	型	説明
`focusIn?`	`boolean`	Workbookコンポーネントからフォーカスを移動する場合は`false`。それ以外の場合はフォーカスが設定されます。

戻り値

void

fromJSON

▸ fromJSON(workbookData, deserializationOptions?): void

指定したJSON文字列からオブジェクト状態をロードします。

実例

// 次のサンプルコードは、fromJSONメソッドを使用します。
activeSheet.getCell(0,0).value(123);
var jsonStr = null;
// エクスポート
jsonStr = JSON.stringify(spread.toJSON());
// インポート
spread.fromJSON(JSON.parse(jsonStr));
alert(jsonStr);

パラメータ

名前	型	説明
`workbookData`	`Object`	逆シリアル化されたスプレッドシートデータ。
`deserializationOptions?`	`Object`	-

戻り値

void

getActiveSheet

▸ getActiveSheet(): Worksheet

アクティブシートを取得します。

戻り値

Worksheet

アクティブシートのインスタンス。

getActiveSheetIndex

▸ getActiveSheetIndex(): number

コントロールのアクティブシートのインデックスを取得します。

実例

// 次のサンプルコードは、getActiveSheetIndexメソッドを使用します。
var index = spread.getActiveSheetIndex();
alert(index);

戻り値

number

アクティブシートのインデックス。

getActiveSheetTab

▸ getActiveSheetTab(): any

アクティブシートタブを取得します。

戻り値

any

アクティブシートタブのインスタンス。

getActiveSheetTabIndex

▸ getActiveSheetTabIndex(): number

コントロールのアクティブなシートタブのインデックスを取得します。

戻り値

number

アクティブなシートタブのインデックス。

getCircularReference

▸ getCircularReference(): ICellsInfo[]

ワークブック内のすべての循環参照セル情報を取得します。

実例

spread.getCircularReference();

戻り値

ICellsInfo[]

循環参照セル情報のオブジェクトを返します。cellsInfo.row は、cellRangeの行インデックスを示します。 cellsInfo.col は、cellRange の列インデックスを示します。 cellsInfo.rowCount は、cellRangeの行数を示します。cellsInfo.colCount は、cellRange の列数を示します。cellsInfo.sheetName は、ワークシート名を示します。

getCustomFunction

▸ getCustomFunction(name): void

カスタム関数を取得します。

パラメータ

名前	型	説明
`name`	`string`	カスタム関数名。

戻り値

void

カスタム関数。

getCustomName

▸ getCustomName(name): NameInfo

指定したカスタム名の情報を取得します。

パラメータ

名前	型	説明
`name`	`string`	カスタム名前。

戻り値

NameInfo

指定したカスタム名の情報。

getCustomNames

▸ getCustomNames(): NameInfo[]

すべてのカスタム名の情報を取得します。

戻り値

NameInfo[]

配列に格納された型GC.Spread.Sheets.NameInfo。

getExternalReferences

▸ getExternalReferences(includeItemDetail?): IExternalReference[]

現在のワークブックのクロスワークブック参照のリストを取得します。

実例

// 次のサンプルコードは、使用されているデータソースを取得して更新します。
spread.getActiveSheet().setFormula(0, 0, "='[Jackson.xlsx]Sheet1'!B6+SUM('[Petrosky.xlsx]Sheet2'!B7:B8)");
spread.getExternalReferences().forEach(item=>{
     spread.updateExternalReference(item.name, spreadList[item.name], item.filePath);
])

パラメータ

名前	型	説明
`includeItemDetail?`	`boolean`	ターゲットセルとソース範囲を含めるかどうかを指定します。デフォルト値は false です。

戻り値

IExternalReference[]

外部リファレンスの配列。
externalReference.name クロスワークブック参照のファイル名。
externalReference.filePath クロスワークブック参照のファイルパス。

getHost

▸ getHost(): HTMLElement

現在のWorkbookインスタンスのホスト要素を取得します。

戻り値

HTMLElement

現在のWorkbookインスタンスのホスト要素。

getNamedStyle

▸ getNamedStyle(name): Style

Workbookの名前付きスタイルコレクションから指定した名前を持つスタイルを取得します。

パラメータ

名前	型	説明
`name`	`string`	取得するスタイルの名前。

戻り値

Style

指定した名前付きスタイルを返します。

getNamedStyles

▸ getNamedStyles(): Style[]

Workbookから名前付きスタイルを取得します。

戻り値

Style[]

名前付きスタイルを含むGC.Spread.Sheets.Styleの配列。

getSheet

▸ getSheet(index): Worksheet

指定したシートを取得します。

実例

// 次のサンプルコードは、シートを取得してセルの前景色を設定します。
var sheet1 = spread.getSheet(1);
sheet1.getCell(0,0).value("A1").foreColor("red");

パラメータ

名前	型	説明
`index`	`number`	取得するシートのインデックス。

戻り値

Worksheet

指定したシート。

getSheetCount

▸ getSheetCount(): number

シートの数を取得します。

実例

// 次のサンプルコードは、getSheetCountメソッドを使用します。
var index = spread.getSheetCount();
alert(index);

戻り値

number

シートの数。

getSheetFromName

▸ getSheetFromName(name): Worksheet

指定した名前を持つシートを取得します。

実例

// 次のサンプルコードは、シートを取得してセルの前景色を設定します。
var sheet1 = spread.getSheetFromName("Sheet2");
sheet1.getCell(0,0).value("A1").foreColor("red");

パラメータ

名前	型	説明
`name`	`string`	シート名。

戻り値

Worksheet

指定した名前を持つシート。

getSheetIndex

▸ getSheetIndex(name): number

指定した名前を持つシートのインデックスを取得します。

実例

// 次のサンプルコードは、getSheetIndexメソッドを使用します。
spread.setSheetCount(5);
var index = spread.getSheetIndex("Sheet2");
alert(index); // 1

パラメータ

名前	型	説明
`name`	`string`	シート名。

戻り値

number

Worksheet コレクションに基づくシートインデックス。

getSheetPosition

▸ getSheetPosition(name): number

指定された名前でシートタブの位置を取得します。

実例

//　次のサンプルコードは、getSheetPosition メソッドを使用します。
spread.setSheetCount(5);
spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
var position = spread.getSheetPosition("tableSheet1");
alert(position); // 5

パラメータ

名前	型	説明
`name`	`string`	シートタブの名前。

戻り値

number

Worksheet とTableSheet コレクションに基づくシートタブの位置。

getSheetTab

▸ getSheetTab(indexOrName): any

指定されたシートタブをインデックスまたは名前で取得します。

パラメータ

名前	型	説明
`indexOrName`	`string` \| `number`	返すシートタブのインデックスまたは名前。

戻り値

any

指定したシートタブ。

getSheetTabCount

▸ getSheetTabCount(): number

シートタブの数を取得します。

戻り値

number

シートタブの数。

getSheetTabIndex

▸ getSheetTabIndex(name): number

指定された名前でシートタブのインデックスを取得します。

実例

//　次のサンプルコードは、getSheetTabIndex メソッドを使用します。
spread.setSheetCount(5);
spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
var index = spread.getSheetTabIndex("tableSheet1");
alert(index); // 0

パラメータ

名前	型	説明
`name`	`string`	シートタブの名前。

戻り値

number

TabSheet コレクションに基づくシートタブのインデックス。

hitTest

▸ hitTest(x, y): IWorkbookHitTestInformation

ヒットテストを実行します。

実例

// 次のサンプルコードは、hitTestメソッドを使用します。
      window.onload = function(){
          var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
          var activeSheet = spread.getActiveSheet();
          $("#ss").click(function (e) {
              // マウスでクリックされた通常セル（固定行/列でも行/列ヘッダでもないセル）の位置からセルインデックスを取得します。
              var offset = $("#ss").offset();
              var x = e.pageX - offset.left;
              var y = e.pageY - offset.top;
              var target = spread.hitTest(x, y);
              if(target.worksheetHitInfo) {
                  if(target.worksheetHitInfo.hitTestType === 0) {
                      str = 'corner';
                  } else if (target.worksheetHitInfo.hitTestType === 1) {
                      str = 'colHeader';
                  } else if (target.worksheetHitInfo.hitTestType === 2) {
                      str = 'rowHeader';
                  } else {
                      str = 'viewport';
                  }
              } else if(target.tabStripHitInfo) {
                  if(target.tabStripHitInfo.navButton){
                      str = target.tabStripHitInfo.navButton;
                  } else if(target.tabStripHitInfo.sheetTab) {
                      str = target.tabStripHitInfo.sheetTab.sheetName;
                  } else if(target.tabStripHitInfo.resize === true) {
                      str = "resize";
                  } else {
                      str = "blank";
                  }
              } else if(target.horizontalScrollBarHitInfo) {
                  str = target.horizontalScrollBarHitInfo.element;
              } else if(target.verticalScrollBarHitInfo) {
                  str = target.verticalScrollBarHitInfo.element;
              } else if(target.footerCornerHitInfo) {
                  str = target.footerCornerHitInfo.element;
              }
        alert(str);
});
}

パラメータ

名前	型	説明
`x`	`number`	Spreadの水平軸方向の<i>x</i>座標。
`y`	`number`	Spreadの垂直軸方向の<i>y</i>座標。

戻り値

IWorkbookHitTestInformation

ヒットテスト情報。ワークシートが選択されている場合は、ワークシート情報が返されます。この情報には、x、y、およびworksheetHitInfoが含まれます。シートタブストリップが選択されている場合は、シートタブストリップ情報が返されます。この情報には、x、y、およびtabStripHitInfoが含まれます。水平スクロールバーが選択されている場合は、水平スクロールバー情報が返されます。この情報には、x、y、およびhorizontalScrollBarHitInfoが含まれます。垂直スクロールバーが選択されている場合は、垂直スクロールバー情報が返されます。この情報には、x、y、およびverticalScrollBarHitInfoが含まれます。フッタコーナーが選択されている場合は、フッタコーナー情報が返されます。この情報には、x、y、およびfooterCornerHitInfoが含まれます。

import

▸ import(file, successCallback?, errorCallback?, importOptions?): void

オブジェクトの状態を Excel、ssjson または csv ファイルからインポートします。

実例

// 次のサンプルコードは、importメソッドを使用します。
// blob を取得します。
var file = document.getElementById("importFileName").files[0];
// インポート
spread.import(file, function () {
   // successCallback
}, function (e) {
   console.log(e); // errorCallback
}, {
   fileType: GC.Spread.Sheets.FileType.excel
});

パラメータ

名前	型	説明
`file`	`File`	インポート用の ssjson、csv、Excel、または JavaScript ファイル。
`successCallback?`	`Function`	-
`errorCallback?`	`Function`	-
`importOptions?`	`ImportOptions`	-

戻り値

void

invalidateLayout

▸ invalidateLayout(): void

コントロールレイアウト情報を更新します。

実例

// 次のサンプルコードは、レイアウトを更新します。
spread.invalidateLayout();
spread.repaint();

戻り値

void

isPaintSuspended

▸ isPaintSuspended(): boolean

描画が一時停止されているかどうかを取得します。

戻り値

boolean

nextControl

▸ nextControl(value?): any

GC.Spread.Sheets.Actions.selectNextControlおよびGC.Spread.Sheets.Actions.moveToNextCellThenControlによって使用される次のコントロールを取得または設定します。

パラメータ

名前	型	説明
`value?`	`HTMLElement`	次のコントロール。このコントロールはfocusメソッドを持つ必要があります。

戻り値

any

値が設定されていない場合は、次のコントロールを返します。値が設定されている場合は、スプレッドシートを返します。

open

▸ open(file, successCallback?, errorCallback?, openOptions?): void

sjs 圧縮したファイルからオブジェクト状態をロードします。

実例

// 次のサンプルコードは、openメソッドを使用します。
// blob を取得します。
var file = document.getElementById("importFileName").files[0];
// インポート
spread.open(file, function () {
   // successCallback
}, function (e) {
 console.log(e); // errorCallback
}, { openMode: GC.Spread.Sheets.OpenMode.lazy });

パラメータ

名前	型	説明
`file`	`File`	圧縮されたスプレッドシートのデータファイル。
`successCallback?`	`Function`	-
`errorCallback?`	`Function`	-
`openOptions?`	`OpenOptions`	-

戻り値

void

pageInfo

▸ pageInfo(sheetIndex?): any

シートのページ情報を取得します。

実例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
spread.suspendPaint();
var sheet = spread.getActiveSheet();
for(var i=0;i<20;i++){
   for(var j=0;j<20;j++){
       sheet.setValue(i,j,"Row"+i+"_Column"+j);
   }
}
var pageInfos =  spread.pageInfo(0);
console.table(pageInfos.pages);

パラメータ

名前	型	説明
`sheetIndex?`	`number`	シートインデックス。

戻り値

any

シートのページ情報を返します。シートインデックスが無視される場合、すべてのシートのページ情報を配列で返します。

previousControl

▸ previousControl(value?): any

GC.Spread.Sheets.Actions.selectPreviousControlおよびGC.Spread.Sheets.Actions.moveToPreviousCellThenControlによって使用される前のコントロールを取得または設定します。

パラメータ

名前	型	説明
`value?`	`HTMLElement`	前のコントロール。このコントロールはfocusメソッドを持つ必要があります。

戻り値

any

値が設定されていない場合は、前のコントロールを返します。値が設定されている場合は、スプレッドシートを返します。

print

▸ print(sheetIndex?): void

指定したシートを印刷します。

パラメータ

名前	型	説明
`sheetIndex?`	`number`	シートインデックス。シートインデックスが無視された場合は、表示可能に設定されたすべてのシートが印刷されます。

戻り値

void

refresh

▸ refresh(): void

Workbookオブジェクトのレイアウトとレンダリングを手動で更新します。

実例

// 次のサンプルコードは、refreshメソッドを使用します。
spread.refresh();

戻り値

void

removeCustomFunction

▸ removeCustomFunction(name): void

カスタム関数を削除します。

パラメータ

名前	型	説明
`name`	`string`	カスタム関数名。

戻り値

void

removeCustomName

▸ removeCustomName(name): void

指定したカスタム名を削除します。

実例

// 次のサンプルコードは、removeCustomNameメソッドを使用します。
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
spread.addCustomName("customName1","=12", 0, 0);
activeSheet.setFormula(1, 0, "customName1");
//spread.removeCustomName("customName1");

パラメータ

名前	型	説明
`name`	`string`	カスタム名前。

戻り値

void

removeNamedStyle

▸ removeNamedStyle(name): void

Workbookの名前付きスタイルコレクションから指定した名前を持つスタイルを削除します。

実例

var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
spread.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // cell(1,1) の backColor は緑です。
activeSheet.setStyleName(2, 1, "style1");
var style = spread.getNamedStyle("style1");
style.foreColor = "red";    //  このnamedStyleのforeColorは赤です。
activeSheet.repaint(); // cell(1,1)およびcell(2,1)の前景色は赤です。
activeSheet.getCell(1,1).value("test");
$("#button1").click(function () {
     spread.removeNamedStyle("style1");
});

パラメータ

名前	型	説明
`name`	`string`	削除するスタイルの名前。

戻り値

void

removeSheet

▸ removeSheet(index): void

指定したシートを削除します。

実例

//　次のサンプルコードは、スプレッドシートからシートを削除します。
spread.setSheetCount(5);
spread.removeSheet(0);

パラメータ

名前	型	説明
`index`	`number`	削除するシートのインデックス。

戻り値

void

removeSheetTab

▸ removeSheetTab(indexOrName): void

指定されたシートタブをインデックスまたは名前で削除します。

パラメータ

名前	型	説明
`indexOrName`	`string` \| `number`	削除するシートタブのインデックスまたは名前。

戻り値

void

removeSparklineEx

▸ removeSparklineEx(name): void

SparklineExコレクションからSparklineExを削除します。

パラメータ

名前	型	説明
`name`	`string`	削除するSparklineExの名前。

戻り値

void

repaint

▸ repaint(): void

Workbookコントロールを再描画します。

実例

// 次のサンプルコードは、レイアウトを更新します。
spread.invalidateLayout();
spread.repaint();

戻り値

void

resumeCalcService

▸ resumeCalcService(recalcAll?): void

計算サービスを再開します。

実例

// 次のサンプルコードは、resumeCalcServiceメソッドを使用します。
spread.suspendCalcService(false);
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
spread.resumeCalcService(true);

パラメータ

名前	型	説明
`recalcAll?`	`boolean`	すべての数式を再計算するかどうかを指定します。

戻り値

void

resumeEvent

▸ resumeEvent(): void

イベントを再開します。

実例

//　次のサンプルコードは、イベントを一時停止して再開します。
 activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
spread.suspendEvent();
activeSheet.setValue(0, 0, "111");
spread.resumeEvent();
activeSheet.setValue(1, 1, "222");

戻り値

void

resumePaint

▸ resumePaint(): void

アクティブなシートとタブストリップの描画を再開します。

戻り値

void

save

▸ save(successCallBack?, errorCallBack?, saveOptions?): void

SpreadJS の状態を sjs ファイルに保存します。

実例

spread.save(function (blob) {
   // blob をファイルに保存します。
   saveAs(blob, fileName);
}, function (e) {
   console.log(e);
}, { includeUnusedNames: false });

パラメータ

名前	型	説明
`successCallBack?`	`Function`	SpreadJS 状態の保存が完了したときの成功コールバック。引数として Blob を受け入れます。
`errorCallBack?`	`Function`	SpreadJS の状態の保存が完了したときのエラーコールバックでエラーが発生しました。
`saveOptions?`	`SaveOptions`	保存オプション。

戻り値

void

savePDF

▸ savePDF(successCallback, errorCallback, options?, sheetIndex?): void

指定したシートをPDFにエクスポートします。

パラメータ

名前	型	説明
`successCallback`	`Function`	この関数は、エクスポートが成功した後に呼び出されます。function (blob)
`errorCallback`	`Function`	この関数は、エラーが発生した場合に呼び出されます。例外パラメータオブジェクトの構造は、{ errorCode: GC.Spread.Sheets.PDF.ErrorCode, errorMessage: string}です。
`options?`	`Object`	-
`sheetIndex?`	`number`	シートインデックス。シートインデックスが無視された場合は、表示可能に設定されたすべてのシートがエクスポートされます。

戻り値

void

search

▸ search(searchCondition): SearchResult

指定した検索基準で指定したシートのセル内のテキストから指定した検索文字列を検索します。

実例

// 次のサンプルコードは、指定した検索条件を使用してアクティブシートを検索します。
activeSheet.getCell(2,3).value("testSearch");
var searchCondition = new GC.Spread.Sheets.Search.SearchCondition();
searchCondition.searchString = "testSearch";
searchCondition.startSheetIndex = spread.getActiveSheetIndex();
searchCondition.endSheetIndex = spread.getActiveSheetIndex();
searchCondition.searchOrder = GC.Spread.Sheets.Search.SearchOrder.nOrder;
searchCondition.searchTarget = GC.Spread.Sheets.Search.SearchFoundFlags.cellText;
searchCondition.searchFlags = GC.Spread.Sheets.Search.SearchFlags.ignoreCase| GC.Spread.Sheets.Search.SearchFlags.useWildCards;
var searchresult= spread.search(searchCondition);
var str ="[searchFoundFlag:"+ searchresult.searchFoundFlag+",\r\n foundSheetIndex:"+searchresult.foundSheetIndex+",foundRowIndex:" +
searchresult.foundRowIndex+", foundColumnIndex:"+searchresult.foundColumnIndex+", foundString:"+searchresult.foundSheetIndex+"]";
alert(str);

パラメータ

名前	型	説明
`searchCondition`	`SearchCondition`	検索条件。

戻り値

SearchResult

検索結果。

setActiveSheet

▸ setActiveSheet(name): void

アクティブシートを名前によって設定します。

実例

// 次のサンプルコードは、アクティブシートを設定します。
spread.setSheetCount(3);
spread.setActiveSheet("Sheet2");

パラメータ

名前	型	説明
`name`	`string`	アクティブシートにするシートの名前。

戻り値

void

setActiveSheetIndex

▸ setActiveSheetIndex(value): void

コントロールのアクティブシートのインデックスを設定します。

実例

// 次のサンプルコードは、setActiveSheetIndexメソッドを使用します。
spread.setActiveSheetIndex(1);

パラメータ

名前	型	説明
`value`	`number`	アクティブシートのインデックス。

戻り値

void

setActiveSheetTab

▸ setActiveSheetTab(indexOrName): void

アクティブなシートタブをインデックスまたは名前で設定します。

パラメータ

名前	型	説明
`indexOrName`	`string` \| `number`	アクティブなシートタブを作成するためのシートタブのインデックスまたは名前。

戻り値

void

setSheetCount

▸ setSheetCount(count): void

シートの数を設定します。

実例

spread.setSheetCount(5);

パラメータ

名前	型	説明
`count`	`number`	シートの数。

戻り値

void

startSheetIndex

▸ startSheetIndex(value?): any

スプレッドシートに表示する最初のシートのインデックスを取得または設定します。

パラメータ

名前	型	説明
`value?`	`number`	スプレッドシートに表示する最初のシートのインデックス。

戻り値

any

値が設定されていない場合は、スプレッドシートに表示する最初のシートのインデックスを返します。値が設定されている場合は、スプレッドシートを返します。

suspendCalcService

▸ suspendCalcService(ignoreDirty?): void

計算サービスを中断します。

実例

// 次のサンプルコードは、suspendCalcServiceメソッドを使用します。
spread.suspendCalcService(false);
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
spread.resumeCalcService(true);

パラメータ

名前	型	説明
`ignoreDirty?`	`boolean`	依存セルを無効にするかどうかを指定します。

戻り値

void

suspendEvent

▸ suspendEvent(): void

イベントを中断します。

実例

//　次のサンプルコードは、イベントを一時停止して再開します。
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
spread.suspendEvent();
activeSheet.setValue(0, 0, "111");
spread.resumeEvent();
activeSheet.setValue(1, 1, "222");

戻り値

void

suspendPaint

▸ suspendPaint(): void

アクティブなシートとタブストリップの描画を中断します。

戻り値

void

toJSON

▸ toJSON(serializationOption?): Object

オブジェクト状態をJSON文字列に保存します。

実例

activeSheet.getCell(0,0).value(123);
var jsonStr = null;
// エクスポート
jsonStr = JSON.stringify(spread.toJSON());
// インポート
spread.fromJSON(JSON.parse(jsonStr));
alert(jsonStr);

パラメータ

名前	型	説明
`serializationOption?`	`Object`	シリアル化のオプション。

戻り値

Object

unbind

▸ unbind(type, fn?): void

Workbookへのイベントの連結を解除します。

実例

// 次のサンプルコードは、イベントの連結を解除します。
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.setValue(0, 0, "111");
spread.unbind(GC.Spread.Sheets.Events.CellChanged);
//spread.unbindAll(); //すべてのイベントの監視をキャンセルします。
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

パラメータ

名前	型	説明
`type`	`string`	イベントタイプ。
`fn?`	`Function`	イベントが発生したときに実行する関数を指定します。

戻り値

void

unbindAll

▸ unbindAll(): void

Workbookへのすべてのイベントの連結を解除します。

実例

// 次のサンプルコードは、イベントの連結を解除します。すべてのイベント連結を解除する場合は、unbindAllメソッドのコメントを外してください。
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.setValue(0, 0, "111");
spread.unbind(GC.Spread.Sheets.Events.CellChanged);
//spread.unbindAll(); //すべてのイベントの監視をキャンセルします。
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

戻り値

void

undoManager

▸ undoManager(): UndoManager

アンドゥマネージャを取得します。

戻り値

UndoManager

アンドゥマネージャ。

updateExternalReference

▸ updateExternalReference(linkInfo, data?, filePath?): void

ワークブックのJSON または GC.Spread.Sheets.IO.getPartialValues の successCallback 結果からの外部値を使用して、外部ソースのデータを設定または更新します。

実例

// 次のサンプルコードは、ワークブックJSONを使用して外部ソースを設定します。
spread.getActiveSheet().setFormula(0, 0, "[calc.xlsx]Sheet1!A1");  // spreadセルのA1値は#REF!です。
spread2.getActiveSheet().setFormula(0, 0, "=123+1"); \xa0// spread2セルのA1値は124です。
spread.updateExternalReference("calc.xlsx", spread2.toJSON());  // spreadセルA1の値は124です。
// 単純なJSONデータでデータを設定します。
spread.getActiveSheet().setFormula(0, 0, "=SUM([calc.xlsx]Sheet1!A1:B2"); \xa0// spreadセルのA1値は#REF!です。
spread.updateExternalReference("calc.xlsx", {"Sheet1":[[1, 2],[1, 3]]}); \xa0// spreadセルA1の値は7です。
spread.updateExternalReference("calc.xlsx", {"Sheet1":{0:{0:10, 1:10}, 1:{0:10, 1:10}}}); \xa0// spread セルA1の値は40です。
// 次のサンプルコードは、GC.Spread.Sheets.IO.getPartialValues の successCallback の結果を使用して外部値を設定します。
let refList = spread.getExternalReferences(true);
GC.Spread.Sheets.IO.getPartialValues(refList, getFile, (externalValues) => {
  // successCallback
  spread.updateExternalReference(externalValues);
}, (errorMsg) => {
  // errorCallback
  console.log(errorMsg);
});

パラメータ

名前	型	説明
`linkInfo`	`string` \| `ExternalPartialValues`	文字列型は外部ソースのファイル名で、ほとんどが「.xlsx」で終わります。別の型は、GC.Spread.Sheets.IO.getPartialValues のコールバックから取得した外部部分値の配列である必要があります。
`data?`	`object`	-
`filePath?`	`string`	-

戻り値

void

GC.Spread.Sheets.Workbook

クラス: Workbook

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

パラメータ

プロパティ

contextMenu

name

options

sheets

touchToolStrip

メソッド

addCustomFunction

パラメータ

戻り値

addCustomName

パラメータ

戻り値

addNamedStyle

パラメータ

戻り値

addSheet

パラメータ

戻り値

addSheetTab

パラメータ

戻り値

addSparklineEx

パラメータ

戻り値

bind

パラメータ

戻り値

calculate

パラメータ

戻り値

changeSheetIndex

パラメータ

戻り値

changeSheetPosition

パラメータ

戻り値

clearCustomFunctions

戻り値

clearCustomNames

戻り値

clearSheetTabs

戻り値

clearSheets

戻り値

commandManager

戻り値

dataManager

戻り値

destroy

戻り値

export

パラメータ

戻り値

focus

パラメータ

戻り値

fromJSON

パラメータ

戻り値

getActiveSheet

戻り値

getActiveSheetIndex

戻り値

getActiveSheetTab

戻り値

getActiveSheetTabIndex

戻り値

getCircularReference

戻り値

getCustomFunction