[]
Sheets.TableSheet.TableSheet
TableSheet
• new TableSheet(name?
, dataView?
, options?
)
具有指定名称、数据视图和选项设置的集算表
代码示例
//本示例创建了一个空的集算表
var tableSheet = spread.addSheetTab(0, "", GC.Spread.Sheets.SheetType.tableSheet);
//本示例创建了一个带名称的集算表
var tableSheet = spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
//本示例创建了一个带有名称和数据源的集算表
var dataManager = spread.dataManager();
var myTable = dataManager.addTable("myTable", {
remote: {
read: {
url: 'https://demodata.grapecity.com/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);
});
//本示例创建了一个带有名称和选项的集算表
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: ITableSheetOptions
集算表选项
属性 allowAddNew
- 是否允许新增空行
property
[sheetTabColor] - 用来表示表格颜色的颜色字符串,例如红色
,#ffff00
,RGB(255,0,0)
,Accent 5
,等等
property
[alternatingRowOptions] - 定义交替的行样式选项
property
[defaultStackRowHeight] - 集算表默认堆栈行高将默认计算平均高度
property
[menuItemVisibility] - 集算表默认堆栈行高将默认计算平均高度
代码示例
//本示例更改集算表的选项
tableSheet.options.allowAddNew = false;
tableSheet.options.alternatingRowOptions = { step: [1, 1], style: new GC.Spread.Sheets.Style("lightyellow")};
▸ addHierarchyItemAbove(row
, rowData
): void
将新的行数据添加为指定行的父
代码示例
// 此示例添加新行数据作为指定行的父行
tableSheet.addHierarchyItemAbove(8, {id: 8, name: "grapecity"});
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
void
▸ addHierarchyItemAfter(row
, rowData
): void
在指定的行之后添加新的行数据
代码示例
// 此示例在指定的行之后添加新的行数据
tableSheet.addHierarchyItemAfter(8, {id: 8, name: "grapecity"});
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
void
▸ addHierarchyItemBefore(row
, rowData
): void
在指定行之前添加新行数据
代码示例
// 此示例在指定行之前添加新行数据
tableSheet.addHierarchyItemBefore(8, {id: 8, name: "grapecity"});
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
void
▸ addHierarchyItemBelow(row
, rowData
): void
添加新行数据作为指定行的子项
代码示例
// 此示例添加新行数据作为指定行的子项
tableSheet.addHierarchyItemBelow(8, {id: 8, name: "grapecity"});
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
void
▸ addRow(rowData
): void
将新行添加到集算表中
代码示例
//本例添加了一个包含数据的新行
tableSheet.addRow({id: 8, name: "grapecity"});
属性名 | 类型 | 说明 |
---|---|---|
rowData |
any |
行数据 |
void
▸ applyFreeHeaderArea(sheetJson?
): any
将工作表JSON应用于集算表列标题自由布局区域
属性名 | 类型 | 说明 |
---|---|---|
sheetJson? |
any |
通过toJSON方法获取的表单JSON |
any
▸ applyTableTheme(tableTheme
): void
将表格主题应用于集算表
属性名 | 类型 | 说明 |
---|---|---|
tableTheme |
TableTheme |
表格主题实例 |
void
▸ cancelChanges(): void
取消批处理模式下的数据管理器的更改
代码示例
//本例在批处理模式下手动取消更改
tableSheet.cancelChanges();
void
▸ collapseAllHierarchyLevels(): void
折迭所有层次结构级别
代码示例
// 此示例折迭所有层次结构级别
tableSheet.collapseAllHierarchyLevels();
void
▸ demoteHierarchyLevel(row
, withChildren?
): void
降级指定行的层次结构数据级别
代码示例
// 此示例通过指定的索引降级层次结构数据级别
tableSheet.demoteHierarchyLevel(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
withChildren? |
boolean |
可选,默认情况下,子项将随记录一起降级 |
void
▸ detailColumnsVisible(value?
): boolean
集算表分组后是否显示或隐藏详情列
代码示例
//本示例显示了如何隐藏详情栏
tableSheet.detailColumnsVisible(false);
属性名 | 类型 | 说明 |
---|---|---|
value? |
boolean |
布尔值,表示详情列的可见性 |
boolean
返回详情列的可见性
▸ expandAllHierarchyLevels(): void
展开所有层次结构级别
代码示例
// 此示例扩展所有层次结构级别
tableSheet.expandAllHierarchyLevels();
void
▸ expandGroup(field
, expand
): void
通过指定的字段扩展或折叠一个级别的分组
代码示例
//本示例显示了如何折叠一个级别的分组,它是由 "LastName"分组
tableSheet.expandGroup("LastName", false);
属性名 | 类型 | 说明 |
---|---|---|
field |
string |
字段名称 |
expand |
boolean |
布尔值,true 意味着扩大分组,false 意味着折叠分组 |
void
▸ expandGroupItem(level
, index
, expand
): void
按指定的级别和索引扩展或折叠一个分组
代码示例
//本示例显示了如何折叠一个分组,该分组的级别为1,起始索引为10
tableSheet.expandGroupItem(1, 10, false);
属性名 | 类型 | 说明 |
---|---|---|
level |
number |
分组级别 |
index |
number |
分组起始索引 |
expand |
boolean |
布尔值,true 意味着扩大分组,false 意味着折叠分组 |
void
▸ expandHierarchyLevel(level
): void
按指定级别展开层次结构数据
代码示例
// 此示例按指定级别扩展层次结构数据
tableSheet.expandHierarchyLevel(8);
属性名 | 类型 | 说明 |
---|---|---|
level |
number |
要扩展的级别 |
void
▸ getChanges(): IDataViewChanges
[]
在 autoSync 或批处理模式下获取数据管理器的更改
代码示例
// 此示例在autoSync或批处理模式下手动进行更改,包括更新的行、插入的行和删除的行
tableSheet.getChanges();
返回对象数组,每个对象都可以包含“类型”,“ dataitem”,“ olddataitem”和“ index” “类型”是更改类型,可以是“插入”,“更新”或“删除”之一 “ Dataitem”是当前行数据 “ OldDataitem”是原始行数据,仅用于“更新” “索引”是表格的视图索引
▸ getDataView(): View
获取集算表的数据视图
代码示例
//本示例获取数据源
tableSheet.getDataView();
返回数据视图
▸ 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 的选项 |
▸ groupOutlinePosition(value?
): boolean
对集算表进行分组后,是否在视图区和列头区或行头区显示或隐藏分组列
代码示例
//本示例显示了如何隐藏分组列
tableSheet.groupOutlinePosition(GC.Spread.Sheets.TableSheet.GroupOutlinePosition.none);
属性名 | 类型 | 说明 |
---|---|---|
value? |
GroupOutlinePosition |
分组列位置的值 |
boolean
返回分组列的位置
▸ hasRowState(type
, row
): boolean
判断具有指定状态的行
代码示例
// 此示例判断具有指定状态的行
tableSheet.hasRowState(GC.Data.RowColumnStates.selected, 0);
属性名 | 类型 | 说明 |
---|---|---|
type |
RowColumnStates |
行状态的类型 |
row |
number |
行索引 |
boolean
▸ moveDown(row
): void
向下移动指定行的层次结构数据
代码示例
// 此示例按指定的索引向下移动层次结构数据
tableSheet.moveDown(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ moveUp(row
): void
向上移动指定行的层次结构数据
代码示例
// 此示例通过向上移动指定的索引来移动层次结构数据
tableSheet.moveUp(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ printInfo(value?
): any
获取或设置表集算表的打印信息
代码示例
//设置打印
var printInfo = tableSheet.printInfo();
printInfo.bestFitRows(true);
printInfo.bestFitColumns(true);
tableSheet.printInfo(printInfo);
属性名 | 类型 |
---|---|
value? |
PrintInfo |
any
如果没有设置值,则返回表集算表的打印信息;否则,返回集算表
▸ promoteHierarchyLevel(row
): void
提升指定行的层次结构数据级别
代码示例
// 此示例通过指定的索引提升层次结构数据级别
tableSheet.promoteHierarchyLevel(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ removeGroupBy(): void
删除集算表的分组状态
代码示例
//本示例展示了删除集算表的分组状态
tablesheet.removeGroupBy()
void
▸ removeRow(row
): void
从集算表中删除指定的行
代码示例
//本示例按指定的索引删除行
//当autoSync为true时,变化将被同步
tableSheet.removeRow(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ resetRow(row
): void
重置集算表中指定行的更改
代码示例
//本示例按指定的索引重置行
tableSheet.resetRow(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ 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 [] |
行操作的选项 |
▸ saveRow(row
): void
将集算表中指定行的更改保存到数据管理器,包括更新的行或插入的行
代码示例
//本例按指定的索引保存行
//当autoSync为true时,变化将被同步
tableSheet.saveRow(8);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
void
▸ setDataView(dataView
): void
设置集算表的数据视图
代码示例
//本示例设置数据源
var dataManager = new GC.Data.DataManager();
var myTable = dataManager.addTable("myTable", {
remote: {
read: {
url: 'https://demodata.grapecity.com/northwind/api/v1/Orders'
}
}
});
myTable.fetch().then(function() {
var myView = myTable.addView("myView");
tableSheet.setDataView(myView);
});
属性名 | 类型 | 说明 |
---|---|---|
dataView |
View |
要绑定的数据视图 |
void
▸ setDefaultRowHeight(value
, sheetArea?
): void
设置视图区域中所有行的默认高度(以像素为单位)
代码示例
//本示例以像素为单位设置默认行高
tableSheet.setDefaultRowHeight(50);
属性名 | 类型 | 说明 |
---|---|---|
value |
number |
以像素为单位的高度 |
sheetArea? |
SheetArea |
- |
void
▸ submitChanges(): void
以批处理方式向服务器提交数据管理器的更改,包括更新的行、插入的行和删除的行
代码示例
//本示例以批处理模式手动提交更改
tableSheet.submitChanges();
void
▸ togglePinnedColumns(index
): void
用指定的列索引数组固定或取消固定列
代码示例
//本示例将几个列排在一起
tableSheet.togglePinnedColumns([1,2,4]);
属性名 | 类型 | 说明 |
---|---|---|
index |
number [] |
要固定或取消固定的列索引数组 |
void
返回固定列数
▸ togglePinnedRows(indexes
): void
用指定的行索引数组固定或取消固定行
代码示例
//本示例将固定几行
tableSheet.togglePinnedRows([1,2,4]);
属性名 | 类型 |
---|---|
indexes |
number [] |
void
返回固定行数