SpreadJS製品ヘルプ
Workbook タイプ
GC.Spread.Sheets 名前空間 : Workbook タイプ
指定したホストDOM要素やDOM IDとオプション設定を持つスプレッドシートを表します。
シンタックス
var instance = new GC.Spread.Sheets.Workbook(host,
                                            options,
                                            options.sheetCount,
                                            options.font,
                                            options.allowUserDragMerge,
                                            options.allowUserDragDrop,
                                            options.allowUserDragFill,
                                            options.allowUserZoom,
                                            options.allowUserResize,
                                            options.allowUndo,
                                            options.allowSheetReorder,
                                            options.allowContextMenu,
                                            options.allowUserDeselect,
                                            options.defaultDragFillType,
                                            options.showDragFillSmartTag,
                                            options.showHorizontalScrollbar,
                                            options.showVerticalScrollbar,
                                            options.scrollbarShowMax,
                                            options.scrollbarMaxAlign,
                                            options.tabStripVisible,
                                            options.tabStripRatio,
                                            options.tabEditable,
                                            options.newTabVisible,
                                            options.allSheetsListVisible,
                                            options.tabNavigationVisible,
                                            options.cutCopyIndicatorVisible,
                                            options.cutCopyIndicatorBorderColor,
                                            options.backColor,
                                            options.backgroundImage,
                                            options.backgroundImageLayout,
                                            options.grayAreaBackColor,
                                            options.showResizeTip,
                                            options.showDragDropTip,
                                            options.showDragFillTip,
                                            options.showScrollTip,
                                            options.scrollIgnoreHidden,
                                            options.highlightInvalidData,
                                            options.useTouchLayout,
                                            options.hideSelection,
                                            options.resizeZeroIndicator,
                                            options.allowUserEditFormula,
                                            options.enableFormulaTextbox,
                                            options.autoFitType,
                                            options.referenceStyle,
                                            options.calcOnDemand,
                                            options.allowCopyPasteExcelStyle,
                                            options.allowExtendPasteRange,
                                            options.copyPasteHeaderOptions,
                                            options.scrollByPixel,
                                            options.scrollPixel,
                                            options.enableAccessibility,
                                            options.allowAutoCreateHyperlink,
                                            options.columnResizeMode,
                                            options.rowResizeMode,
                                            options.customList,
                                            options.scrollbarAppearance,
                                            options.pasteSkipInvisibleRange,
                                            options.allowAutoExtendFilterRange);
function Workbook;
使用例
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});
解説

次の表にWorkbookオプションの一覧を示します。

