在线Excel  ->  APIs

APIs


关键词: APIs

SheetAPI类提供了对工作表的API访问,这个类不是直接实例化的,而是将openFileByOnlyLoadDataFlag选项传递给该类。

SheetAPI用法示例


    SHEET_API = Ext.create('EnterpriseSheet.api.SheetAPI', {
        openFileByOnlyLoadDataFlag: true
    });
    SHEET_API_HD = SHEET_API.createSheetApp({
        renderTo: 'sheet-markup',
        height: '100%'
    });

    SHEET_API.loadData(SHEET_API_HD, {
        fileName: 'Example Sheet',
        sheets: [{
            name: 'First tab',
            id: 1
        }],
        cells: [{
            sheet: 1,
            row: 1,
            col: 1,
            json: {data: 110}
        }]
    });
    

上面代码做了以下三件事:

当页面准备好并加载了所有JavaScript并成功呈现工作表时, 将初始相关数据加载到此工作表中。在本例中,一个文件名为“Example Sheet”的文件被创建,该文件包含一个工作表“First工作表”,工作表“First工作表”中的单元格A1为 数字110。


配置选项


openFileByOnlyLoadDataFlag : Boolean

如果为真,则只加载数据,不刷新url。

可用版本号: 3.0.0


方法




addCalculates( calculates )

此方法用于添加自定义的计算操,它允许你定义你的计算。 这些计算将被传递到工作表计算系统,因此用户可以在计算单元中使用这些计算。

可用版本号: 3.0.0

点击 add Calculates method 查看详情。


addCalculateExceptions( calExceptions )

此方法用于添加自定义的计算异常。它允许您定义计算异常。 这些异常将被传递到工作表计算系统,因此当发生匹配的异常时, 单元格上会有一个红色提示,向用户显示一些异常信息。

可用版本号: 3.0.0

点击 add calculate exceptions method 查看详情。


addFilter2Span( SHEET_API_HD, span, filterCdts, persist )

此方法用于将筛选器添加到具有特定条件的选定范围列表中。

可用版本号: 3.4.0

点击 addFilter2Span method 查看详情。


addSheetTab( hd, sheetTabConfig, callback, scope, notSwitchToNewSheet )

此方法将向工作表文件添加一个新工作表Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetTabConfig : Object

添加工作表信息,Name是添加的工作表名称,它应该是唯一的。 工作表的位置是从0开始的,如果没有定义位置,将在最后一个位置添加新工作表。


    {
        name: "Sheet5",
        color: "red",
        position: 1
    }
    

callback : Function

回调函数,工作表标签被添加后,将被调用。

scope : Object

回调函数的作用域

notSwitchToNewSheet : Boolean

如果为真,则表示添加表tab后不切换到新tab。




alignSet( hd, dir )

设置选中单元格文本左对齐

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

dir : String

要对齐的内容的方向,应是下列项目之一:

        left
        middle
        right
        top
        center
        bottom
    


applyCellsBorder(hd, cood, config)

将边框样式应用于单元格。

可用版本号: 3.0.11

点击 applyCellsBorder method 查看详情。


applyTableTpl(hd, sheetId, startRow, startCol, endRow, endCol, tpl, trigger)

将表格模板应用于一系列单元格。

可用版本号: 3.0.8

点击 applyTableTpl method 查看详情。


average( hd )

这个函数用来弹出一个平均公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




bold(hd)

使选定的单元格文本加粗或取消加粗。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




cancelMergeCell( hd )

取消合并单元格的合并。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。


cancelGroup(hd, dir, start, end)

取消选定区域中的第一组。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

dir : String

方向,行或列

start : Integer

开始的行号或者列号。

end : Integer

结束的行号或者列号。


clean( hd )

清除选定范围内的所有内容和格式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




cleanContent( hd )

清除选定范围内的内容。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




cleanStyle( hd )

清除选定范围内的样式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




clearAllVariables(hd)

清除所有的变量。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。




clearCellsBorder(hd, cood)

清除选定单元格的边框。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

coord : Array

