[]
        
(Showing Draft Content)

GC.Spread.Sheets.TableSheet.TableSheet

クラス: TableSheet

Sheets.TableSheet.TableSheet

階層

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

new TableSheet(name?, dataView?, options?)

指定された名前、データビュー、およびオプション設定を持つテーブルシートを表します。

実例

// 次のサンプルコードは、空のTableSheetを作成します。
var tableSheet = spread.addSheetTab(0, "", GC.Spread.Sheets.SheetType.tableSheet);

// 次のサンプルコードは、名前が指定されたTableSheetを作成します。
var tableSheet = spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);

// 次のサンプルコードは、名前とデータソースが指定されたTableSheetを作成します。
var dataManager = spread.dataManager();
var myTable = dataManager.addTable("myTable", {
    remote: {
        read: {
            url: 'https://demodata.mescius.io/northwind/api/v1/Orders'
        }
    }
});
myTable.fetch().then(function() {
    var myView = myTable.addView("myView");
    var tableSheet = spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
    tableSheet.setDataView(myView);
});

// 次のサンプルコードは、名前とオプションが指定されたTableSheetを作成します。
var style = new GC.Spread.Sheets.Style();
var tableSheet = spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
tableSheet.options = {allowAddNew: false, alternatingRowOptions: { step: [1, 1], style: style}};

パラメータ

名前
name? string
dataView? View
options? ITableSheetOptions

プロパティ

options

options: ITableSheetOptions

テーブルシートのオプションを表します。

プロパティ [allowAddNew ]- 新しい空の行を追加できるかどうか。

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

プロパティ [alternatingRowOptions ]- 交互行スタイルのオプションを定義します。

プロパティ [defaultStackRowHeight ]- テーブルシートのデフォルトのスタック行の高さ。 デフォルトで平均高さを計算します。

プロパティ [menuItemVisibility ]- テーブルシートのデフォルトのスタック行の高さ。 デフォルトで平均高さを計算します。

プロパティ [showRowNumber] - 行ヘッダの番号を表示するかどうか。

プロパティ [enableDefineColumn] - 列の定義を有効にするかどうか。

プロパティ [defineColumnCommand] - 列オプションを定義するコマンドを指定します。

プロパティ [submitDefineColumnCommand] - 定義された列オプションを送信するコマンドを指定します。

プロパティ [columnTypeItems] - 列タイプを指定します。

プロパティ [groupLayout] - グループレイアウトのオプションを指定します。

実例

// 次のサンプルコードは、TableSheetのオプションを変更します。
tableSheet.options.allowAddNew = false;
tableSheet.options.alternatingRowOptions = { step: [1, 1], style: new GC.Spread.Sheets.Style("lightyellow")};

メソッド

addHierarchyItemAbove

addHierarchyItemAbove(row, rowData): void

指定した行の親として新しい行データを追加します。

実例

// 次のサンプルコードは、指定された行の親として新しい行データを追加します。
tableSheet.addHierarchyItemAbove(8, {id: 8, name: "spreadjs"});

パラメータ

名前 説明
row number 行インデックス。
rowData any 行データ。

戻り値

void


addHierarchyItemAfter

addHierarchyItemAfter(row, rowData): void

指定した行の後に新しい行データを追加します。

実例

// 次のサンプルコードは、指定した行の後に新しい行データを追加します。
tableSheet.addHierarchyItemAfter(8, {id: 8, name: "spreadjs"});

パラメータ

名前 説明
row number 行インデックス。
rowData any 行データ。

戻り値

void


addHierarchyItemBefore

addHierarchyItemBefore(row, rowData): void

指定した行の前に新しい行データを追加します。

実例

// 次のサンプルコードは、指定した行の前に新しい行データを追加します。
tableSheet.addHierarchyItemBefore(8, {id: 8, name: "spreadjs"});

パラメータ

名前 説明
row number 行インデックス。
rowData any 行データ。

戻り値

void


addHierarchyItemBelow