名前 説明
allowUserDragMerge boolean ユーザーがセルをドラッグしてマージできるかどうか(オプション)。
allowUserDragDrop boolean ユーザーが範囲データをドラッグ&ドロップできるかどうかを指定します(オプション)。
allowUserDragFill boolean ユーザーが範囲をドラッグフィルできるかどうかを指定します(オプション)。
allowUserZoom boolean [Ctrl]キーを押しながらマウスホイールを回すことによって表示をズームできるかどうかを指定します(オプション)。
allowUserResize boolean ユーザーが行および列のサイズを変更できるかどうかを指定します(オプション)。
allowUndo boolean ユーザーが編集をアンドゥできるかどうかを指定します(オプション)。
allowSheetReorder boolean ユーザーがSpreadコンポーネントのシートの順序を変更できるかどうかを指定します(オプション)。
allowContextMenu boolean ユーザーが組み込みのコンテキストメニューを開くことができるかどうか(オプション)。
allowCopyPasteExcelStyle boolean ユーザーがSpread.SheetsのスタイルをコピーしてExcelに貼り付ける、またはExcelのスタイルをコピーしてSpread.Sheetsに貼り付けることができるかどうかを指定します(オプション)。
allowExtendPasteRange boolean 貼り付け範囲が足りない場合に貼り付け範囲を拡張するかどうかを指定します(オプション)。
copyPasteHeaderOptions GC.Spread.Sheets.CopyPasteHeaderOptions データをコピーまたは貼り付けるときに含めるヘッダを指定します(オプション)。
defaultDragFillType GC.Spread.Sheets.Fill.AutoFillType デフォルトのフィルタイプ(オプション)。
showDragFillSmartTag boolean ドラッグフィルダイアログを表示するかどうかを指定します(オプション)。
showHorizontalScrollbar boolean 水平スクロールバーを表示するかどうかを指定します(オプション)。
showVerticalScrollbar boolean 垂直スクロールバーを表示するかどうかを指定します(オプション)。
scrollbarShowMax boolean 表示されるスクロールバーがシートの全体の列数と行数に基づくかどうかを指定します(オプション)。
scrollbarMaxAlign boolean スクロールバーがアクティブシートの最後の行および列に揃うかどうかを指定します(オプション)。
tabStripVisible boolean シートタブストリップを表示するかどうかを指定します(オプション)。
tabStripRatio number 水平スクロールバーの幅全体に対する割合として表されたタブストリップの幅(オプション)。
tabEditable boolean ユーザーがシートタブストリップを編集できるかどうかを指定します(オプション)。
newTabVisible boolean ユーザーが新しいシートを挿入するための特殊なタブをスプレッドシートに表示するかどうかを指定します(オプション)。
tabNavigationVisible boolean シートタブナビゲーションを表示するかどうかを指定します(オプション)。
cutCopyIndicatorVisible boolean 選択した項目をコピーまたは切り取るときにインジケーターを表示するかどうかを指定します(オプション)。
cutCopyIndicatorBorderColor string ユーザーが選択した項目をコピーまたは切り取るときに表示されるインジケーターの境界線の色(オプション)。
backColor string Spreadコンポーネントの背景色を表す色文字列(オプション)。"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など。
backgroundImage string Spreadコンポーネントの背景画像(オプション)。
backgroundImageLayout GC.Spread.Sheets.ImageLayout Spreadコンポーネントの背景画像レイアウト(オプション)。
grayAreaBackColor string 灰色領域の背景色を表す色文字列(オプション)。"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など。
showResizeTip GC.Spread.Sheets.ShowResizeTip サイズ変更チップの表示方法を指定します(オプション)。
showDragDropTip boolean ドラッグ&ドロップチップを表示するかどうかを指定します(オプション)。
showDragFillTip boolean ドラッグフィルチップを表示するかどうかを指定します(オプション)。
showScrollTip GC.Spread.Sheets.ShowScrollTip スクロールチップの表示方法を指定します(オプション)。
scrollIgnoreHidden boolean スクロールバーが非表示の行または列を無視するかどうかを指定します(オプション)。
highlightInvalidData boolean 無効なデータを強調表示するかどうかを指定します(オプション)。
useTouchLayout boolean Spreadコンポーネントを表示するためにタッチレイアウトを使用するかどうかを指定します(オプション)。
hideSelection boolean Spreadコンポーネントがフォーカスを持たないときに選択範囲をハイライト表示するかどうかを指定します(オプション)。
resizeZeroIndicator GC.Spread.Sheets.ResizeZeroIndicator 行または列のサイズがゼロに変更されたときの描画ポリシー(オプション)。
allowUserEditFormula boolean ユーザーがスプレッドシートのセルに設定された数式を編集できるかどうかを指定します(オプション)。
enableFormulaTextbox boolean スプレッドシートで数式テキストボックスを有効にするかどうかを指定します(オプション)。
autoFitType GC.Spread.Sheets.AutoFitType セル内またはセルおよびヘッダ内に収まるように内容を書式設定するかどうかを指定します(オプション)。
referenceStyle GC.Spread.Sheets.ReferenceStyle このシート上のセル数式でのセルおよび範囲参照のスタイル(オプション)。
rowResizeMode GC.Spread.Sheets.ResizeMode 行のサイズを変更する方法を指定します(オプション)。
columnResizeMode GC.Spread.Sheets.ResizeMode 列のサイズを変更する方法を指定します(オプション)。
scrollByPixel boolean ピクセル単位による正確なスクロールを有効にするかどうかを指定します(オプション)。
scrollPixel number scrollByPixelがtrueの場合に、一度にスクロールするピクセルの数を決定します。 最終的なスクロール量は、スクロールデルタとscrollPixelの乗算結果になります。 たとえば、スクロールデルタが3、scrollPixelが5の場合、スクロール量は15ピクセルになります。
customList array ユーザーがドラッグアンドフィルをカスタマイズするためのリスト。各フィル処理でこのリストが優先されます。 各配列型項目は、文字列配列です。
calcOnDemand boolean 数式が要求されたときにのみ計算するかどうかを指定します(オプション)。
font string タブストリップのフォント。
allowUserDeselect boolean ユーザーが選択範囲内の選択を解除できるかどうかを指定します(オプション)。
sheetCount number シートの数。
allowAutoCreateHyperlink boolean シートでハイパーリンクの自動作成を有効にするかどうかを指定します。
scrollbarAppearance GC.Spread.Sheets.ScrollbarAppearance skinとmobileの2つの列挙型を含むスクロールバーの外観。 デフォルトはスキンです。
allowDynamicArray boolean 動的配列を有効にするかどうかを指定します(オプション)。
enableAccessibility boolean スプレッドシートでアクセシビリティサポートを有効にするかどうかを指定します。
iterativeCalculation boolean 反復計算を有効にするかどうかを指定します。
iterativeCalculationMaximumIterations number 反復計算時の最大反復。
iterativeCalculationMaximumChange number 反復計算時の最大変更。
pasteSkipInvisibleRange boolean 非表示の範囲を貼り付けるかスキップするか。 デフォルトはfalseです。
allowAutoExtendFilterRange boolean Excelのようにフィルター処理する範囲を自動拡張できるかどうか。 デフォルトでfalseに設定されます。
継承階層

Object
   GC.Spread.Sheets.Workbook

コンストラクタ
 名前解説
public コンストラクタ指定したホストDOM要素やDOM IDとオプション設定を持つスプレッドシートを表します。  
トップ
フィールド
 名前解説