要应用边框的特定数组列表。

[[sheetId, startRow, startCol, endRow, endCol]]

定义了一个sheetId下需要清除边框样式的单元格范围。




clearCondition( hd, coord )

清除选定单元格的条件

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

coord : Array

要应用边框的特定数组列表。

[[sheetId, startRow, startCol, endRow, endCol]]

定义了一个sheetId下需要清除边框样式的单元格范围。




clearItem( hd )

清除选定单元格的内容、格式、样式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




clearTableTpl( hd, span )

清除选定单元格的表格模板。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

span : Array

要应用边框的特定数组列表。

[[sheetId, startRow, startCol, endRow, endCol]]

定义了一个sheetId下需要清除边框样式的单元格范围。




count( hd )

这个函数用来弹出一个计数公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




createSheetApp( config ) : Object

根据给定的配置创建一个SheetApp。

可用版本号: 3.0.0

点击 createSheetApp method 查看详情。


createNamedRange( hd, nameRangeObj )

基于指定的命名范围对象创建新的命名范围。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

nameRangeObj : object

名称范围对象,格式如:
    {
        name: 'TTTT',
        rangeOfAddress: "'Sheet1'!$A$1:$A$2",
        comment: "This is test",
        scopeSheetId: 1235
    }
    

如果范围scopeSheetId未设置,则默认为整个文档级别。

返回

Object

    {result: true}
    OR
    {msg: "name already in use", result: false, errorcode: 3}

    For errorcode:
    1 - name is already used in formula
    2 - name is not valid, only accept a-zA-Z_
    3 - range name already in used
    


commaFormat( hd )

对选定单元格应用逗号格式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




copy(hd)

复制选中的单元格

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




copySheetTab( hd, sheetTabId, newName, callback, scope )

此方法将复制现有的工作表并创建一个新工作表Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetTabId : Integer

被复制的工作表id。

newName : String

新工作表的名称。

callback : Function

工作表添加后的回调函数。

scope : Object

回调函数的作用域参数。




createSheetWin( sheetConfig, winConfig ) : Object

创建包含工作表应用程序的窗口实例并返回句柄信息。

可用版本号: 3.0.0

点击 createSheetWin method 查看详情。


currencyFormat( hd, currencyName, decimalNo, negativeFormat, showName )

将货币格式添加到选定范围。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

currencyName : String

货币的名称。如:“美元”、“人民币”、“欧元”等。

	usd --  'money_us_dollar'
	rmb --  'money_china_rmb'
	eur --  'money_european_euro'
	all --  'money_albania'
	afn --  'money_afghan'
	ars --  'money_argentina_peso'
	aud --  'money_australian_dollar'
	bob --  'money_bolivia'
	brl --  'money_brazil_real'
	bgn --  'money_bulgaria'
	cad --  'money_canada_dollar'
	clp --  'money_chile_peso'
	cop --  'money_columbia_peso'
	cup --  'money_cuba'
	czk --  'money_czech'
	dkk --  'money_denmark_krone'
	egp --  'money_egypt'
	hkd --  'money_hongkong'
	huf --  'money_hungary'
	isk --  'money_iceland'
	irr --  'money_iran'
	inr --  'money_indian_rupee'
	idr --  'money_indonsia_rupiah'
	ils --  'money_israel_shekel'
	jmd --  'money_jamaica'
	jpy --  'money_japanese_yen'
	kzt --  'money_kazakhstan'
	won --  'money_korean_won'
	lbp --  'money_lebanon'
	ltl --  'money_lithuania'
	myr --  'money_malaysia'
	mxn --  'money_mexico'
	nzd --  'money_newzealand'
	ngn --  'money_nigeria'
	nok --  'money_norway'
	pkr --  'money_pakistan'
	pln --  'money_poland'
	ron --  'money_romania'
	rub --  'money_russian_rouble'
	sar --  'money_saudi'
	sgd --  'money_sigapore'
	zar --  'money_southAf_rand'
	sek --  'money_sweden'
	chf --  'money_swit_franc'
	twd --  'money_taiwan_yen'
	thb --  'money_thailand'
	try --  'money_turky_lira'
	uah --  'money_ukraine'
	gbp --  'money_english_pound'
	vnd --  'money_viet'
	zwd --  'money_zimbabwe'