addHierarchyItemBelow(row, rowData): void

指定した行の子として新しい行データを追加します。

実例

// 次のサンプルコードは、指定された行の子として新しい行データを追加します。
tableSheet.addHierarchyItemBelow(8, {id: 8, name: "spreadjs"});

パラメータ

名前 説明
row number 行インデックス。
rowData any 行データ。

戻り値

void


addRow

addRow(rowData): void

テーブルシートに新しい行を追加します。

実例

//次のサンプルコードは、データを含む新しい行を追加します。
tableSheet.addRow({id: 8, name: "spreadjs"});

パラメータ

名前 説明
rowData any 行データ。

戻り値

void


applyFreeHeaderArea

applyFreeHeaderArea(sheetJson?): any

ワークシートのJSONをTableSheet列ヘッダのないレイアウト領域に適用します。

パラメータ

名前 説明
sheetJson? any ワークシートのJSON。ワークシートのtoJSONメソッドで簡単に取得できます。

戻り値

any


applyTableTheme

applyTableTheme(tableTheme): void

現在のTableSheetにテーブルのテーマを適用します。

パラメータ

名前 説明
tableTheme TableTheme テーブルのテーマのインスタンス。

戻り値

void


cancelChanges

cancelChanges(): void

バッチモードでのデータマネージャの変更をキャンセルします。

実例

// 次のサンプルコードは、バッチモードで変更を手動でキャンセルします。
tableSheet.cancelChanges();

戻り値

void


collapseAllHierarchyLevels

collapseAllHierarchyLevels(): void

すべての階層レベルを折りたたみます。

実例

// 次のサンプルコードは、すべての階層レベルを折りたたみます。
tableSheet.collapseAllHierarchyLevels();

戻り値

void


demoteHierarchyLevel

demoteHierarchyLevel(row, withChildren?): void

指定された行の階層データ ベルを下げます。

実例

// 次のサンプルコードは、指定されたインデックスによって階層データレベルを下げます。
tableSheet.demoteHierarchyLevel(8);

パラメータ

名前 説明
row number 行インデックス。
withChildren? boolean (オプション) 子はデフォルトでレコードに降格されます。

戻り値

void


detailColumnsVisible

detailColumnsVisible(value?): boolean

テーブルシートがグループ化された後に詳細列を表示するか非表示にするか。

実例

// 次のサンプルコードは、詳細列を非表示にする方法を示します。
tableSheet.detailColumnsVisible(false);

パラメータ

名前 説明
value? boolean 詳細列の可視性を示すブール値。

戻り値

boolean

詳細列の可視性を返します。


expandAllHierarchyLevels

expandAllHierarchyLevels(): void

すべての階層レベルを展開します。

実例

// 次のサンプルコードは、すべての階層レベルを展開します。
tableSheet.expandAllHierarchyLevels();

戻り値

void


expandGroup

expandGroup(field, expand): void

指定されたフィールドでグループ化された1つのレベルを展開または折りたたみます。

実例

// 次のサンプルコードは、「LastName」でグループ化された1つのレベルのグループ化を折りたたむ方法を示します。
tableSheet.expandGroup("LastName", false);

パラメータ

名前 説明
field string フィールド名。
expand boolean ブール値。 trueはグループ化を拡張することを意味し、falseはグループ化を折りたたむことを意味します。

戻り値

void


expandGroupItem

expandGroupItem(level, index, expand): void

指定されたレベルとインデックスで1つのグループを展開または折りたたみます。

実例

// 次のサンプルコードは、レベルが1で開始インデックスが10の1つのグループを折りたたむ方法を示します。
tableSheet.expandGroupItem(1, 10, false);

パラメータ

名前 説明
level number グループ化レベル。
index number グループ化の開始インデックス。
expand boolean ブール値。 trueはグループ化を拡張することを意味し、falseはグループ化を折りたたむことを意味します。

戻り値

void


expandHierarchyLevel

expandHierarchyLevel(level): void

指定したレベルで階層データを展開します。

