GC.Spread.Sheets.Worksheet

类: Worksheet

Spread.Sheets.Worksheet

继承关系

Worksheet

↳ TemplateSheet

构造方法

constructor

属性

方法

构造方法

constructor

• new Worksheet(name)

工作表

参数

属性名	类型	说明
`name`	`string`	工作表名称

属性

autoGenerateColumns

• autoGenerateColumns: boolean

在绑定数据上下文时是否自动生成列

代码示例

//本示例为表单设置数据源
 var test = [
       { "Series0": 2, "Series1": 1 },
       { "Series0": 4, "Series1": 2 },
       { "Series0": 3, "Series1": 4 }
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(test, true);

cellStates

• cellStates: CellStateManager

单元格状态（cellState）管理器

charts

• charts: ChartCollection

表单的图表管理器

代码示例

//本示例说明如何添加图表
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);

columnOutlines

• columnOutlines: Outline

列区域分组

comments

• comments: CommentManager

表单的批注管理器

conditionalFormats

• conditionalFormats: ConditionalFormats

表单的条件格式管理器

代码示例

//本示例创建一个规则
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.getRules();
alert(ruletest[0].style().backColor);

defaults

• defaults: ISheetDefaultOption

表单的默认行高和列宽

代码示例

//本示例设置默认的行高和列宽
activeSheet.suspendPaint();
activeSheet.defaults.rowHeight = 40;
activeSheet.defaults.colWidth = 30;
activeSheet.resumePaint();

floatingObjects

• floatingObjects: FloatingObjectCollection

表单的浮动对象（FloatingObject）管理器

代码示例

//本示例创建了一个浮动对象
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

options

• options: IWorksheetOptions

表单选项属性 allowCellOverflow - 表示数据是否可以溢出到相邻的空单元格

属性 showFormulas - 表示是否显示公式字符串而不是公式结果

属性 showZeros - 表示是否在包含零值的单元格中显示 0。默认为 true

属性 sheetTabColor - 用于表示工作表选项卡颜色的颜色字符串，例如 "red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5" 等等

属性 frozenlineColor - 用于表示冻结线颜色的颜色字符串，例如 "red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5" 等等

属性 clipBoardOptions - 剪贴板选项

属性 gridline - 网格线的选项

属性 gridline.color - 网格线的颜色

属性 gridline.showVerticalGridline - 是否显示垂直网格线

属性 gridline.showHorizontalGridline - 是否显示水平网格线

属性 rowHeaderVisible - 表示行标题是否可见

属性 colHeaderVisible - 表示列标题是否可见

属性 rowHeaderAutoText - 表示行标题显示字母或数字或为空

属性 colHeaderAutoText - 表示列标题显示字母或数字或为空

属性 rowHeaderAutoTextIndex - 当存在多个行标题列时，指定哪个行标题列显示自动文本

属性 colHeaderAutoTextIndex - 当存在多个列标题行时，指定哪个列标题行显示自动文本

属性 isProtected - 表示在该工作表上标记为受保护的单元格是否可以编辑

属性 protectionOptions - 表示您希望用户能够更改的元素

property [protectionOptions.allowSelectLockedCells] - 如果用户可以选择锁定的单元格，则为 true 或未定义

property [protectionOptions.allowSelectUnlockedCells] - 如果用户可以选择未锁定的单元格，则为 true 或未定义

property [protectionOptions.allowSort] - 如果用户可以对范围进行排序，则为 true

property [protectionOptions.allowFilter] - 如果用户可以筛选范围，则为 true

property [protectionOptions.allowEditObjects] - 如果用户可以编辑浮动对象，则为 true

property [protectionOptions.allowResizeRows] - 如果用户可以调整行的大小，则为 true

property [protectionOptions.allowResizeColumns] - 如果用户可以调整列的大小，则为 true

property [protectionOptions.allowDragInsertRows] - 如果用户可以拖动以插入行，则为 true

property [protectionOptions.allowDragInsertColumns] - 如果用户可以拖动以插入列，则为 true

property [protectionOptions.allowInsertRows] - 如果用户可以插入行，则为 true

property [protectionOptions.allowInsertColumns] - 如果用户可以插入列，则为 true

property [protectionOptions.allowDeleteRows] - 如果用户可以删除行，则为 true

property [protectionOptions.allowDeleteColumns] - 如果用户可以删除列，则为 true

property [protectionOptions.allowOutlineColumns] - 如果用户可以展开或折叠列组，则为 true

property [protectionOptions.allowOutlineRows] - 如果用户可以展开或折叠行组，则为 true

属性 selectionBackColor - 工作表的选定单元格背景颜色

属性 selectionBorderColor - 工作表的选定单元格边框颜色

属性 sheetAreaOffset - sheetAreaOffset 的选项。

property [sheetAreaOffset.left] - 工作表相对于主机的左侧偏移量。

property [sheetAreaOffset.top] - 工作表顶部距主机的偏移量。

属性 keepUnknownFormulas - 指示未知公式是否可以包含在工作表 json 数据中。

property [addRowButtonOption] - 添加行按钮的选项。

property [addColumnButtonOption] - 添加列按钮的选项。

属性 rightToLeft - 指示工作表是否从右向左渲染。

代码示例

sheet.setRowCount(2,GC.Spread.Sheets.SheetArea.colHeader);
sheet.setColumnCount(2,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(0, 2,"Column",GC.Spread.Sheets.SheetArea.colHeader);
sheet.options.colHeaderAutoTextIndex = 1;
sheet.options.colHeaderAutoText = GC.Spread.Sheets.HeaderAutoText.numbers;

outlineColumn

• outlineColumn: OutlineColumn

获取表单的分组列

returns

pictures

• pictures: FloatingObjectCollection

表单的图片管理器

deprecated 从15.2.0版开始，请改用"sheet.shapes"

代码示例

//本示例添加了一张图片
activeSheet.pictures.add("f2","Event.png",2,2,10,10);
var picture = activeSheet.pictures.get("f2");
picture.pictureStretch(GC.Spread.Sheets.ImageLayout.center);
picture.backColor("Blue");
picture.borderWidth(2);
picture.borderColor("Red");
picture.borderStyle("dotted");
picture.borderRadius(5);

pivotTables

• pivotTables: PivotTableManager

数据透视表管理器

代码示例

//本示例创建数据透视表
var pivotTableManager = sheet.pivotTables;
var sourceData = [["Date","Buyer","Type","Amount"],["01-Jan","Mom","Fuel",74],["15-Jan","Mom","Food",235],["17-Jan","Dad","Sports",20],["21-Jan","Kelly","Books",125],["02-Feb","Mom","Food",235],["20-Feb","Kelly","Music",20],["25-Feb","Kelly","Tickets",125]];
var options = {showRowHeader: true, showColumnHeader: true};
var myPivotTable = pivotTableManager.add("pivotTable_1", sourceData , 1, 1, GC.Spread.Pivot.PivotTableLayoutType.tabular, GC.Spread.Pivot.PivotTableThemes.medium2, option);

rowOutlines

• rowOutlines: Outline

行区域分组

shapes

• shapes: ShapeCollection

形状管理器

代码示例

//本示例展示了如何添加一个形状
var shape = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 50, 100, 150);

slicers

• slicers: SlicerCollection

切片器管理器

代码示例

