クラス: Worksheet

Spread.Sheets.Worksheet

Table of contents

コンストラクタ

• constructor

プロパティ

• autoGenerateColumns
• cellStates
• charts
• columnOutlines
• comments
• conditionalFormats
• defaults
• floatingObjects
• options
• outlineColumn
• pictures
• pivotTables
• rowOutlines
• shapes
• slicers
• tables

メソッド

• addColumns
• addCustomFunction
• addCustomName
• addNamedStyle
• addRows
• addSelection
• addSpan
• autoFitColumn
• autoFitRow
• autoMerge
• bind
• bindColumn
• bindColumns
• clear
• clearCustomFunctions
• clearCustomNames
• clearPendingChanges
• clearSelection
• copyTo
• currentTheme
• deleteColumns
• deleteRows
• editorStatus
• endEdit
• fillAuto
• fromJSON
• frozenColumnCount
• frozenRowCount
• frozenTrailingColumnCount
• frozenTrailingRowCount
• getActiveColumnIndex
• getActiveRowIndex
• getActualStyle
• getArray
• getBindingPath
• getCell
• getCellRect
• getCellType
• getColumnCount
• getColumnPageBreak
• getColumnResizable
• getColumnVisible
• getColumnWidth
• getCsv
• getCustomFunction
• getCustomName
• getCustomNames
• getDataColumnName
• getDataItem
• getDataSource
• getDataValidator
• getDefaultStyle
• getDeletedRows
• getDependents
• getDirtyCells
• getDirtyRows
• getFormatter
• getFormula
• getFormulaInformation
• getHyperlink
• getInsertRows
• getNamedStyle
• getNamedStyles
• getParent
• getPrecedents
• getRange
• getRowCount
• getRowHeight
• getRowPageBreak
• getRowResizable
• getRowVisible
• getSelections
• getSpans
• getSparkline
• getStyle
• getStyleName
• getTag
• getText
• getUsedRange
• getValue
• getViewportBottomRow
• getViewportHeight
• getViewportLeftColumn
• getViewportRightColumn
• getViewportTopRow
• getViewportWidth
• groupSparkline
• hasPassword
• hasPendingChanges
• hitTest
• invalidateLayout
• isDirtySuspended
• isEditing
• isPaintSuspended
• isPrintLineVisible
• isSelected
• isValid
• moveTo
• name
• printInfo
• protect
• recalcAll
• removeCustomFunction
• removeCustomName
• removeNamedStyle
• removeSpan
• removeSparkline
• repaint
• reset
• resumeCalcService
• resumeDirty
• resumeEvent
• resumePaint
• rowFilter
• scroll
• search
• selectionPolicy
• selectionUnit
• setActiveCell
• setArray
• setArrayFormula
• setBindingPath
• setCellType
• setColumnCount
• setColumnPageBreak
• setColumnResizable
• setColumnVisible
• setColumnWidth
• setCsv
• setDataSource
• setDataValidator
• setDefaultStyle
• setFormatter
• setFormula
• setHyperlink
• setRowCount
• setRowHeight
• setRowPageBreak
• setRowResizable
• setRowVisible
• setSelection
• setSparkline
• setStyle
• setStyleName
• setTag
• setText
• setValue
• showCell
• showColumn
• showColumnOutline
• showRow
• showRowOutline
• sortRange
• startEdit
• suspendCalcService
• suspendDirty
• suspendEvent
• suspendPaint
• tag
• toJSON
• unbind
• unbindAll
• ungroupSparkline
• unprotect
• visible
• zoom

コンストラクタ

constructor

• new Worksheet(name)

ワークシートを表します。

パラメータ

名前	型	説明
name	string	ワークシートの名前。

プロパティ

autoGenerateColumns

• autoGenerateColumns: boolean

データコンテキストを連結するときに列を自動的に生成するかどうかを示します。

実例

//　次のサンプルコードは、シートのデータソースを設定します。
 var test = [
       { "Series0": 2, "Series1": 1 },
       { "Series0": 4, "Series1": 2 },
       { "Series0": 3, "Series1": 4 }
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(test, true);

---

cellStates

• cellStates: CellStateManager

cellStateマネージャー。

---

charts

• charts: ChartCollection

シートのチャートマネージャ。

実例

// 次のサンプルコードは、チャートの追加方法を示します。
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);

---

columnOutlines

• columnOutlines: Outline

列範囲グループを示します。

---

comments

• comments: CommentManager

シートのコメントマネージャ。

---

conditionalFormats

• conditionalFormats: ConditionalFormats

シートの条件付き書式マネージャ。

実例

// 次のサンプルコードは、ルールを作成します。
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.getRules();
alert(ruletest[0].style().backColor);

---

defaults

• defaults: ISheetDefaultOption

シートのデフォルトの行の高さと列の幅を示します。

実例

//　次のサンプルコードは、デフォルトの行の高さと列の幅を設定します。
activeSheet.suspendPaint();
activeSheet.defaults.rowHeight = 40;
activeSheet.defaults.colWidth = 30;
activeSheet.resumePaint();

---

floatingObjects

• floatingObjects: FloatingObjectCollection

シートのフローティングオブジェクトマネージャ。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

---

options

• options: IWorksheetOptions

シートのオプションを示します。

プロパティ allowCellOverflow - データが隣接する空白セルにオーバーフローできるかどうかを示します。

プロパティ showFormulas - 数式の結果ではなく、数式の文字列を表示するかどうかを示します。

プロパティ showZeros - ゼロ値を含むセルに0を表示するかどうかを示します。デフォルトはtrueです。

プロパティ sheetTabColor - シートタブの色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。

プロパティ frozenlineColor - 固定線の色を表す色文字列（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）。

プロパティ clipBoardOptions - クリップボードオプション。

プロパティ gridline - グリッド線のオプション。

プロパティ gridline.color - グリッド線の色。

プロパティ showVerticalScrollbar - 垂直グリッド線を表示するかどうか。

プロパティ gridline.showHorizontalGridline - 水平グリッド線を表示するかどうか。

プロパティ rowHeaderVisible - 行ヘッダーが表示されるかどうかを示します。

プロパティ colHeaderVisible - 列ヘッダーが表示されるかどうかを示します。

プロパティ rowHeaderAutoText - 行ヘッダが英字または数字を表示するか、それとも空白であるかを表す値を示します。

プロパティ colHeaderAutoText - 列ヘッダが英字または数字を表示するか、それとも空白であるかを表す値を示します。

プロパティ rowHeaderAutoTextIndex - 複数の行ヘッダ列があるときに、自動テキストを表示する行ヘッダ列を示します。

プロパティ colHeaderAutoTextIndex - 複数の列ヘッダ行があるときに、自動テキストを表示する列ヘッダ行を示します。

プロパティ isProtected - このシート上の保護対象としてマークされたセルを編集できないかどうかを示します。

プロパティ protectionOptions - ユーザーが変更できるようにする要素を示す値。

プロパティ [protectionOptions.allowSelectLockedCells] - ユーザーがロックされたセルを選択できる場合はtrueまたはundefined。

プロパティ [protectionOptions.allowSelectUnlockedCells] - ユーザーがロックされていないセルを選択できる場合はtrueまたはundefined。

プロパティ [protectionOptions.allowSort] - ユーザーが範囲をソートできる場合はtrue。

プロパティ [protectionOptions.allowFilter] - ユーザーが範囲をフィルタリングできる場合はtrue。

プロパティ [protectionOptions.allowEditObjects] - ユーザーがフローティングオブジェクトを編集できる場合はtrue。

プロパティ [protectionOptions.allowResizeRows] - ユーザーが行のサイズを変更できる場合はtrue。

プロパティ [protectionOptions.allowFilter] - ユーザーが列のサイズを変更できる場合はtrue。

プロパティ [protectionOptions.allowDragInsertRows] - ユーザーがドラッグして行を挿入できる場合はtrue。

プロパティ [protectionOptions.allowDragInsertColumns] - ユーザーがドラッグして列を挿入できる場合はtrue。

プロパティ [protectionOptions.allowInsertRows] - ユーザーが行を挿入できる場合はtrue。

プロパティ [protectionOptions.allowInsertColumns] - ユーザーが列を挿入できる場合はtrue。

プロパティ [protectionOptions.allowDeleteRows] - ユーザーが行を削除できる場合はtrue。

プロパティ [protectionOptions.allowDeleteColumns] - ユーザーが列を削除できる場合はtrue。

プロパティ [protectionOptions.allowOutlineColumns] - ユーザーが列グループを展開または折りたたむことができる場合はTrue。

プロパティ [protectionOptions.allowOutlineRows] - ユーザーが行グループを展開または折りたたむことができる場合はTrue。

プロパティ selectionBackColor - シートの選択の背景色。

プロパティ selectionBorderColor - シートの選択の境界線の色。

プロパティ sheetAreaOffset - sheetAreaOffsetのオプション。

プロパティ sheetAreaOffset.left - ホストからのシートの左オフセット。

プロパティ sheetAreaOffset.top - ホストからのシートの上オフセット。

プロパティ keepUnknownFormulas - 不明な数式をシートのJSONのデータに含めることができるかどうかを示します。

実例