実例

// 次のサンプルコードは、指定されたレベルで階層データを展開します。
tableSheet.expandHierarchyLevel(8);

パラメータ

名前 説明
level number 展開するレベル。

戻り値

void


getChanges

getChanges(): IDataViewChanges[]

autoSync または batch モードでデータマネージャの変更を取得します。

実例

// 次のサンプルコードは、autoSync または batch モードで、更新された行、挿入された行、削除された行、列の追加、列の削除、列の更新などの変更を手動で取得する方法を示します。
tableSheet.getChanges();

戻り値

IDataViewChanges[]

オブジェクト配列を返します。各オブジェクトには、「type」、「dataItem」、「oldDataItem」、「column」、「originalColumn」および「index」」を含めることができます。「type」は変更タイプで、「insert」、「update」、「delete」、「addColumn」、「updateColumn」または「removeColumn」のいずれかになります。「dataItem」は現在の行データです。「oldDataItem」は元の行データで、「update」にのみ使用されます。「column」は現在の列です。「data」は現在追加された列のデフォルト値です。「originalColumn」は元の列で、「updateColumn」にのみ使用されます。「index」は、テーブルシートのビューインデックスです。


getDataView

getDataView(): View

テーブルシートのデータビューを取得します。

実例

// 次のサンプルコードは、データソースを取得します。
tableSheet.getDataView();

戻り値

View

データビューを返します。


groupBy

groupBy(options?): IGroupByOptions[]

テーブルシートをオプションでグループ化します。

実例

//次のサンプルコードは、グループオプションを設定し、テーブルシートをグループ化します。
tablesheet.groupBy([
     {
         caption: 'Category',
         field: 'category',
         summaryFields:[
             {
                 caption: 'SUM(Quantity)', width: 120, style: { formatter: "$ #,##0.00" }
                 formula: '=SUM([Quantity])',
                 slice: 'Office'
             }
         ]
     }
 ])

パラメータ

名前 説明
options? IGroupByOptions[] groupByのオプション。

戻り値

IGroupByOptions[]


groupOutlinePosition

groupOutlinePosition(value?): boolean

ビューポート領域と列ヘッダ領域、またはテーブルシートがグループ化された後の行ヘッダ領域でグループ化のアウトラインを表示するか非表示にするか。

実例

// 次のサンプルコードは、グループ化のアウトラインを非表示にする方法を示します。
tableSheet.groupOutlinePosition(GC.Spread.Sheets.TableSheet.GroupOutlinePosition.none);

パラメータ

名前 説明
value? GroupOutlinePosition グループ化のアウトラインの位置を示す値。

戻り値

boolean

グループ化のアウトラインの位置を返します。


hasRowState

hasRowState(type, row): boolean

指定された状態の行を判定します。

実例

// 次のサンプルコードは、指定された状態の行を判定方法を示します。
tableSheet.hasRowState(GC.Data.RowColumnStates.selected, 0);

パラメータ

名前 説明
type RowColumnStates 行状態のタイプ。
row number 行インデックス。

戻り値

boolean


moveDown

moveDown(row): void

指定した行だけ階層データを下に移動します。

実例

// 次のサンプルコードは、指定されたインデックスで階層データを下に移動します。
tableSheet.moveDown(8);

パラメータ

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

戻り値

void


moveUp

moveUp(row): void

指定した行だけ階層データを上に移動します。

実例

// 次のサンプルコードは、指定されたインデックスで階層データを上に移動します。
tableSheet.moveUp(8);

パラメータ

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

戻り値

void


printInfo

printInfo(value?): any

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

実例

// 次のサンプルコードは、印刷情報を設定します。
var printInfo = tableSheet.printInfo();
printInfo.bestFitRows(true);
printInfo.bestFitColumns(true);
tableSheet.printInfo(printInfo);

パラメータ

名前
value? PrintInfo

戻り値

any

値が設定されていない場合は、テーブルシートの印刷情報を返します。 それ以外の場合は、テーブルシートを返します。