//本示例添加了一个切片器
//创建一个表
datas = [
    ["1", "NewYork", "1968/6/8", "80", "180"],
    ["4", "NewYork", "1972/7/3", "72", "168"],
    ["4", "NewYork", "1964/3/2", "71", "179"],
    ["5", "Washington", "1972/8/8","80", "171"],
    ["6", "Washington", "1986/2/2", "89", "161"],
    ["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
//向表单添加一个切片器并返回切片器实例
var slicer = activeSheet.slicers.add("slicer1",table.name(),"Height");
 //改变切片器的属性
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.disableResizingAndMoving(true);
slicer.style(style1);

tables

• tables: TableManager

表管理器

代码示例

//本示例创建了一个表
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");

方法

addColumns

▸ addColumns(col, count, sheetArea?): void

将指定索引处的一列或多列添加到数据模型

代码示例

//本示例添加列
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1,GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1,GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

参数

属性名	类型	说明
`col`	`number`	要在其中添加新列的列索引
`count`	`number`	要添加的列数
`sheetArea?`	`SheetArea`	-

返回值

void

addCustomFunction

▸ addCustomFunction(fn): void

添加一个自定义函数

参数

属性名	类型	说明
`fn`	`Function`	需要添加的函数

返回值

void

addCustomName

▸ addCustomName(name, formula, baseRow, baseCol, comment?, isReadOnly?): void

添加自定义名称

代码示例

//本示例创建自定义名称
sheet.setValue(0, 0, 1);
sheet.setValue(0, 1, 2);
sheet.setValue(0, 2, 3);
sheet.addCustomName("customName1","=12", 0, 0);
sheet.addCustomName("customName2","Average(20,45)", 0, 0);
sheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
sheet.setFormula(1, 0, "customName1");
sheet.setFormula(1, 1, "customName2");
sheet.setFormula(1, 2, "sum(customName3)");

参数

属性名	类型	说明
`name`	`string`	自定义名称
`formula`	`string`	公式
`baseRow`	`number`	行索引
`baseCol`	`number`	列索引
`comment?`	`string`	-
`isReadOnly?`	`boolean`	-

返回值

void

addNamedStyle

▸ addNamedStyle(style): void

将样式添加到名为styles的表单中

代码示例

var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
activeSheet.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // 单元格(1,1)的背景色为绿色
activeSheet.setStyleName(2, 1, "style1");
var style = activeSheet.getNamedStyle("style1");
style.foreColor = "red";    // namedStyle的前景色为红色
activeSheet.repaint(); // 单元格(1,1)和单元格(2,1)的前颜色为红色
activeSheet.getCell(1,1).value("test");
$("#button1").click(function () {
activeSheet.removeNamedStyle("style1");
    });

参数

属性名	类型	说明
`style`	`Style`	要添加的样式

返回值

void

addRows

▸ addRows(row, count, sheetArea?): void

在此表单中添加行

代码示例

//本示例添加行
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1,GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1,GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

参数

属性名	类型	说明
`row`	`number`	起始行的索引
`count`	`number`	要添加的行数
`sheetArea?`	`SheetArea`	-

返回值

void

addSelection

▸ addSelection(row, column, rowCount, columnCount): void

向选定内容添加一个或多个单元格

代码示例

//本示例添加一个选择内容并在规则中使用该选择内容
sheet.setValue(0,0, 1,3);
sheet.setValue(1,0, 50,3);
sheet.setValue(2,0, 100,3);
sheet.setValue(3,0, 2,3);
sheet.setValue(4,0, 60,3);
sheet.setValue(5,0, 90,3);
sheet.setValue(6,0, 3,3);
sheet.setValue(7,0, 40,3);
sheet.setValue(8,0, 70,3);
sheet.setValue(9,0, 5,3);
sheet.setValue(10,0, 35,3);
sheet.addSelection(0,0,11,1);
sheet.conditionalFormats.add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());

参数

属性名	类型	说明
`row`	`number`	要添加的第一个单元格的行索引
`column`	`number`	要添加的第一个单元格的列索引
`rowCount`	`number`	要添加的行数
`columnCount`	`number`	要添加的列数

返回值

void

addSpan

▸ addSpan(row, col, rowCount, colCount, sheetArea?): void

在指定表单区域中添加合并单元格

代码示例

//本示例创建单元格合并
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	开始跨度的单元格的行索引。
`col`	`number`	-
`rowCount`	`number`	要跨越的行数。
`colCount`	`number`	要跨越的列数。
`sheetArea?`	`SheetArea`	-

返回值

void

addSpans

▸ addSpans(spans, sheetArea?): void

在指定的工作表区域中向该工作表添加大量跨度。

代码示例

//This example creates cell spans.
sheet.addSpans([{row: 0, col: 0, rowCount: 2, colCount: 2}, {row: 3, col: 0, rowCount: 3, colCount: 3}, {row: 7, col: 0, rowCount: 4, colCount: 4}], GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`spans`	`IRange`[]	跨度范围，每个范围包含 row、col、rowCount、colCount。
`sheetArea?`	`SheetArea`	-

返回值

void

autoFitColumn

▸ autoFitColumn(column): void

自动适合视图列

代码示例

//本示例根据文本设置列宽
activeSheet.setValue(0, 1, "testing");
activeSheet.autoFitColumn(1);

参数

属性名	类型	说明
`column`	`number`	列索引

返回值

void

autoFitRow

▸ autoFitRow(row): void

自动适合视图行

代码示例

//本示例根据文本设置行高
activeSheet.setValue(0, 1, "testing\r\nmultiple\r\nlines");
activeSheet.getCell(0,1).wordWrap(true);
activeSheet.autoFitRow(0);

参数

属性名	类型	说明
`row`	`number`	行索引

返回值

void

autoMerge

▸ autoMerge(range, direction?, mode?, sheetArea?, selectionMode?): IRangeInfo[]

自动合并区域

代码示例

var range = new GC.Spread.Sheets.Range(-1, 0, -1, 1);
sheet.autoMerge(range);

参数

属性名	类型	说明
`range`	`Range`	自动合并区域
`direction?`	`AutoMergeDirection`	自动合并方向。如果未提供此参数，则默认为 column （列方向）。如果方向为 none ,则该区域的自动合并将被取消
`mode?`	`AutoMergeMode`	自动合并模式。如果未提供此参数，则默认为 free
`sheetArea?`	`SheetArea`	自动合并区域的图纸区域.如果未提供此参数，则默认为 viewport
`selectionMode?`	`SelectionMode`	自动合并选择模式如果没有提供此参数，则默认为source

返回值

IRangeInfo[]

如果未提供任何参数，则返回当前表单的所有自动合并区域信息.每个区域信息都包含区域，方向，模式，表单区域

bind

▸ bind(type, data?, fn?): void

将事件绑定到表单

代码示例

//绑定事件示例
sheet.bind(GC.Spread.Sheets.Events.LeftColumnChanged,function(event,data)
  {
    var str = "----------------------------------------\n";
    var title = "Event [LeftColumnChanged ] Fired";
    str = str.substr(0, 4) + title + str.substr(4 + title.length);
    if (typeof data == "object") {
        for (var key in data) {
            str += key + " : " + data[key] + "\n";
          }
      } else {
        str += data + "\n";
      }
      alert(str);
  });
sheet.bind(GC.Spread.Sheets.Events.TopRowChanged,function(event,data)
  {
        var str = "----------------------------------------\n";
        var title = "Event [TopRowChanged] Fired";
        str = str.substr(0, 4) + title + str.substr(4 + title.length);
        if (typeof data == "object") {
            for (var key in data) {
                str += key + " : " + data[key] + "\n";
            }
        } else {
            str += data + "\n";
        }
        alert(str);
    });

参数

属性名	类型	说明
`type`	`string`	事件类型
`data?`	`any`	可选的要传递给函数的其他数据
`fn?`	`Function`	事件触发时要执行的函数

返回值

void

bindColumn

▸ bindColumn(index, column): void

使用指定的数据字段绑定列

代码示例

var test = [
{"Series0":2,"Series1":1},
{"Series0":4,"Series1":2},
{"Series0":3,"Series1":4}
];
sheet.setDataSource(test);
sheet.bindColumn(1,"Series0");
sheet.bindColumn(0,"Series1");

参数

属性名	类型	说明
`index`	`number`	列索引
`column`	`string` \| `IColumn`	具有数据字段的列信息如果其类型为字符串，则将其视为名称

返回值

void

bindColumns

▸ bindColumns(columns): void

使用指定的数据字段绑定列

代码示例

var datasource = [
                 { name: "Alice", age: 27, birthday: "1985/08/31", position: "Beijing", isMarried: false},
                 { name: "Aimee", age: 28, birthday: "1984/07/31", position: "Xi'An", isMarried: true},
                 { name: "Charles", age: 29, birthday: "1983/03/31", position: "ShangHai", isMarried: true},
            ];
var colInfos = [
                { name: "name", displayName: "Name", size: 70, pageBread: false},
                { name: "age", displayName: "Age", size: 40, resizable: false },
                { name: "birthday", displayName: "Birthday", formatter: "d/M/yy", size: 120 },
                { name: "position", displayName: "Position", size: 50, visible: true, value: function (item){
			             return 'China ' + item['position'];
		           }},
                { name: "isMarried", displayName: "IsMarried", size: 50, visible: true, cellType: new GC.Spread.Sheets.CellTypes.CheckBox()}
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(datasource);
activeSheet.bindColumns(colInfos);

参数

属性名	类型	说明
`columns`	`IColumn`[]	具有数据字段的列信息数组如果项的类型为字符串，则将该项视为名称

返回值

void

clear

▸ clear(row, column, rowCount, colCount, area, storageType): void

清除指定区域

代码示例

//本示例清除指定区域内的数据
activeSheet.getCell(0,0).value("A1");
activeSheet.clear(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport,GC.Spread.Sheets.StorageType.data);

参数

属性名	类型	说明
`row`	`number`	起始行索引
`column`	`number`	起始列索引
`rowCount`	`number`	要清除的行数
`colCount`	`number`	-
`area`	`SheetArea`	需要清理的区域
`storageType`	`StorageType`	清除类型

返回值

void

clearCustomFunctions

▸ clearCustomFunctions(): void

清除所有自定义功能

代码示例

//本示例从活动表单中清除自定义功能
activeSheet.clearCustomFunctions();

返回值

void

clearCustomNames

▸ clearCustomNames(): void

清除自定义名称

代码示例

//本示例创建自定义名称，然后清除它们
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1","=12", 0, 0);
activeSheet.addCustomName("customName2","Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
activeSheet.clearCustomNames();

返回值

void

clearPendingChanges

▸ clearPendingChanges(clearChangeInfo?): void

从当前表单中清除脏数据，插入和删除状态

代码示例

sheet.clearPendingChanges({clearType: 1, row: 0, rowCount: 3, col: 0, colCount: 4});
sheet.clearPendingChanges({clearType: 2, row: 0, rowCount: 3, col: -1});
sheet.clearPendingChanges({clearType: 4, row: 0, rowCount: 10, col: -1});

参数

属性名	类型
`clearChangeInfo?`	`IClearChangeInfo`

返回值

void

clearSelection

▸ clearSelection(): void

清除选择

代码示例

//本示例清除选择
sheet.addSelection(4, 0, 2, 2);
sheet.clearSelection();

返回值

void

copyTo

▸ copyTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option): void

将数据从一个区域复制到另一个区域

代码示例

//本示例将数据复制到指定位置
activeSheet.getCell(0,0).value("1");
activeSheet.copyTo(0,0,1,1,2,2,GC.Spread.Sheets.CopyToOptions.value);

参数

属性名	类型	说明
`fromRow`	`number`	源行
`fromColumn`	`number`	源列
`toRow`	`number`	目标行
`toColumn`	`number`	目标列
`rowCount`	`number`	行数
`columnCount`	`number`	列数
`option`	`CopyToOptions`	复制选项

返回值

void

currentTheme

▸ currentTheme(value?): any

获取或设置表单的当前主题

代码示例

//本示例设置一个主题
sheet.currentTheme("Civic");

参数

属性名	类型	说明
`value?`	`string` \| `Theme`	主题名称或主题

返回值

any

如果未设置任何值，则返回当前主题否则，返回表单

deleteColumns

▸ deleteColumns(col, count, sheetArea?): void

删除此表单中指定索引处的列

代码示例

activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(0,4).value("Test")
activeSheet.deleteColumns(0,2);
activeSheet.deleteRows(3,1);

参数

属性名	类型	说明
`col`	`number`	要删除的第一列的索引
`count`	`number`	要删除的列数
`sheetArea?`	`SheetArea`	-

返回值

void

deleteRows

▸ deleteRows(row, count, sheetArea?): void

删除此表单中指定索引的行

代码示例

activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(0,4).value("Test")
activeSheet.deleteColumns(0,2);
activeSheet.deleteRows(3,1);

参数

属性名	类型	说明
`row`	`number`	要删除的第一行的索引
`count`	`number`	要删除的行数
`sheetArea?`	`SheetArea`	-

返回值

void

editorStatus

▸ editorStatus(): EditorStatus

返回编辑器的状态

返回值

EditorStatus

编辑器状态

endEdit

▸ endEdit(ignoreValueChange?): boolean

停止编辑活动单元格

代码示例

//此示例在键入单元格时删除文本“ 123”
activeSheet.bind(GC.Spread.Sheets.Events.EditChange, function (sender,args) {
                if (args.editingText === "123") {
                    activeSheet.endEdit(true);
               }
            });

参数

属性名	类型	说明
`ignoreValueChange?`	`boolean`	如果设置为`true`,则不会将编辑后的文本应用于单元格

返回值

boolean

true能够成功停止单元格编辑时；否则为false

fillAuto

▸ fillAuto(startRange, wholeRange, options): void

自动填充指定区域

代码示例

activeSheet.setValue(0, 0, 5);
var start = new GC.Spread.Sheets.Range(0, 0, 1, 1);
var r3 = new GC.Spread.Sheets.Range(0, 0, 4, 1);
activeSheet.fillAuto(start,r3, {fillType:GC.Spread.Sheets.Fill.FillType.auto, series:GC.Spread.Sheets.Fill.FillSeries.column, direction:GC.Spread.Sheets.Fill.FillDirection.down});

参数

属性名	类型	说明
`startRange`	`Range`	填充开始区域
`wholeRange`	`Range`	整个区域要填充
`options`	`IFillOptions`	区域填充信息

返回值

void

fromJSON

▸ fromJSON(sheetSettings): void

从指定的JSON字符串加载对象状态

代码示例

//本示例使用fromJSON方法
activeSheet.getCell(0,0).value(123);
var jsonStr = null;
//export
jsonStr = JSON.stringify(activeSheet.toJSON());
//import
activeSheet.fromJSON(JSON.parse(jsonStr));
alert(jsonStr);

参数

属性名	类型	说明
`sheetSettings`	`Object`	反序列化的表单数据

返回值

void

frozenColumnCount

▸ frozenColumnCount(colCount?, leftCol?): any

获取或设置表单的冻结列数

代码示例

sheet.frozenColumnCount(30, 20);

参数

属性名	类型
`colCount?`	`number`

返回值

any

如果未设置任何值，则返回冻结的列数；否则，返回表单

frozenRowCount

▸ frozenRowCount(rowCount?, topRow?): any

获取或设置表单的冻结行数

代码示例

sheet.frozenRowCount(60, 50);

参数

属性名	类型
`rowCount?`	`number`

返回值

any

如果未设置任何值，则返回冻结的行数；否则，返回表单

frozenTrailingColumnCount

▸ frozenTrailingColumnCount(colCount?, stickToEdge?): any

获取或设置表单的冻结尾列数

代码示例

sheet.frozenTrailingColumnCount(1, false);

参数

属性名	类型
`colCount?`	`number`
`stickToEdge?`	`boolean`

返回值

any

如果未设置任何值，则返回尾随的冻结列数；否则，返回表单

frozenTrailingRowCount

▸ frozenTrailingRowCount(rowCount?, stickToEdge?): any

获取或设置表单的冻结尾行数

代码示例

sheet.frozenTrailingRowCount(1, false);

参数

属性名	类型
`rowCount?`	`number`
`stickToEdge?`	`boolean`

返回值

any

如果未设置值，则返回尾部冻结行数；否则，返回工作表

getActiveColumnIndex

▸ getActiveColumnIndex(): number

获取此表单的活动列索引

代码示例

//本示例获取活动列
sheet.setActiveCell(5,5);
alert(sheet.getActiveColumnIndex());
alert(sheet.getActiveRowIndex());
spread.bind(GC.Spread.Sheets.Events.EnterCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });
spread.bind(GC.Spread.Sheets.Events.LeaveCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });

返回值

number

活动单元格的列索引

getActiveRowIndex

▸ getActiveRowIndex(): number

获取此表单的活动行索引

代码示例

//本示例获取活动行
sheet.setActiveCell(5,5);
alert(sheet.getActiveColumnIndex());
alert(sheet.getActiveRowIndex());
spread.bind(GC.Spread.Sheets.Events.EnterCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });
spread.bind(GC.Spread.Sheets.Events.LeaveCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });

返回值

number

活动单元格的行索引

getActualStyle

▸ getActualStyle(row, column, sheetArea?, sheetStyleOnly?): Style

获取指定表单区域中指定单元格的实际样式信息

代码示例

//本示例使用getActualStyle方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getActualStyle(1,1,GC.Spread.Sheets.SheetArea.viewport, true);
alert(cstyle.backColor);

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`sheetArea?`	`SheetArea`	-
`sheetStyleOnly?`	`boolean`	-

返回值

Style

返回指定单元格的单元格样式

getAltText

▸ getAltText(row, col, sheetArea?): any

从指定的工作表区域中获取指定单元格的替代文本

代码示例

var SpreadIcon = {
    FolderOpen: '\ue685',
    InfoFilled: '\ue718',
    Library: '\ue69d',
    NotebookFilled: '\uD800\uDC0F',
    Browse: '\ue626'
};
activeSheet.setValue(1, 1, SpreadIcon.FolderOpen);
activeSheet.setAltText(1, 1, "Folder Open Icon");
alert(activeSheet.getAltText(1, 1));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	工作表区域。如果未提供此参数，则默认为 `viewport`

返回值

any

返回单元格的替代文本

getArray

▸ getArray(row, column, rowCount, columnCount, getFormula?): any[]

从单元格的指定区域中获取对象数组

代码示例

//本示例使用getArray方法
//设定值
var array = [[1,2,3],[4,5],[6,7,8,9]];
activeSheet.setArray(1, 2, array);
//设定公式
var array = [["=1+1","=2+2","=3+3"],["=4+4","=5+5"],["=6+6","=7+7","=8+8","=9+9"]];
activeSheet.setArray(1, 2, array, true);
//设定值
var newArray = activeSheet.getArray(1, 2, 3, 4);
//getformula
var newArray = activeSheet.getArray(1, 2, 3, 4, true);
//alert(newArray[0]);

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`rowCount`	`number`	行数
`columnCount`	`number`	-
`getFormula?`	`boolean`	如果`true`,则返回公式；否则，返回值

返回值

any[]

单元格区域内的对象数组

getBindingPath

▸ getBindingPath(row, col): string

从指定表单区域中的指定单元格获取单元格级绑定的绑定路径

代码示例

//本示例使用getBindingPath方法
var person = {name: "Wang feng", age: 25, address: {postcode: "710075"}};
var source = new GC.Spread.Sheets.Bindings.CellBindingSource(person);
activeSheet.setBindingPath(0, 0, "name");
activeSheet.setBindingPath(1, 1, "age");
activeSheet.setBindingPath(3, 3, "address.postcode");
activeSheet.setDataSource(source);
alert(activeSheet.getBindingPath(0, 0, GC.Spread.Sheets.SheetArea.viewport));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

string

返回单元格级别绑定的单元格绑定路径

getCell

▸ getCell(row, col, sheetArea?): CellRange

获取指定表单区域中的指定单元格

代码示例

//本示例获取单元格
activeSheet.getCell(1,1).text("cell object");

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	表单区域。如果未提供此参数，则默认为 viewport

返回值

CellRange

单元格

getCellRect

▸ getCellRect(row, col, rowViewportIndex?, colViewportIndex?): Rect

获取单元格的矩形

代码示例

//本示例使用getCellRect方法
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (e, info) {
               if (info.sheetArea === GC.Spread.Sheets.SheetArea.viewport) {
                   alert("Clicked cell index (" + info.row + "," + info.col + ")");
                   //获取存在于指定索引位置的规则单元格的坐标信息
                   var cellRect = activeSheet.getCellRect(info.row, info.col);
                   alert("X coordinate:" + cellRect.x);
                   alert("Y coordinate:" + cellRect.y);
                   alert("Cell width:" + cellRect.width);
                   alert("Cell height:" + cellRect.height);
               }
           });

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`rowViewportIndex?`	`number`	-
`colViewportIndex?`	`number`	-

返回值

Rect

包含单元格矩形的大小和位置的对象

getCellType

▸ getCellType(row, col, sheetArea?): Base

获取单元格类型

代码示例

//本示例获取单元格类型
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.getCell(0, 2).cellType(cellType);
var cellType = activeSheet.getCellType(0,2,GC.Spread.Sheets.SheetArea.viewport)
if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
      alert("This is a ButtonCellType");
}

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

Base

返回指定单元格的单元格类型

getColumnCount

▸ getColumnCount(sheetArea?): number

获取指定表单区域中的列数

代码示例

//本示例获取列数
var count = activeSheet.getColumnCount(GC.Spread.Sheets.SheetArea.viewport);
alert(count);

参数

属性名	类型
`sheetArea?`	`SheetArea`

返回值

number

列数

getColumnPageBreak

▸ getColumnPageBreak(column): boolean

获取在打印时是否在此页面上的指定列之前插入强制分页符

参数

属性名	类型	说明
`column`	`number`	列索引

返回值

boolean

true如果在指定的列之前插入了强制分页符；否则为false

getColumnResizable

▸ getColumnResizable(col, sheetArea?): boolean

获取一个用户是否可以调整指定表单区域中指定列的大小值

代码示例

//本示例获取列是否可调整大小
sheet.setRowCount(10);
sheet.setColumnCount(7);
sheet.setValue(0, 0,"Western");
sheet.setValue(0, 1,"Western");
sheet.setValue(0, 2,"Western");
sheet.setValue(1, 0,"A");
sheet.setValue(1, 1,"B");
sheet.setValue(1, 2,"C");
sheet.setColumnResizable(0,true, GC.Spread.Sheets.SheetArea.colHeader);
sheet.setRowResizable(0,true, GC.Spread.Sheets.SheetArea.rowHeader);
alert( sheet.getColumnResizable(0));
alert( sheet.getRowResizable(0, GC.Spread.Sheets.SheetArea.rowHeader));

参数

属性名	类型	说明
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

boolean

true,如果用户可以调整指定列的大小；否则为false

getColumnVisible

▸ getColumnVisible(col, sheetArea?): boolean

获取是否显示指定表单区域中的列

代码示例

//本示例返回列的可见和宽度设置
var visible = activeSheet.getColumnVisible(1, GC.Spread.Sheets.SheetArea.viewport);
var width = activeSheet.getColumnWidth(1, GC.Spread.Sheets.SheetArea.viewport);
alert(visible);
alert(width);

参数

属性名	类型	说明
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

boolean

true如果该列在表单区域中可见；否则为false

getColumnWidth

▸ getColumnWidth(col, sheetArea?, getDynamicSize?): any

获取指定表单区域中指定列的宽度(以像素为单位)或动态大小

代码示例

//本示例返回列的可见和宽度设置
var visible = activeSheet.getColumnVisible(1, GC.Spread.Sheets.SheetArea.viewport);
var width = activeSheet.getColumnWidth(1, GC.Spread.Sheets.SheetArea.viewport);
alert(visible);
alert(width);

参数

属性名	类型	说明
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-
`getDynamicSize?`	`boolean`	-

返回值

any

以像素为单位的列宽或动态大小

getCsv

▸ getCsv(row, column, rowCount, columnCount, rowDelimiter, columnDelimiter): string

获取区域内的分隔文本

参数

属性名	类型	说明
`row`	`number`	起始行
`column`	`number`	起始列
`rowCount`	`number`	行数
`columnCount`	`number`	列数
`rowDelimiter`	`string`	附加到行末尾的行分隔符
`columnDelimiter`	`string`	附加到列末尾的列分隔符

返回值

string

具有指定分隔符的区域内的文本

getCustomFunction

▸ getCustomFunction(name): void

获取自定义函数

参数

属性名	类型
`name`	`string`

返回值

void

自定义函数

getCustomName

▸ getCustomName(name): NameInfo

获取指定的自定义名称信息

代码示例

//本示例获取自定义名称和公式
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1", "=12", 0, 0);
activeSheet.addCustomName("customName2", "Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1");
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
$("#button1").click(function () {
    let cname = activeSheet.getCustomName("customName2");
    if (cname instanceof GC.Spread.Sheets.NameInfo) {
        //获取自定义名称
        let name = cname.getName();
        //获取表达式
        let expression = cname.getExpression();
        //获取表达式字符串
        let expStr = GC.Spread.Sheets.CalcEngine.expressionToFormula(activeSheet, expression, 0, 0);
        alert("Name:" + name + ";Expression: =" + expStr);
    }
});

参数

属性名	类型
`name`	`string`

返回值

NameInfo

自定义名称的信息

getCustomNames

▸ getCustomNames(): NameInfo[]

获取所有自定义名称信息

返回值

NameInfo[]

类型GC.Spread.Sheets.NameInfo存储在数组中

getDataColumnName

▸ getDataColumnName(column): string

获取指定位置的列名

代码示例

//本示例返回指定绑定列的名称
var test = [
        {"Series0":2,"Series1":1},
        {"Series0":4,"Series1":2},
        {"Series0":3,"Series1":4}
    ];
activeSheet.setDataSource(test);
activeSheet.bindColumn(1,"Series0");
activeSheet.bindColumn(0,"Series1");
var colname = activeSheet.getDataColumnName(0);
alert(colname);

参数

属性名	类型	说明
`column`	`number`	请求名称的列索引

返回值

string

数据绑定的列名

getDataItem

▸ getDataItem(row): any

获取数据项

代码示例

//本示例使用getDataItem方法
var test = [
      { "Series0": 2, "Series1": 1 },
      { "Series0": 4, "Series1": 2 },
      { "Series0": 3, "Series1": 4 }
           ];
           activeSheet.autoGenerateColumns = true;
           activeSheet.setDataSource(test, false);
           alert(JSON.stringify(activeSheet.getDataItem(0)));

参数

属性名	类型	说明
`row`	`number`	行索引

返回值

any

行数据

getDataSource

▸ getDataSource(): any

获取填充表单的数据源

function

代码示例

