Workbook コンストラクタ

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

シンタックス

Javascript (Usage)
Javascript (Specification)

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( 
   host : undefined,
   (optional) options : Object,
   (optional) options.sheetCount : number,
   (optional) options.font : string,
   (optional) options.allowUserDragMerge : boolean,
   (optional) options.allowUserDragDrop : boolean,
   (optional) options.allowUserDragFill : boolean,
   (optional) options.allowUserZoom : boolean,
   (optional) options.allowUserResize : boolean,
   (optional) options.allowUndo : boolean,
   (optional) options.allowSheetReorder : boolean,
   (optional) options.allowContextMenu : boolean,
   (optional) options.allowUserDeselect : boolean,
   (optional) options.defaultDragFillType : AutoFillType,
   (optional) options.showDragFillSmartTag : boolean,
   (optional) options.showHorizontalScrollbar : boolean,
   (optional) options.showVerticalScrollbar : boolean,
   (optional) options.scrollbarShowMax : boolean,
   (optional) options.scrollbarMaxAlign : boolean,
   (optional) options.tabStripVisible : boolean,
   (optional) options.tabStripRatio : number,
   (optional) options.tabEditable : boolean,
   (optional) options.newTabVisible : boolean,
   (optional) options.allSheetsListVisible : AllSheetsListVisibility,
   (optional) options.tabNavigationVisible : boolean,
   (optional) options.cutCopyIndicatorVisible : boolean,
   (optional) options.cutCopyIndicatorBorderColor : string,
   (optional) options.backColor : string,
   (optional) options.backgroundImage : string,
   (optional) options.backgroundImageLayout : ImageLayout,
   (optional) options.grayAreaBackColor : string,
   (optional) options.showResizeTip : ShowResizeTip,
   (optional) options.showDragDropTip : boolean,
   (optional) options.showDragFillTip : boolean,
   (optional) options.showScrollTip : ShowScrollTip,
   (optional) options.scrollIgnoreHidden : boolean,
   (optional) options.highlightInvalidData : boolean,
   (optional) options.useTouchLayout : boolean,
   (optional) options.hideSelection : boolean,
   (optional) options.resizeZeroIndicator : ResizeZeroIndicator,
   (optional) options.allowUserEditFormula : boolean,
   (optional) options.enableFormulaTextbox : boolean,
   (optional) options.autoFitType : AutoFitType,
   (optional) options.referenceStyle : ReferenceStyle,
   (optional) options.calcOnDemand : boolean,
   (optional) options.allowCopyPasteExcelStyle : boolean,
   (optional) options.allowExtendPasteRange : boolean,
   (optional) options.copyPasteHeaderOptions : CopyPasteHeaderOptions,
   (optional) options.scrollByPixel : boolean,
   (optional) options.scrollPixel : number,
   (optional) options.enableAccessibility : boolean,
   (optional) options.allowAutoCreateHyperlink : boolean,
   (optional) options.columnResizeMode : ResizeMode,
   (optional) options.rowResizeMode : ResizeMode,
   (optional) options.customList : Array,
   (optional) options.scrollbarAppearance : ScrollbarAppearance,
   (optional) options.pasteSkipInvisibleRange : boolean,
   (optional) options.allowAutoExtendFilterRange : boolean
) : Workbook;

パラメータ