sheet.setRowCount(2,GC.Spread.Sheets.SheetArea.colHeader);
sheet.setColumnCount(2,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(0, 2,"Column",GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.colHeaderAutoTextIndex = 1;
sheet.options.colHeaderAutoText = GC.Spread.Sheets.HeaderAutoText.numbers;

---

outlineColumn

• outlineColumn: OutlineColumn

シートのアウトライン列を取得します。

returns

---

pictures

• pictures: FloatingObjectCollection

シートのピクチャマネージャ。

非推奨 バージョン15.2.0以降では、代わりに「sheet.shapes」を使用してください。

実例

//次のサンプルコードは、ピクチャを追加します。
activeSheet.pictures.add("f2","Event.png",2,2,10,10);
var picture = activeSheet.pictures.get("f2");
picture.pictureStretch(GC.Spread.Sheets.ImageLayout.center);
picture.backColor("Blue");
picture.borderWidth(2);
picture.borderColor("Red");
picture.borderStyle("dotted");
picture.borderRadius(5);

---

pivotTables

• pivotTables: PivotTableManager

ピボットテーブルマネージャ。

実例

// 次のサンプルコードは、ピボットテーブルを作成します。
var pivotTableManager = sheet.pivotTables;
var sourceData = [["Date","Buyer","Type","Amount"],["01-Jan","Mom","Fuel",74],["15-Jan","Mom","Food",235],["17-Jan","Dad","Sports",20],["21-Jan","Kelly","Books",125],["02-Feb","Mom","Food",235],["20-Feb","Kelly","Music",20],["25-Feb","Kelly","Tickets",125]];
var options = {showRowHeader: true, showColumnHeader: true};
var myPivotTable = pivotTableManager.add("pivotTable_1", sourceData , 1, 1, GC.Spread.Pivot.PivotTableLayoutType.tabular, GC.Spread.Pivot.PivotTableThemes.medium2, option);

---

rowOutlines

• rowOutlines: Outline

行範囲グループを示します。

---

shapes

• shapes: ShapeCollection

シートのシェイプマネージャ。

実例

// 次のサンプルコードは、シェイプの追加方法を示します。
var shape = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);

---

slicers

• slicers: SlicerCollection

スライサーマネージャ。

実例

// 次のサンプルコードは、スライサーを追加します。
// テーブルを作成します。
datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
// スライサーをシートに追加し、スライサーインスタンスを返します。
var slicer = activeSheet.slicers.add("slicer1",table.name(),"Height");
 // スライサーのプロパティを変更します。
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.disableResizingAndMoving(true);
slicer.style(style1);

---

tables

• tables: TableManager

テーブルマネージャ。

実例

// 次のサンプルコードは、テーブルを作成します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableThemes.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");

メソッド

addColumns

▸ addColumns(col, count, sheetArea?): void

データモデルの指定したインデックスに１つ以上の列を追加します。

実例

// 次のサンプルコードは、列を追加します。
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1,GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1,GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

パラメータ

名前	型	説明
col	number	新しい列を追加する列インデックス。
count	number	追加する列の数。
sheetArea?	SheetArea	-

戻り値

void

---

addCustomFunction

▸ addCustomFunction(fn): void

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

パラメータ

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

戻り値

void

---

addCustomName

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

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

実例

// 次のサンプルコードは、カスタム名を作成します。
sheet.setValue(0, 0, 1);
sheet.setValue(0, 1, 2);
sheet.setValue(0, 2, 3);
sheet.addCustomName("customName1","=12", 0, 0);
sheet.addCustomName("customName2","Average(20,45)", 0, 0);
sheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
sheet.setFormula(1, 0, "customName1");
sheet.setFormula(1, 1, "customName2");
sheet.setFormula(1, 2, "sum(customName3)");

パラメータ

名前	型	説明
name	string	カスタム名前。
formula	string	数式
baseRow	number	行インデックス。
baseCol	number	列インデックス。
comment	string	コメント。

戻り値

void

---

addNamedStyle

▸ addNamedStyle(style): void

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

実例

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

パラメータ

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

戻り値

void

---

addRows

▸ addRows(row, count, sheetArea?): void

このワークシートに行を追加します。

実例

// 次のサンプルコードは、行を追加します。
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1,GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1,GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

パラメータ

名前	型	説明
row	number	開始行のインデックス。
count	number	追加する行数。
sheetArea?	SheetArea	-

戻り値

void

---

addSelection

▸ addSelection(row, column, rowCount, columnCount): void

選択範囲に１つまたは複数のセルを追加します。

実例

// 次のサンプルコードは、選択範囲を追加してから、その範囲をルールで使用します。
sheet.setValue(0,0, 1,3);
sheet.setValue(1,0, 50,3);
sheet.setValue(2,0, 100,3);
sheet.setValue(3,0, 2,3);
sheet.setValue(4,0, 60,3);
sheet.setValue(5,0, 90,3);
sheet.setValue(6,0, 3,3);
sheet.setValue(7,0, 40,3);
sheet.setValue(8,0, 70,3);
sheet.setValue(9,0, 5,3);
sheet.setValue(10,0, 35,3);
sheet.addSelection(0,0,11,1);
sheet.conditionalFormats.add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());

パラメータ

名前	型	説明
row	number	追加する最初のセルの行インデックス。
column	number	追加する最初のセルの列インデックス。
rowCount	number	追加する行数。
columnCount	number	追加する列の数。

戻り値

void

---

addSpan

▸ addSpan(row, col, rowCount, colCount, sheetArea?): void

このシートの指定したシート領域にセル結合を追加します。

実例

// 次のサンプルコードは、セル結合を作成します。
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	結合を開始するセルの行インデックス。
col	number	-
rowCount	number	結合する行数。
colCount	number	結合する列数。
sheetArea?	SheetArea	-

戻り値

void

---

autoFitColumn

▸ autoFitColumn(column): void

ビューポート列の幅を自動調整します。

実例

// 次のサンプルコードは、テキストに基づいて列の幅を設定します。
activeSheet.setValue(0, 1, "testing");
activeSheet.autoFitColumn(1);

パラメータ

名前	型	説明
column	number	列インデックス。

戻り値

void

---

autoFitRow

▸ autoFitRow(row): void

ビューポート行の高さを自動調整します。

実例

// 次のサンプルコードは、テキストに基づいて行の高さを設定します。
activeSheet.setValue(0, 1, "testing\r\nmultiple\r\nlines");
activeSheet.getCell(0,1).wordWrap(true);
activeSheet.autoFitRow(0);

パラメータ

名前	型	説明
row	number	行インデックス。

戻り値

void

---

autoMerge

▸ autoMerge(range, direction?, mode?, sheetArea?, selectionMode?): IRangeInfo[]

選択範囲に対して自動マージを適用します。

実例

var range = new GC.Spread.Sheets.Range(-1, 0, -1, 1);
sheet.autoMerge(range);

パラメータ

名前	型	説明
range	Range	自動マージの範囲。
direction?	AutoMergeDirection	自動マージの方向。 このパラメーターは提供されていない場合、 column　にデフォルトとして設定されます。方向が none の場合、範囲の自動マージはキャンセルされます。
mode?	AutoMergeMode	自動マージのモード。 このパラメーターが指定されていない場合、自由モードにデフォルトとして設定されます。
sheetArea?	SheetArea	自動マージ範囲のシート領域。このパラメーターが指定されていない場合は、viewportにデフォルトとして設定されます。
selectionMode?	SelectionMode	自動マージのモード。 このパラメーターが指定されていない場合、sourceにデフォルトとして設定されます。

戻り値

IRangeInfo[]

パラメータが指定されていない場合、現在のワークシートのすべての自動マージ範囲情報を返します。 各範囲情報には、選択範囲、方向、モード、シート領域、および選択モードが含まれます。

---

bind

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

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

実例

// 次のサンプルコードは、イベントを連結します。
sheet.bind(GC.Spread.Sheets.Events.LeftColumnChanged,function(event,data)
  {
    var str = "----------------------------------------\n";
    var title = "Event [LeftColumnChanged ] Fired";
    str = str.substr(0, 4) + title + str.substr(4 + title.length);
    if (typeof data == "object") {
        for (var key in data) {
            str += key + " : " + data[key] + "\n";
          }
      } else {
        str += data + "\n";
      }
      alert(str);
  });
sheet.bind(GC.Spread.Sheets.Events.TopRowChanged,function(event,data)
  {
        var str = "----------------------------------------\n";
        var title = "Event [TopRowChanged] Fired";
        str = str.substr(0, 4) + title + str.substr(4 + title.length);
        if (typeof data == "object") {
            for (var key in data) {
                str += key + " : " + data[key] + "\n";
            }
        } else {
            str += data + "\n";
        }
        alert(str);
    });

パラメータ

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

戻り値

void

---

bindColumn

▸ bindColumn(index, column): void

指定したデータフィールドを使用して列を連結します。

実例

var test = [
{"Series0":2,"Series1":1},
{"Series0":4,"Series1":2},
{"Series0":3,"Series1":4}
];
sheet.setDataSource(test);
sheet.bindColumn(1,"Series0");
sheet.bindColumn(0,"Series1");

パラメータ

名前	型	説明
index	number	列インデックス。
column	string | IColumn	データフィールドを含む列情報。型が文字列の場合は名前とみなされます。

戻り値

void

---

bindColumns

▸ bindColumns(columns): void

指定したデータフィールドを使用して列を連結します。

実例

var datasource = [
                 { name: "Alice", age: 27, birthday: "1985/08/31", position: "Beijing", isMarried: false},
                 { name: "Aimee", age: 28, birthday: "1984/07/31", position: "Xi'An", isMarried: true},
                 { name: "Charles", age: 29, birthday: "1983/03/31", position: "ShangHai", isMarried: true},
            ];