var test = [
        {"Series0":2,"Series1":1},
        {"Series0":4,"Series1":2},
        {"Series0":3,"Series1":4}
    ];
activeSheet.setDataSource(test);
alert(activeSheet.getDataSource);

返回值

any

返回数据源

getDataValidator

▸ getDataValidator(row, col, sheetArea): DefaultDataValidator

获取单元格数据验证器

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

DefaultDataValidator

返回指定单元格的单元格数据验证器

getDefaultStyle

▸ getDefaultStyle(sheetArea?): Style

获取表单的默认样式信息

代码示例

//本示例使用getDefaultStyle方法
var defaultStyle = new GC.Spread.Sheets.Style();
defaultStyle.backColor = "LemonChiffon";
defaultStyle.foreColor = "Red";
defaultStyle.borderLeft = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderTop = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderRight = new GC.Spread.Sheets.LineBorder("Green");
defaultStyle.borderBottom = new GC.Spread.Sheets.LineBorder("Green");
activeSheet.setDefaultStyle(defaultStyle, GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getDefaultStyle(GC.Spread.Sheets.SheetArea.viewport);
alert(cstyle.backColor);

参数

属性名	类型
`sheetArea?`	`SheetArea`

返回值

Style

返回表单的默认样式

getDefaultValue

▸ getDefaultValue(row, col): any

从指定单元格获取默认值

代码示例

sheet.setDefaultValue(0, 0, 20);
let defaultValue = sheet.getDefaultValue(0, 0);
let value = sheet.getValue(0, 0); // the value equals to defaultValue

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

any

返回单元格的默认值

getDeletedRows

▸ getDeletedRows(): any[]

获取已删除的行集合

返回值

any[]

删除的行集合数组中的项包含两个属性row.row：删除的行索引,row.originalItem：删除的数据项

getDependents

▸ getDependents(row, col): ICellsInfo[]

获取获取公式单元格的从属单元格区域信息对象数组

代码示例

sheet.getDependents(1, 1);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

ICellsInfo[]

Returns dependent cell information object array dependentsInfo.row Indicates the cellRange row index. dependentsInfo.col Indicates the cellRange col index. dependentsInfo.rowCount Indicates the cellRange row count. dependentsInfo.colCount Indicates the cellRange colcount. dependentsInfo.sheetName Indicates the workSheet name.

getDirtyCells

▸ getDirtyCells(row, col, rowCount, colCount): IDirtyCellInfo[]

获取脏单元格集合

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`rowCount`	`number`	脏单元格区域内的行数
`colCount`	`number`	脏单元格区域内的列数

返回值

IDirtyCellInfo[]

脏单元格

getDirtyRows

▸ getDirtyRows(): any[]

获取脏行集合

返回值

any[]

脏行集合，数组中的项包含三个属性,row.row：行索引,row.item：当前行的数据项,row.originalItem：该行的原始数据项

getFormatter

▸ getFormatter(row, col, sheetArea): any

获取单元格格式化

代码示例

//本示例返回活动表单的格式对象
activeSheet.getCell(0, 1).formatter("M");
activeSheet.setValue(0, 1, new Date(2011, 2, 9));
var style = activeSheet.getFormatter(0,1,GC.Spread.Sheets.SheetArea.viewport);
alert(style);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

any

返回指定单元格的单元格格式化字符串或对象

getFormula

▸ getFormula(row, col, sheetArea?): string

获取此表单中指定单元格中的公式

代码示例

//本示例返回指定单元格中的公式
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
let formula = activeSheet.getFormula(1, 1, GC.Spread.Sheets.SheetArea.viewport);
alert(formula);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

string

返回公式字符串

getFormulaInformation

▸ getFormulaInformation(row, col): IFormulaInfo

获取此表单中指定单元格中的公式详细信息

代码示例

activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
let test = activeSheet.getFormulaInformation(1,1, GC.Spread.Sheets.SheetArea.viewport);
alert(test.formula);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

IFormulaInfo

formulaInfo - Returns the formula information about the cell. formulaInfo.hasFormula 单元格中是否有公式 formulaInfo.isArrayFormula 公式是否为数组公式 formulaInfo.formula 公式字符串 formulaInfo.formulaWithCulture 本地化的公式字符串

getHyperlink

▸ getHyperlink(row, col, sheetArea?): IHyperlink

设置指定表单区域中指定单元格的超链接数据

代码示例

//本示例使用getHyperlink方法
let firstHyperlinkData = sheet.getHyperlink(0, 2, GC.Spread.Sheets.SheetArea.viewport);
let secondHyperlinkData = sheet.setHyperlink(1, 1, GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

IHyperlink

getInsertRows

▸ getInsertRows(): any[]

获取插入的行集合

返回值

any[]

插入的行集合，数组中的项包含两个属性,row.row：插入行索引,row.item：插入数据项

getNamedStyle

▸ getNamedStyle(name): Style

从具有指定名称的名为样式集合的表单中获取样式

参数

属性名	类型	说明
`name`	`string`	要返回的样式的名称

返回值

Style

返回指定的命名样式

getNamedStyles

▸ getNamedStyles(): Style[]

从表单中获取命名样式

返回值

Style[]

命名样式的GC.Spread.Sheets.Style数组

getParent

▸ getParent(): Workbook

获取当前表单的父Spread对象

返回值

Workbook

返回当前表单的父Spread对象

getPrecedents

▸ getPrecedents(row, col): ICellsInfo[]

获取公式单元格的引用的单元格区域的信息对象数组

代码示例

sheet.getPrecedents(1, 1);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

ICellsInfo[]

返回前一个单元格区域信息对象数组 precedentsInfo.row 单元格区域行索引 precedentsInfo.col 单元格区域列索引 precedentsInfo.rowCount 单元格区域行数 precedentsInfo.colCount 列数 precedentsInfo.sheetName 工作表名称

getRange

▸ getRange(row, col, rowCount?, colCount?, sheetArea?): CellRange

按指定工作表区域中的行信息和列信息获取单元格区域

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`rowCount?`	`number`	区域的行数如果不提供此参数，则默认为 1
`colCount?`	`number`	区域的列数如果不提供此参数，则默认为 1
`sheetArea?`	`SheetArea`	表单区域。如果未提供此参数，则默认为 viewport

返回值

CellRange

单元格区域如果row为-1并且rowCount为-1,则区域表示列例如,sheet.getRange(-1,4,-1,6)返回列"E:J" 如果col为-1并且colCount为-1,则区域表示行例如,sheet.getRange(4,-1,6,-1)返回行"5:10"

▸ getRange(address, sheetArea?): CellRange

按指定工作表区域中的A1样式地址(不支持R1C1样式)获取单元格范围

代码示例

// 得到一个单元格，它等于sheet.getRange(0,0,1,1)
sheet.getRange("A1")
// 得到整列，它等于sheet.getRange(- 1,0, 1,3)
sheet.getRange("A:C")
// 得到整行，它等于sheet.getRange(0, -1, 3, -1)
sheet.getRange("1:3")
// 得到一个区域，它等于sheet.getRange(0,0,3,3)
sheet.getRange("A1:C3")

参数

属性名	类型	说明
`address`	`string`	区域地址字符串例如"C1","A:C","A1:C3","1:3"
`sheetArea?`	`SheetArea`	表单区域。如果未提供此参数，则默认为 viewport

返回值

CellRange

单元格区域

getRowCount

▸ getRowCount(sheetArea?): number

获取指定表单区域中的行数

代码示例

//本示例获取行数
var count = activeSheet.getRowCount(GC.Spread.Sheets.SheetArea.viewport);
alert(count);

参数

属性名	类型
`sheetArea?`	`SheetArea`

返回值

number

行数

getRowHeight

▸ getRowHeight(row, sheetArea?, getDynamicSize?): any

获取指定表单区域中指定行的高度(以像素为单位)或动态大小

代码示例

//本示例返回指定行的高度
var rheight = activeSheet.getRowHeight(1,GC.Spread.Sheets.SheetArea.viewport);
alert(rheight);

参数

属性名	类型	说明
`row`	`number`	行索引
`sheetArea?`	`SheetArea`	-
`getDynamicSize?`	`boolean`	-

返回值

any

行高(以像素为单位)或动态尺寸

getRowPageBreak

▸ getRowPageBreak(row): boolean

获取在打印时是否在此页面上的指定行之前插入强制分页符

参数

属性名	类型	说明
`row`	`number`	行索引

返回值

boolean

true 在指定的行之前插入了强制分页符；除此以外,false.

getRowResizable

▸ getRowResizable(row, sheetArea?): boolean

获取一个指示用户是否可以调整指定表单区域中指定行的大小值

代码示例

//本示例获取行是否可调整大小
sheet.setRowCount(10);
sheet.setColumnCount(7);
sheet.setValue(0, 0,"Western");
sheet.setValue(0, 1,"Western");
sheet.setValue(0, 2,"Western");
sheet.setValue(1, 0,"A");
sheet.setValue(1, 1,"B");
sheet.setValue(1, 2,"C");
sheet.setColumnResizable(0,true, GC.Spread.Sheets.SheetArea.colHeader);
sheet.setRowResizable(0,true, GC.Spread.Sheets.SheetArea.rowHeader);
alert( sheet.getColumnResizable(0));
alert( sheet.getRowResizable(0, GC.Spread.Sheets.SheetArea.rowHeader));

参数

属性名	类型	说明
`row`	`number`	行索引
`sheetArea?`	`SheetArea`	-

返回值

boolean

true 用户可以调整指定行的大小；否则为false

getRowVisible

▸ getRowVisible(row, sheetArea?): boolean

获取控件是否显示指定的行

代码示例

//本示例返回指定行的可见设置
rvisible = activeSheet.getRowVisible(1,GC.Spread.Sheets.SheetArea.viewport);
alert(rvisible);

参数

属性名	类型	说明
`row`	`number`	行索引
`sheetArea?`	`SheetArea`	-

返回值

boolean

true该行在表单区域中可见；否则为false

getSelections

▸ getSelections(): Range[]

获取当前表单的选择

返回值

Range[]

GC.Spread.Sheets.Range存储在数组中

getSortState

▸ getSortState(): ISortState

Get last sort state in this sheet.

代码示例

//This example get sort state.
sheet.setValue(0,0,"112");
sheet.setValue(1,0,"10");
sheet.setValue(2,0,"223");
sheet.setValue(3,0,"20");
sheet.setValue(4,0,"334");
sheet.setValue(5,0,"30");
sheet.sortRange(0, 0, 6, 1, true, [{index:0, ascending:true}]);
let sortState = sheet.getSortState();

返回值

ISortState

the last sort state info .

getSpans

▸ getSpans(range?, sheetArea?): Range[]

获取指定表单区域中指定区域内的合并

参数

属性名	类型	说明
`range?`	`Range`	单元格区域
`sheetArea?`	`SheetArea`	-

返回值

Range[]

一个包含区域信息的数组，该区域信息的项类型为GC.Spread.Sheets.Range

getSparkline

▸ getSparkline(row, column): Sparkline

获取指定单元格的迷你图

代码示例

//本示例创建并设置迷你图
var cellr = new GC.Spread.Sheets.Range(0, 0, 1, 5);
var ex = new GC.Spread.Sheets.Sparklines.SparklineSetting();
ex.options.SeriesColor  = "Aquamarine";
sheet.setValue(0, 0, 2);
sheet.setValue(0, 1, 5);
sheet.setValue(0, 2, 4);
sheet.setValue(0, 3, -1);
sheet.setValue(0, 4, 3);
sheet.setSparkline(0, 5, cellr, GC.Spread.Sheets.Sparklines.DataOrientation.horizontal, GC.Spread.Sheets.Sparklines.SparklineType.column, ex);
alert(sheet.getSparkline(0, 5).toString());
//sheet.removeSparkline(0, 5);

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	-

返回值

Sparkline

单元格的迷你图

getStyle

▸ getStyle(row, column, sheetArea?): Style

获取指定表单区域中指定单元格的样式信息

代码示例

//本示例使用getStyle方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
var cstyle = activeSheet.getStyle(1,1,GC.Spread.Sheets.SheetArea.viewport);
alert(cstyle.backColor);

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

Style

返回指定单元格的单元格样式

getStyleName

▸ getStyleName(row, column, sheetArea?): string

获取指定表单区域中指定单元格的样式名称

代码示例

//本示例使用getStyleName方法
var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
activeSheet.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // 单元格(1,1)的背景色为绿色
activeSheet.setStyleName(2, 1, "style1");
alert(activeSheet.getStyleName(1,1,GC.Spread.Sheets.SheetArea.viewport));

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

string

返回样式的名称字符串

getTag

▸ getTag(row, col, sheetArea?): any

从指定表单区域中的指定单元格获取标签值

代码示例

//本示例添加并获取一个单元格标签
activeSheet.getRange(1, -1, 1, -1).tag("row tag");
alert(activeSheet.getTag(1,-1,GC.Spread.Sheets.SheetArea.viewport));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

any

返回单元格的标签值

getText

▸ getText(row, col, sheetArea?): string

获取指定表单区域中单元格中的格式化文本

代码示例

activeSheet.getText(1, 0);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-

返回值

string

返回单元格的格式化文本

getUsedRange

▸ getUsedRange(type?): Range

获取表单使用的区域

代码示例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:1});
var sheet = spread.getSheet(0);
sheet.setValue(2, 2, "value");
sheet.setValue(4, 2, "value");
sheet.setValue(6, 8, "value");
sheet.setValue(10, 15, "value");
sheet.setFormula(5, 5, "=C3");
sheet.setFormula(8, 8, "=I6");
sheet.setStyle(30,4, new GC.Spread.Sheets.Style())
sheet.setStyle(3, 24, new GC.Spread.Sheets.Style())
sheet.setRowHeight(8, 40);
sheet.getUsedRange(GC.Spread.Sheets.UsedRangeType.all);