promoteHierarchyLevel

promoteHierarchyLevel(row): void

指定された行の階層データレベルを上げます。

実例

// 次のサンプルコードは、指定されたインデックスによって階層データレベルを上げます。
tableSheet.promoteHierarchyLevel(8);

パラメータ

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

戻り値

void


removeGroupBy

removeGroupBy(): void

テーブルシートのグループステータスを削除します。

実例

// 次のサンプルコードは、テーブルシートのグループステータスを削除する方法を示します。
tablesheet.removeGroupBy()

戻り値

void


removeRow

removeRow(row): void

テーブルシートから指定した行を削除します。

実例

// 次のサンプルコードは、指定されたインデックスで行を削除します。
// autoSyncがtrueの場合、変更は同期されます。
tableSheet.removeRow(8);

パラメータ

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

戻り値

void


resetRow

resetRow(row): void

テーブルシートの指定された行の変更をリセットします。

実例

// 次のサンプルコードは、指定されたインデックスで行をリセットします。
tableSheet.resetRow(8);

パラメータ

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

戻り値

void


rowActionOptions

rowActionOptions(options?): IRowActionOptions[]

行アクションのオプションを取得または設定します。

実例

// 次のサンプルコードは、行アクションのオプションを設定します。
let options = tableSheet.rowActionOptions();
options.push({
     icons: ["./comment.png"],
     iconSelector: (item) => {
         return item.comment && item.comment.length > 0;
     }
 });
tableSheet.rowActionOptions(options);

パラメータ

名前 説明
options? IRowActionOptions[] 行アクションのオプション。

戻り値

IRowActionOptions[]


saveRow

saveRow(row): void

更新された行または挿入された行を含む、テーブルシートの指定された行の変更をデータマネージャーに保存します。

実例

// 次のサンプルコードは、指定されたインデックスで行を保存します。
// autoSyncがtrueの場合、変更は同期されます。
tableSheet.saveRow(8);

パラメータ

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

戻り値

void


setDataView

setDataView(dataView): void

テーブルシートのデータビューを設定します。

実例

// 次のサンプルコードは、データソースを設定します。
var dataManager = spread.dataManager();
var myTable = dataManager.addTable("myTable", {
    remote: {
        read: {
            url: 'https://demodata.mescius.io/northwind/api/v1/Orders'
        }
    }
});
myTable.fetch().then(function() {
    var myView = myTable.addView("myView");
    tableSheet.setDataView(myView);
});

パラメータ

名前 説明
dataView View バインドするデータビュー。

戻り値

void


setDefaultRowHeight

setDefaultRowHeight(value, sheetArea?): void

ビューポート領域のすべての行のデフォルトの高さをピクセル単位で設定します。

実例

// 次のサンプルコードは、デフォルトの行の高さをピクセル単位で設定します。
tableSheet.setDefaultRowHeight(50);

パラメータ

名前 説明
value number 高さ(ピクセル単位)。
sheetArea? SheetArea -

戻り値

void


submitChanges

submitChanges(): void

更新された行、挿入された行、削除された行など、データマネージャーの変更をバッチモードでサーバーに送信します。

実例

// 次のサンプルコードは、変更をバッチモードで手動で送信します。
tableSheet.submitChanges();

戻り値

void


togglePinnedColumns

togglePinnedColumns(index): void

指定された列インデックス配列で列を固定または固定解除します。

実例

// 次のサンプルコードは、列を固定します。
tableSheet.togglePinnedColumns([1,2,4]);

パラメータ

名前 説明
index number[] 固定または固定解除を行うための列インデックスの配列。

戻り値

void

固定された列の数を返します。


togglePinnedRows

togglePinnedRows(indexes): void

指定された行インデックス配列で行を固定または固定解除します。

実例

// 次のサンプルコードは、行を固定します。
tableSheet.togglePinnedRows([1,2,4]);

パラメータ

名前
indexes number[]

戻り値

void

固定された行の数を返します。