var colInfos = [
                { name: "name", displayName: "Name", size: 70, pageBread: false},
                { name: "age", displayName: "Age", size: 40, resizable: false },
                { name: "birthday", displayName: "Birthday", formatter: "d/M/yy", size: 120 },
                { name: "position", displayName: "Position", size: 50, visible: true, value: function (item){
			             return 'China ' + item['position'];
		           }},
                { name: "isMarried", displayName: "IsMarried", size: 50, visible: true, cellType: new GC.Spread.Sheets.CellTypes.CheckBox()}
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(datasource);
activeSheet.bindColumns(colInfos);

パラメータ

名前	型	説明
columns	IColumn[]	データフィールドを含む列情報の配列。項目の型が文字列の場合、その項目は名前とみなされます。

戻り値

void

---

clear

▸ clear(row, column, rowCount, colCount, area, storageType): void

指定した領域をクリアします。

実例

// 次のサンプルコードは、指定した範囲内のデータをクリアします。
activeSheet.getCell(0,0).value("A1");
activeSheet.clear(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport,GC.Spread.Sheets.StorageType.data);

パラメータ

名前	型	説明
row	number	開始行インデックス。
column	number	開始列インデックス。
rowCount	number	クリアする行数。
colCount	number	-
area	SheetArea	クリアする領域。
storageType	StorageType	クリアタイプ。

戻り値

void

---

clearCustomFunctions

▸ clearCustomFunctions(): void

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

実例

// 次のサンプルコードは、アクティブシートからカスタム関数をクリアします。
activeSheet.clearCustomFunctions();

戻り値

void

---

clearCustomNames

▸ clearCustomNames(): void

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

実例

// 次のサンプルコードは、カスタム名を作成してからそれらをクリアします。
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1","=12", 0, 0);
activeSheet.addCustomName("customName2","Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
activeSheet.clearCustomNames();

戻り値

void

---

clearPendingChanges

▸ clearPendingChanges(clearChangeInfo?): void

現在のワークシートからダーティ、挿入、削除のステータスをクリアします。

実例

sheet.clearPendingChanges({clearType: 1, row: 0, rowCount: 3, col: 0, colCount: 4});
sheet.clearPendingChanges({clearType: 2, row: 0, rowCount: 3, col: -1});
sheet.clearPendingChanges({clearType: 4, row: 0, rowCount: 10, col: -1});

パラメータ

名前	型
clearChangeInfo?	IClearChangeInfo

戻り値

void

---

clearSelection

▸ clearSelection(): void

選択をクリアします。

実例

// 次のサンプルコードは、選択をクリアします。
sheet.addSelection(4, 0, 2, 2);
sheet.clearSelection();

戻り値

void

---

copyTo

▸ copyTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option): void

ある範囲から別の範囲にデータをコピーします。

実例

// 次のサンプルコードは、指定した位置にデータをコピーします。
activeSheet.getCell(0,0).value("1");
activeSheet.copyTo(0,0,1,1,2,2,GC.Spread.Sheets.CopyToOptions.value);

パラメータ

名前	型	説明
fromRow	number	コピー元の行。
fromColumn	number	コピー元の列。
toRow	number	コピー先の行。
toColumn	number	コピー先の列。
rowCount	number	行数。
columnCount	number	列数。
option	CopyToOptions	コピーオプション。

戻り値

void

---

currentTheme

▸ currentTheme(value?): any

シートの現在のテーマを取得または設定します。

実例

// 次のサンプルコードは、テーマを設定します。
sheet.currentTheme("Civic");

パラメータ

名前	型	説明
value?	string | Theme	テーマ名またはテーマ。

戻り値

any

値が設定されていない場合は、現在のテーマを返します。値が設定されている場合は、ワークシートを返します。

---

deleteColumns

▸ deleteColumns(col, count, sheetArea?): void

このシートの指定したインデックスにある列を削除します。

実例

activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(0,4).value("Test")
activeSheet.deleteColumns(0,2);
activeSheet.deleteRows(3,1);

パラメータ

名前	型	説明
col	number	削除する最初の列のインデックス。
count	number	削除する列数。
sheetArea?	SheetArea	-

戻り値

void

---

deleteRows

▸ deleteRows(row, count, sheetArea?): void

このワークシートの指定したインデックスにある行を削除します。

実例

activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(0,4).value("Test")
activeSheet.deleteColumns(0,2);
activeSheet.deleteRows(3,1);

パラメータ

名前	型	説明
row	number	削除する最初の行のインデックス。
count	number	削除する行数。
sheetArea?	SheetArea	-

戻り値

void

---

editorStatus

▸ editorStatus(): EditorStatus

エディタのステータスを返します。

戻り値

EditorStatus

エディタのステータス。

---

endEdit

▸ endEdit(ignoreValueChange?): boolean

アクティブセルの編集を終了します。

実例

// 次のサンプルコードは、セルにテキスト"123"が入力されたときにそのテキストを削除します。
activeSheet.bind(GC.Spread.Sheets.Events.EditChange, function (sender,args) {
                if (args.editingText === "123") {
                    activeSheet.endEdit(true);
               }
            });

パラメータ

名前	型	説明
ignoreValueChange?	boolean	trueに設定した場合、編集されたテキストをセルに適用しません。

戻り値

boolean

セルの編集を正常に終了できる場合はtrue、それ以外の場合はfalse。

---

fillAuto

▸ fillAuto(startRange, wholeRange, options): void

指定した範囲に対してオートフィルを実行します。

実例

activeSheet.setValue(0, 0, 5);
var start = new GC.Spread.Sheets.Range(0, 0, 1, 1);
var r3 = new GC.Spread.Sheets.Range(0, 0, 4, 1);
activeSheet.fillAuto(start,r3, {fillType:GC.Spread.Sheets.Fill.FillType.auto, series:GC.Spread.Sheets.Fill.FillSeries.column, direction:GC.Spread.Sheets.Fill.FillDirection.down});

パラメータ

名前	型	説明
startRange	Range	フィルの開始範囲。
wholeRange	Range	フィルする全体範囲。
options	IFillOptions	範囲フィル情報。

戻り値

void

---

fromJSON

▸ fromJSON(sheetSettings): void

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

実例

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

パラメータ

名前	型	説明
sheetSettings	Object	逆シリアル化されたシートのデータ。

戻り値

void

---

frozenColumnCount

▸ frozenColumnCount(colCount?): any

シートの固定列の数を取得または設定します。

実例

sheet.frozenColumnCount(1);

パラメータ

名前	型
colCount?	number

戻り値

any

値が設定されていない場合は、固定列の数を返します。値が設定されている場合は、ワークシートを返します。

---

frozenRowCount

▸ frozenRowCount(rowCount?): any

シートの固定行の数を取得または設定します。

実例

sheet.frozenRowCount(1);

パラメータ

名前	型
rowCount?	number

戻り値

any

値が設定されていない場合は、固定行の数を返します。値が設定されている場合は、ワークシートを返します。

---

frozenTrailingColumnCount

▸ frozenTrailingColumnCount(colCount?, stickToEdge?): any

シートの固定末尾列の数を取得または設定します。

実例

sheet.frozenTrailingColumnCount(1, false);

パラメータ

名前	型
colCount?	number
stickToEdge?	boolean

戻り値

any

値が設定されていない場合は、固定末尾列の数を返します。値が設定されている場合は、ワークシートを返します。

---

frozenTrailingRowCount

▸ frozenTrailingRowCount(rowCount?, stickToEdge?): any

シートの固定末尾行の数を取得または設定します。

実例

sheet.frozenTrailingRowCount(1, false);

パラメータ

名前	型
rowCount?	number
stickToEdge?	boolean

戻り値

any

値が設定されていない場合は、固定末尾行の数を返します。値が設定されている場合は、ワークシートを返します。

---

getActiveColumnIndex

▸ getActiveColumnIndex(): number

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

実例

// 次のサンプルコードは、アクティブ列を取得します。
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);
  });

戻り値

number

アクティブセルの列インデックス。

---

getActiveRowIndex

▸ getActiveRowIndex(): number

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

実例

// 次のサンプルコードは、アクティブ行を取得します。
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);
  });

戻り値

number

アクティブセルの行インデックス。

---

getActualStyle

▸ getActualStyle(row, column, sheetArea?, sheetStyleOnly?): Style

指定したシート領域内の指定したセルの実際のスタイル情報を取得します。

実例

// 次のサンプルコードは、getActualStyleメソッドを使用します。
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getActualStyle(1,1,GC.Spread.Sheets.SheetArea.viewport, true);
alert(cstyle.backColor);

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
sheetArea?	SheetArea	-
sheetStyleOnly?	boolean	-

戻り値

Style

指定したセルのセルスタイルを返します。

---

getArray

▸ getArray(row, column, rowCount, columnCount, getFormula?): any[]

指定したセル範囲からオブジェクト配列を取得します。

実例

// 次のサンプルコードは、getArrayメソッドを使用します。
// 値を設定します。
var array = [[1,2,3],[4,5],[6,7,8,9]];
activeSheet.setArray(1, 2, array);
// 数式を設定します。
var array = [["=1+1","=2+2","=3+3"],["=4+4","=5+5"],["=6+6","=7+7","=8+8","=9+9"]];
activeSheet.setArray(1, 2, array, true);
// 値を取得します。
var newArray = activeSheet.getArray(1, 2, 3, 4);
//getformula
var newArray = activeSheet.getArray(1, 2, 3, 4, true);
//alert(newArray[0]);

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
rowCount	number	行数。
columnCount	number	-
getFormula?	boolean	trueの場合は数式を返します。それ以外の場合は値を返します。

戻り値

any[]

指定したセル範囲から取得したオブジェクト配列。

---

getBindingPath

▸ getBindingPath(row, col): string

指定したシート領域内の指定したセルからセルレベル連結の連結パスを取得します。

実例

// 次のサンプルコードは、getBindingPathメソッドを使用します。
var person = {name: "Wang feng", age: 25, address: {postcode: "710075"}};
var source = new GC.Spread.Sheets.Bindings.CellBindingSource(person);
activeSheet.setBindingPath(0, 0, "name");
activeSheet.setBindingPath(1, 1, "age");
activeSheet.setBindingPath(3, 3, "address.postcode");
activeSheet.setDataSource(source);
alert(activeSheet.getBindingPath(0, 0, GC.Spread.Sheets.SheetArea.viewport));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。

戻り値

string

指定したセルの、セルレベル連結の連結パスを返します。

---

getCell

▸ getCell(row, col, sheetArea?): CellRange

指定したシート領域内の指定したセルを取得します。

実例

// 次のサンプルコードは、セルを取得します。
activeSheet.getCell(1,1).text("cell object");

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、viewportにデフォルト設定されます。

戻り値

CellRange

セル。

---

getCellRect

▸ getCellRect(row, col, rowViewportIndex?, colViewportIndex?): Rect

セルの矩形を取得します。

実例

// 次のサンプルコードは、getCellRectメソッドを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (e, info) {
               if (info.sheetArea === GC.Spread.Sheets.SheetArea.viewport) {
                   alert("Clicked cell index (" + info.row + "," + info.col + ")");
                   // 指定されたインデックス位置に存在する通常セルの座標情報を取得します。
                   var cellRect = activeSheet.getCellRect(info.row, info.col);
                   alert("X coordinate:" + cellRect.x);
                   alert("Y coordinate:" + cellRect.y);
                   alert("Cell width:" + cellRect.width);
                   alert("Cell height:" + cellRect.height);
               }
           });

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
rowViewportIndex?	number	-
colViewportIndex?	number	-

戻り値

Rect

セルの矩形のサイズと位置を含むオブジェクト。

---

getCellType

▸ getCellType(row, col, sheetArea?): Base

セル型を取得します。

実例

// 次のサンプルコードは、セル型を取得します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.getCell(0, 2).cellType(cellType);
var cellType = activeSheet.getCellType(0,2,GC.Spread.Sheets.SheetArea.viewport)
if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
      alert("This is a ButtonCellType");
}

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

Base

指定したセルのセル型を返します。

---

getColumnCount

▸ getColumnCount(sheetArea?): number

指定したシート領域の列数を取得します。

実例

// 次のサンプルコードは、列数を取得します。
var count = activeSheet.getColumnCount(GC.Spread.Sheets.SheetArea.viewport);
alert(count);

パラメータ

名前	型
sheetArea?	SheetArea

戻り値

number

列数。

---

getColumnPageBreak

▸ getColumnPageBreak(column): boolean

印刷時にこのシートの指定した列の前に強制改ページが挿入されるかどうかを判定します。

パラメータ

名前	型	説明
column	number	列インデックス。

戻り値

boolean

指定した列の前に強制改ページが挿入される場合はtrue、それ以外の場合はfalse。

---

getColumnResizable

▸ getColumnResizable(col, sheetArea?): boolean

指定したシート領域内の指定した列のサイズをユーザーが変更できるかどうかを示す値を取得します。

実例

// 次のサンプルコードは、列がサイズ変更可能かどうかを取得します。
sheet.setRowCount(10);
sheet.setColumnCount(7);
sheet.setValue(0, 0,"Western");
sheet.setValue(0, 1,"Western");
sheet.setValue(0, 2,"Western");
sheet.setValue(1, 0,"A");
sheet.setValue(1, 1,"B");
sheet.setValue(1, 2,"C");
sheet.setColumnResizable(0,true, GC.Spread.Sheets.SheetArea.colHeader);
sheet.setRowResizable(0,true, GC.Spread.Sheets.SheetArea.rowHeader);
alert( sheet.getColumnResizable(0));
alert( sheet.getRowResizable(0, GC.Spread.Sheets.SheetArea.rowHeader));

パラメータ

名前	型	説明
col	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

boolean

指定した列のサイズをユーザーが変更できる場合はtrue、それ以外の場合はfalse。

---

getColumnVisible

▸ getColumnVisible(col, sheetArea?): boolean

指定したシート領域内の列が表示されるかどうかを取得します。

実例

// のサンプルコードは、列の表示/非表示の設定と幅設定を返します。
var visible = activeSheet.getColumnVisible(1, GC.Spread.Sheets.SheetArea.viewport);
var width = activeSheet.getColumnWidth(1, GC.Spread.Sheets.SheetArea.viewport);
alert(visible);
alert(width);

パラメータ

名前	型	説明
col	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

boolean

列がシート領域に表示される場合はtrue、それ以外の場合はfalse。

---

getColumnWidth

▸ getColumnWidth(col, sheetArea?, getDynamicSize?): any

指定されたシート領域内の指定した列の幅（ピクセル単位）を取得します。

実例

// のサンプルコードは、列の表示/非表示の設定と幅設定を返します。
var visible = activeSheet.getColumnVisible(1, GC.Spread.Sheets.SheetArea.viewport);
var width = activeSheet.getColumnWidth(1, GC.Spread.Sheets.SheetArea.viewport);
alert(visible);
alert(width);