参数

属性名	类型
`type?`	`UsedRangeType`

返回值

Range

如果未设置值，则返回null;否则，返回使用的范围

getValue

▸ getValue(row, col, sheetArea?, valueType?): any

从工作表区域中获取数据

代码示例

activeSheet.getValue(1, 1, GC.Spread.Sheets.SheetArea.viewport, GC.Spread.Sheets.ValueType.richText);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`sheetArea?`	`SheetArea`	-
`valueType?`	`ValueType`	-

返回值

any

返回单元格的值

getViewportBottomRow

▸ getViewportBottomRow(rowViewportIndex): number

获取视图底部行索引

代码示例

//本示例返回当前表单视图中底部和顶部行以及左侧和右侧列的索引
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

参数

属性名	类型	说明
`rowViewportIndex`	`number`	视图的索引

返回值

number

视图中底行的索引

getViewportHeight

▸ getViewportHeight(rowViewportIndex): number

获取活动表单的指定视图行的高度

代码示例

//本示例使用getViewportHeight方法
alert(activeSheet.getViewportHeight(1));

参数

属性名	类型	说明
`rowViewportIndex`	`number`	行视图的索引

返回值

number

视图的高度

getViewportLeftColumn

▸ getViewportLeftColumn(columnViewportIndex): number

获取视图中左列的索引

代码示例

//本示例返回当前表单视图中底部和顶部行以及左侧和右侧列的索引
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

参数

属性名	类型	说明
`columnViewportIndex`	`number`	视图的索引

返回值

number

视图中左列的索引

getViewportRightColumn

▸ getViewportRightColumn(columnViewportIndex): number

获取视图中右列的索引

代码示例

//本示例返回当前表单视图中底部和顶部行以及左侧和右侧列的索引
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

参数

属性名	类型	说明
`columnViewportIndex`	`number`	视图的索引

返回值

number

视图中右列的索引

getViewportTopRow

▸ getViewportTopRow(rowViewportIndex): number

获取视图中第一行的索引

代码示例

//本示例返回当前表单视图中底部和顶部行以及左侧和右侧列的索引
var brow = activeSheet.getViewportBottomRow(1);
var lcol = activeSheet.getViewportLeftColumn(1);
var rcol = activeSheet.getViewportRightColumn(1);
var trow = activeSheet.getViewportTopRow(1);
alert(brow);
alert(lcol);
alert(rcol);
alert(trow);

参数

属性名	类型	说明
`rowViewportIndex`	`number`	视图的索引

返回值

number

视图中第一行的索引

getViewportWidth

▸ getViewportWidth(columnViewportIndex): number

获取活动表单的指定视图列的宽度

代码示例

//本示例使用getViewportWidth方法
alert(activeSheet.getViewportWidth(1));

参数

属性名	类型	说明
`columnViewportIndex`	`number`	列视图的索引

返回值

number

视图宽度

groupSparkline

▸ groupSparkline(sparklines): SparklineGroup

将迷你图分组

代码示例

//本示例对迷你图进行分组
sheet.setValue(0, 0, "Data Range is A2-A9");
sheet.setValue(1, 0, 1);
sheet.setValue(2, 0, -2);
sheet.setValue(3, 0, -1);
sheet.setValue(4, 0, 6);
sheet.setValue(5, 0, 4);
sheet.setValue(6, 0, -4);
sheet.setValue(7, 0, 3);
sheet.setValue(8, 0, 8);
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
var s1=  sheet.setSparkline(13, 0, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.line
        , setting
        );
var s2 =sheet.setSparkline(13, 3, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.column
        , setting
        );
var s3=  sheet.setSparkline(13, 6, data
        , GC.Spread.Sheets.Sparklines.DataOrientation.vertical
        , GC.Spread.Sheets.Sparklines.SparklineType.winloss
        , setting
        );
var group = sheet.groupSparkline([s1,s2,s3]);

参数

属性名	类型	说明
`sparklines`	`Sparkline`[]	分组的迷你图

返回值

SparklineGroup

迷你图组

hasPassword

▸ hasPassword(): boolean

获取表单是否已设置保护密码

代码示例

let password = "fe4c4be8"
sheet.protect(password);
if(sheet.hasPassword()) {
    sheet.unprotect(password);
} else {
    sheet.unprotect();
}

返回值

boolean

如果设置了密码，返回True，否则返回False

hasPendingChanges

▸ hasPendingChanges(): boolean

获取指定区域的脏数据，插入或删除状态

返回值

boolean

true如果区域内的任何行或单元格是脏的，或者已被插入或删除；否则为false

hitTest

▸ hitTest(x, y): IHitTestInformation

执行命中测试

参数

属性名	类型	说明
`x`	`number`	x坐标
`y`	`number`	y坐标

返回值

IHitTestInformation

命中测试信息

invalidateLayout

▸ invalidateLayout(): void

使表单布局无效

代码示例

//本示例更新布局
activeSheet.columnOutlines.group(0, 1);
activeSheet.invalidateLayout();
activeSheet.repaint();

返回值

void

isDirtySuspended

▸ isDirtySuspended(): boolean

获取是否记录脏数据

代码示例

//本示例使用isDirtySuspended方法
var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

返回值

boolean

脏数据是否被挂起

isEditing

▸ isEditing(): boolean

获取表单是否处于编辑模式

代码示例

//本示例使用isEditing方法
alert(activeSheet.isEditing());

返回值

boolean

true表单处于编辑模式；否则为false

isPaintSuspended

▸ isPaintSuspended(): boolean

获取是否暂停绘制

返回值

boolean

isPrintLineVisible

▸ isPrintLineVisible(value?): boolean

获取或设置是否显示表单的打印预览线

参数

属性名	类型
`value?`	`boolean`

返回值

boolean

如果未设置任何值，则返回一个值，该值指示是否显示打印预览线

isSelected

▸ isSelected(selectedState?): any

获取或设置表单的选定状态

代码示例

spread.sheets[0].isSelected();
spread.sheets[1].isSelected(true);

参数

属性名	类型
`selectedState?`	`boolean`

返回值

any

如果未设置selectedState,则返回表单的选定状态；否则，返回表单选定状态否则，返回表单

isValid

▸ isValid(row, column, value): boolean

确定单元格值是否有效

代码示例

//本示例使用isValid方法
alert(activeSheet.isValid(0, 0, 10));

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`value`	`Object`	单元格值

返回值

boolean

true该值有效；否则为false

moveTo

▸ moveTo(fromRow, fromColumn, toRow, toColumn, rowCount, columnCount, option): void

将数据从一个区域移动到另一个区域

代码示例

//本示例将数据移动到指定位置
activeSheet.getCell(0,0).value("A1");
activeSheet.getCell(1,1).value("Test")
activeSheet.moveTo(0,0,3,3,2,2,GC.Spread.Sheets.CopyToOptions.value);

参数

属性名	类型	说明
`fromRow`	`number`	源行
`fromColumn`	`number`	源列
`toRow`	`number`	目标行
`toColumn`	`number`	目标列
`rowCount`	`number`	行数
`columnCount`	`number`	列数
`option`	`CopyToOptions`	复制选项

返回值

void

name

▸ name(value?): any

获取或设置表单的名称

代码示例

spread.sheets[0].name("The first sheet");
spread.sheets[1].name( "The second sheet");

参数

属性名	类型
`value?`	`string`

返回值

any

如果未设置任何值，则返回表单名称。否则，返回表单

printInfo

▸ printInfo(value?): any

获取或设置表单的打印信息

参数

属性名	类型
`value?`	`PrintInfo`

返回值

any

如果未设置任何值，则返回表单的打印信息；否则，返回表单

protect

▸ protect(password?): void

给表单添加密码保护，如果已经存在密码保护，则什么都不么都不修改

代码示例

let password = "fe4c4be8"
sheet.protect(password);

参数

属性名	类型	说明
`password?`	`string`	Sheet protection password.

返回值

void

recalcAll

▸ recalcAll(refreshAll?): void

重新计算表单中的所有公式

代码示例

//本示例使用recalcAll方法
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
activeSheet.recalcAll();

参数

属性名	类型	说明
`refreshAll?`	`boolean`	指定是否重建所有公式引用，自定义名称和自定义函数

返回值

void

removeCustomFunction

▸ removeCustomFunction(name): void

删除自定义函数

代码示例

//本示例使用removeCustomFunction方法
// 添加自定义函数
// Type =myfunc(1)
// 在单元格中查看结果
function myfunc() {}
myfunc.prototype = new GC.Spread.CalcEngine.Functions.Function("myfunc", 0, 0, {name: "myfunc",description: "This is my first function"});
myfunc.prototype.evaluate = function (args) {
    return 100;
}
spread.addCustomFunction(new myfunc());
//spread.removeCustomFunction("myfunc");

参数

属性名	类型
`name`	`string`

返回值

void

removeCustomName

▸ removeCustomName(name): void

删除指定的自定义名称

代码示例