decimalNo : Integer

小数点后保留小数点后的数字。默认值是2。格式是这样的:$23.56。

negativeFormat : String

选择将显示负数的格式之一,默认值是:none。

    negative1  --  -$1,234.00
    negative2  --  $1,234.00
    negative3  --  -$1,234.00

showName : boolean

是使用货币名称还是是货币符号, 默认是假的。




currencyFormatWin( hd, currencyName )

弹出货币格式选择窗口。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

currencyName : String

货币的名称。如:“美元”、“人民币”、“欧元”等。




cut( hd )

剪贴所选单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




dateFormat( hd, format )

日期格式。

可用版本号: 4.0.0

Parameters 参数

hd : object

您创建的工作表应用程序的句柄信息。

format : String

日期的格式。

    'Y-m-d'
    'd-m-Y'
    'F d, Y'
    'M d, Y'
    'm/d/Y'
    'y-m-d'
    'd-m-y'
    'd-M-y'
    'l, M d, Y'



dateTimeFormat( hd, format )

日期时间格式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

format : String

日期时间的格式。

    'Y-m-d H:i:s'
    'Y-m-d H:i'
    'Y-m-d g:i:s A'
    'Y-m-d g:i A'
    'Y-m-d G:i:s A'



desFontSize( hd )

减少选定的单元格文本大小

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




deleteCommentForCoord( hd, coord, suspendEvent, suspendRefresh )

删除传递的坐标数组中的注释。

可用版本号: 3.1.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

coord : Array

要删除注释的坐标数组,例如: [1, 2, 2, 4, 4] 含义如 [sheetId, x1, y1, x2, y2]。

suspendEvent : boolean

是否阻止触发更新事件。

suspendRefresh : boolean

是否阻止刷新。

Example: SHEET_API.deleteCommentForCoord(SHEET_API_HD, [1, 2, 2, 4, 4]);


deleteNamedRangeByName( hd, name )

此方法将按名称删除命名范围。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

name : String

需要删除的命名范围的名称。

返回

True 或者 False




deletePageBreak( hd )

此方法将删除焦点处的分页符。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




deleteRepeat( hd )

此方法将删除选定范围内的重复项。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




deleteSheetTab( hd, sheetTabId, callback, scope )

此方法将删除工作表数据Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetTabId : Integer

需要数据的工作表的id

callback : Function

数据删除后的回调函数

scope : Object

回调函数的作用域参数。




fillBackgroundColor(hd, color)

设置选定的单元格背景颜色

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

color : String

需要设置的颜色,例如: '#FF00FF'。




filter( hd )

向选定的单元格范围添加筛选器。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




fontColor(hd, fontColor)

设置选定单元格的文本颜色

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

fontColor : String

需要设置的颜色,例如: '#FF00FF'。




fontFamily(hd, fontfamily)

设置选定的单元格文本字体

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

fontfamily : String

需要设置的字体: 'Arial'

p>


fontSize(hd, fontSize)

设置选定的单元格的文本大小

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

fontSize : Integer

需要设置的大小,例如: 12




freezeSheet( hd, row, column )

此方法用于冻结表中的行和列。

可用版本号: 3.0.8

参数

hd : object

您创建的工作表应用程序的句柄信息。

row : Integer

冻结开始的行,整数 number >= 0.

column : Integer

冻结开始的列,整数 number >= 0.




getAllChanges( hd )

用于获取历史上的所有变化,返回一个对象列表。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

Array

格式如下的数据对象列表:

    [{
        text: "Input "1" at C5"
    }]
    


getAllDefinedNamedRangeNames( hd )

获取所有的命名范围的名称。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

Array

格式如下的数据对象列表:

