文档

页面

更新时间:

本文档介绍如何获取登录操作者信息、分页和连页模式切换、目录隐藏、保存文件、导出文件的类型以及获取页面高度、获取页面宽度和页面坐标。

获取登录操作者信息

  • 语法:

    表达式.ActivePDF.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.ActivePDF.GetOperatorsInfo();
      console.log(operatorsInfo);
    }

分页和连页模式切换

  • 语法

    表达式.ActivePDF.PageMode = Number

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

    赋值Number。1为单页模式,0为多页模式。

  • 示例

    async function example() {
      await instance.ready();
      
      const app = instance.Application;
    
      //单页/多页模式切换
      app.ActivePDF.PageMode = 1;
    }

目录显示隐藏

控制目录的显示隐藏。

  • 语法

    表达式.ActivePDF.DocumentMap = Boolean

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

    赋值Boolean。true为显示目录,false为隐藏目录。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //控制目录的显示隐藏
      app.ActivePDF.DocumentMap = true;
    }

保存

保存文件的改动。

  • 语法

    表达式.ActivePDF.Save()

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

  • 返回值

    属性

    数据类型

    描述

    result

    String

    保存状态。

    size

    Number

    文件大小,单位为字节。

    version

    Number

    版本。

    保存状态说明如下表。

    保存状态

    描述

    ok

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

    nochange

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

    SavedEmptyFile

    暂不支持保存空文件。

    触发场景:内核保存完后文件为空。

    SpaceFull

    空间已满。

    QueneFull

    保存中请勿频繁操作。

    触发场景:服务端处理保存队列已满,正在排队。

    fail

    保存失败。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //保存文件的改动
      const saveResult = await app.ActivePDF.Save();
      console.log(saveResult);
    }

导出图片文件

  • 语法

    表达式.ActivePDF.ExportAsFixedFormat({ FixedFormatType })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    FixedFormatType

    Enum

    可选

    导出的文件类型,当前版本仅支持导出图片。默认值为0。

    Print

    Boolean

    可选

    是否直接打开。取值范围如下:

    • false(默认):否。

    • true:是。

    ImgFormat

    Enum

    可选

    导出图片的格式。Enum.ExportImgFormatType取值:

    • 0或ImgTypePNG(默认):PNG格式。

    • 1或ImgTypeJPG:JPG格式。

    • 2或ImgTypeBMP:BMP格式。

    • 3或ImgTypeTIF:TIF格式。

    Dpi

    Number

    可选

    图片质量。默认值96。

    Combine2LongPic

    Boolean

    可选

    是否导出长图。取值范围如下:

    • false(默认):否。

    • true:是。

    RangeType

    Enum

    可选

    导出范围。Enum.RangeType取值:

    • 0或ImgTypeAll(默认):所有页面。

    • 1或ImgTypePage:指定范围。

    • 2或ImgTypeCurrent:当前幻灯片。

    WaterMark

    Boolean

    可选

    是否含水印。取值范围如下:

    • false(默认):否。

    • true:是。

    From

    Boolean

    可选

    起始页,默认值为当前页。

    To

    Boolean

    可选

    结束页,默认值为当前页。

  • 返回值

    返回打印的URL。

    属性

    数据类型

    描述

    url

    string

    打印的URL。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //导出文件为图片
      const imgUrl = await app.ActivePDF.ExportAsFixedFormat({
        FixedFormatType: app.Enum.FixedFormatType.TypeIMG,
      });
      console.log(imgUrl);
    }

获取页面宽度

获取指定页码页面的宽度。

重要

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

  • 语法

    表达式.ActivePDF.GetPageWidth(PageIndex)

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

  • 参数

    参数

    数据类型

    是否必填

    描述

    PageIndex

    Number

    页码(索引从1开始)。

  • 返回值

    返回Number表示指定页码页面的宽度。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取指定页码页面的宽度,索引从1开始
      const pageWidth = await app.ActivePDF.GetPageWidth(1);
      console.log(pageWidth);
    }

获取页面高度

获取指定页码页面的高度。

重要

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

  • 语法

    表达式.ActivePDF.GetPageHeigh(PageIndex)

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    PageIndex

    Number

    页码(索引从1开始)。

  • 返回值

    返回Number表示指定页码页面的高度。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取指定页码页面的高度,索引从1开始
      const pageHeight = await app.ActivePDF.GetPageHeight(1);
      console.log(pageHeight);
    }

获取页面坐标

通过相对窗口页面的坐标获取原始PDF页面的坐标和页码。

  • 语法

    表达式.ActivePDF.GetPointPageInfoByWinPoint(x, y)

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    x

    Number

    相对窗口页面的x坐标。

    y

    Number

    相对窗口页面的y坐标。

  • 返回值

    Object object

    属性

    数据类型

    描述

    inContentRange

    Boolean

    传入坐标是否在PDF正文区域(值为false代表不在正文区域,此时不会有其他的属性)。

    pageIndex

    Number

    传入坐标对应原始PDF的所在页的页码。

    x

    Number

    传入坐标对应原始PDF页面的x坐标。

    y

    Number

    传入坐标对应原始PDF页面的y坐标。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //通过相对窗口的坐标,获取到对应的点在原始页面的坐标和页码
      const pointPageInfo = await app.ActivePDF.GetPointPageInfoByWinPoint(500,500);
      console.log(pointPageInfo);
    }
  • 本页导读 (1)
文档反馈