- GC.Data
- GC.Pivot
- GC.Spread.CalcEngine
- GC.Spread.CalcEngine.Functions
- GC.Spread.CalcEngine.LanguagePackages
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Pivot
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Slicers
- GC.Spread.Sheets.Designer
- GC.Spread.Excel.IO
GC.Spread.Sheets.Tables.Table
クラス: Table
Table of contents
コンストラクタ
メソッド
- allowAutoExpand
- autoGenerateColumns
- bandColumns
- bandRows
- bind
- bindColumns
- bindingPath
- clearPendingChanges
- dataRange
- deleteColumns
- deleteRows
- expandBoundRows
- filterButtonVisible
- footerIndex
- getColumnFormula
- getColumnName
- getColumnValue
- getDirtyRows
- headerIndex
- highlightFirstColumn
- highlightLastColumn
- insertColumns
- insertRows
- name
- range
- rowFilter
- setColumnDataFormula
- setColumnFormula
- setColumnName
- setColumnValue
- showFooter
- showHeader
- showResizeHandle
- style
- useFooterDropDownList
コンストラクタ
constructor
• new Table(name?, row?, col?, rowCount?, colCount?, style?)
シートに追加できるテーブルを表します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
name? |
string |
テーブル名。 |
row? |
number |
テーブルの行インデックス。 |
col? |
number |
テーブルの列インデックス。 |
rowCount? |
number |
テーブルの行数。 |
colCount? |
number |
テーブルの列数。 |
style? |
TableTheme |
テーブルスタイル。 |
メソッド
allowAutoExpand
▸ allowAutoExpand(allowAutoExpandState?): boolean | Table
テーブルのallowAutoExpandStateを取得または設定します。
実例
table.allowAutoExpand();
table.allowAutoExpand(true);
パラメータ
| 名前 | 型 |
|---|---|
allowAutoExpandState? |
boolean |
戻り値
boolean | Table
allowAutoExpandStateが設定されていない場合は、テーブルallowAutoExpandStateを返します。 値が設定されている場合は、テーブルを返します。
autoGenerateColumns
▸ autoGenerateColumns(value?): any
データソースに連結するときに列を自動的に生成するかどうかを取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
データソースに連結するときに列を自動的に生成するかどうか。 |
戻り値
any
値が設定されていない場合は、データソースに連結するときに列を自動的に生成するかどうかを返します。値が設定されている場合は、テーブルを返します。
bandColumns
▸ bandColumns(value?): any
交互列スタイルを表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.bandColumns(true);
sTable.bandRows(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
交互列スタイルを表示するかどうか。 |
戻り値
any
値が設定されていない場合は、交互列スタイルを表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
bandRows
▸ bandRows(value?): any
交互行スタイルを表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.bandColumns(true);
sTable.bandRows(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
交互行スタイルを表示するかどうか。 |
戻り値
any
値が設定されていない場合は、交互行スタイルを表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
bind
▸ bind(columns, path?, dataSource?): Table
テーブルのdataSource、バインディング列、およびバインディングパスを取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
columns |
TableColumn[] |
データフィールドと名前を含むテーブル列情報の配列。各配列要素はGC.Spread.Sheets.Tables.TableColumnです。 |
path? |
string |
- |
dataSource? |
object |
テーブルのデータソース。 |
戻り値
テーブルを返します。
bindColumns
▸ bindColumns(columns): void
指定したデータフィールドを使用して列を連結します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
columns |
TableColumn[] |
データフィールドと名前を含むテーブル列情報の配列。各配列要素はGC.Spread.Sheets.Tables.TableColumnです。 |
戻り値
void
bindingPath
▸ bindingPath(value?): any
テーブル内のセルレベル連結の連結パスを取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
テーブル内のセルレベル連結の連結パス。 |
戻り値
any
値が設定されていない場合は、テーブル内のセルレベル連結の連結パスを返します。値が設定されている場合は、テーブルを返します。
clearPendingChanges
▸ clearPendingChanges(): void
現在のテーブルからダーティステータスをクリアします。
実例
table.clearPendingChanges();
戻り値
void
dataRange
▸ dataRange(): Range
テーブルデータ領域のセル範囲を取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
var drange = sTable.dataRange();
alert(drange.row);
戻り値
テーブルのデータ範囲。
deleteColumns
▸ deleteColumns(col, count): void
このテーブルの指定した列インデックスの前に列数を削除します。
実例
var table = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
table.deleteColumns(3, 1);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
col |
number |
テーブルのインデックスに基づいて削除する最初の列のインデックス。 |
count |
number |
削除する列数。 |
戻り値
void
deleteRows
▸ deleteRows(row, count): void
このテーブルの指定した行インデックスにある行を削除します。
実例
var table = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
table.deleteRows(3, 1);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
row |
number |
テーブルのインデックスに基づいて削除する最初の行のインデックス。 |
count |
number |
削除する行数。 |
戻り値
void
expandBoundRows
▸ expandBoundRows(value?): any
バインディングのモードの場合にテーブルが行を展開する値を取得または設定します。
実例
var spread = GC.Spread.Sheets.findControl("ss") || GC.Spread.Sheets.findControl("sampleDiv");
var sheet = spread.getActiveSheet();
var data = {
name: 'Jones', region: 'East',
sales: [
{ orderDate: '1/6/2013', item: 'Pencil', units: 95, cost: 1.99 },
{ orderDate: '4/1/2013', item: 'Binder', units: 60, cost: 4.99 },
{ orderDate: '6/8/2013', item: 'Pen Set', units: 16, cost: 15.99 },
{ orderDate: '8/1/2013', item: 'Pencil', units: 20, cost: 24.99 },
{ orderDate: '10/8/2013', item: 'Binder', units: 31, cost: 16.99 }
]
};
var table1 = sheet.tables.add('tableRecords', 0, 0, 4, 4);
var table2 = sheet.tables.add('tableBelow', 4, 0, 4, 7);
table1.bindingPath('sales');
var dataSource = new GC.Spread.Sheets.Bindings.CellBindingSource(data);
table1.expandBoundRows(true);
sheet.setDataSource(dataSource);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
行を挿入/削除してシートまたはテーブルを展開するかどうか。 |
戻り値
any
値が設定されていない場合は、シートまたはテーブルの挿入/削除行で展開するかどうかを返します。 それ以外の場合は、テーブルを返します。
filterButtonVisible
▸ filterButtonVisible(tableColumnIndex?, value?): any
テーブル列のフィルタボタンが表示されるかどうかを取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.bandColumns(true);
sTable.bandRows(true);
sTable.filterButtonVisible(2, false);
alert(sTable.filterButtonVisible(2));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex? |
number |
フィルタボタンのテーブル列インデックス。 |
value? |
boolean |
テーブル列のフィルタボタンが表示されるかどうか。 |
戻り値
any
テーブル列のフィルタボタンの表示状態。
パラメーターが設定されていない場合、すべてのフィルタボタンが表示されない場合はfalse、それ以外の場合はtrueを返します。数値のみが設定されている場合は、指定されたテーブル列のフィルタボタンが表示されるかどうかを返します。フィルタボタンを表示するかどうかを示すブール値のみが設定されている場合は、それをすべてのフィルタボタンに適用してテーブルを返します。2個のパラメータが指定されている場合は、指定されたテーブル列のフィルタボタンに適用してテーブルを返します。
footerIndex
▸ footerIndex(): number
シート上のフッタインデックスを取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.showFooter(true);
sTable.setColumnName(4, "SUM");
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
var value = sTable.footerIndex();
alert(value);
戻り値
number
フッタのインデックス。
getColumnFormula
▸ getColumnFormula(tableColumnIndex): string
指定したインデックスを持つテーブルフッタの数式を取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.showFooter(true);
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
var value = sTable.getColumnFormula(4);
alert(value);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルフッタの列インデックス。インデックスは0から始まります。 |
戻り値
string
テーブルフッタの数式。
getColumnName
▸ getColumnName(tableColumnIndex): string
指定したテーブルインデックスを持つテーブルヘッダのテキストを取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.showFooter(true);
sTable.setColumnName(4, "SUM");
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
var value = sTable.getColumnName(4);
alert(value);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルヘッダの列インデックス。インデックスは0から始まります。 |
戻り値
string
インデックスで指定した列のヘッダテキスト。
getColumnValue
▸ getColumnValue(tableColumnIndex): string
指定したインデックスを持つテーブルフッタの値を取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
sTable.showFooter(true);
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
var value = sTable.getColumnValue(0);
alert(value);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルフッタの列インデックス。インデックスは0から始まります。 |
戻り値
string
テーブルフッタの値。
getDirtyRows
▸ getDirtyRows(): IRowState[]
ダーティな行の配列を取得します。
戻り値
ダーティな行のコレクション。配列の各要素には次の3つのプロパティが含まれます。row.: 行インデックスを示します。item: 現在の行のデータ項目を示します。originalItem: 行の元のデータ項目を示します。
headerIndex
▸ headerIndex(): number
シート上のヘッダインデックスを取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
var hindex = sTable.headerIndex();
alert(hindex);
戻り値
number
ヘッダのインデックス。
highlightFirstColumn
▸ highlightFirstColumn(value?): any
最初の列を強調表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.highlightFirstColumn(true);
sTable.highlightLastColumn(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
最初の列を強調表示するかどうか。 |
戻り値
any
値が設定されていない場合は、最初の列を強調表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
highlightLastColumn
▸ highlightLastColumn(value?): any
最後の列を強調表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.highlightFirstColumn(true);
sTable.highlightLastColumn(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
最後の列を強調表示するかどうか。 |
戻り値
any
値が設定されていない場合は、最後の列を強調表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
insertColumns
▸ insertColumns(col, count, isInsertAfter?): void
このテーブルの指定した列インデックスの前に列数を挿入します。
実例
var table = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
table.insertColumns(3, 1);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
col |
number |
テーブルのインデックスに基づいて新しい列を追加する列インデックス。 |
count |
number |
追加する列の数。 |
isInsertAfter? |
boolean |
指定した列インデックスの前または後に列を挿入するかどうか。 デフォルトの値は前に挿入することです。 |
戻り値
void
insertRows
▸ insertRows(row, count, isInsertAfter?): void
このテーブルの指定した行インデックスの前に行を挿入します。
実例
var table = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
table.insertRows(3, 1);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
row |
number |
テーブルのインデックスに基づいて挿入する最初行のインデックス。 |
count |
number |
追加する行数。 |
isInsertAfter? |
boolean |
指定した行インデックスの前または後に行を挿入するかどうか。 デフォルトの値は前に挿入することです。 |
戻り値
void
name
▸ name(value?): any
テーブル名を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
var tname = sTable.name();
alert(tname);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
テーブル名。 |
戻り値
any
値が設定されていない場合は、テーブル名を返します。値が設定されている場合は、テーブルを返します。
range
▸ range(): Range
テーブル全体の範囲を取得します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableTheme.medium2);
var drange = sTable.range();
alert(drange.row);
戻り値
テーブル全体の範囲。
rowFilter
▸ rowFilter(): HideRowFilter
テーブルの行フィルタを取得します。
戻り値
行フィルタ。
setColumnDataFormula
▸ setColumnDataFormula(tableColumnIndex, formula): Table
指定したインデックスを持つテーブルのデータ範囲に数式を設定します。
実例
// 次のサンプルコードは、テーブルで構造化された参照数式を使用します。
activeSheet.tables.add("Table1", 0, 0, 4, 3, GC.Spread.Sheets.Tables.TableTheme.dark1);
activeSheet.getCell(0,0).text("Value1");
activeSheet.getCell(0,1).text("Value2");
activeSheet.getCell(0,2).text("Total");
activeSheet.getCell(1,0).text("1");
activeSheet.getCell(2,0).text("2");
activeSheet.getCell(3,0).text("3");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(2,1).text("5");
activeSheet.getCell(3,1).text("5");
activeSheet.tables.findByName("Table1").setColumnDataFormula(2, "=[Value1]*[Value2]");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルの列インデックス。インデックスは0から始まります。 |
formula |
string |
データ範囲の数式。 |
戻り値
テーブル。
setColumnFormula
▸ setColumnFormula(tableColumnIndex, formula): Table
指定したインデックスを持つテーブルフッタの数式を設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showFooter(true);
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルフッタの列インデックス。インデックスは0から始まります。 |
formula |
string |
テーブルフッタの数式。 |
戻り値
テーブル。
setColumnName
▸ setColumnName(tableColumnIndex, name): Table
指定したテーブルインデックスを持つテーブルヘッダのテキストを設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showFooter(true);
sTable.setColumnName(4, "SUM");
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルヘッダの列インデックス。インデックスは0から始まります。 |
name |
string |
ヘッダテキスト。 |
戻り値
テーブル。
setColumnValue
▸ setColumnValue(tableColumnIndex, value): Table
指定したインデックスを持つテーブルフッタの値を設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showFooter(true);
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
tableColumnIndex |
number |
テーブルフッタの列インデックス。インデックスは0から始まります。 |
value |
Object |
テーブルフッタの値。 |
戻り値
テーブル。
showFooter
▸ showFooter(value?, isFooterInserted?): any
フッタを表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showFooter(true);
// フッタの値を設定します。
sTable.setColumnValue(0, "Total");
// フッタの数式を設定します。
sTable.setColumnFormula(4, "SUM(F3:F11)");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
フッタを表示するかどうか。 |
isFooterInserted? |
boolean |
値によってフッターを追加する方法が決定されます。合計行を挿入するか、次の行にオーバーライドするかを指定できます。同じ値の場合はフッターを削除します。 |
戻り値
any
値が設定されていない場合は、フッタを表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
showHeader
▸ showHeader(value?): any
ヘッダを表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showHeader(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
ヘッダを表示するかどうか。 |
戻り値
any
値が設定されていない場合は、ヘッダを表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
showResizeHandle
▸ showResizeHandle(value?): any
テーブルのサイズ変更ハンドルを表示するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.showResizeHandle(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
テーブルのサイズ変更ハンドルを表示するかどうか |
戻り値
any
値が設定されていない場合は、テーブルのサイズ変更ハンドルを表示するかどうかを返します。値が設定されている場合は、テーブルを返します。
style
▸ style(value?): any
テーブルのスタイルを取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
TableTheme |
テーブルのスタイル。 |
戻り値
any
値が設定されていない場合は、テーブルスタイルを返します。値が設定されている場合は、テーブルを返します。
useFooterDropDownList
▸ useFooterDropDownList(value?): any
合計行にフッタードロップダウンリストを使用するかどうかを示す値を取得または設定します。
実例
var sTable = activeSheet.tables.add("table1", 1, 1, 10, 5, GC.Spread.Sheets.Tables.TableThemes.medium2);
sTable.useFooterDropDownList(true);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
フッターのドロップダウンリストを使用するかどうか。 |
戻り値
any
値が設定されていない場合は、合計行に対してフッタードロップダウンリストを使用するかどうかを返します。デフォルトの値はfalseです。 値が設定されている場合は、テーブルを返します。