[{
    id: id,
    name: name,
    scopeSheetId: null, // null or 1230 -- sheetId
    rangeOfAddress: 'Sheet1'!$A$1:$A$2,
    comment: jsonIt.comment
}]


getCell( hd, sheetId, rowIndex, colIndex )

获取指定单元格的json数据。

可用版本号: 3.0.0

点击 getCell method 查看详情。


getCellValue( hd, sheetId, rowIndex, colIndex )

此方法用于获取特定的单元格json数据,与getCell相同,但不返回单元格格式。

可用版本号: 3.0.12

点击 getCell method 查看详情。


getCellsComment( hd, sheetId )

获取文件中的所有单元格注释。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : integer

需要获取所有单元格注释的工作表的id,如果没有指定,默认为当前的活动工作表。

返回

Array

格式如下的数据对象列表:

[{sheetId: 1, x: 2, y: 2, comment: "great work"}, {sheetId: 1, x: 2, y: 3, comment: "test", data: "cell data"}]
.

getCellsByAddress( hd, address )

根据地址值获取单元格对象。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

address : String

单元格地址,例如:'Sheet1'!$A$1:$A$2

返回

Array

格式如下的数据对象列表:

[{sheetId: 1, row: 2, col: 2, val: "great work"}]
.

getCellVariables( hd )

获取文件中的所有单元格变量。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

Object

格式如下的数据对象列表:

{'company_name':'ABC Company', 'address':'1 infinity loop'}



getDefinedNameContent( hd, definedName )

获取文件中名称范围的已定义内容。

可用版本号: 3.2.0

点击 getDefinedNameContent method 查看详情。


getDefinedNamedRange( hd, name )

获取名称的范围对象。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

name : String

名称范围对象的名称

返回

Object

格式如下的数据:

    {
        name: "name", // Name of named range;
        rangeOfAddress: "'Sheet1'!$A$1:$A$2",
        comment: "This is test", // Comment of named range; if it is null, return undefined
        scopeSheetId: 1230, // Scope of named range;  if it is null, this means in the whole document level.
        // otherwise, it return the specific sheet range with sheetId
        cells: cells  // Set of cells belonging to the named range.
    }
    
.

getSelectedRangeData( hd )

获取选定的单元格范围的数据值。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

Array

格式如下的数据:

[{row: 2, col: 2, val: 100}, {row: 2, col: 3, val: "test"}]
.

getFilename( hd )

获取文件名。

可用版本号: 3.0.8

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

String

当前文件的文件名




getItemValueByName( hd, name )

通过名称获取项目(单选或复选框)的值。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

name : String

已定义的单选或复选框名称。

返回

String

项目(单选或复选框)的值




getJsonData( hd, compress ) : Object

获取工作表的json数据

可用版本号: 3.0.0

点击 getJsonData method 查看详情。


getSheetTabData( hd ) : Object

获取工作表的数据Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

返回

Object

数据格式如下:


    [{
       id: 1,
       name: 'sheet 1',
       color: 'red',
    }]
    


hideRow( hd, startRowNumber, endRowNumber, sheetId )

隐藏指定工作表下的指定行。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

startRowNumber : Integer

开始行号。

endRowNumber : Integer

结束行号。

sheetId : String

工作表的id,如果未指定,默认未当前活动工作表




hideColumn( hd, startColNumber, endColNumber, sheetId )

隐藏指定工作表下的指定列。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

startColNumber : Integer

开始列号

endColNumber : Integer

结束列号。

sheetId : String

工作表的id,如果未指定,默认未当前活动工作表




incFontSize( hd )

增加选定的单元格文本大小

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertDatePicker( hd )

插入日历控件。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertFloatingItem( hd, sheetTabId, config, callback, scope )

将浮动项插入到现有的工作表选项卡。目前支持以下浮动项:wedgit、图表和图像。

可用版本号: 3.0.0

点击 insertFloatingItem method 查看详情。


insertBackgroundImage( hd )

插入背景图片。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertComment( hd, scope )

插入注释。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

scope : Object

作用域参数。




insertColumn( hd, sheetId, column, colSpan )