host: ホストDOM要素やDOM ID。
options: 初期化オプション。
options.sheetCount: シートの数。
options.font: タブストリップのフォント。
options.allowUserDragMerge: - ユーザーがセルをドラッグしてマージできるかどうか。
options.allowUserDragDrop: - ユーザーが範囲データをドラッグ＆ドロップできるかどうか。
options.allowUserDragFill: - ユーザーが範囲をドラッグフィルできるかどうか。
options.allowUserZoom: - ［Ctrl］キーを押しながらマウスホイールを回すことによって表示をズームできるかどうか。
options.allowUserResize: - ユーザーが行および列のサイズを変更できるかどうか。
options.allowUndo: - ユーザーが編集をアンドゥできるかどうか。
options.allowSheetReorder: - ユーザーがSpreadコンポーネントのシートの順序を変更できるかどうか。
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: Spreadコンポーネントの背景色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。
options.backgroundImage: Spreadコンポーネントの背景画像。
options.backgroundImageLayout: Spreadコンポーネントの背景画像レイアウト。
options.grayAreaBackColor: 灰色領域の背景色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。
options.showResizeTip: サイズ変更チップの表示方法。
options.showDragDropTip: - ドラッグ＆ドロップチップを表示するかどうか。
options.showDragFillTip: ドラッグフィルチップを表示するかどうか。
options.showScrollTip: スクロールチップの表示方法。
options.scrollIgnoreHidden: スクロールバーが非表示の行または列を無視するかどうか。
options.highlightInvalidData: 無効なデータを強調表示するかどうか。
options.useTouchLayout: Spreadコンポーネントを表示するためにタッチレイアウトを使用するかどうか。
options.hideSelection: Spreadコンポーネントがフォーカスを持たないときに選択範囲をハイライト表示するかどうか。
options.resizeZeroIndicator: 行または列のサイズがゼロに変更されたときの描画ポリシー。
options.allowUserEditFormula: ユーザーがスプレッドシートのセルに設定された数式を編集できるかどうか。
options.enableFormulaTextbox: スプレッドシートで数式テキストボックスを有効にするかどうか。
options.autoFitType: セル内またはセルおよびヘッダ内に収まるように内容を書式設定するかどうか。
options.referenceStyle: このシート上のセル数式でのセルおよび範囲参照のスタイル。
options.calcOnDemand: 数式が要求されたときにのみ計算するかどうか。
options.allowCopyPasteExcelStyle: ユーザーがSpread SheetsのスタイルをコピーしてExcelに貼り付ける、またはExcelのスタイルをコピーしてSpread Sheetsに貼り付けることができるかどうか。
options.allowExtendPasteRange: 貼り付け範囲が足りない場合に貼り付け範囲を拡張するかどうか。
options.copyPasteHeaderOptions: データをコピーまたは貼り付けるときに含めるヘッダ。
options.scrollByPixel: ピクセル単位による正確なスクロールを有効にするかどうか。
options.scrollPixel: - scrollByPixelがtrueの場合、一度にそのピクセル数でスクロールを決定します。最終的なスクロールピクセルは、スクロールデルタ乗算scrollPixelの結果です。たとえば、スクロールデルタは3、scrollPixelは5、最終スクロールピクセルは15です。
options.enableAccessibility: スプレッドシートでアクセシビリティサポートを有効にするかどうか。
options.allowAutoCreateHyperlink: シートでハイパーリンクの自動作成を有効にするかどうか。
options.columnResizeMode: 列のサイズを変更する方法を指定します。
options.rowResizeMode: 行のサイズを変更する方法を指定します。
options.customList: - ユーザーがドラッグアンドフィルをカスタマイズするためのリスト。各フィル処理でこのリストが優先されます。各配列型項目は、文字列配列です。
options.scrollbarAppearance: skinとmobileの2つの列挙型を含むスクロールバーの外観。デフォルトはスキンです。
options.pasteSkipInvisibleRange: 非表示の範囲を貼り付けるかスキップするか。デフォルトはfalseです。
options.allowAutoExtendFilterRange: Excelのようにフィルター処理する範囲を自動拡張できるかどうか。デフォルトでfalseに設定されます。

使用例

次のサンプルコードは、ワークブックのオプションを設定します。

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0],{sheetCount:3, font:"12pt Arial"});

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0],{sheetcount:3, newTabVisible:false});

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0], { sheetCount: 3, tabEditable: false });

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0],{sheetCount:3, tabStripVisible:false});

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0],{sheetCount:3, allowUserResize:false});

Javascript

var spread = new GC.Spread.Sheets.Workbook($("#ss")[0], { sheetCount: 3, allowUserZoom: false});

解説

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

名前	型	説明
sheetCount	number	シートの数（オプション）。
font	string	タブストリップのフォント（オプション）。
allowUserDragDrop	boolean	ユーザーが範囲データをドラッグ＆ドロップできるかどうかを指定します（オプション）。
allowUserDragFill	boolean	ユーザーが範囲をドラッグフィルできるかどうかを指定します（オプション）。
allowUserZoom	boolean	［Ctrl］キーを押しながらマウスホイールを回すことによって表示をズームできるかどうかを指定します（オプション）。
allowUserResize	boolean	ユーザーが行および列のサイズを変更できるかどうかを指定します（オプション）。
allowUndo	boolean	ユーザーが編集をアンドゥできるかどうかを指定します（オプション）。
allowSheetReorder	boolean	ユーザーがSpreadコンポーネントのシートの順序を変更できるかどうかを指定します（オプション）。
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に設定されます。

参照

Workbook タイプ