パラメータ

名前	型	説明
col	number	列インデックス。
sheetArea?	SheetArea	-
getDynamicSize?	boolean	-

戻り値

any

ピクセル単位での列幅または動的サイズ。

---

getCsv

▸ getCsv(row, column, rowCount, columnCount, rowDelimiter, columnDelimiter): string

範囲から区切り付きテキストを取得します。

パラメータ

名前	型	説明
row	number	開始行。
column	number	開始列。
rowCount	number	行数。
columnCount	number	列数。
rowDelimiter	string	行の最後に付加される行区切り文字。
columnDelimiter	string	列の最後に付加される列区切り文字。

戻り値

string

指定した区切り文字が付いた範囲内のテキスト。

---

getCustomFunction

▸ getCustomFunction(name): void

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

パラメータ

名前	型
name	string

戻り値

void

カスタム関数。

---

getCustomName

▸ getCustomName(name): NameInfo

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

実例

// 次のサンプルコードは、カスタム名と数式を取得します。
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1", "=12", 0, 0);
activeSheet.addCustomName("customName2", "Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1");
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
$("#button1").click(function () {
    let cname = activeSheet.getCustomName("customName2");
    if (cname instanceof GC.Spread.Sheets.NameInfo) {
        //　カスタム名を取得します。
        let name = cname.getName();
        //　式を取得します。
        let expression = cname.getExpression();
        // 式文字列を取得します。
        let expStr = GC.Spread.Sheets.CalcEngine.expressionToFormula(activeSheet, expression, 0, 0);
        alert("Name:" + name + ";Expression: =" + expStr);
    }
});

パラメータ

名前	型
name	string

戻り値

NameInfo

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

---

getCustomNames

▸ getCustomNames(): NameInfo[]

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

戻り値

NameInfo[]

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

---

getDataColumnName

▸ getDataColumnName(column): string

指定した位置にある列の名前を取得します。

実例

//　次のサンプルコードは、指定した連結列の名前を返します。
var test = [
        {"Series0":2,"Series1":1},
        {"Series0":4,"Series1":2},
        {"Series0":3,"Series1":4}
    ];
activeSheet.setDataSource(test);
activeSheet.bindColumn(1,"Series0");
activeSheet.bindColumn(0,"Series1");
var colname = activeSheet.getDataColumnName(0);
alert(colname);

パラメータ

名前	型	説明
column	number	名前を取得する列のインデックス。

戻り値

string

データ連結用の列名。

---

getDataItem

▸ getDataItem(row): any

データ項目を取得します。

実例

//　次のサンプルコードは、getDataItemメソッドを使用します。
var test = [
      { "Series0": 2, "Series1": 1 },
      { "Series0": 4, "Series1": 2 },
      { "Series0": 3, "Series1": 4 }
           ];
           activeSheet.autoGenerateColumns = true;
           activeSheet.setDataSource(test, false);
           alert(JSON.stringify(activeSheet.getDataItem(0)));

パラメータ

名前	型	説明
row	number	行インデックス。

戻り値

any

行データ。

---

getDataSource

▸ getDataSource(): any

シートにデータを供給するデータソースを取得します。

function

実例

var test = [
        {"Series0":2,"Series1":1},
        {"Series0":4,"Series1":2},
        {"Series0":3,"Series1":4}
    ];
activeSheet.setDataSource(test);
alert(activeSheet.getDataSource);

戻り値

any

データソースを返します。

---

getDataValidator

▸ getDataValidator(row, col, sheetArea): DefaultDataValidator

セルデータバリデーターを取得します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

DefaultDataValidator

指定したセルのセルデータバリデーターを返します。

---

getDefaultStyle

▸ getDefaultStyle(sheetArea?): Style

シートのデフォルトスタイル情報を取得します。

実例

//　次のサンプルコードは、getDefaultStyleメソッドを使用します。
var defaultStyle = new GC.Spread.Sheets.Style();
defaultStyle.backColor = "LemonChiffon";
defaultStyle.foreColor = "Red";
defaultStyle.borderLeft = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderTop = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderRight = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderBottom = new GC.Spread.Sheets.LineBorder("Green");
activeSheet.setDefaultStyle(defaultStyle, GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getDefaultStyle(GC.Spread.Sheets.SheetArea.viewport);
alert(cstyle.backColor);

パラメータ

名前	型
sheetArea?	SheetArea

戻り値

Style

シートのデフォルトスタイルを返します。

---

getDeletedRows

▸ getDeletedRows(): any[]

削除された行のコレクションを取得します。

戻り値

any[]

削除された行のコレクション。配列の各要素には次の2つのプロパティが含まれます。row.row: 削除された行のインデックスを示します。row.originalItem: 削除されたデータ項目を示します。

---

getDependents

▸ getDependents(row, col): ICellsInfo[]

セルの参照先CellRange情報のオブジェクト配列を取得します。

実例

sheet.getDependents(1, 1);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。

戻り値

ICellsInfo[]

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

---

getDirtyCells

▸ getDirtyCells(row, col, rowCount, colCount): IDirtyCellInfo[]

ダーティなセルのコレクションを取得します。

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
rowCount	number	ダーティなセル範囲内の行数。
colCount	number	ダーティなセル範囲内の列数。

戻り値

IDirtyCellInfo[]

ダーティなセル。

---

getDirtyRows

▸ getDirtyRows(): any[]

ダーティな行のコレクションを取得します。

戻り値

any[]

ダーティな行のコレクション。配列の各要素には次の3つのプロパティが含まれます。row.row: 行インデックスを示します。row.item: 現在の行のデータ項目を示します。row.originalItem: 行の元のデータ項目を示します。

---

getFormatter

▸ getFormatter(row, col, sheetArea): any

セルフォーマッターを取得します。

実例

//　次のサンプルコードは、アクティブシートの書式オブジェクトを返します。
activeSheet.getCell(0, 1).formatter("M");
activeSheet.setValue(0, 1, new Date(2011, 2, 9));
var style = activeSheet.getFormatter(0,1,GC.Spread.Sheets.SheetArea.viewport);
alert(style);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

any

指定したセルのセルフォーマッター文字列またはオブジェクトを返します。

---

getFormula

▸ getFormula(row, col, sheetArea?): string

このシートの指定したセルの数式を取得します。

実例

//　次のサンプルコードは、指定したセルの数式を返します。
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
let formula = activeSheet.getFormula(1, 1, GC.Spread.Sheets.SheetArea.viewport);
alert(formula);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

string

数式文字列を返します。

---

getFormulaInformation

▸ getFormulaInformation(row, col): IFormulaInfo

このシートの指定したセルの数式詳細情報を取得します。

実例

activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
let test = activeSheet.getFormulaInformation(1,1, GC.Spread.Sheets.SheetArea.viewport);
alert(test.formula);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。

戻り値

IFormulaInfo

formulaInfo - セルの数式情報を返します。formulaInfo.hasFormula セルに数式があるかどうかを示します。formulaInfo.formula 数式文字列。formulaInfo.isArrayFormula 数式が配列数式かどうかを示します。formulaInfo.formula 数式文字列。formulaInfo.formulaWithCulture カルチャ固有の数式。

---

getHyperlink

▸ getHyperlink(row, col, sheetArea?): IHyperlink

指定されたシート領域の指定したセルにハイパーリンクデータを設定します。

実例

//　次のサンプルコードは、getHyperlinkメソッドを使用します。
let firstHyperlinkData = sheet.getHyperlink(0, 2, GC.Spread.Sheets.SheetArea.viewport);
let secondHyperlinkData = sheet.setHyperlink(1, 1, GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

IHyperlink

---

getInsertRows

▸ getInsertRows(): any[]

挿入された行のコレクションを取得します。

戻り値

any[]

挿入された行のコレクション。配列の各要素には次の2つのプロパティが含まれます。row.row: 挿入された行のインデックスを示します。row.item: 挿入されたデータ項目を示します。

---

getNamedStyle

▸ getNamedStyle(name): Style

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

パラメータ

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

戻り値

Style

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

---

getNamedStyles

▸ getNamedStyles(): Style[]

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

戻り値

Style[]

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

---

getParent

▸ getParent(): Workbook

現在のシートの親Spreadオブジェクトを取得します。

戻り値

Workbook

現在のシートの親Spreadオブジェクトを返します。

---

getPrecedents

▸ getPrecedents(row, col): ICellsInfo[]

セルの参照元のCellRange情報のオブジェクト配列を取得します。

実例

sheet.getPrecedents(1, 1);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。

戻り値

ICellsInfo[]

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

---

getRange

▸ getRange(row, col, rowCount?, colCount?, sheetArea?): CellRange

指定されたシート領域の行情報と列情報によってセルの範囲を取得します。

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
rowCount?	number	範囲の行数。このパラメーターを指定しない場合は、<b>1</b>にデフォルト設定されます。
colCount?	number	範囲の列数。このパラメーターを指定しない場合は、<b>1</b>にデフォルト設定されます。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、viewportにデフォルト設定されます。

戻り値

CellRange

セル範囲。row = -1かつrowCount = -1の場合、その範囲は列を表します。たとえば、sheet.getRange(-1,4,-1.6)は列"E:J"を返します。col = -1かつcolCount = -1の場合、その範囲は行を表します。たとえば、sheet.getRange(4,-1.6,-1)は行"5:10"を返します。

▸ getRange(address, sheetArea?): CellRange

指定されたシート領域のA1スタイルアドレス（R1C1スタイルをサポートしていません）によってセルの範囲を取得します。

実例

// 単一のセルを取得します。sheet.getRange(0, 0, 1, 1)と同じです。
sheet.getRange("A1")
// 列全体を取得します。sheet.getRange(-1, 0, -1, 3)と同じです。
sheet.getRange("A:C")
// 行全体を取得します。sheet.getRange(0, -1, 3, -1)と同じです。
sheet.getRange("1:3")
// 範囲を取得します。sheet.getRange(0, 0, 3, 3)と同じです。
sheet.getRange("A1:C3")

パラメータ

名前	型	説明
address	string	範囲アドレスの文字列。 たとえば、「C1」、「A：C」、「A1：C3」、「1：3」。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、viewportにデフォルト設定されます。

戻り値

CellRange

セル範囲。

---

getRowCount

▸ getRowCount(sheetArea?): number

指定したシート領域の行数を取得します。

実例

//　次のサンプルコードは、行数を取得します。
var count = activeSheet.getRowCount(GC.Spread.Sheets.SheetArea.viewport);
alert(count);

パラメータ

名前	型
sheetArea?	SheetArea

戻り値

number

行数。

---

getRowHeight

▸ getRowHeight(row, sheetArea?, getDynamicSize?): any

指定したシート領域内の指定した行の高さ（ピクセル単位または動的サイズ）を取得します。

実例

//　次のサンプルコードは、指定した行の高さを返します。
var rheight = activeSheet.getRowHeight(1,GC.Spread.Sheets.SheetArea.viewport);
alert(rheight);

パラメータ

名前	型	説明
row	number	行インデックス。
sheetArea?	SheetArea	-
getDynamicSize?	boolean	-

戻り値

any

ピクセル単位での行の高さまたは動的サイズ。

---

getRowPageBreak

▸ getRowPageBreak(row): boolean

印刷時にこのシートの指定した行の前に強制改ページが挿入されるかどうかを判定します。

パラメータ

名前	型	説明
row	number	行インデックス。

戻り値

boolean

指定した行の前に強制改ページが挿入される場合はtrue、それ以外の場合はfalse。

---

getRowResizable

▸ getRowResizable(row, sheetArea?): boolean

指定したシート領域内の指定した行のサイズをユーザーが変更できるかどうかを示す値を取得します。

実例

//　行がサイズ変更可能かどうかを取得します。
sheet.setRowCount(10);
sheet.setColumnCount(7);
sheet.setValue(0, 0,"Western");
sheet.setValue(0, 1,"Western");
sheet.setValue(0, 2,"Western");
sheet.setValue(1, 0,"A");
sheet.setValue(1, 1,"B");
sheet.setValue(1, 2,"C");
sheet.setColumnResizable(0,true, GC.Spread.Sheets.SheetArea.colHeader);
sheet.setRowResizable(0,true, GC.Spread.Sheets.SheetArea.rowHeader);
alert( sheet.getColumnResizable(0));
alert( sheet.getRowResizable(0, GC.Spread.Sheets.SheetArea.rowHeader));

パラメータ

名前	型	説明
row	number	行インデックス。
sheetArea?	SheetArea	-

戻り値

boolean

指定した行のサイズをユーザーが変更できる場合はtrue、それ以外の場合はfalse。

---

getRowVisible

▸ getRowVisible(row, sheetArea?): boolean

指定した行がコントロールに表示されるかどうかを取得します。

実例

//　次のサンプルコードは、指定した行の表示/非表示の設定を返します。
rvisible = activeSheet.getRowVisible(1,GC.Spread.Sheets.SheetArea.viewport);
alert(rvisible);

パラメータ

名前	型	説明
row	number	行インデックス。
sheetArea?	SheetArea	-

戻り値

boolean

行がシート領域に表示される場合はtrue、それ以外の場合はfalse。

---

getSelections

▸ getSelections(): Range[]

現在のシートの選択範囲を取得します。

戻り値

Range[]

型GC.Spread.Sheets.Rangeが配列に格納されます。

---

getSpans

▸ getSpans(range?, sheetArea?): Range[]

指定したシート領域内の指定した範囲にあるセル結合を取得します。

パラメータ

名前	型	説明
range?	Range	セル範囲。
sheetArea?	SheetArea	-

戻り値

Range[]

セル結合情報を含む配列。配列要素の型はGC.Spread.Sheets.Rangeです。

---

getSparkline

▸ getSparkline(row, column): Sparkline

指定したセルのスパークラインを取得します。

実例

//　次のサンプルコードは、スパークラインを作成して取得します。
var cellr = new GC.Spread.Sheets.Range(0, 0, 1, 5);
var ex = new GC.Spread.Sheets.Sparklines.SparklineSetting();
ex.options.SeriesColor  = "Aquamarine";
sheet.setValue(0, 0, 2);
sheet.setValue(0, 1, 5);
sheet.setValue(0, 2, 4);
sheet.setValue(0, 3, -1);
sheet.setValue(0, 4, 3);
sheet.setSparkline(0, 5, cellr, GC.Spread.Sheets.Sparklines.DataOrientation.horizontal, GC.Spread.Sheets.Sparklines.SparklineType.column, ex);
alert(sheet.getSparkline(0, 5).toString());
//sheet.removeSparkline(0, 5);

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	-

戻り値

Sparkline

セルのスパークライン。

---

getStyle

▸ getStyle(row, column, sheetArea?): Style

指定したシート領域内の指定したセルのスタイル情報を取得します。

実例

//　次のサンプルコードは、getStyleメソッドを使用します。
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getStyle(1,1,GC.Spread.Sheets.SheetArea.viewport);
alert(cstyle.backColor);

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

Style

指定したセルのセルスタイルを返します。

---

getStyleName

▸ getStyleName(row, column, sheetArea?): string

指定したシート領域内の指定したセルのスタイルの名前を取得します。

実例

//　次のサンプルコードは、getStyleNameメソッドを使用します。
var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
activeSheet.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // cell(1,1) の backColor は緑です。
activeSheet.setStyleName(2, 1, "style1");
alert(activeSheet.getStyleName(1,1,GC.Spread.Sheets.SheetArea.viewport));

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

string

スタイルの名前を表す文字列を返します。

---

getTag

▸ getTag(row, col, sheetArea?): any

指定したシート領域内の指定したセルからタグ値を取得します。

実例

//　次のサンプルコードは、セルタグを追加して、そのタグを取得します。
activeSheet.getRange(1, -1, 1, -1).tag("row tag");
alert(activeSheet.getTag(1,-1,GC.Spread.Sheets.SheetArea.viewport));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

any

セルのタグ値を返します。

---

getText

▸ getText(row, col, sheetArea?): string

指定したシート領域内のセルの書式付きテキストを取得します。

実例

activeSheet.getText(1, 0);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	-

戻り値

string

セルの書式付きテキストを返します。

---

getUsedRange

▸ getUsedRange(type?): Range

シートで使用されている範囲を取得します。

実例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:1});
var sheet = spread.getSheet(0);
sheet.setValue(2, 2, "value");
sheet.setValue(4, 2, "value");
sheet.setValue(6, 8, "value");
sheet.setValue(10, 15, "value");
sheet.setFormula(5, 5, "=C3");
sheet.setFormula(8, 8, "=I6");
sheet.setStyle(30,4, new GC.Spread.Sheets.Style())
sheet.setStyle(3, 24, new GC.Spread.Sheets.Style())
sheet.setRowHeight(8, 40);
sheet.getUsedRange(GC.Spread.Sheets.UsedRangeType.all);

