全部产品

页面

导出

导出整个表格

导出整个表格为对应的 PDF 或者 Img 图片,并获取导出后的 url。

语法:

表达式.ActiveWorkbook.ExportAsFixedFormat({ Type })

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Type

Enum

可选

导出的类型,详细可参考 Enum.XlFixedFormatType,目前仅支持导出图片和导出 PDF

返回值:

属性

数据类型

说明

url

string

导出后的 url

示例1:导出PDF

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat();
  console.log(workbookPdfUrl);
}

示例2:导出图片

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat({
    Type: app.Enum.XlFixedFormatType.xlTypeIMG,
  });
  console.log(workbookPdfUrl);
}

导出当前工作表

导出整个表格为对应的 PDF 或者 Img 图片,并获取导出后的 url。

语法:

表达式.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({ Type })

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Type

Enum

可选

导出的类型,详细可参考 Enum.XlFixedFormatType,目前仅支持导出图片和导出 PDF

返回值:

属性

数据类型

说明

url

string

导出后的 url

示例1:导出PDF

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat();
  console.log(workbookPdfUrl);
}

示例2:导出图片

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 导出整个表格
  const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({
    Type: app.Enum.XlFixedFormatType.xlTypeIMG,
  });
  console.log(workbookPdfUrl);
}

工作表名称

所有工作表名称

获取所有工作表名称。

语法:

表达式.For(Start, End, Step, Handle)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Start

Number

表格开头 Sheet 位置

End

Number

表格结束 Sheet 位置

Step

Number

每次遍历步骤

Handle

Number

回调方法

示例:

async function example() {
  await instance.ready();
  
  const app = instance.Application;

  // 获取所有工作表名称
  const Names = [];
  await app.For(
    1,
    app.Sheets.Count,
    1,
    async (Index) => {
      Names.push(await app.Sheets.Item(Index).Name);
    },
  );
  console.log(Names);
}

当前工作表名称

获取当前工作表名称。

语法:

表达式.ActiveWorkbook.ActiveSheet.Name

表达式:文档类型应用对象

返回值:

返回 String 表示对应的 Sheet 名称。

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取当前工作表名称
  const name = await app.ActiveWorkbook.ActiveSheet.Name;
  console.log(name);
}

切换工作表

切换到指定工作表

切换到指定工作表。

语法:

表达式.ActiveWorkbook.Sheets.Item(Index).Activate()

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Index

Number

第 Index 个 Sheet

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 切换到指定工作表
  const sheetIndex = 2; // Sheets 序号,从 1 开始
  app.ActiveWorkbook.Sheets.Item(sheetIndex).Activate();
}

监听工作表切换

监听工作表的切换。

语法:

表达式.Sub.Worksheet_Activate = Function

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 监听工作表的切换
  app.Sub.Worksheet_Activate = async () => {
    console.log('ActiveSheet:', await app.ActiveSheet.Name);
  };
}

获取登录操作者信息

获取当前登录操作者信息。

语法:

表达式.ActiveWorkbook.GetOperatorsInfo()

表达式:文档类型应用对象

返回值:

Object object

属性

数据类型

说明

type

String

请求类型

response

Object

用户信息列表

response结构:

属性

数据类型

说明

id

String

用户 id

avatar_url

Object

用户头像

logined

Object

用户登录状态

name

Object

用户姓名

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取当前登录操作者信息
  const operatorsInfo = await app.ActiveWorkbook.GetOperatorsInfo();
  console.log(operatorsInfo);
}

监听剪切板

监听复制操作。

语法:

表达式.Sub.Clipboard_Copy = Function

表达式:文档类型应用对象

返回值:

属性

数据类型

说明

copyId

String

剪切板 id

isRestoreFocus

Boolean

undefined

text

String

复制的内容

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取剪切板回调事件
  app.Sub.Clipboard_Copy = async (e) => {
    await console.log(e);
  }
}

缩放

窗口缩放比例。

语法:

表达式.ActiveWindow.Zoom

表达式:文档类型应用对象

返回值:

返回 Number 型的缩放比例

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 获取窗口缩放比例
  const zoom = await app.ActiveWindow.Zoom;
  console.log(zoom);

  // 操作窗口缩放比例
  app.ActiveWindow.Zoom = 10;
}

网格线

是否显示网格线。

语法:

表达式.ActiveWindow.DisplayGridlines = Boolean

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 隐藏网格线
  app.ActiveWindow.DisplayGridlines = false;
}

标题

是否显示行标题和列标题。

语法:

表达式.ActiveWindow.DisplayHeadings = Boolean

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 隐藏行标题和列标题
  app.ActiveWindow.DisplayHeadings = false;
}

保存

注意

JSSDK: v1.1.9+支持

保存文件的改动。

语法:

表达式.ActiveWorkbook.Save()

表达式:文档类型应用对象

返回值:

属性

数据类型

说明

result

String

保存状态

size

Number

文件大小,单位 byte

version

Number

版本

保存状态说明:

保存状态

说明

ok

版本保存成功,可在历史版本中查看

nochange

文档无更新,无需保存版本

SavedEmptyFile

暂不支持保存空文件 触发场景:内核保存完后文件为空

SpaceFull

空间已满

QueneFull

保存中请勿频繁操作 触发场景:服务端处理保存队列已满,正在排队

fail

保存失败

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 保存文件的改动
  const saveResult = await app.ActiveWorkbook.Save();
  console.log(saveResult);
}