阿里云首页 智能媒体管理

页面

在使用表格文档在线协作时,您可以导出表格、获取工作表名称、切换工作表、获取登录操作者信息、监听剪切板等。

导出表格

导出整个表格

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

  • 语法

    表达式.ActiveWorkbook.ExportAsFixedFormat({ Type }

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Enum

    可选

    导出的文件类型。Enum.XlFixedFormatType取值:

    • 0或xlTypePDF:将文件导出为PDF格式。

    • 1或xlTypeXPS:将文件导出为XML Paper Specification(XPS)格式,当前版本不支持。

    • 2或xlTypeIMG:将文件导出为IMG图片。

  • 返回值

    属性

    数据类型

    描述

    url

    string

    导出后的URL。

  • 示例

    • 导出PDF

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //导出整个表格
        const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat();
        console.log(workbookPdfUrl);
      }
    • 导出图片

      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取值:

    • 0或xlTypePDF:将文件导出为PDF格式。

    • 1或xlTypeXPS:将文件导出为XML Paper Specification(XPS)格式,当前版本不支持。

    • 2或xlTypeIMG:将文件导出为IMG图片。

  • 返回值

    属性

    数据类型

    描述

    url

    string

    导出后的URL。

  • 示例

    • 导出PDF

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //导出当前工作表
        const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat();
        console.log(workbookPdfUrl);
      }
    • 导出图片

      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()

    • 表达式.Sheets(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();
      }
    • 示例二

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //切换到指定工作表
        const sheetIndex = 2; //Sheets序号,从1开始
        app.Sheets(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;
    }

保存文件

注意

支持JS-SDK 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);
    }

切换卡片视图面板

注意

支持JS-SDK V1.1.15及以上版本。

  • 语法

    表达式.ActiveWorkbook.SwitchCardView()

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

  • 参数

    传入一个布尔值,表明打开或者关闭卡片视图面板。

    属性

    数据类型

    是否必填

    描述

    Status

    Boolean

    目前仅支持打开面板。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //打开卡片视图面板
      await app.ActiveWorkbook.SwitchCardView(true);
    }