パラメータ

名前	型
type?	UsedRangeType

戻り値

Range

値が設定されていない場合は、nullを返します。 それ以外の場合は、使用されている範囲を返します。

---

getValue

▸ getValue(row, col, sheetArea?, valueType?): any

指定したシート領域内の指定したセルから書式なしデータを取得します。

実例

activeSheet.getValue(1, 1, GC.Spread.Sheets.SheetArea.viewport, GC.Spread.Sheets.ValueType.richText);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
sheetArea?	SheetArea	-
valueType?	ValueType	-

戻り値

any

セルの値を返します。

---

getViewportBottomRow

▸ getViewportBottomRow(rowViewportIndex): number

ビューポートの一番下の行のインデックスを取得します。

実例

//　次のサンプルコードは、現在のシートビューの一番上の行と一番下の行、および一番左の列と一番右の列のインデックスを返します。
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

パラメータ

名前	型	説明
rowViewportIndex	number	ビューポートのインデックス。

戻り値

number

ビューポートの一番下の行のインデックス。

---

getViewportHeight

▸ getViewportHeight(rowViewportIndex): number

アクティブシートの指定したビューポート行の高さを取得します。

実例

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

パラメータ

名前	型	説明
rowViewportIndex	number	行ビューポートのインデックス。

戻り値

number

ビューポートの高さ。

---

getViewportLeftColumn

▸ getViewportLeftColumn(columnViewportIndex): number

ビューポートの左列のインデックスを取得します。

実例

//　次のサンプルコードは、現在のシートビューの一番上の行と一番下の行、および一番左の列と一番右の列のインデックスを返します。
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

パラメータ

名前	型	説明
columnViewportIndex	number	ビューポートのインデックス。

戻り値

number

ビューポートの左列のインデックス。

---

getViewportRightColumn

▸ getViewportRightColumn(columnViewportIndex): number

ビューポートの右列のインデックスを取得します。

実例

//　次のサンプルコードは、現在のシートビューの一番上の行と一番下の行、および一番左の列と一番右の列のインデックスを返します。
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

パラメータ

名前	型	説明
columnViewportIndex	number	ビューポートのインデックス。

戻り値

number

ビューポートの右列のインデックス。

---

getViewportTopRow

▸ getViewportTopRow(rowViewportIndex): number

ビューポートの一番上の行のインデックスを取得します。

実例

//　次のサンプルコードは、現在のシートビューの一番上の行と一番下の行、および一番左の列と一番右の列のインデックスを返します。
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

パラメータ

名前	型	説明
rowViewportIndex	number	ビューポートのインデックス。

戻り値

number

ビューポートの一番上の行のインデックス。

---

getViewportWidth

▸ getViewportWidth(columnViewportIndex): number

アクティブシートの指定したビューポート列の幅を取得します。

実例

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

パラメータ

名前	型	説明
columnViewportIndex	number	列ビューポートのインデックス。

戻り値

number

ビューポートの幅。

---

groupSparkline

▸ groupSparkline(sparklines): SparklineGroup

スパークラインをグループ化します。

実例

//　次のサンプルコードは、スパークラインをグループ化します。
sheet.setValue(0, 0, "Data Range is A2-A9");
sheet.setValue(1, 0, 1);
sheet.setValue(2, 0, -2);
sheet.setValue(3, 0, -1);
sheet.setValue(4, 0, 6);
sheet.setValue(5, 0, 4);
sheet.setValue(6, 0, -4);
sheet.setValue(7, 0, 3);
sheet.setValue(8, 0, 8);
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
var s1=  sheet.setSparkline(13, 0, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.line
        , setting
        );
var s2 =sheet.setSparkline(13, 3, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.column
        , setting
        );
var s3=  sheet.setSparkline(13, 6, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.winloss
        , setting
        );
var group = sheet.groupSparkline([s1,s2,s3]);

パラメータ

名前	型	説明
sparklines	Sparkline[]	グループ化するスパークライン。

戻り値

SparklineGroup

スパークライングループ

---

hasPassword

▸ hasPassword(): boolean

ワークシートに保護用のパスワードが設定されるかどうかを取得します。

実例

let password = "fe4c4be8"
sheet.protect(password);
if(sheet.hasPassword()) {
    sheet.unprotect(password);
} else {
    sheet.unprotect();
}

戻り値

boolean

パスワードが設定されている場合はtrue、それ以外の場合はfalseを返します。

---

hasPendingChanges

▸ hasPendingChanges(): boolean

指定した範囲にダーティ、挿入、削除のいずれかのステータスがあるかどうかを取得します。

戻り値

boolean

範囲内の行またはセルがダーティであるか、挿入または削除された場合はtrue、それ以外の場合はfalse。

---

hitTest

▸ hitTest(x, y): IHitTestInformation

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

パラメータ

名前	型	説明
x	number	x座標。
y	number	y座標。

戻り値

IHitTestInformation

ヒットテスト情報。

---

invalidateLayout

▸ invalidateLayout(): void

シートレイアウトを無効にします。

実例

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

戻り値

void

---

isDirtySuspended

▸ isDirtySuspended(): boolean

ダーティデータの記録が一時停止されているかどうかを取得します。

実例

//　次のサンプルコードは、isDirtySuspended メソッドを使用します。
var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

戻り値

boolean

ダーティデータが一時停止されているかどうか。

---

isEditing

▸ isEditing(): boolean

シートが編集モードかどうかを取得します。

実例

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

戻り値

boolean

シートが編集モードにある場合はtrue、それ以外の場合はfalse。

---

isPaintSuspended

▸ isPaintSuspended(): boolean

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

戻り値

boolean