public フィールドContextMenu for the spread.  
public フィールドSpreadコントロールの名前を表します。  
public フィールドSpreadコントロールのオプションを表します。  
public フィールドシートコレクションを表します。  
public フィールドタッチツールストリップを表します。  
トップ
メソッド
 名前解説
public メソッドカスタム関数を追加します。  
public メソッドカスタム名を追加します。  
public メソッドWorkbookの名前付きスタイルコレクションにスタイルを追加します。  
public メソッド指定したインデックスにシートを挿入します。  
public メソッド特定のインデックスにシートタブを挿入します。  
public メソッドSparklineExをSparklineExコレクションに追加します。  
public メソッドイベントをWorkbookに連結します。  
public メソッドシートのインデックスを変更し、シートを並べ替えます。  
public メソッドすべてのカスタム関数をクリアします。  
public メソッドカスタム名をクリアします。  
public メソッドコントロールのすべてのシートをクリアします。  
public メソッドコントロール内のすべてのシートタブをクリアします。  
public メソッドコマンドマネージャを取得します。  
public メソッドデータマネージャを取得します。  
public メソッドワークブックと、ワークブックに含まれるすべてのシートを破棄します。  
public メソッドWorkbookコンポーネントにフォーカスを設定するか、Workbookコンポーネントからフォーカスを移動します。  
public メソッド指定したJSON文字列からオブジェクト状態をロードします。  
public メソッドアクティブシートを取得します。  
public メソッドコントロールのアクティブシートのインデックスを取得します。  
public メソッドアクティブシートタブを取得します。  
public メソッドコントロールのアクティブなシートタブのインデックスを取得します。  
public メソッドワークブック内のすべての循環参照セル情報を取得します。  
public メソッドカスタム関数を取得します。  
public メソッド指定したカスタム名の情報を取得します。  
public メソッドすべてのカスタム名の情報を取得します。  
public メソッド現在のワークブックのクロスワークブック参照のリストを取得します。  
public メソッド現在のWorkbookインスタンスのホスト要素を取得します。  
public メソッドWorkbookの名前付きスタイルコレクションから指定した名前を持つスタイルを取得します。  
public メソッドWorkbookから名前付きスタイルを取得します。  
public メソッド指定したシートを取得します。  
public メソッドシートの数を取得します。  
public メソッド指定した名前を持つシートを取得します。  
public メソッド指定した名前を持つシートのインデックスを取得します。  
public メソッド指定されたシートタブをインデックスまたは名前で取得します。  
public メソッドシートタブの数を取得します。  
public メソッド指定された名前でシートタブのインデックスを取得します。  
public メソッドヒット テストを実行します。  
public メソッドコントロールレイアウト情報を更新します。  
public メソッド描画が一時停止されているかどうかを取得します。  
public メソッドGC.Spread.Sheets.Actions.selectNextControlおよびGC.Spread.Sheets.Actions.moveToNextCellThenControlによって使用される次のコントロールを取得または設定します。  
public メソッド  
public メソッドGC.Spread.Sheets.Actions.selectPreviousControlおよびGC.Spread.Sheets.Actions.moveToPreviousCellThenControlによって使用される前のコントロールを取得または設定します。  
public メソッド指定したシートを印刷します。  
public メソッドWorkbookオブジェクトのレイアウトとレンダリングを手動で更新します。  
public メソッドカスタム関数を削除します。  
public メソッド指定したカスタム名を削除します。  
public メソッドWorkbookの名前付きスタイルコレクションから指定した名前を持つスタイルを削除します。  
public メソッド指定したシートを削除します。  
public メソッド指定されたシートタブをインデックスまたは名前で削除します。  
public メソッドSparklineExコレクションからSparklineExを削除します。  
public メソッドWorkbookコントロールを再描画します。  
public メソッド計算サービスを再開します。  
public メソッドイベントを再開します。  
public メソッドアクティブなシートとタブストリップの描画を再開します。  
public メソッド指定したシートをPDFにエクスポートします。  
public メソッド指定した検索基準で指定したシートのセル内のテキストから指定した検索文字列を検索します。  
public メソッドアクティブシートを名前によって設定します。  
public メソッドコントロールのアクティブシートのインデックスを設定します。  
public メソッドアクティブなシートタブをインデックスまたは名前で設定します。  
public メソッドシートの数を設定します。  
public メソッドスプレッドシートに表示する最初のシートのインデックスを取得または設定します。  
public メソッド計算サービスを中断します。  
public メソッドイベントを中断します。  
public メソッドアクティブなシートとタブストリップの描画を中断します。  
public メソッドオブジェクト状態をJSON文字列に保存します。  
public メソッドWorkbookへのイベントの連結を解除します。  
public メソッド
 
public メソッドアンドゥマネージャを取得します。  
public メソッドワークブックのJSONを使用して外部ソースのデータを設定または更新します。  
トップ
関連トピック

参照

GC.Spread.Sheets 名前空間