AnnoAPI

AnnoAPI

当前 AnnoAPI 对象

• 语法

  表达式.ActivePDF.AnnoAPI

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    // 当前 AnnoAPI 对象
    const AnnoAPI = await app.ActivePDF.AnnoAPI;
  }
  

方法

AnnoAPI.SelectAnno()

通过SelectAnno()方法，您可以选中批注。

• 语法

  表达式.AnnoAPI.SelectAnno({PageIndex, Id})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  PageIndex	Number	是	批注所在的页码（从1开始）
  ID	String	是	批住ID

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 选中注解
    await app.ActivePDF.AnnoAPI.SelectAnno({PageIndex:1, Id: '{8c3300cf-ec08-4350-aab3-2f42c480d92e}'});
  }
  

AnnoAPI.ClearAnnoSelection()

通过ClearAnnoSelection()方法，您可以取消批注选中。

• 语法

  表达式.AnnoAPI.ClearAnnoSelection()

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

• 示例

  async function example() {
    await instance.ready();
    const app = instance.Application;
    // 取消批注选中
    await app.ActivePDF.AnnoAPI.ClearAnnoSelection();
  }
  

AnnoAPI.GetAnnoSelection()

通过GetAnnoSelection()方法，您可以获取选中批注。

• 语法

  表达式.AnnoAPI.GetAnnoSelection()

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

• 返回值

  属性	数据类型	描述

  属性	数据类型	描述
  result	Array	数组包裹返回注解对象Object

• result 结构中注解对象Object

  属性	数据类型	描述

  属性	数据类型	描述
  type	String	批注类型
  id	String	批注ID
  pageIndex	Number	批注所在正文页码,以0起始
  rect	Object	批注位置信息

• 示例

  async function example() {
    await instance.ready();
    const app = instance.Application;
    // 获取选中批注
    await app.ActivePDF.AnnoAPI.GetAnnoSelection();
  }
  

AnnoAPI.CopyAnnoSelection()

通过CopyAnnoSelection()方法，您可以获取选中批注。

• 语法

  表达式.AnnoAPI.CopyAnnoSelection()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 复制选中的批注文案
    await app.ActivePDF.AnnoAPI.CopyAnnoSelection();
  
  }

AnnoAPI.SetSelectionAnno()

通过SetSelectionAnno()方法，您可以设置选区为注释（高亮、删除线、下划线）。

• 语法

  表达式.AnnoAPI.SetSelectionAnno({type, color})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  type	Enum	是	注释类型，详细可参考Enum.AnnoType
  color	String	否	rgb或者rgba格式

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置选区为高亮
    await app.ActivePDF.AnnoAPI.SetSelectionAnno({type: app.Enum.AnnoType.Highlight, color: 'rgba(14,14,14,1)'});
  
  }

AnnoAPI.SetAnnoMode()

通过SetAnnoMode()方法，您可以设置注释模式（高亮、删除线、下划线）。

• 语法

  表达式.AnnoAPI.SetAnnoMode({type, color})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  type	Enum	是	注释类型，详细可参考Enum.AnnoType
  color	String	否	rgb或者rgba格式

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置高亮模式
    await app.ActivePDF.AnnoAPI.SetAnnoMode({type: app.Enum.AnnoType.Highlight, color: 'rgba(14,14,14,1)'});
  
  }

AnnoAPI.ExitAnnoMode()

通过ExitAnnoMode()方法，您可以退出注释模式（高亮、删除线、下划线）。

• 语法

  表达式.AnnoAPI.ExitAnnoMode()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 退出注释模式
    await app.ActivePDF.AnnoAPI.ExitAnnoMode();
  
  }

AnnoAPI.SwitchEraser()

通过SwitchEraser()方法，您可以设置、退出橡皮擦模式。

• 语法

  表达式.AnnoAPI.SwitchEraser({IsEraser})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  IsEraser	Boolean	否	是否设置为橡皮擦模式。true为设置,false为退出

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置橡皮擦模式
    await app.ActivePDF.AnnoAPI.SwitchEraser({IsEraser: true});
  
    // 退出橡皮擦模式
    await app.ActivePDF.AnnoAPI.SwitchEraser({IsEraser: false});
  
  }

AnnoAPI.AddTextAnnoComment()

通过AddTextAnnoComment()方法，您可以注解增加评论。