---

isPrintLineVisible

▸ isPrintLineVisible(value?): boolean

シートで印刷用のプレビュー枠線を表示するかどうかを取得または設定します。

パラメータ

名前	型
value?	boolean

戻り値

boolean

値が設定されていない場合、印刷用のプレビュー枠線が表示されるかどうかを示す値を返します。

---

isSelected

▸ isSelected(selectedState?): any

ワークシートの選択状態を取得または設定します。

実例

spread.sheets[0].isSelected();
spread.sheets[1].isSelected(true);

パラメータ

名前	型
selectedState?	boolean

戻り値

any

選択状態が設定されていない場合は、ワークシートの選択状態を返します。 それ以外の場合は、ワークシートを返します。

---

isValid

▸ isValid(row, column, value): boolean

セルの値が有効かどうかを判断します。

実例

//　次のサンプルコードは、isValidメソッドを使用します。
alert(activeSheet.isValid(0, 0, 10));

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
value	Object	セル値。

戻り値

boolean

値が有効な場合はtrue、それ以外の場合はfalse。

---

moveTo

▸ moveTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option): void

ある範囲から別の範囲にデータを移動します。

実例

//　次のサンプルコードは、指定した位置にデータを移動します。
activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(1,1).value("Test")
activeSheet.moveTo(0,0,3,3,2,2,GC.Spread.Sheets.CopyToOptions.value);

パラメータ

名前	型	説明
fromRow	number	コピー元の行。
fromColumn	number	コピー元の列。
toRow	number	コピー先の行。
toColumn	number	コピー先の列。
rowCount	number	行数。
columnCount	number	列数。
option	CopyToOptions	コピーオプション。

戻り値

void

---

name

▸ name(value?): any

ワークシートの名前を取得または設定します。

実例

spread.sheets[0].name("The first sheet");
spread.sheets[1].name( "The second sheet");

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、ワークシート名を返します。値が設定されている場合は、ワークシートを返します。

---

printInfo

▸ printInfo(value?): any

シートの印刷情報を取得または設定します。

パラメータ

名前	型
value?	PrintInfo

戻り値

any

値が設定されていない場合は、シートの印刷情報を返します。値が設定されている場合は、シートを返します。

---

protect

▸ protect(password?): void

ワークシートを保護します。既に保護されている場合は何もしません。

実例

let password = "fe4c4be8"
sheet.protect(password);

パラメータ

名前	型	説明
password?	string	シート保護のパスワード。

戻り値

void

---

recalcAll

▸ recalcAll(refreshAll?): void

シートのすべての数式を再計算します。

実例

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

パラメータ

名前	型	説明
refreshAll?	boolean	すべての数式参照、カスタム名、およびカスタム関数を再構築するかどうかを指定します。

戻り値

void

---

removeCustomFunction

▸ removeCustomFunction(name): void

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

実例

//　次のサンプルコードは、removeCustomFunctionメソッドを使用します。
// カスタム関数を追加します。
// Type =myfunc(1)
// と入力し、結果を表示します。
function myfunc() {}
myfunc.prototype = new GC.Spread.CalcEngine.Functions.Function("myfunc", 0, 0, {name: "myfunc",description: "This is my first function"});
myfunc.prototype.evaluate = function (args) {
    return 100;
}
spread.addCustomFunction(new myfunc());
//spread.removeCustomFunction("myfunc");

パラメータ

名前	型
name	string

戻り値

void

---

removeCustomName

▸ removeCustomName(name): void

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

実例

// 次のサンプルコードは、removeCustomNameメソッドを使用します。
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1","=12", 0, 0);
activeSheet.addCustomName("customName2","Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
//activeSheet.removeCustomName("customName3");

パラメータ

名前	型
name	string

戻り値

void

---

removeNamedStyle

▸ removeNamedStyle(name): void

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

パラメータ

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

戻り値

void

---

removeSpan

▸ removeSpan(row, col, sheetArea?): void

指定したシート領域から指定したアンカーセルを含むセル結合を削除します。

実例

activeSheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);
//activeSheet.removeSpan(0, 0, GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	セル結合のアンカーセル（結合された一連のセルの開始位置にあるセル）の行インデックス。
col	number	セル結合のアンカーセル（結合された一連のセルの開始位置にあるセル）の列インデックス。
sheetArea?	SheetArea	-

戻り値

void

---

removeSparkline

▸ removeSparkline(row, col): void

指定したセルのスパークラインを削除します。

実例

//　次のサンプルコードは、スパークラインを削除します。
var cellr = new GC.Spread.Sheets.Range(0, 0, 1, 5);
var ex = new GC.Spread.Sheets.Sparklines.SparklineSetting();
ex.options.SeriesColor  = "Aquamarine";
sheet.setValue(0, 0, 2);
sheet.setValue(0, 1, 5);
sheet.setValue(0, 2, 4);
sheet.setValue(0, 3, -1);
sheet.setValue(0, 4, 3);
sheet.setSparkline(0, 5, cellr, GC.Spread.Sheets.Sparklines.DataOrientation.horizontal, GC.Spread.Sheets.Sparklines.SparklineType.column, ex);
alert(sheet.getSparkline(0, 5).toString());
//sheet.removeSparkline(0, 5);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。

戻り値

void

---

repaint

▸ repaint(clipRect?): void

指定した矩形を再描画します。

実例

//　次のサンプルコードは、再描画を発生させます。
var cellrange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
sheet.rowFilter(hideRowFilter);
sheet.resumePaint();
sheet.repaint();

パラメータ

名前	型	説明
clipRect?	Rect	再描画する矩形。

戻り値

void

---

reset

▸ reset(): void

シートをリセットします。

実例

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

戻り値

void

---

resumeCalcService

▸ resumeCalcService(recalcAll?): void

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

実例

// 次のサンプルコードは、resumeCalcServiceメソッドを使用します。
activeSheet.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)");
activeSheet.resumeCalcService(true);

パラメータ

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

戻り値

void

---

resumeDirty

▸ resumeDirty(): void

ダーティデータの記録を再開します。

実例

//　次のサンプルコードは、resumeDirtyメソッドを使用します。
 var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

戻り値

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));
    }
});
activeSheet.suspendEvent();
activeSheet.setValue(0, 0, "111");
activeSheet.resumeEvent();
activeSheet.setValue(1, 1, "222");

戻り値

void

---

resumePaint

▸ resumePaint(): void

描画を再開します。

戻り値

void

---

rowFilter

▸ rowFilter(value?): RowFilterBase

シートの行フィルタを取得または設定します。

実例

// 次のサンプルコードは、行フィルタを作成します。
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(1,1,10,3)));

パラメータ

名前	型	説明
value?	RowFilterBase	シートの行フィルタ。

戻り値

RowFilterBase

パラメータなしでメソッドを呼び出すと、フィルタインスタンスを返します。それ以外の場合は、ワークシートインスタンスを返します。

---

scroll

▸ scroll(vPixels, hPixels): void

指定されたピクセル単位でシートをスクロールします。vPixelsが正の値の場合、ワークシートは下方向にスクロールします。 vPixelsが負の値の場合、ワークシートは上方向にスクロールします。 また、vPixelsが0の場合、ワークシートは垂直方向にスクロールしません。hPixelsが正の値の場合、ワークシートは右方向にスクロールします。 hPixelsが負の値の場合、ワークシートは左方向にスクロールします。また、 hPixelsが0の場合、ワークシートは水平方向にスクロールしません。ワークブックのscrollByPixelがtrueの場合、ワークシートは新しい先頭行/左列のインデックスと新しい先頭行/左列のオフセットまでスクロールします。ワークブックのオプションscrollByPixelがfalseの場合、ワークシートは新しい先頭行/左列のインデックスにスクロールし、新しい先頭行/左列のオフセットは常に0になります。

実例

//　次のサンプルコードは、シートを下方向に10ピクセル、右方向に5ピクセルをスクロールします。
activeSheet.scroll(10, 5);

パラメータ

名前	型	説明
vPixels	number	垂直方向にスクロールするピクセル単位。
hPixels	number	水平方向にスクロールするピクセル単位。

戻り値

void

---

search

▸ search(searchCondition): SearchResult

指定した内容を検索します。

実例

//　次のサンプルコードは、searchメソッドを使用します。
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= activeSheet.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

検索結果。

---

selectionPolicy

▸ selectionPolicy(value?): any

ユーザーがシート上の項目の範囲を選択できるかどうかを取得または設定します。

実例

//　次のサンプルコードは、selectionPolicyメソッドを使用します。
activeSheet.selectionUnit(GC.Spread.Sheets.SelectionUnit.row);
activeSheet.selectionPolicy(GC.Spread.Sheets.SelectionPolicy.range);

パラメータ

名前	型
value?	SelectionPolicy

戻り値

any

値が設定されていない場合は、選択ポリシーの設定を返します。値が設定されている場合は、シートを返します。

---

selectionUnit

▸ selectionUnit(value?): any

ユーザーがシート上のセル、行、または列を選択できるかどうかを取得または設定します。

実例

//　次のサンプルコードは、selectionUnitメソッドを使用します。
activeSheet.selectionUnit(GC.Spread.Sheets.SelectionUnit.row);
activeSheet.selectionPolicy(GC.Spread.Sheets.SelectionPolicy.range);

パラメータ

名前	型
value?	SelectionUnit

戻り値

any

値が設定されていない場合は、選択単位の設定を返します。値が設定されている場合は、シートを返します。

---

setActiveCell

▸ setActiveCell(row, col): void

このシートのアクティブセルを設定します。

実例

//　次のサンプルコードは、アクティブセルを設定します。
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);
  });

パラメータ

名前	型	説明
row	number	セルの行インデックス。
col	number	セルの列インデックス。

戻り値

void

---

setArray

▸ setArray(row, column, array, setFormula?): void

指定したオブジェクトの２次元配列の値をこのシートの 指定したセル範囲に設定します。

実例

// 次のサンプルコードは、setArrayメソッドを使用します。
// 値を設定します。
var array = [[1,2,3],[4,5],[6,7,8,9]];
activeSheet.setArray(1, 2, array);
// 数式を設定します。
var array = [["=1+1","=2+2","=3+3"],["=4+4","=5+5"],["=6+6","=7+7","=8+8","=9+9"]];
activeSheet.setArray(1, 2, array, true);
// 値を取得します。
var newArray = activeSheet.getArray(1, 2, 3, 4);
//getformula
var newArray = activeSheet.getArray(1, 2, 3, 4, true);
//alert(newArray[0]);

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
array	any[]	設定する値が格納された配列。
setFormula?	boolean	-

戻り値

void

---

setArrayFormula

▸ setArrayFormula(row, col, rowCount, colCount, value, sheetArea?): void

指定したシート領域内の指定したセルに数式を設定します。

実例

