クラス: TableManager

Sheets.Tables.TableManager

Table of contents

コンストラクタ

• constructor

メソッド

• add
• addFromDataSource
• all
• find
• findByName
• move
• remove
• resize

コンストラクタ

constructor

• new TableManager(sheet)

シートのすべてのテーブルを管理するテーブルマネージャを表します。

パラメータ

名前	型	説明
sheet	Worksheet	ワークシート。

メソッド

add

▸ add(name?, row?, column?, rowCount?, columnCount?, style?): Table

指定したサイズの範囲テーブルをシートに追加します。

実例

// 次のサンプルコードは、テーブルを追加します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, '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");

パラメータ

名前	型	説明
name?	string	テーブル名。
row?	number	行インデックス。
column?	number	列インデックス。
rowCount?	number	テーブルの行数。
columnCount?	number	テーブルの列数。
style?	string | TableTheme	テーブルのスタイル。

戻り値

Table

新しいテーブルインスタンス。

---

addFromDataSource

▸ addFromDataSource(name, row, column, dataSource, style, options?): Table

指定したデータソースを持つ範囲テーブルをシートに追加します。

実例

var source = [
                { LastName: "Freehafer", FirstName: "Nancy", Title: "Sales Representative", Phone: "(123)555-0100"},
                { LastName: "Cencini", FirstName: "Andrew", Title: "Vice President, Sales", Phone: "(123)555-0101"},
                { LastName: "Kotas", FirstName: "Jan", Title: "Sales Representative", Phone: "(123)555-0102"},
                { LastName: "Sergienko", FirstName: "Mariya", Title: "Sales Representative", Phone: "(123)555-0103"},
            ];
 activeSheet.tables.addFromDataSource("Table1", 5, 2, source, GC.Spread.Sheets.Tables.TableThemes.dark1);

パラメータ

名前	型	説明
name	string	テーブル名。
row	number	行インデックス。
column	number	列インデックス。
dataSource	Object	テーブルのデータソース。
style	TableTheme	テーブルのスタイル。
options?	ITableOptions	-

戻り値

Table

新しいテーブルインスタンス。

---

all

▸ all(): Table[]

シートのすべてのテーブルを取得します。

戻り値

Table[]

テーブルのインスタンスを含むGC.Spread.Sheets.Tables.Tableの配列。この配列がnullになることはありません。

---

find

▸ find(row, column): Table

指定したセルのテーブルを取得します。

実例

// 次のサンプルコードは、findメソッドを使用します。
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");
// ボタンクリック。
$("#button1").click(function () {
     var table  = activeSheet.tables.find(0,0);
     console.log(table.name());
});

パラメータ

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

戻り値

Table

セルがテーブルに属する場合はテーブルインスタンス。それ以外の場合は null。

---

findByName

▸ findByName(name): Table

指定した名前を持つテーブルを取得します。

実例

// 次のサンプルコードは、名前によってテーブルを検索します。
var activeSheet = spread.getActiveSheet();
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");
// ボタンクリック。
$("#button1").click(function () {
     var table  = activeSheet.tables.findByName("Table1");
     console.log(table.name());
});

パラメータ

名前	型	説明
name	string	テーブル名。

戻り値

Table

セルがテーブルに属する場合はテーブルインスタンス。それ以外の場合は null。

---

move

▸ move(table, row, column): void

テーブルの位置を変更します。

実例

var activeSheet = spread.getActiveSheet();
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");
// ボタンクリック。
$("#button1").click(function () {
     var table  = activeSheet.tables.findByName("Table1");
     alert(table);
     activeSheet.tables.move(table, 3, 3);
});

パラメータ

名前	型	説明
table	string | Table	テーブルインスタンスまたはテーブル名。
row	number	新しい行インデックス。
column	number	新しい列インデックス。

戻り値

void

---

remove

▸ remove(table, options): Table

指定したテーブルを削除します。

実例

var table  = activeSheet.tables.find(0,0);
activeSheet.tables.remove(table, GC.Spread.Sheets.Tables.TableRemoveOptions.keepData);

パラメータ

名前	型	説明
table	string | Table	テーブルインスタンスまたはテーブル名。
options	TableRemoveOptions	テーブルを削除するときにどのデータを保持するかを指定します。

戻り値

Table

---

resize

▸ resize(table, range): void

テーブルのサイズを変更します。

実例

// 次のサンプルコードは、テーブルをサイズ変更します。
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");
// ボタンクリック。
$("#button1").click(function () {
     var table  = activeSheet.tables.find(0,0);
     activeSheet.tables.resize(table, new GC.Spread.Sheets.Range(0,0,4,4));
});

パラメータ

名前	型	説明
table	string | Table	テーブルまたはテーブル名。
range	Range	新しいテーブル範囲。ヘッダは同じ行にとどまる必要があります。また、結果のテーブル範囲が元のテーブル範囲と重なっている必要があります。

戻り値

void