- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- 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.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Excel
GC.Spread.Sheets.GanttSheet.GanttSheet
类: GanttSheet
Sheets.GanttSheet.GanttSheet
继承关系
-
↳
GanttSheet
Table of contents
构造方法
属性
方法
- addHierarchyItemAbove
- addHierarchyItemAfter
- addHierarchyItemBefore
- addHierarchyItemBelow
- addRow
- applyFreeHeaderArea
- applyTableTheme
- bindGanttView
- cancelChanges
- collapseAllHierarchyLevels
- demoteHierarchyLevel
- detailColumnsVisible
- expandAllHierarchyLevels
- expandGroup
- expandGroupItem
- expandHierarchyLevel
- getActiveTask
- getChanges
- getDataView
- getSelections
- getTaskByRow
- groupBy
- groupOutlinePosition
- hasRowState
- moveDown
- moveUp
- printInfo
- promoteHierarchyLevel
- removeGroupBy
- removeRow
- resetRow
- resumePaint
- rowActionOptions
- saveRow
- setDataView
- setDefaultRowHeight
- submitChanges
- suspendPaint
- togglePinnedColumns
- togglePinnedRows
构造方法
constructor
• new GanttSheet(name?, dataView?)
使用指定的数据视图和选项创建一个甘特表
参数
| 属性名 | 类型 |
|---|---|
name? |
string |
dataView? |
View |
Overrides
属性
gridlines
• gridlines: GanttGridlines
获取甘特图的网格线，并配置行类型和颜色
readonly
mapping
• mapping: GanttMapping
获取此甘特表的映射，用于转换或转换查看的数据
readonly
options
• options: ITableSheetOptions
代表表格选项。
property [allowAddNew] - 是否允许添加新的空行。
property [sheetTabColor] - 用于表示工作表选项卡颜色的颜色字符串，例如“red”、“#FFFF00”、“rgb(255,0,0)”、“Accent 5”等。
property [alternatingRowOptions] - 定义交替行样式选项。
property [defaultStackRowHeight] - Tablesheet默认堆叠行高，默认会计算平均高度。
property [menuItemVisibility] - Tablesheet默认堆叠行高，默认会计算平均高度。
property [showRowNumber] - 是否显示行号标题。
property [enableDefineColumn] - 是否启用定义列。
property [defineColumnCommand] - 指定用于定义列选项的命令。
property [submitDefineColumnCommand] - 指定用于提交定义的列选项的命令。
property {GC.Spread.Sheets.TableSheet.IColumnTypeItem[]} [columnTypeItems] - 指定列类型。
property [groupLayout] - 指定组布局的选项。
代码示例
// 此示例更改了集算表的选项
tableSheet.options.allowAddNew = false;
tableSheet.options.alternatingRowOptions = { step: [1, 1], style: new GC.Spread.Sheets.Style("lightyellow")};
继承自
project
• project: Project
获取该项目以显示和编辑此甘特表
readonly
方法
addHierarchyItemAbove
▸ addHierarchyItemAbove(row, rowData): void
将新的行数据添加为指定行的父
代码示例
//此示例将一个新的行数据添加为指定行的父
tableSheet.addHierarchyItemAbove(8, {id: 8, name: "grapecity"});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
返回值
void
继承自
TableSheet.addHierarchyItemAbove
addHierarchyItemAfter
▸ addHierarchyItemAfter(row, rowData): void
在指定的行之后添加新的行数据
代码示例
//此示例在指定的行之后添加了一个新的行数据
tableSheet.addHierarchyItemAfter(8, {id: 8, name: "grapecity"});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
返回值
void
继承自
TableSheet.addHierarchyItemAfter
addHierarchyItemBefore
▸ addHierarchyItemBefore(row, rowData): void
在指定的行之前添加新的行数据
代码示例
//此示例在指定的行之前添加了一个新的行数据
tableSheet.addHierarchyItemBefore(8, {id: 8, name: "grapecity"});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
返回值
void
继承自
TableSheet.addHierarchyItemBefore
addHierarchyItemBelow
▸ addHierarchyItemBelow(row, rowData): void
将新的行数据添加为指定行的子
代码示例
//此示例将一个新的行数据添加为指定行的孩子
tableSheet.addHierarchyItemBelow(8, {id: 8, name: "grapecity"});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
rowData |
any |
行数据 |
返回值
void
继承自
TableSheet.addHierarchyItemBelow
addRow
▸ addRow(rowData): void
在表格表中添加了新行
代码示例
//此示例添加了一个带有数据的新行
tableSheet.addRow({id: 8, name: "grapecity"});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
rowData |
any |
行数据 |
返回值
void
继承自
applyFreeHeaderArea
▸ applyFreeHeaderArea(sheetJson?): any
将工作表JSON应用于集算表列标题布局区域
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
sheetJson? |
any |
工作表JSON，可以通过工作表的toJson方法获得 |
返回值
any
继承自
TableSheet.applyFreeHeaderArea
applyTableTheme
▸ applyTableTheme(tableTheme): void
将表主题应用于当前的表格
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
tableTheme |
TableTheme |
表主题实例 |
返回值
void
继承自
bindGanttView
▸ bindGanttView(dataView, options?): void
设置表格的数据视图
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
dataView |
View |
要绑定的数据视图 |
options? |
IGanttSheetOptions |
- |
返回值
void
cancelChanges
▸ cancelChanges(): void
在批处理模式下取消数据管理器的更改
代码示例
//此示例在批处理模式下手动取消更改
tableSheet.cancelChanges();
返回值
void
继承自
collapseAllHierarchyLevels
▸ collapseAllHierarchyLevels(): void
折叠所有层次结构
代码示例
//此示例折叠了所有层次结构级别
tableSheet.collapseAllHierarchyLevels();
返回值
void
继承自
TableSheet.collapseAllHierarchyLevels
demoteHierarchyLevel
▸ demoteHierarchyLevel(row, withChildren?): void
降低指定行的层次结构数据级
代码示例
//此示例通过指定的索引降低了层次结构数据级别
tableSheet.demoteHierarchyLevel(8);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
withChildren? |
boolean |
可选，默认情况下，子记录将被降级 |
返回值
void
继承自
TableSheet.demoteHierarchyLevel
detailColumnsVisible
▸ detailColumnsVisible(value?): boolean
是否显示或隐藏表格之后的详细列
代码示例
//该示例显示了如何隐藏详细列
tableSheet.detailColumnsVisible(false);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
boolean |
布尔值，指示细节列的可见性 |
返回值
boolean
返回细节列的可见性
继承自
TableSheet.detailColumnsVisible
expandAllHierarchyLevels
▸ expandAllHierarchyLevels(): void
展开所有层次结构级别
代码示例
//此示例展开了所有层次结构级别
tableSheet.expandAllHierarchyLevels();
返回值
void
继承自
TableSheet.expandAllHierarchyLevels
expandGroup
▸ expandGroup(field, expand): void
通过指定字段展开或折叠一个级别的分组
代码示例
//该示例显示了如何折叠一个级别的分组，该分组由 “LastName” 分组
tableSheet.expandGroup("LastName", false);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
field |
string |
字段名称 |
expand |
boolean |
布尔值，True 代表展开分组，False 代表分组折叠 |
返回值
void
继承自
expandGroupItem
▸ expandGroupItem(level, index, expand): void
通过指定的级别和索引展开或折叠一个分组
代码示例
//该样本显示了如何折叠一个分组，哪个级别为1，启动索引为10
tableSheet.expandGroupItem(1, 10, false);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
level |
number |
分组级别 |
index |
number |
分组开始索引 |
expand |
boolean |
布尔值，True 代表展开分组，False 代表分组折叠 |
返回值
void
继承自
expandHierarchyLevel
▸ expandHierarchyLevel(level): void
按指定级别展开层次结构数据
代码示例
//此示例按指定级别展开层次结构数据
tableSheet.expandHierarchyLevel(8);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
level |
number |
展开的级别 |
返回值
void
继承自
TableSheet.expandHierarchyLevel
getActiveTask
▸ getActiveTask(): Task
在活动行中获取任务
返回值
在活动行中的任务
getChanges
▸ getChanges(): IDataViewChanges[]
在AutoSync或批处理模式下获取数据管理器的更改
代码示例
//此示例以AutoSync或批处理模式手动更改，包括更新的行，插入的行和删除行
tableSheet.getChanges();
返回值
返回一个对象数组，每个对象可以包含“type”、“dataItem”、“oldDataItem”、“column”、“originalColumn”和“index”。 “type”是更改类型，可以是“insert”、“update”、“delete”、“addColumn”、“updateColumn”、“removeColumn”之一。 “dataItem”是当前行数据。 “oldDataItem”是原始行数据，仅用于“更新”。 “列”是当前列。 “data”是当前添加列的默认值。 “originalColumn”是原始列，仅用于“更新列”。 “索引”是表格表的视图索引。
继承自
getDataView
▸ getDataView(): View
获取表格的数据视图
代码示例
//此示例获取数据源
tableSheet.getDataView();
返回值
返回数据视图
继承自
getSelections
▸ getSelections(): Range[]
获取选择区域
返回值
Range[]
选择的区域
getTaskByRow
▸ getTaskByRow(rowIndex): Task
在指定的行中获取任务
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
rowIndex |
number |
一个数字指示行索引 |
返回值
指定行的任务
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 的选项 |
返回值
继承自
groupOutlinePosition
▸ groupOutlinePosition(value?): boolean
是在视窗区域和列标题区域中显示或隐藏分组大纲，还是将表格之后的行标头区域分组
代码示例
//该示例显示了如何隐藏分组大纲
tableSheet.groupOutlinePosition(GC.Spread.Sheets.TableSheet.GroupOutlinePosition.none);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value? |
GroupOutlinePosition |
表示分组大纲位置的值 |
返回值
boolean
返回分组大纲的位置
继承自
TableSheet.groupOutlinePosition
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
继承自
TableSheet.promoteHierarchyLevel
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
继承自
resumePaint
▸ resumePaint(): void
恢复甘特表的绘制
返回值
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[] |
行动作的选项 |
返回值
继承自
saveRow
▸ saveRow(row): void
将表格表的指定行的更改保存到数据管理器，包括更新的行或插入的行
代码示例
//此示例通过指定的索引保存一行
//当autoSync为true时，更改将同步
tableSheet.saveRow(8);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
row |
number |
行索引 |
返回值
void
继承自
setDataView
▸ setDataView(dataView): void
Sets the data view of table sheet.
代码示例
//此示例设置数据源
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");
tableSheet.setDataView(myView);
});
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
dataView |
View |
要绑定的数据视图 |
返回值
void
继承自
setDefaultRowHeight
▸ setDefaultRowHeight(value, sheetArea?): void
为视图区域的所有行设置像素的默认高度
代码示例
//此示例设置像素中的默认行高度
tableSheet.setDefaultRowHeight(50);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
value |
number |
高度的像素 |
sheetArea? |
SheetArea |
- |
返回值
void
继承自
TableSheet.setDefaultRowHeight
submitChanges
▸ submitChanges(): void
在批处理模式下将数据管理器的更改提交到服务器，包括更新的行，插入的行和删除行
代码示例
//此示例以批处理模式手动提交更改
tableSheet.submitChanges();
返回值
void
继承自
suspendPaint
▸ suspendPaint(): void
暂停甘特表的绘制
返回值
void
togglePinnedColumns
▸ togglePinnedColumns(index): void
带有指定列索引数组的 pin 或 unpin 列
代码示例
//此示例 pin 某些列
tableSheet.togglePinnedColumns([1,2,4]);
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number[] |
列索引的阵列要执行 pin 或 unpin |
返回值
void
返回固定列的计数
继承自
TableSheet.togglePinnedColumns
togglePinnedRows
▸ togglePinnedRows(indexes): void
带有指定的行索引数组的 pin 或 unpin 行
代码示例
//此示例固定某几行
tableSheet.togglePinnedRows([1,2,4]);
参数
| 属性名 | 类型 |
|---|---|
indexes |
number[] |
返回值
void
返回固定行的计数