在指定的工作表插入列。

可用版本号: 3.0.10

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : String

工作表的id。

column : Integer

插入新列的位置,整数>= 0,这一列将向右移动。

colSpan : Integer

可选,要插入的列数,整数>= 1,默认值为1。




insertPageBreak( hd )

在焦点处插入分页符。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertHyperlink( hd, scope )

插入链接地址。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

scope : Object

作用域参数。




insertRadio( hd )

插入单选控件。

可用版本号: 3.0.10

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertRow( hd, sheetId, row, rowSpan )

在指定的工作表插入行。

可用版本号: 3.0.10

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : String

工作表的id。

row : Integer

插入新行的位置,整数>= 0,这一列将向下移动。

rowSpan : Integer

可选,要插入的行数,整数>= 1,默认值为1。




insertFormula( hd )

插入公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertCheckbox( hd )

插入复选框控件。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




insertDropList( hd, scope )

插入下拉列表控件。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

scope : Object

回调函数的作用域参数。




isMergedCell( hd, sheetId, row, col )

判断单元格是否是合并单元格。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : String

工作表的id。

row : Integer

单元格的行号。

col : Integer

单元格的列号。




italic(hd)

使选定的单元格文本变为斜体或非斜体。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




loadData( hd, json, callback, scope )

将Json数据加载到传递的工作表应用程序中。

可用版本号: 3.0.0

点击 loadData method 查看详情。


loadTabData( hd, json, callback, scope )

将工作表Json数据加载到传递的工作表应用程序中。

可用版本号: 3.1.0

点击 loadTabData method 查看详情。


loadMoreData( hd, json, callback, scope )

加载更多数据到文件中,在加载大数据的时候和 loadData method 一起使用来提高性能。

可用版本号: 3.0.8

点击 loadMoreData method 查看详情。


loadFile( hd, fileId, callback, scope )

将文件加载到传递的工作表应用程序中。

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

fileId : String

文件的id。

callback : Function

数据加载完成后的回调函数。

scope : Object

回调函数的作用域参数。




loadRowsData( hd, sheetId, startRow, endRow, callback, scope )

加载行数据到传递的工作表应用程序中。

可用版本号: 3.3.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : String

工作表的id。

startRow : Integer

加载数据的开始行。

endRow : Integer

加载数据的结束行。

callback : Function

数据加载完成后的回调函数。

scope : Object

回调函数的作用域参数。




max( hd )

插入获取最大值公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




min( hd )

插入获取最小值公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




mergeCell( hd )

合并单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




mergeCellInColumn( hd )

按照列合并单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




mergeCellInRow( hd )

按照行合并单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




mergeCellForSpan( hd, span, suspendEvent, suspendRefresh )

合并选中范围内的单元格。

可用版本号: 3.1.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

span : Array

选中的范围,例如:[sheetId, minrow, mincol, maxrow, maxcol]

suspendEvent : boolean

是否阻止数据更新。

suspendRefresh : boolean

是否阻止刷新。

Example: SHEET_API.mergeCellForSpan(SHEET_API_HD, [1, 2, 2, 4, 4]);


moveDecimalPoint( hd, number )

小数点左移或右移

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

number : Integer

移动的位数。




nameRange( hd )

插入名称范围。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




paste( hd )

粘贴数据到单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




percentFormat( hd, format )

应用百分数格式到单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

format : String

格式,默认:'0.00%'。




purgeChangeList( hd, step )

清除历史纪录。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

step : Integer

一次的操作数,1 - 20,默认:1

Example: SHEET_API.purgeChangeList(SHEET_API_HD, 5);


redo( hd )

重做一步已撤消的操作。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




redoChange( hd, step )

重做历史记录中的操作。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

step : Integer

一次的操作数,1 - 20,默认:1

Example: SHEET_API.redoChange(SHEET_API_HD, 5);


removeFilter( hd, sheetId, persist )

删除过滤器。

可用版本号: 3.4.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetId : Integer

工作表的id。

persist: true or false.

