Skip to content

当前 AnnoAPI 对象(AnnoAPI)

当前 AnnoAPI 对象

方法列表

方法说明
选中批注
取消批注选中
设置选区为注释(高亮、删除线、下划线)
设置注释模式(高亮、删除线、下划线)
退出注释模式(高亮、删除线、下划线)
设置、退出橡皮擦模式
注解增加评论
设置选中的批注样式-针对注解
设置选中的批注线宽-画笔(水彩笔、智能画笔)起效
设置选中的批注颜色
设置画笔模式
退出画笔模式
新增注解气泡
插入批注图(图章)

SelectAnno()

JSSDK: v1.1.19+ 支持

选中批注

语法

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

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

参数

属性数据类型默认值必填说明
PageIndex
Number
注解所在的页码(从1开始)
ID
String
注解ID

示例

js
//@file=base.pdf
async function example() {
  await instance.ready();

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

}

ClearAnnoSelection()

JSSDK: v1.1.19+ 支持

取消批注选中

语法

表达式.AnnoAPI.ClearAnnoSelection()

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

示例

js
//@file=base.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 取消批注选中
  await app.ActivePDF.AnnoAPI.ClearAnnoSelection();

}

SetSelectionAnno()

JSSDK: v1.1.19+ 支持

仅支持PC端

设置选区为注释(高亮、删除线、下划线)

语法

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

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

参数

属性数据类型默认值必填说明
type
Enum
注释类型,详细可参考 Enum.AnnoType
color
String
rgb或者rgba格式

示例

js
//@file=EnglishVersion.pdf
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)'});

}

SetAnnoMode()

JSSDK: v1.1.19+ 支持

仅支持PC端

设置注释模式(高亮、删除线、下划线)

语法

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

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

参数

属性数据类型默认值必填说明
type
Enum
注释类型,详细可参考 Enum.AnnoType
color
String
rgb或者rgba格式

示例

js
//@file=EnglishVersion.pdf
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)'});

}

ExitAnnoMode()

JSSDK: v1.1.19+ 支持

仅支持PC端

退出注释模式(高亮、删除线、下划线)

语法

表达式.AnnoAPI.ExitAnnoMode()

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

示例

js
//@file=EnglishVersion.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 退出注释模式
  await app.ActivePDF.AnnoAPI.ExitAnnoMode();

}

SwitchEraser()

JSSDK: v1.1.19+ 支持

仅支持PC端

设置、退出橡皮擦模式

语法

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

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

参数

属性数据类型默认值必填说明
IsEraser
Boolean
是否设置为橡皮擦模式。true为设置,false为退出

示例

js
//@file=EnglishVersion.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 设置橡皮擦模式
  await app.ActivePDF.AnnoAPI.SwitchEraser({IsEraser: true});

  // 退出橡皮擦模式
  await app.ActivePDF.AnnoAPI.SwitchEraser({IsEraser: false});

}

AddTextAnnoComment()

注解增加评论

语法

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

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

参数

属性数据类型默认值必填说明
PageIndex
Number
批注所在页面页码,页码从1开始
Id
String
注解id
Comment
String
评论

示例

js
//@file=EnglishVersion.pdf
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'});

}

SetAnnoStyleBySelection()

设置选中的批注样式-针对注解

语法

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

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

参数

属性数据类型默认值必填说明
Style
Enum
注解气泡类型,详细可参考 Enum.TextStyle

示例

js
//@file=base.pdf
async function example() {
  await instance.ready();

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

}

SetAnnoLineWidthBySelection()

设置选中的批注线宽-画笔(水彩笔、智能画笔)起效

语法

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

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

参数

属性数据类型默认值必填说明
Width
Number
线宽,限制[1-12]

示例

js
//@file=anno.pdf
async function example() {
  await instance.ready();

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

}

SetAnnoColorBySelection()

设置选中的批注线宽-画笔(水彩笔、智能画笔)起效

语法

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

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

参数

属性数据类型默认值必填说明
Color
String
rgb或者rgba格式

示例

js
//@file=anno.pdf
async function example() {
  await instance.ready();

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

}

SetInkMode()

JSSDK: v1.1.19+ 支持

仅支持PC端

设置画笔模式

语法

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

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

参数

属性数据类型默认值必填说明
type
Enum
画笔类型,详细可参考 Enum.InkType
lineWidth
Number
线宽 限制[0.5-12]
Color
String
颜色

示例

js
//@file=EnglishVersion.pdf
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)'});

}

ExitInkMode()

JSSDK: v1.1.19+ 支持

仅支持PC端

退出画笔模式

语法

表达式.AnnoAPI.ExitInkMode()

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

示例

js
//@file=EnglishVersion.pdf
async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 退出画笔模式
  await app.ActivePDF.AnnoAPI.ExitInkMode();

}

AddTextData()

JSSDK: v1.1.19+ 支持

新增注解气泡

语法

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

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

参数

属性数据类型默认值必填说明
x
Number
x坐标(clientX)
y
Number
y坐标(clientY)
content
String
内容文本
color
颜色,rgba格式
Style
Enum
注解气泡类型,详细可参考 Enum.TextStyle

示例

js
//@file=EnglishVersion.pdf
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});

}

InsertAnnoPic()

JSSDK: v1.1.19+ 支持

插入批注图(图章)

语法

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

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

参数

属性数据类型默认值必填说明
dataUrl
String
图片base64字符串
width
Number
宽度
height
Number
高度
x
Number
x坐标(clientX)
y
Number
y坐标(clientY)

示例

js
//@file=EnglishVersion.pdf
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}); 

}