// 次のサンプルコードは、setArrayFormulaメソッドを使用します。
activeSheet.getCell(1,1).value(3);
activeSheet.getCell(2,1).value(1);
activeSheet.getCell(3,1).value(3);
activeSheet.getCell(4,1).value(7);
activeSheet.getCell(1,2).value(7);
activeSheet.getCell(2,2).value(7);
activeSheet.getCell(3,2).value(7);
activeSheet.getCell(4,2).value(7);
spread.allowUserEditFormula(true);
activeSheet.setArrayFormula(0, 3, 4, 1, "B2:B5*C2:C5", GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	開始行インデックス。
col	number	開始列インデックス。
rowCount	number	範囲内の行数。
colCount	number	範囲内の列数。
value	string	指定した範囲に設定する配列数式。
sheetArea?	SheetArea	-

戻り値

void

---

setBindingPath

▸ setBindingPath(row, col, path): Worksheet

指定したシート領域内の指定したセルにセルレベル連結の連結パスを設定します。

実例

//　次のサンプルコードは、セルを連結します。
var test = {name: "John", gender: "male"};
sheet.setBindingPath(0, 0, "name");
sheet.setBindingPath(0, 1, "gender");
sheet.setDataSource(new GC.Spread.Sheets.Bindings.CellBindingSource(test));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
path	string	セル連結ソースの連結パス。

戻り値

Worksheet

---

setCellType

▸ setCellType(row, col, value, sheetArea?): void

セル型を設定します。

実例

// 次のサンプルコードは、setCellTypeメソッドを使用します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.setCellType(1,1,cellType);
spread.bind(GC.Spread.Sheets.Events.ButtonClicked, function (e, args) {
    var sheet = args.sheet, row = args.row, col = args.col;
    var cellType = activeSheet.getCellType(row, col);
    if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
        alert("Button Clicked");
    }
});

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	Base	セル型。
sheetArea?	SheetArea	-

戻り値

void

---

setColumnCount

▸ setColumnCount(colCount, sheetArea?, guardContent?): void

指定したシート領域の列数を設定します。

実例

//　次のサンプルコードは、列数を設定します。
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
colCount	number	列数。
sheetArea?	SheetArea	-
guardContent?	UsedRangeType	-

戻り値

void

---

setColumnPageBreak

▸ setColumnPageBreak(column, value): void

印刷時にこのシートの指定した列の前に強制改ページが挿入されるかどうかを設定します。

実例

//　次のサンプルコードは、改ページを設定します。
activeSheet.setColumnPageBreak(5, true);

パラメータ

名前	型	説明
column	number	列インデックス。
value	boolean	印刷時にこのシートの指定した列の前で強制的に改ページする場合、trueに設定します。

戻り値

void

---

setColumnResizable

▸ setColumnResizable(col, value, sheetArea?): void

指定したシート領域内の指定した列のサイズをユーザーが変更できるかどうかを設定します。

実例

// 次のサンプルコードは、setColumnResizableメソッドを設定します。
sheet.setRowResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(1,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);
sheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);

パラメータ

名前	型	説明
col	number	列インデックス。
value	boolean	列のサイズをユーザーが変更できるようにする場合、trueに設定します。
sheetArea?	SheetArea	-

戻り値

void

---

setColumnVisible

▸ setColumnVisible(col, value, sheetArea?): void

指定したシート領域内の列が表示されるかどうかを設定します。

実例