是否永久,如果true,操作将会发送给后台进行永久性操作,如果false,只是在界面做此操作,不进行后台操作。

Example: SHEET_API.removeFilter(SHEET_API_HD, SHEET_API_HD.sheet.getSheetId(), true);


resetHistory( hd )

重置已处理操作的所有历史记录。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




rotateText( hd, angle )

设置所选单元格文本以特定角度旋转。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

angle : Integer

旋转的角度,下列数据之一:45, 90, 270, 315。




saveData( hd, callback, scope )

将当前工作表保存到后端,如果未在后端创建此工作表,它将弹出一个窗口询问输入文件名,否则将所有数据保存到后端。

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

callback : Function

数据保存成功后的回调函数。

scope : Object

回调函数的作用域参数。




scienceFormat( hd )

将科学计数法格式应用到单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




setRangeBorder( hd, dir, color, width, style, suspendRefresh )

设置选择范围的边框。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

dir : String

边框的方向,默认是null,这意味着所有。可以是以下其中一种:

    top
    bottom
    left
    right
    topbottom
    outside
    all

color : String

边框的颜色。

width : Integer

边框的宽度。

style : String

边框的样式,例如:solid, double, dotted, dashed。

suspendRefresh : Boolean

是否阻止刷新。


    SHEET_API.setRangeBorder(SHEET_API_HD, 'all', 'black', 1, 'solid', false);
    SHEET_API.setRangeBorder(SHEET_API_HD);
    


setReadOnly( hd, readonly )

设置文件只读或者非只读。

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

readonly : boolean

是否只读。




setValueToVariable( hd, variableValues )

将值赋给变量。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

variableValues : Object

指定值的变量列表。使用list.*(DOT)设置内嵌变量。如:

{
        'company_name': 'Apple Inc.',
        'street_address': '1 Infinite Loop',
        'city_state_zip': 'Cupertino, CA 95014',
        'city_state_zip': 'Cupertino, CA 95014',
        'phone': '1 800-692-7753',
        'bill_to_name': 'John Doe',
        'bill_to_company_name': 'ABC Company',
        'bill_to_phone': '1 613 2222 222',
        'bill_to_email': 'info@abc.com',
        'invoice_no': '20150515001',
        'list.description': ['Service Fee', 'Labor: 5 hours @ $75/hr', 'Tax(10%)'],
        'list.amount': [200.00, 375.00, 57.50]
}



setCondition( hd, coord, cdtName, config )

向现有文件添加条件。

可用版本号: 3.0.11

点击 setCondition method 查看详情。


setFocus( hd, row, column )

设置焦点在现有文件的特定行和列上。

可用版本号: 3.1.1

参数

hd : object

您创建的工作表应用程序的句柄信息。

row : Integer

行号。

column : Integer

列号。




setMaxColNumber( maxCol )

设置工作表的最大列号。

可用版本号: 3.1.2

参数

maxCol : Integer

最大的列号。




setMaxRowNumber( maxRow )

设置工作表的最大行号。

可用版本号: 3.1.2

参数

maxRow : Integer

最大的行号。




showSidebarBtnWin( hd, btn, callback, scope )

根据按钮名称显示相应的侧边菜单栏窗口。

可用版本号: 3.0.8

参数

hd : object

您创建的工作表应用程序的句柄信息。

btn : String

按钮名称,必须是下列值之一:

    chart
    cellStyle
    tableStyle
    search
    picture
    widget
    condition

callback : Function

操作完成后的回调函数。

scope : Object

回调函数的作用域参数。




showValidation( hd )

显示验证信息。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




showRow( hd, startRowNumber, endRowNumber, sheetId )

显示相关工作表的行。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

startRowNumber : Integer

开始的行号。

endRowNumber : Integer

结束的行号。

sheetId : String

工作表的id,如果未指定,默认未当前活动工作表




showColumn( hd, startColNumber, endColNumber, sheetId )

显示相关工作表的列。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

startColNumber : Integer

开始的列号。

endColNumber : Integer

结束的列号。