//本示例使用removeCustomName方法
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(0, 1, 2);
activeSheet.setValue(0, 2, 3);
activeSheet.addCustomName("customName1","=12", 0, 0);
activeSheet.addCustomName("customName2","Average(20,45)", 0, 0);
activeSheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
activeSheet.setFormula(1, 0, "customName1");
activeSheet.setFormula(1, 1, "customName2");
activeSheet.setFormula(1, 2, "sum(customName3)");
//activeSheet.removeCustomName("customName3");

参数

属性名	类型
`name`	`string`

返回值

void

removeNamedStyle

▸ removeNamedStyle(name): void

从具有指定名称的命名样式集合的表单中删除样式

参数

属性名	类型	说明
`name`	`string`	要删除的样式的名称

返回值

void

removeSpan

▸ removeSpan(row, col, sheetArea?): void

移除在指定表单区域中包含指定单元格的合并

代码示例

activeSheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);
//activeSheet.removeSpan(0, 0, GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	合并单元格的行索引(合并单元格从该行开始)
`col`	`number`	合并单元格的列索引(合并的单元格在此开始)
`sheetArea?`	`SheetArea`	-

返回值

void

removeSparkline

▸ removeSparkline(row, col): void

删除指定单元格的迷你图

代码示例

//本示例将删除迷你图
var cellr = new GC.Spread.Sheets.Range(0, 0, 1, 5);
var ex = new GC.Spread.Sheets.Sparklines.SparklineSetting();
ex.options.SeriesColor  = "Aquamarine";
sheet.setValue(0, 0, 2);
sheet.setValue(0, 1, 5);
sheet.setValue(0, 2, 4);
sheet.setValue(0, 3, -1);
sheet.setValue(0, 4, 3);
sheet.setSparkline(0, 5, cellr, GC.Spread.Sheets.Sparklines.DataOrientation.horizontal, GC.Spread.Sheets.Sparklines.SparklineType.column, ex);
alert(sheet.getSparkline(0, 5).toString());
//sheet.removeSparkline(0, 5);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

void

repaint

▸ repaint(clipRect?): void

重新绘制指定的矩形

代码示例

//本示例将导致重绘
var cellrange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
sheet.rowFilter(hideRowFilter);
sheet.resumePaint();
sheet.repaint();

参数

属性名	类型	说明
`clipRect?`	`Rect`	要重绘的矩形

返回值

void

reset

▸ reset(): void

重置表单

代码示例

//本示例使用reset方法
activeSheet.reset();

返回值

void

resumeCalcService

▸ resumeCalcService(recalcAll?): void

恢复计算服务

代码示例

//本示例使用resumeCalcService方法
activeSheet.suspendCalcService(false);
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
activeSheet.resumeCalcService(true);

参数

属性名	类型	说明
`recalcAll?`	`boolean`	指定是否重新计算所有公式

返回值

void

resumeDirty

▸ resumeDirty(): void

恢复记录的脏数据

代码示例

//本示例使用resumeDirty方法
 var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

返回值

void

resumeEvent

▸ resumeEvent(): void

恢复事件

代码示例

//本示例暂停并恢复事件
 activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.suspendEvent();
activeSheet.setValue(0, 0, "111");
activeSheet.resumeEvent();
activeSheet.setValue(1, 1, "222");

返回值

void

resumePaint

▸ resumePaint(): void

恢复绘制

返回值

void

rowFilter

▸ rowFilter(value?): RowFilterBase

获取或设置表单的行筛选

代码示例

//本示例创建一个行筛选
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(1,1,10,3)));

参数

属性名	类型	说明
`value?`	`RowFilterBase`	表单的行筛选

返回值

RowFilterBase

如果调用该方法时没有传递参数，将返回过滤器实例；否则，将返回工作表实例

scroll

▸ scroll(vPixels, hPixels): void

将表单滚动指定的像素当vPixels为正时，表单将向下滚动；当vPixels为负时，表单将向上滚动；当vPixels为0时，表单将不会沿垂直方向滚动当hPixels为正时，表单将向右滚动；否则，表单将向右滚动当hPixels为负数时，表单将向左滚动；当hPixels为0时，表单将不会在水平方向滚动当工作簿的选项scrollByPixel为true时，表单将滚动到新的顶行/左列索引和新的顶行/左列偏移; 当工作簿的选项scrollByPixel为false时，表单将滚动到新的第一行/左列索引，并且新的第一行/左列偏移量将始终为0

代码示例

//本示例向下滚动表单10像素，向右滚动表单5像素
activeSheet.scroll(10, 5);

参数

属性名	类型	说明
`vPixels`	`number`	要在垂直方向上滚动的像素
`hPixels`	`number`	在水平方向上滚动的像素

返回值

void

search

▸ search(searchCondition): SearchResult

搜索指定的内容

代码示例

//本示例使用搜索方法
activeSheet.getCell(2,3).value("testSearch");
var searchCondition = new GC.Spread.Sheets.Search.SearchCondition();
searchCondition.searchString = "testSearch";
searchCondition.startSheetIndex = spread.getActiveSheetIndex();
searchCondition.endSheetIndex = spread.getActiveSheetIndex();
searchCondition.searchOrder = GC.Spread.Sheets.Search.SearchOrder.nOrder;
searchCondition.searchTarget = GC.Spread.Sheets.Search.SearchFoundFlags.cellText;
searchCondition.searchFlags = GC.Spread.Sheets.Search.SearchFlags.ignoreCase| GC.Spread.Sheets.Search.SearchFlags.useWildCards;
var searchresult= activeSheet.search(searchCondition);
var str ="[searchFoundFlag:"+ searchresult.searchFoundFlag+",\r\n foundSheetIndex:"+searchresult.foundSheetIndex+",foundRowIndex:" +
searchresult.foundRowIndex+", foundColumnIndex:"+searchresult.foundColumnIndex+", foundString:"+searchresult.foundSheetIndex+"]";
alert(str);

参数

属性名	类型	说明
`searchCondition`	`SearchCondition`	搜索条件

返回值

SearchResult

搜索结果

selectionPolicy

▸ selectionPolicy(value?): any

获取或设置用户是否可以选择表单上的项区域

代码示例

//本示例使用selectionPolicy方法
activeSheet.selectionUnit(GC.Spread.Sheets.SelectionUnit.row);
activeSheet.selectionPolicy(GC.Spread.Sheets.SelectionPolicy.range);

参数

属性名	类型
`value?`	`SelectionPolicy`

返回值

any

如果未设置任何值，则返回选择策略设置否则，返回表单

selectionUnit

▸ selectionUnit(value?): any

获取或设置用户是否可以选择表单上的单元格，行或列

代码示例

//本示例使用selectionUnit方法
activeSheet.selectionUnit(GC.Spread.Sheets.SelectionUnit.row);
activeSheet.selectionPolicy(GC.Spread.Sheets.SelectionPolicy.range);

参数

属性名	类型
`value?`	`SelectionUnit`

返回值

any

如果未设置任何值，则返回选择单位设置否则，返回表单

setActiveCell

▸ setActiveCell(row, col): void

设置此表单的活动单元格

代码示例

//本示例设置活动单元格
sheet.setActiveCell(5,5);
alert(sheet.getActiveColumnIndex());
alert(sheet.getActiveRowIndex());
spread.bind(GC.Spread.Sheets.Events.EnterCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });
spread.bind(GC.Spread.Sheets.Events.LeaveCell, function (event, data) {
    alert(data.col);
    alert(data.row);
  });

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引

返回值

void

setAltText

▸ setAltText(row, col, value, sheetArea?): void

在指定的工作表区域中设置指定单元格的替代文本

代码示例

var SpreadIcon = {
    FolderOpen: '\ue685',
    InfoFilled: '\ue718',
    Library: '\ue69d',
    NotebookFilled: '\uD800\uDC0F',
    Browse: '\ue626'
};
activeSheet.setValue(1, 1, SpreadIcon.FolderOpen);
activeSheet.setAltText(1, 1, "Folder Open Icon");

// 除了普通文本外，替代文本还可以包含占位符 {value} 或 {formatted}，分别表示单元格的值或格式化后的值
// 例如，如果单元格的值为1000，并且替代文本为"Sales amount is {value}"，则最终的可访问内容应为"Sales amount is 1000"
activeSheet.setValue(1, 1, 1000);
activeSheet.setAltText(1, 1, "Sales amount is {value}");

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`string`	要设置的指定单元格的替代文本
`sheetArea?`	`SheetArea`	工作表区域。如果未提供此参数，则默认为 `viewport`

返回值

void

setArray

▸ setArray(row, column, array, setFormula?): void

将指定的二维对象数组中的值设置到此表单中指定的单元格区域内

代码示例

//本示例使用setArray方法
//设定值
var array = [[1,2,3],[4,5],[6,7,8,9]];
activeSheet.setArray(1, 2, array);
//设定公式
var array = [["=1+1","=2+2","=3+3"],["=4+4","=5+5"],["=6+6","=7+7","=8+8","=9+9"]];
activeSheet.setArray(1, 2, array, true);
//设定值
var newArray = activeSheet.getArray(1, 2, 3, 4);
//getformula
var newArray = activeSheet.getArray(1, 2, 3, 4, true);
//alert(newArray[0]);

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`array`	`any`[]	要从中设置值的数组
`setFormula?`	`boolean`	-

返回值

void

setArrayFormula

▸ setArrayFormula(row, col, rowCount, colCount, value, sheetArea?): void

给一个或者一片区域中的单元格设置公式

代码示例

//本示例使用setArrayFormula方法
activeSheet.getCell(1,1).value(3);
activeSheet.getCell(2,1).value(1);
activeSheet.getCell(3,1).value(3);
activeSheet.getCell(4,1).value(7);
activeSheet.getCell(1,2).value(7);
activeSheet.getCell(2,2).value(7);
activeSheet.getCell(3,2).value(7);
activeSheet.getCell(4,2).value(7);
spread.allowUserEditFormula(true);
activeSheet.setArrayFormula(0, 3, 4, 1, "B2:B5*C2:C5", GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	起始行索引
`col`	`number`	起始列索引
`rowCount`	`number`	行数
`colCount`	`number`	列数
`value`	`string`	要设置的公式
`sheetArea?`	`SheetArea`	-

返回值

void

setBindingPath

▸ setBindingPath(row, col, path): Worksheet

设置指定表单区域中指定单元格中单元格级别绑定的绑定路径

代码示例

//本示例绑定单元格
var test = {name: "John", gender: "male"};
sheet.setBindingPath(0, 0, "name");
sheet.setBindingPath(0, 1, "gender");
sheet.setDataSource(new GC.Spread.Sheets.Bindings.CellBindingSource(test));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`path`	`string`	单元格绑定源的绑定路径

返回值

Worksheet

setCellType

▸ setCellType(row, col, value, sheetArea?): void

设置单元格类型

代码示例

//本示例使用setCellType方法
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.setCellType(1,1,cellType);
spread.bind(GC.Spread.Sheets.Events.ButtonClicked, function (e, args) {
    var sheet = args.sheet, row = args.row, col = args.col;
    var cellType = activeSheet.getCellType(row, col);
    if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
        alert("Button Clicked");
    }
});

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`Base`	单元格类型
`sheetArea?`	`SheetArea`	-

返回值

void

setColumnCount

▸ setColumnCount(colCount, sheetArea?, guardContent?): void

设置指定表单区域中的列数

代码示例

//本示例设置列数
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`colCount`	`number`	列数
`sheetArea?`	`SheetArea`	-
`guardContent?`	`UsedRangeType`	-

返回值

void