//　次のサンプルコードは、指定した列を非表示に設定します。
activeSheet.setColumnVisible(2,false,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
col	number	列インデックス。
value	boolean	列を表示するかどうか。
sheetArea?	SheetArea	-

戻り値

void

---

setColumnWidth

▸ setColumnWidth(col, value, sheetArea?): void

指定したシート領域内の指定した列の幅（ピクセル単位または動的サイズ）を設定します。

実例

//　次のサンプルコードは、列の幅を設定します。
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(1, "2*", GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

パラメータ

名前	型	説明
col	number	列インデックス。
value	string | number	ピクセル単位での幅、または「*」文字列を使用して動的サイズを表します。
sheetArea?	SheetArea	-

戻り値

void

---

setCsv

▸ setCsv(row, column, text, rowDelimiter, columnDelimiter): void

区切り付きテキスト（CSV）をシートに設定します。

パラメータ

名前	型	説明
row	number	開始行。
column	number	開始列。
text	string	区切り付きテキスト。
rowDelimiter	string	行区切り文字。
columnDelimiter	string	列区切り文字。

戻り値

void

---

setDataSource

▸ setDataSource(data, reset?): void

シートにデータを供給するデータソースを設定します。

実例

var test = [
       { "Series0": 2, "Series1": 1 },
       { "Series0": 4, "Series1": 2 },
       { "Series0": 3, "Series1": 4 }
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(test, true);

パラメータ

名前	型	説明
data	any	データソース。
reset?	boolean	シートがリセットされた場合はtrue、それ以外の場合はfalse。

戻り値

void

---

setDataValidator

▸ setDataValidator(row, col, value, sheetArea?): void

セルデータバリデーターを設定します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	DefaultDataValidator	データバリデーター。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

void

▸ setDataValidator(row, col, rowCount, colCount, value, sheetArea?): void

セルデータバリデーターを設定します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
rowCount	number	行数。
colCount	number	列数。
value	DefaultDataValidator	データバリデーター。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

void

---

setDefaultStyle

▸ setDefaultStyle(style, sheetArea?): void

シートのデフォルトスタイル情報を設定します。

パラメータ

名前	型	説明
style	Style	設定するスタイル。
sheetArea?	SheetArea	-

戻り値

void

---

setFormatter

▸ setFormatter(row, col, value, sheetArea): void

セルフォーマッターを設定します。

実例

//　次のサンプルコードは、アクティブシートの書式オブジェクトを設定します。
activeSheet.setValue(2, 3, new Date(2011, 2, 9));
activeSheet.setFormatter(2,3,"M",GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	string | FormatterBase	フォーマッター文字列またはオブジェクト。
sheetArea	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

void

---

setFormula

▸ setFormula(row, col, value, sheetArea?): void

指定したシート領域内の指定したセルに数式を設定します。

実例

//　次のサンプルコードは、指定したセルの数式を設定します。
activeSheet.setValue(0, 2, 3);
activeSheet.setFormula(1,1,"C1+D1",GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	string	指定したセルに設定する数式。
sheetArea?	SheetArea	-

戻り値

void

---

setHyperlink

▸ setHyperlink(row, col, value, sheetArea?): void

指定されたシート領域の指定したセルにハイパーリンクデータを設定します。

実例

//　次のサンプルコードは、setHyperlinkメソッドを使用します。
sheet.setHyperlink(0, 2, {
   url: 'https://www.grapecity.com/spreadjs',
   tooltip: 'baidu',
   linkColor: 'blue',
   visitedLinkColor: 'red',
   target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank,
   command: 'navigationLeft'
}, GC.Spread.Sheets.SheetArea.viewport);
sheet.setHyperlink(1, 1, {
   url: 'https://www.grapecity.com/spreadjs',
   tooltip: 'baidu',
   setUnderlineToStyle: true;
   setForeColorToStyle: true;
   target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.top,
   command: function() { console.log('Only show this message when click the hyperlink.')}
}, GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	IHyperlink	指定されたセルに設定するハイパーリンクデータ。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

void

---

setRowCount

▸ setRowCount(rowCount, sheetArea?, guardContent?): void

指定したシート領域の行数を設定します。

実例

//　次のサンプルコードは、行数を設定します。
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
rowCount	number	行数。
sheetArea?	SheetArea	-
guardContent?	UsedRangeType	-

戻り値

void

---

setRowHeight

▸ setRowHeight(row, value, sheetArea?): void

指定したシート領域内の指定した行の高さ（ピクセル単位または動的サイズ）を設定します。

実例

// 次のサンプルコードは、行の高さを設定します。
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setRowHeight(1, "3*", GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

パラメータ

名前	型	説明
row	number	行インデックス。
value	string | number	ピクセル単位での高さ、または「*」文字列を使用して動的サイズを表します。
sheetArea?	SheetArea	-

戻り値

void

---

setRowPageBreak

▸ setRowPageBreak(row, value): void

印刷時にこのシートの指定した行の前に強制改ページが挿入されるかどうかを設定します。

実例

activeSheet.setRowPageBreak(3, true);

パラメータ

名前	型	説明
row	number	行インデックス。
value	boolean	印刷時にこのシートの指定した行の前で強制的に改ページする場合、trueに設定します。

戻り値

void

---

setRowResizable

▸ setRowResizable(row, value, sheetArea?): void

指定したシート領域内の指定した行のサイズをユーザーが変更できるかどうかを設定します。

実例

//　次のサンプルコードは、特定の行および列がサイズ変更されないようにします。
sheet.setRowResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(1,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);
sheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);

パラメータ

名前	型	説明
row	number	行インデックス。
value	boolean	指定した行のサイズをユーザーが変更できるようにする場合、trueに設定します。
sheetArea?	SheetArea	-

戻り値

void

---

setRowVisible

▸ setRowVisible(row, value, sheetArea?): void

指定したシート領域内の指定した行がコントロールに表示されるかどうかを設定します。

実例

//　次のサンプルコードは、指定した行を非表示に設定します。
activeSheet.setRowVisible(1,false,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
value	boolean	指定した行を表示する場合、trueに設定します。
sheetArea?	SheetArea	-

戻り値

void

---

setSelection

▸ setSelection(row, column, rowCount, columnCount): void

セルまたは範囲に選択を設定し、アクティブセルを最初のセルに設定します。

実例

//　次のサンプルコードは、セル範囲を選択します。
sheet.setValue(0,0, 1,3);
sheet.setValue(1,0, 50,3);
sheet.setValue(2,0, 100,3);
sheet.setValue(3,0, 2,3);
sheet.setValue(4,0, 60,3);
sheet.setValue(5,0, 90,3);
sheet.setValue(6,0, 3,3);
sheet.setValue(7,0, 40,3);
sheet.setValue(8,0, 70,3);
sheet.setValue(9,0, 5,3);
sheet.setValue(10,0, 35,3);
sheet.setSelection(0,0,11,1);
sheet.conditionalFormats.add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());

パラメータ

名前	型	説明
row	number	追加する最初のセルの行インデックス。
column	number	追加する最初のセルの列インデックス。
rowCount	number	追加する行数。
columnCount	number	追加する列の数。

戻り値

void

---

setSparkline

▸ setSparkline(row, col, dataRange, dataOrientation, sparklineType, sparklineSetting, dateAxisRange?, dateAxisOrientation?): Sparkline

セルのスパークラインを設定します。

実例

//　次のサンプルコードは、指定した範囲に対するスパークラインを作成します。
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
setting.options.seriesColor = "Text 2 1";
setting.options.firstMarkerColor = "Text 2 3";
setting.options.negativeColor = "Accent 2 1";
setting.options.markersColor = "Accent 3 1";
setting.options.lowMarkerColor = "Accent 4 1";
setting.options.highMarkerColor = "Accent 6 1";
setting.options.lastMarkerColor = "Accent 6 6";
setting.options.axisColor ="Text 1 1";
sheet.addSpan(13, 0, 4, 3, null);
sheet.setSparkline(13, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
sheet.setValue(1, 0, 1);
sheet.setValue(2, 0, -2);
sheet.setValue(3, 0, -1);
sheet.setValue(4, 0, 6);
sheet.setValue(5, 0, 4);
sheet.setValue(6, 0, -4);
sheet.setValue(7, 0, 3);
sheet.setValue(8, 0, 8);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
dataRange	string | Range	データ範囲。
dataOrientation	DataOrientation	データの方向。
sparklineType	SparklineType	スパークラインの種類。
sparklineSetting	SparklineSetting	スパークライン設定。
dateAxisRange?	string | Range	日付軸範囲。
dateAxisOrientation?	DataOrientation	日付軸範囲の方向。

戻り値

Sparkline

スパークライン

---

setStyle

▸ setStyle(row, col, value, sheetArea?): void

指定したシート領域内の指定したセルのスタイル情報を設定します。

実例

//　次のサンプルコードは、setStyleメソッドを使用します。
var style = new GC.Spread.Sheets.Style();
style.backColor = "lightgreen";
style.backgroundImage = "./css/images/quarter1.png";
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	-
value	Style	セルスタイル。
sheetArea?	SheetArea	-

戻り値

void

---

setStyleName

▸ setStyleName(row, column, value, sheetArea?): void

指定したシート領域内の指定したセルに指定したスタイルの名前を設定します。

実例

var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
activeSheet.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // cell(1,1) の backColor は緑です。
activeSheet.setStyleName(2, 1, "style1");

パラメータ

名前	型	説明
row	number	行インデックス。
column	number	列インデックス。
value	string	設定するスタイルの名前。
sheetArea?	SheetArea	-

戻り値

void

---

setTag

▸ setTag(row, col, tag, sheetArea?): void

指定したシート領域内の指定したセルのタグ値を設定します。

実例

activeSheet.setTag(1,1,"test");

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
tag	any	指定したセルに設定するタグ値。
sheetArea?	SheetArea	シート領域。このパラメーターが指定されていない場合は、<b>viewport</b>にデフォルト設定されます。

戻り値

void

---

setText

▸ setText(row, col, value, sheetArea?): void

指定したシート領域内のセルの書式付きテキストを設定します。

実例

activeSheet.setText(1, 0, "10");

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	string	指定したセルのテキスト。
sheetArea?	SheetArea	-

戻り値

void

---

setValue

▸ setValue(row, col, value, sheetArea?, ignoreRecalc?): void

指定したシート領域内の指定したセルの値を設定します。

実例

//　次のサンプルコードは、setValueメソッドを使用します。
sheet.setValue(0,2,"ColumnHeader", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(2,0,{richText:[{style:{font:'bold 24px Arial'},text:'SpreadJS'}]}, GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(1, 1, {richText:[{style:{vertAlign: GC.Spread.Sheets.VertAlign.subscript},text:'SpreadJS'}]}, GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
value	any	指定されたセルに設定する値。値がリッチテキスト形式の場合は、リッチテキストスタイルの配列であるrichTextフィールドを含める必要があります。
sheetArea?	SheetArea	-
ignoreRecalc?	boolean	再計算を無視するかどうか。

戻り値

void

---

showCell

▸ showCell(row, col, verticalPosition, horizontalPosition): void

セルのビューをビューポート内の指定した位置に移動します。

実例

//　次のサンプルコードは、showCellメソッドを使用します。
//　セル(3,3)をアクティブセルとして設定します。
activeSheet.setActiveCell(3, 3);
//　アクティブセルを左上に表示します。
activeSheet.showCell(3, 3, GC.Spread.Sheets.VerticalPosition.top, GC.Spread.Sheets.HorizontalPosition.left);

パラメータ

名前	型	説明
row	number	行インデックス。
col	number	列インデックス。
verticalPosition	VerticalPosition	セルを表示する垂直位置。
horizontalPosition	HorizontalPosition	セルを表示する水平位置。

戻り値

void

---

showColumn

▸ showColumn(col, horizontalPosition): void

列のビューをビューポート内の指定した位置に移動します。

実例

activeSheet.showColumn(9, GC.Spread.Sheets.HorizontalPosition.left);

パラメータ

名前	型	説明
col	number	列インデックス。
horizontalPosition	HorizontalPosition	列を表示する水平位置。

戻り値

void

---

showColumnOutline

▸ showColumnOutline(value?): any

列アウトライン（範囲グループ）が表示されるかどうかを取得または設定します。

実例

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

パラメータ

名前	型	説明
value?	boolean	列アウトラインを表示するかどうか。

戻り値

any

値が設定されていない場合は、列アウトラインがこのシートに表示されるかどうかを示す値を返します。値が設定されている場合は、ワークシートを返します。

---

showRow

▸ showRow(row, verticalPosition): void

行のビューをビューポート内の指定した位置に移動します。

実例

activeSheet.showRow(9, GC.Spread.Sheets.VerticalPosition.top);

パラメータ

名前	型	説明
row	number	行インデックス。
verticalPosition	VerticalPosition	行を表示する垂直位置。

戻り値

void

---

showRowOutline

▸ showRowOutline(value?): any

行アウトライン（範囲グループ）が表示されるかどうかを取得または設定します。

実例

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

パラメータ

名前	型	説明
value?	boolean	行アウトラインを表示するかどうか。

戻り値

any

値が設定されていない場合は、行アウトラインがこのシートに表示されるかどうかを示す値を返します。値が設定されている場合は、ワークシートを返します。

---

sortRange

▸ sortRange(row, column, rowCount, columnCount, byRows, sortInfo, sortOption?): boolean

このシートのデータモデル内のセル範囲をソートします。

実例

//　次のサンプルコードは、範囲をソートします。
sheet.setValue(0,0,"112");
sheet.setValue(1,0,"10");
sheet.setValue(2,0,"223");
sheet.setValue(3,0,"20");
sheet.setValue(4,0,"334");
sheet.setValue(5,0,"30");
function pinyinCompare (obj1, obj2) {
    return obj1.toString().localeCompare(obj2.toString(), 'zh');
}
sheet.sortRange(0, 0, 6, 1, true, [
                {index:0, ascending:true, compareFunction: pinyinCompare}
                ], {groupSort: GC.Spread.Sheets.GroupSort.full, ignoreHidden: true});

パラメータ

名前	型	説明
row	number	ソートするセルブロックの開始行のインデックス。
column	number	ソートするセルブロックの開始列のインデックス。
rowCount	number	セルブロックの行数。
columnCount	number	セルブロックの列数。
byRows	boolean	行単位でソートする場合はtrue、列単位でソートする場合はfalseに設定します。
sortInfo	(ICellColorSortInfo | ICustomSortInfo | IFontColorSortInfo | IValueSortInfo)[]	ソート基準と、ソートの実行方法に関する情報を含むSortInfoオブジェクト。例: [{index:0,ascending:true}]。
sortOption?	ISortOptions	sortOptionは、ソートの詳細なパフォーマンスを示します。

戻り値

boolean

データのソートが成功した場合はtrue、それ以外の場合はfalse。

---

startEdit

▸ startEdit(selectAll?, defaultText?): void

セルの編集を開始します。

実例

//　次のサンプルコードは、startEditメソッドを使用します。
activeSheet.setActiveCell(5,5);
activeSheet.startEdit(true, "Test");

パラメータ

名前	型	説明
selectAll?	boolean	セルのすべてのテキストを選択する場合、trueに設定します。
defaultText?	string	セルの編集中に表示するデフォルトテキスト。

戻り値

void

---

suspendCalcService

▸ suspendCalcService(ignoreDirty?): void

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

実例

// 次のサンプルコードは、suspendCalcServiceメソッドを使用します。
activeSheet.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)");
activeSheet.resumeCalcService(true);

パラメータ

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

戻り値

void

---

suspendDirty

▸ suspendDirty(): void

ダーティデータの記録を一時停止します。

実例

//　次のサンプルコードは、suspendDirtyメソッドを使用します。
 var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

戻り値

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));
    }
});
activeSheet.suspendEvent();
activeSheet.setValue(0, 0, "111");
activeSheet.resumeEvent();
activeSheet.setValue(1, 1, "222");

戻り値

void

---

suspendPaint

▸ suspendPaint(): void

描画を中断します。

戻り値

void

---

tag

▸ tag(value?): any

現在のシートのタグ値を取得または設定します。

実例

//　次のサンプルコードは、シートタグを設定します。
activeSheet.tag("test");
alert(activeSheet.tag());

パラメータ

名前	型	説明
value?	any	現在のシートに設定するタグ値。

戻り値

any

値が設定されていない場合は、現在のシートのタグ値を返します。値が設定されている場合は、ワークシートを返します。

---

toJSON

▸ toJSON(serializationOption?): Object

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

実例

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

パラメータ

名前	型	説明
serializationOption?	Object	<i>includeBindingSource</i>引数を含むシリアル化オプション。詳細については、「解説」を参照してください。

戻り値

Object

シートのデータ。

---

unbind

▸ unbind(type, fn?): void

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

実例

//　次のサンプルコードは、最初の値を設定した後にイベントの連結を解除します。
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");
activeSheet.unbind(GC.Spread.Sheets.Events.CellChanged);
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

パラメータ

名前	型	説明
type	string	イベントタイプ。
fn?	Function	連結を解除する関数を指定します。

戻り値

void

---

unbindAll

▸ unbindAll(): void

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

実例

//　次のサンプルコードは、すべてのイベントの監視をキャンセルします。
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");
activeSheet.unbindAll(); //すべてのイベントの監視をキャンセルします。
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

戻り値

void

---

ungroupSparkline

▸ ungroupSparkline(group): void

指定したグループに含まれるスパークラインのグループ化を解除します。

実例

//　次のサンプルコードは、ungroupSparklineメソッドを使用します。
activeSheet.setValue(0, 0, "Data Range is A2-A9");
activeSheet.setValue(1, 0, 1);
activeSheet.setValue(2, 0, -2);
activeSheet.setValue(3, 0, -1);
activeSheet.setValue(4, 0, 6);
activeSheet.setValue(5, 0, 4);
activeSheet.setValue(6, 0, -4);
activeSheet.setValue(7, 0, 3);
activeSheet.setValue(8, 0, 8);
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
var s1=  activeSheet.setSparkline(11, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
var s2 =activeSheet.setSparkline(11, 3, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.column, setting);
var s3=  activeSheet.setSparkline(11, 6, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.winloss, setting);
var group = activeSheet.groupSparkline([s1,s2,s3]);
//activeSheet.ungroupSparkline(group);

パラメータ

名前	型	説明
group	SparklineGroup	スパークライングループ

戻り値

void

---

unprotect

▸ unprotect(password?): boolean

ワークシートの保護を解除します。

実例

let password = "fe4c4be8"
sheet.protect(password);
sheet.unprotect(password);

パラメータ

名前	型	説明
password?	string	シート保護のパスワード。

戻り値

boolean

正しいパスワードであるかisProtectがfalseである場合はtrue、それ以外の場合はfalseを返します。

---

visible

▸ visible(value?): any

ワークシートが表示されるかどうかを設定します。

実例

activeSheet.visible(false);

パラメータ

名前	型
value?	boolean | SheetTabVisible

戻り値

any

この関数をパラメーターなしで呼び出すと、シートが表示されるかどうかを示すブール値が返されます。それ以外の場合は、現在のワークシートオブジェクトが返されます。

---

zoom

▸ zoom(factor?): any

シートのズーム率を取得または設定します。

実例

//　次のサンプルコードは、シートをズームします。
spread.options.allowUserZoom = false;
sheet.zoom(3);

パラメータ

名前	型
factor?	number

戻り値

any

値が設定されていない場合は、ズーム率を返します。値が設定されている場合は、ワークシートを返します。