选区（selection）

选区说明

获取选区的区域范围。

如果没有指定范围，则返回当前选区的范围；

如果指定了范围，则返回指定范围的选区；

如果选区不存在，则返回 null。

方法列表

方法	说明
getRange()	获取一个选区或指定区域
setRange()	选中指定的区域
addRoangeListener()	添加选区变化监听器
getWholeRange()	获取全部区域

getRange()

获取一个选区或指定区域。

语法

pdf.selection.getRange(value?)

参数

参数	类型	必填	说明
value	object	否	可选参数，包含 start 和 end 的对象，用于指定选区的起始和结束位置。若不传入此参数，默认获取当前页面中的选区范围。
start	string	否	区域开始位置的编码字符串，表示选中内容的起始位置。若不传入，默认获取当前选区的起始位置。
end	string	否	区域结束位置的编码字符串，表示选中内容的结束位置。若不传入，默认获取当前选区的结束位置。

使用示例

function async example() {

  const pdf = await sdk.connect();
  
  //获取选区
  const range = await pdf.selection.getRange();
  
  //获取指定区域
  const newRange = await pdf.selection.getRange({ start: 'JshJDFF', end: 'SJfdHsdGf' })

}

setRange()

选中指定的区域。

语法

pdf.selection.setRange(value?)

参数

参数	类型	必填	说明
range	object	是	一个表示选区范围的对象，通常由 getRange 或其他方法返回。包含 start 和 end 的对象，用于指定选区的起始和结束位置。如果设置为 null，则清空选区。
start	string	是	区域开始位置的编码字符串，表示选中内容的起始位置。若不传入，默认获取当前选区的起始位置。
end	string	是	区域结束位置的编码字符串，表示选中内容的结束位置。若不传入，默认获取当前选区的结束位置。

使用示例

function async example() {

  const pdf = await sdk.connect();
  
  //获取区域
  const range = await pdf.selection.getRange({ start: 'JshJDFF', end: 'SJfdHsdGf' });
  
  //选中区域
  await pdf.selection.setRange(range);
  
  //清空选区
  await pdf.selection.setRange()

}

addRangeListener()

添加选区变化监听器，当选区发生变化时，会触发回调。

语法

pdf.selection.addRangeListener(listener: (value: PdfRangeValue | null) => void
)

使用示例

function async example() {

  const pdf = await sdk.connect();
  const listener = (range) => { console.log(range); }
  // 选区变化时触发回调 listener
  pdf.selection.addRangeListener(listener
);

}

getWholeRange()

获取全部区域。

该接口于 V1.1.3 版本启用。

语法

pdf.selection.getWholeRange(range?)

使用示例

function async example() {

  const pdf = await sdk.connect();

  //获取全部区域
  const range = await pdf.selection.getWholeRange();
}

选区说明#

方法列表#

getRange()#

setRange()#

addRangeListener()#

getWholeRange()#

选区说明

方法列表

getRange()

setRange()

addRangeListener()

getWholeRange()