• 语法

  表达式.AnnoAPI.AddTextAnnoComment({PageIndex, Id, Comment})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  PageIndex	Number	是	批注所在页面页码，页码从1开始
  Id	String	是	注解id
  Comment	String	是	评论

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 对注解添加一条评论
    await app.ActivePDF.AnnoAPI.AddTextAnnoComment({PageIndex: 1, Id: '{8c3300cf-ec08-4350-aab3-2f42c480d92e}', Comment: '11111'});
  
  }

AnnoAPI.SetAnnoStyleBySelection()

通过SetAnnoStyleBySelection()方法，您可以设置选中的批注样式-针对注解。

• 语法

  表达式.AnnoAPI.SetAnnoStyleBySelection({Style})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  Style	Enum	是	注解气泡类型，详细可参考Enum.TextStyle

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置注解气泡的样式为评论图标样式
    await app.ActivePDF.AnnoAPI.SetAnnoStyleBySelection({Style: app.Enum.TextStyle.Comment});
  
  }

AnnoAPI.SetAnnoLineWidthBySelection()

通过SetAnnoLineWidthBySelection()方法，您可以设置选中的批注线宽-画笔（水彩笔、智能画笔）起效。

• 语法

  表达式.AnnoAPI.SetAnnoLineWidthBySelection({Width})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  Width	Number	是	线宽，限制[1-12]

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置选中的画笔的线宽为10
    await app.ActivePDF.AnnoAPI.SetAnnoLineWidthBySelection({Width: 10});
  
  }

AnnoAPI.SetAnnoColorBySelection()

通过SetAnnoColorBySelection()方法，您可以设置选中的批注线宽-画笔（水彩笔、智能画笔）起效。

• 语法

  表达式.AnnoAPI.SetAnnoColorBySelection({Color})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  Color	String	是	rgb或者rgba格式

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置选中的批注颜色
    await app.ActivePDF.AnnoAPI.SetAnnoColorBySelection({Color: 'rgba(14,14,14,1)'});
  
  }

AnnoAPI.SetInkMode()

通过SetInkMode()方法，您可以设置画笔模式。

• 语法

  表达式.AnnoAPI.SetInkMode({type, lineWidth, color})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  type	Enum	是	画笔类型
  lineWidth	Number	否	线宽，限制[0.5-12]
  Color	String	否	颜色

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 设置为钢笔模式，线宽为6，颜色为rgba(189,16,224,1)
    await app.ActivePDF.AnnoAPI.SetInkMode({type: app.Enum.InkType.Handwriting, lineWidth: 6,color:'rgba(189,16,224,1)'});
  
  }

AnnoAPI.ExitInkMode()

通过ExitInkMode()方法，您可以退出画笔模式。

• 语法

  表达式.AnnoAPI.ExitInkMode()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 退出画笔模式
    await app.ActivePDF.AnnoAPI.ExitInkMode();
  
  }

AnnoAPI.AddTextData()

通过AddTextData()方法，您可以新增注解气泡。

• 语法

  表达式.AnnoAPI.AddTextData({x, y, content, color, style})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  x	Number	是	x坐标(clientX)
  y	Number	是	y坐标(clientY)
  content	String	是	内容文本
  color	String	否	颜色，rgba格式
  Style	Enum	否	注解气泡类型，详细可参考Enum.TextStyle

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 新增注解气泡
    await app.ActivePDF.AnnoAPI.AddTextData({x: 600, y: 400, content: '11111', color: 'rgba(14,14,14,1)', style: app.Enum.TextStyle.Comment});
  
  }

AnnoAPI.InsertAnnoPic()

通过InsertAnnoPic()方法，您可以插入批注图（图章）。

• 语法

  表达式.AnnoAPI.InsertAnnoPic({dataUrl, width, height, x, y})

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

• 参数

  属性	数据类型	是否必填	描述

  属性	数据类型	是否必填	描述
  dataUrl	String	是	图片base64字符串
  width	Number	是	宽度
  height	Number	是	高度
  x	Number	是	x坐标(clientX)
  y	Number	是	y坐标(clientY)

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    const dataUrl = 'base64'; // base64图片字符串
    
    // 插入批注图(图章)
    await app.ActivePDF.AnnoAPI.InsertAnnoPic({dataUrl: dataUrl, width: 543, height: 277, x: 600, y: 400}); 
  
  }