setColumnPageBreak

▸ setColumnPageBreak(column, value): void

设置在打印时是否在此页面上的指定列之前插入强制分页符

代码示例

//本示例设置分页符
activeSheet.setColumnPageBreak(5, true);

参数

属性名	类型	说明
`column`	`number`	列索引
`value`	`boolean`	设置为`true`可以在打印时强制分页符在此表单上的指定列之前

返回值

void

setColumnResizable

▸ setColumnResizable(col, value, sheetArea?): void

设置用户是否可以调整指定表单区域中指定列的大小

代码示例

//本示例设置setColumnResizable方法
sheet.setRowResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(1,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);
sheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);

参数

属性名	类型	说明
`col`	`number`	列索引
`value`	`boolean`	设置为`true`以允许用户调整列的大小
`sheetArea?`	`SheetArea`	-

返回值

void

setColumnVisible

▸ setColumnVisible(col, value, sheetArea?): void

设置是否显示指定表单区域中的列

代码示例

//本示例将指定的列设置为隐藏
activeSheet.setColumnVisible(2,false,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`col`	`number`	列索引
`value`	`boolean`	是否显示该列
`sheetArea?`	`SheetArea`	-

返回值

void

setColumnWidth

▸ setColumnWidth(col, value, sheetArea?): void

设置指定表单区域中指定列的宽度(以像素为单位)或动态大小

代码示例

//本示例设置列宽
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(1, "2*", GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

参数

属性名	类型	说明
`col`	`number`	列索引
`value`	`string` \| `number`	以像素为单位的宽度，或使用带有 "*" 的字符串表示动态尺寸
`sheetArea?`	`SheetArea`	-

返回值

void

setCsv

▸ setCsv(row, column, text, rowDelimiter, columnDelimiter): void

在表单中设置定界文本(CSV)

参数

属性名	类型	说明
`row`	`number`	起始行
`column`	`number`	起始列
`text`	`string`	分隔的文本
`rowDelimiter`	`string`	行定界符
`columnDelimiter`	`string`	列定界符

返回值

void

setDataSource

▸ setDataSource(data, reset?): void

填充表单的数据源

代码示例

var test = [
       { "Series0": 2, "Series1": 1 },
       { "Series0": 4, "Series1": 2 },
       { "Series0": 3, "Series1": 4 }
            ];
activeSheet.autoGenerateColumns = true;
activeSheet.setDataSource(test, true);

参数

属性名	类型	说明
`data`	`any`	数据源
`reset?`	`boolean`	为`true`时会重置表单，若为`false`则不重置

返回值

void

setDataValidator

▸ setDataValidator(row, col, value, sheetArea?): void

设置单元格数据验证器

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`DefaultDataValidator`	数据验证
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

void

▸ setDataValidator(row, col, rowCount, colCount, value, sheetArea?): void

设置单元格数据验证器

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`rowCount`	`number`	行数
`colCount`	`number`	列数
`value`	`DefaultDataValidator`	数据验证
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

void

setDefaultStyle

▸ setDefaultStyle(style, sheetArea?): void

设置表单的默认样式信息

参数

属性名	类型	说明
`style`	`Style`	要设置的样式
`sheetArea?`	`SheetArea`	-

返回值

void

setDefaultValue

▸ setDefaultValue(row, col, value): void

将默认值设置为单元格，可以是值数据或公式字符串。当单元格没有数据时生效

代码示例

sheet.setDefaultValue(0, 0, "name");
sheet.setDefaultValue(0, 1, "=A1");

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`any`	单元格默认值

返回值

void

setFormatter

▸ setFormatter(row, col, value, sheetArea): void

设置单元格格式化

代码示例

//本示例为活动表单设置格式对象
activeSheet.setValue(2, 3, new Date(2011, 2, 9));
activeSheet.setFormatter(2,3,"M",GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`string` \| `FormatterBase`	格式化字符串或对象
`sheetArea`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

void

setFormula

▸ setFormula(row, col, value, sheetArea?): void

给一个或者一片区域中的单元格设置公式

代码示例

//本示例为指定的单元格设置公式
activeSheet.setValue(0, 2, 3);
activeSheet.setFormula(1,1,"C1+D1",GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`string`	要放在指定单元格中的公式
`sheetArea?`	`SheetArea`	-

返回值

void

setHyperlink

▸ setHyperlink(row, col, value, sheetArea?): void

设置指定表单区域中指定单元格的超链接数据

代码示例

//本示例使用setHyperlink方法
sheet.setHyperlink(0, 2, {
   url: 'https://www.grapecity.com/spreadjs',
   tooltip: 'baidu',
   linkColor: 'blue',
   visitedLinkColor: 'red',
   target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank,
   command: 'navigationLeft'
}, GC.Spread.Sheets.SheetArea.viewport);
sheet.setHyperlink(1, 1, {
   url: 'https://www.grapecity.com/spreadjs',
   tooltip: 'baidu',
   setUnderlineToStyle: true;
   setForeColorToStyle: true;
   target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.top,
   command: function() { console.log('Only show this message when click the hyperlink.')}
}, GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`IHyperlink`	为指定单元格设置的超链接数据
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

void

setRowCount

▸ setRowCount(rowCount, sheetArea?, guardContent?): void

设置指定表单区域中的行数

代码示例

//本示例设置行数
sheet.setRowCount(4,1);
sheet.setColumnCount(4,2);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.colHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.rowHeader);
sheet.addSpan(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`rowCount`	`number`	行数
`sheetArea?`	`SheetArea`	-
`guardContent?`	`UsedRangeType`	-

返回值

void

setRowHeight

▸ setRowHeight(row, value, sheetArea?): void

设置指定表单区域中指定行的高度(以像素为单位)或动态大小

代码示例

//本示例设置行高
sheet.setValue(0, 0, "value");
sheet.addRows(0, 2);
sheet.addColumns(0, 2);
sheet.setRowHeight(0, 50.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.setRowHeight(1, "3*", GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnWidth(0, 150.0, GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).backColor("Gray");
sheet.getRange(-1, 0, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor ("Brown");

参数

属性名	类型	说明
`row`	`number`	行索引
`value`	`string` \| `number`	以像素为单位的高度，或使用带有 "*" 的字符串表示动态尺寸
`sheetArea?`	`SheetArea`	-

返回值

void

setRowPageBreak

▸ setRowPageBreak(row, value): void

设置在打印时是否在此表单上的指定行之前插入强制分页符

代码示例

activeSheet.setRowPageBreak(3, true);

参数

属性名	类型	说明
`row`	`number`	行索引
`value`	`boolean`	设置为`true`可以在打印时强制分页符在此表单上的指定行之前

返回值

void

setRowResizable

▸ setRowResizable(row, value, sheetArea?): void

设置用户是否可以调整指定表单区域中指定行的大小

代码示例

//本示例防止调整某些行和列的大小
sheet.setRowResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.setColumnResizable(3,false,GC.Spread.Sheets.SheetArea.viewport);
sheet.getRange(1,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);
sheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).resizable(false);

参数

属性名	类型	说明
`row`	`number`	行索引
`value`	`boolean`	设置为`true`可以让用户调整指定行的大小
`sheetArea?`	`SheetArea`	-

返回值

void

setRowVisible

▸ setRowVisible(row, value, sheetArea?): void

设置控件是否在指定的表单区域中显示指定的行

代码示例

//本示例将指定的行设置为隐藏
activeSheet.setRowVisible(1,false,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`value`	`boolean`	设置为`true`以显示指定的行
`sheetArea?`	`SheetArea`	-

返回值

void

setSelection

▸ setSelection(row, column, rowCount, columnCount): void

将选择内容设置为一个单元格或一个区域，并将活动单元格设置为第一个单元格

代码示例

//本示例选择一个单元格区域
sheet.setValue(0,0, 1,3);
sheet.setValue(1,0, 50,3);
sheet.setValue(2,0, 100,3);
sheet.setValue(3,0, 2,3);
sheet.setValue(4,0, 60,3);
sheet.setValue(5,0, 90,3);
sheet.setValue(6,0, 3,3);
sheet.setValue(7,0, 40,3);
sheet.setValue(8,0, 70,3);
sheet.setValue(9,0, 5,3);
sheet.setValue(10,0, 35,3);
sheet.setSelection(0,0,11,1);
sheet.conditionalFormats.add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", sheet.getSelections());

参数

属性名	类型	说明
`row`	`number`	要添加的第一个单元格的行索引
`column`	`number`	要添加的第一个单元格的列索引
`rowCount`	`number`	要添加的行数
`columnCount`	`number`	要添加的列数

返回值

void

setSparkline

▸ setSparkline(row, col, dataRange, dataOrientation, sparklineType, sparklineSetting, dateAxisRange?, dateAxisOrientation?): Sparkline

设置单元的迷你图

代码示例

//本示例为指定区域创建迷你图
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
setting.options.seriesColor = "Text 2 1";
setting.options.firstMarkerColor = "Text 2 3";
setting.options.negativeColor = "Accent 2 1";
setting.options.markersColor = "Accent 3 1";
setting.options.lowMarkerColor = "Accent 4 1";
setting.options.highMarkerColor = "Accent 6 1";
setting.options.lastMarkerColor = "Accent 6 6";
setting.options.axisColor ="Text 1 1";
sheet.addSpan(13, 0, 4, 3, null);
sheet.setSparkline(13, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
sheet.setValue(1, 0, 1);
sheet.setValue(2, 0, -2);
sheet.setValue(3, 0, -1);
sheet.setValue(4, 0, 6);
sheet.setValue(5, 0, 4);
sheet.setValue(6, 0, -4);
sheet.setValue(7, 0, 3);
sheet.setValue(8, 0, 8);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`dataRange`	`string` \| `Range`	数据区域
`dataOrientation`	`DataOrientation`	数据方向
`sparklineType`	`SparklineType`	迷你图的类型
`sparklineSetting`	`SparklineSetting`	迷你图设置
`dateAxisRange?`	`string` \| `Range`	日期轴区域
`dateAxisOrientation?`	`DataOrientation`	日期轴区域方向

返回值

Sparkline

迷你图

setStyle

▸ setStyle(row, col, value, sheetArea?): void

设置指定表单区域中指定单元格的样式信息

代码示例

//本示例使用setStyle方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "lightgreen";
style.backgroundImage = "./css/images/quarter1.png";
activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	-
`value`	`Style`	单元格样式
`sheetArea?`	`SheetArea`	-

返回值

void

setStyleName

▸ setStyleName(row, column, value, sheetArea?): void

为指定表单区域中的指定单元格设置指定的样式名称

代码示例

var namedStyle = new GC.Spread.Sheets.Style();
namedStyle.name = "style1";
namedStyle.backColor = "green";
activeSheet.addNamedStyle(namedStyle);
activeSheet.setStyleName(1, 1, "style1"); // 单元格(1,1)的背景色为绿色
activeSheet.setStyleName(2, 1, "style1");

参数

属性名	类型	说明
`row`	`number`	行索引
`column`	`number`	列索引
`value`	`string`	要设置的样式的名称
`sheetArea?`	`SheetArea`	-

返回值

void

setTag

▸ setTag(row, col, tag, sheetArea?): void

设置指定表单区域中指定单元格的标签值

代码示例

activeSheet.setTag(1,1,"test");

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`tag`	`any`	要为指定单元格设置的标签值
`sheetArea?`	`SheetArea`	表单区域如果未提供此参数，则默认为 viewport

返回值

void

setText

▸ setText(row, col, value, sheetArea?): void

设置指定表单区域内单元格中的格式化文本

代码示例

activeSheet.setText(1, 0, "10");

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`string`	指定单元格的文本
`sheetArea?`	`SheetArea`	-

返回值

void

setValue

▸ setValue(row, col, value, sheetArea?, ignoreRecalc?): void

设置指定表单区域中指定单元格的值

代码示例

//本例使用setValue方法
sheet.setValue(0,2,"ColumnHeader", GC.Spread.Sheets.SheetArea.colHeader);
sheet.setValue(2,0,{richText:[{style:{font:'bold 24px Arial'},text:'SpreadJS'}]}, GC.Spread.Sheets.SheetArea.rowHeader);
sheet.setValue(1, 1, {richText:[{style:{vertAlign: GC.Spread.Sheets.VertAlign.subscript},text:'SpreadJS'}]}, GC.Spread.Sheets.SheetArea.viewport);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`value`	`any`	要为指定单元格设置的值如果值是富文本格式，则应该包含一个类型为富文本样式数组的richText字段
`sheetArea?`	`SheetArea`	-
`ignoreRecalc?`	`boolean`	是否忽略重新计算

返回值

void

showCell

▸ showCell(row, col, verticalPosition, horizontalPosition): void

将单元格的视图移动到视窗中的指定位置

代码示例

//本示例使用了showCell方法
//设置单元格(3,3)为活动单元格
activeSheet.setActiveCell(3, 3);
//在左上角显示活动单元格
activeSheet.showCell(3, 3, GC.Spread.Sheets.VerticalPosition.top, GC.Spread.Sheets.HorizontalPosition.left);

参数

属性名	类型	说明
`row`	`number`	行索引
`col`	`number`	列索引
`verticalPosition`	`VerticalPosition`	显示单元格的垂直位置
`horizontalPosition`	`HorizontalPosition`	显示单元格的水平位置

返回值

void

showColumn

▸ showColumn(col, horizontalPosition): void

将列的视图移动到视窗中的指定位置

代码示例

activeSheet.showColumn(9, GC.Spread.Sheets.HorizontalPosition.left);

参数

属性名	类型	说明
`col`	`number`	列索引
`horizontalPosition`	`HorizontalPosition`	显示列的水平位置

返回值

void

showColumnOutline

▸ showColumnOutline(value?): any

获取或设置列分组列(分组区域)是否可见

代码示例

//本示例使用showColumnOutline方法
activeSheet.showColumnOutline(false);

参数

属性名	类型	说明
`value?`	`boolean`	是否显示列分组

返回值

any

如果未设置值，则返回一个值，该值指示列分组是否显示在此表单上；否则，返回表单

showRow

▸ showRow(row, verticalPosition): void

将行视图移动到视窗中的指定位置

代码示例

activeSheet.showRow(9, GC.Spread.Sheets.VerticalPosition.top);

参数

属性名	类型	说明
`row`	`number`	行索引
`verticalPosition`	`VerticalPosition`	显示行的垂直位置

返回值

void

showRowOutline

▸ showRowOutline(value?): any

获取或设置行分组(分组区域)是否可见

代码示例

//本例使用了showRowOutline方法
activeSheet.showRowOutline(false);

参数

属性名	类型	说明
`value?`	`boolean`	是否显示行分组

返回值

any

如果未设置值，则返回一个值，该值指示行分组是否显示在此表单上；否则，返回表单

sortRange

▸ sortRange(row, column, rowCount, columnCount, byRows, sortInfo, sortOption?): boolean

对数据模型中的单元格区域进行排序

代码示例

//本示例对区域进行排序
sheet.setValue(0,0,"112");
sheet.setValue(1,0,"10");
sheet.setValue(2,0,"223");
sheet.setValue(3,0,"20");
sheet.setValue(4,0,"334");
sheet.setValue(5,0,"30");
function pinyinCompare (obj1, obj2) {
    return obj1.toString().localeCompare(obj2.toString(), 'zh');
}
sheet.sortRange(0, 0, 6, 1, true, [
                {index:0, ascending:true, compareFunction: pinyinCompare}
                ], {groupSort: GC.Spread.Sheets.GroupSort.full, ignoreHidden: true});

参数

属性名	类型	说明
`row`	`number`	要排序的单元格块的起始行索引
`column`	`number`	要排序的单元格块的起始列的索引
`rowCount`	`number`	单元格块中的行数
`columnCount`	`number`	单元格块中的列数
`byRows`	`boolean`	设为`true`为按行排序,`false`为按列排序
`sortInfo`	(`ICellColorSortInfo` \| `ICustomSortInfo` \| `IFontColorSortInfo` \| `IValueSortInfo`)[]	包含排序条件和有关如何执行排序的SortInfo对象例如, [{index:0,ascending:true}]
`sortOption?`	`ISortOptions`	sortOption表示排序的性能

返回值

boolean

如果数据排序成功，则为true; 否则，为 false

startEdit

▸ startEdit(selectAll?, defaultText?): void

开始编辑单元格

代码示例

//本例使用startEdit方法
activeSheet.setActiveCell(5,5);
activeSheet.startEdit(true, "Test");

参数

属性名	类型	说明
`selectAll?`	`boolean`	设置为`true`选择单元格中的所有文本
`defaultText?`	`string`	编辑单元格时要显示的默认文本

返回值

void

suspendCalcService

▸ suspendCalcService(ignoreDirty?): void

挂起计算服务

代码示例

//本示例使用suspendCalcService方法
activeSheet.suspendCalcService(false);
activeSheet.setValue(0,0,1);
activeSheet.setValue(0,1,2);
activeSheet.setValue(0,2,10);
activeSheet.getCell(1,1).formula("=SUM(A1:C1)");
activeSheet.resumeCalcService(true);

参数

属性名	类型	说明
`ignoreDirty?`	`boolean`	是否使依赖关系单元格无效

返回值

void

suspendDirty

▸ suspendDirty(): void

暂停记录脏数据

代码示例

//本例使用了suspendDirty方法
 var customers = [
               { ID: 0, Name: 'A', Info1: 'Info0' },
               { ID: 1, Name: 'B', Info1: 'Info1' },
               { ID: 2, Name: 'C', Info1: 'Info2' },
            ];
activeSheet.setDataSource(customers);
activeSheet.suspendDirty();
alert(activeSheet.isDirtySuspended());
activeSheet.resumeDirty();
alert(activeSheet.isDirtySuspended());

返回值

void

suspendEvent

▸ suspendEvent(): void

挂起事件

代码示例

//本示例暂停并恢复事件
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.suspendEvent();
activeSheet.setValue(0, 0, "111");
activeSheet.resumeEvent();
activeSheet.setValue(1, 1, "222");

返回值

void

suspendPaint

▸ suspendPaint(): void

暂停绘制

返回值

void

tag

▸ tag(value?): any

获取或设置当前表单的标签值

代码示例

//本示例设置表单标签
activeSheet.tag("test");
alert(activeSheet.tag());

参数

属性名	类型	说明
`value?`	`any`	要为当前表单设置的标签值

返回值

any

如果没有设置值，返回当前表单的标签值；否则，返回表单

toJSON

▸ toJSON(serializationOption?): Object

将对象状态保存为JSON字符串

代码示例

//本例使用toJSON方法
activeSheet.getCell(0,0).value(123);
var jsonStr = null;
//export
jsonStr = JSON.stringify(activeSheet.toJSON());
//import
activeSheet.fromJSON(JSON.parse(jsonStr));
alert(jsonStr);

参数

属性名	类型	说明
`serializationOption?`	`Object`	包含includeBindingSource参数的序列化选项更多信息请参见备注

返回值

Object

表单数据

unbind

▸ unbind(type, fn?): void

删除事件到表单的绑定

代码示例

//本示例在设置第一个值后取消绑定事件
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.setValue(0, 0, "111");
activeSheet.unbind(GC.Spread.Sheets.Events.CellChanged);
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

参数

属性名	类型	说明
`type`	`string`	事件类型
`fn?`	`Function`	要移除其绑定的函数

返回值

void

unbindAll

▸ unbindAll(): void

删除所有事件到表单的绑定

代码示例

//本示例取消监视所有事件
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (sender, args) {
    if (args.propertyName === "value") {
        alert(activeSheet.getValue(args.row, args.col));
    }
});
activeSheet.setValue(0, 0, "111");
activeSheet.unbindAll(); //取消监视所有事件
activeSheet.setValue(1, 0, "222");
activeSheet.setValue(2, 0, "333");
activeSheet.setValue(3, 0, "444");

返回值

void

ungroupSparkline

▸ ungroupSparkline(group): void

取消对指定组中的迷你图进行分组

代码示例

//本示例使用ungroupSparkline方法
activeSheet.setValue(0, 0, "Data Range is A2-A9");
activeSheet.setValue(1, 0, 1);
activeSheet.setValue(2, 0, -2);
activeSheet.setValue(3, 0, -1);
activeSheet.setValue(4, 0, 6);
activeSheet.setValue(5, 0, 4);
activeSheet.setValue(6, 0, -4);
activeSheet.setValue(7, 0, 3);
activeSheet.setValue(8, 0, 8);
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
var s1=  activeSheet.setSparkline(11, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
var s2 =activeSheet.setSparkline(11, 3, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.column, setting);
var s3=  activeSheet.setSparkline(11, 6, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.winloss, setting);
var group = activeSheet.groupSparkline([s1,s2,s3]);
//activeSheet.ungroupSparkline(group);

参数

属性名	类型	说明
`group`	`SparklineGroup`	迷你图组

返回值

void

unprotect

▸ unprotect(password?): boolean

解除表单的密码保护

代码示例

let password = "fe4c4be8"
sheet.protect(password);
sheet.unprotect(password);

参数

属性名	类型	说明
`password?`	`string`	密码

返回值

boolean

密码正确或者isProect为false时，会返回True，否则返回False

visible

▸ visible(value?): any

设置是否显示表单

代码示例

activeSheet.visible(false);

参数

属性名	类型
`value?`	`boolean` \| `SheetTabVisible`

返回值

any

如果在不带参数的情况下调用此函数，则它将返回一个布尔值，表示该表单是否可见否则，它将返回当前表单对象

zoom

▸ zoom(factor?): any

获取或设置表单的缩放比例

代码示例

//本示例缩放表单
spread.options.allowUserZoom = false;
sheet.zoom(3);

参数

属性名	类型
`factor?`	`number`

返回值

any

如果未设置任何值，则返回缩放比例；否则，返回表单

GC.Spread.Sheets.Worksheet

类: Worksheet

继承关系

Table of contents

构造方法

属性

方法

构造方法

constructor

参数

属性

autoGenerateColumns

cellStates

charts

columnOutlines

comments

conditionalFormats

defaults

floatingObjects

options

outlineColumn

pictures

pivotTables

rowOutlines

shapes

slicers

tables

方法

addColumns

参数

返回值

addCustomFunction

参数

返回值

addCustomName

参数

返回值

addNamedStyle

参数

返回值

addRows

参数

返回值

addSelection

参数

返回值

addSpan

参数

返回值

addSpans

参数

返回值

autoFitColumn

参数

返回值

autoFitRow

参数

返回值

autoMerge

参数

返回值

bind

参数

返回值

bindColumn

参数

返回值

bindColumns

参数

返回值

clear

参数

返回值

clearCustomFunctions

返回值

clearCustomNames

返回值

clearPendingChanges

参数

返回值