sheetId : String

工作表的id,如果未指定,默认未当前活动工作表




sortCellByAsc( hd, span )

对选定的单元格按照升序排序。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

span : Array

选定的单元格,格式如下:

[sheetId, startRow, startCol, endRow, endCol]



sortCellByDesc( hd, span )

对选定的单元格按照降序排序。

可用版本号: 3.0.12

参数

hd : object

您创建的工作表应用程序的句柄信息。

span : Array

选定的单元格,格式如下:

[sheetId, startRow, startCol, endRow, endCol]



strikeline(hd)

设置选定单元格的文本成为条纹状或非条纹状

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




sum( hd )

插入求和公式。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




timeFormat( hd, format )

应用时间格式到单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

format : String

时间格式,如下:

    'H:i:s'
    'H:i'
    'g:i:s A'
    'g:i A'
    'G:i:s A'



toggleColumn( hd )

隐藏或显示列标题名称(切换)。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




toggleRow( hd )

隐藏或显示行名称(切换)。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




toggleEditable( hd )

隐藏或显示选定范围上的可编辑单元格。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




toggleFreeze( hd )

隐藏或显示选定范围上的冻结单元格。

可用版本号: 3.0.8

参数

hd : object

您创建的工作表应用程序的句柄信息。




toggleGridLine( hd, hideGridline, sheetId )

隐藏或显示网格线Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

hideGridline : Boolean

是否隐藏表格线。

sheetId : Integer

工作表的id,如果未指定,默认未当前活动工作表。




toggleSplit( hd )

隐藏或显示选定范围上的分割。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




toggleTitleBar( hd, visible )

隐藏或显示标题栏。

可用版本号: 3.3.1

参数

hd : object

您创建的工作表应用程序的句柄信息。

visible : Boolean

是否显示标题栏。

SHEET_API.toggleTitleBar(SHEET_API_HD, false);


toggleToolBar( hd, visible )

隐藏或显示工具栏。

可用版本号: 3.3.1

参数

hd : object

您创建的工作表应用程序的句柄信息。

visible : Boolean

是否显示工具栏。

SHEET_API.toggleToolBar(SHEET_API_HD, false);


undo( hd )

撤销操作。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




underline(hd)

设置文本下划线。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




updateCells( hd, cellObjs, callback, scope )

更新多个单元格。

可用版本号: 3.0.0

点击 updateCells method 查看详情。


updateFloatings( hd, cellObjs, callback, scope )

更新多个浮动元素(例如合并单元格、图表)。

可用版本号: 3.1.2

点击 updateFloatings method 查看详情。


updateGroups( hd, groupObjs )

更新多个组。

可用版本号: 3.0.11

参数

hd : object

您创建的工作表应用程序的句柄信息。

groupObjs : array

需要更新的组信息。

[{
    dir: 'row',
    start: 2,
    end: 5
}, {
    dir: 'row',
    start: 3,
    end: 5
}, {
    dir: 'col',
    start: 2,
    end: 5
}, {
    dir: 'col',
    start: 2,
    end: 4
}]
    



updateSheetTab( hd, sheetTabConfig, callback, scope, notSwitchToNewSheet )

更新工作表信息Example code

可用版本号: 3.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

sheetTabConfig : Object

更新工作表信,Name是更新工作表名称,它应该是唯一的,Position是更新工作表位置, sheetId是所需的更新工作表id,如果忽略它,默认是当前活动的工作表。

{
	name: 'Market',
	color: 'darkblue',
	sheetId: 0,
	position: 0
}

callback : Function

操作执行完成后的回调函数。

scope : Object

回调函数的作用域参数。

notSwitchToNewSheet : Boolean

是否将新的工作表切换成当前活动的工作表。




wordWrap( hd )

设置文本换行。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。




zoom( hd, size )

根据给定的尺寸,缩放选定的工作表。

可用版本号: 4.0.0

参数

hd : object

您创建的工作表应用程序的句柄信息。

size : Integer

缩放的尺寸,例如:2, 1, 0.5, 0.25。