本文介绍演示文件页面的高级接口,包含导出、获取登录操作者信息、缩放、自适应、保存、注脚信息和触发器动画。
导出
导出文件为PDF或者图片。
语法
表达式.ActivePresentation.ExportAsFixedFormat({ RangeType, FrameSlides, FixedFormatType, ImgFormat, Dpi, Combine2LongPic, From, To, WaterMark })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
RangeType
Enum
可选
幻灯片范围的类型,
Enum.PpPrintRangeType
取值:1或ppPrintAll:打印演示文稿中的所有幻灯片。
2或ppPrintSelection:打印所选幻灯片。
3或ppPrintCurrent:打印演示文稿中的当前幻灯片。
4或ppPrintSlideRange:打印若干张幻灯片。
5或ppPrintNamedSlideShow:打印命名的幻灯片 。
FrameSlides
Enum
可选
导出的幻灯片是否带边框。
Enum.MsoTriState
取值:-1或msoTrue:给导出的幻灯片加上边框。
0或msoFalse:不给导出的幻灯片加上边框。
FixedFormatType
Enum
可选
导出的文件类型,
Enum.PpFixedFormatType
取值:1或ppFixedFormatTypeXPS:XPS格式,当前版本不支持。
2或ppFixedFormatTypePDF(默认值):PDF格式。
3或ppFixedFormatTypeIMG:IMG格式。
ImgFormat
Enum
可选
导出图片的格式,当导出文件类型为图片时,可设置此参数。
Enum.PpExportImgFormatType
取值:0或ppImgTypePNG:导出PNG格式的图片。
1或ppImgTypeJPG:导出JPG格式的图片。
2或ppImgTypeBMP:导出BMP格式的图片。
3或ppImgTypeTIF:导出TIF格式的图片。
Dpi
Number
可选
导出的图片质量,当导出文件类型为图片时,可设置此参数。默认值为96。
Combine2LongPic
Boolean
可选
是否输出为长图,当导出文件类型为图片时,可设置此参数。默认值为false。
From
Number
可选
从哪一页导出到哪一页,起始。当导出文件类型为图片时,可设置此参数。默认值为0。
To
Number
可选
从哪一页导出到哪一页,结束。当导出文件类型为图片时,可设置此参数。默认值为0。
WaterMark
Boolean
可选
是否带水印。默认值为false。
返回值
返回打印的
url
。属性
数据类型
描述
url
string
打印的url。
示例
导出文件为PDF
async function example() { await instance.ready(); const app = instance.Application; //导出文件为PDF const pdfUrl = await app.ActivePresentation.ExportAsFixedFormat(); console.log(pdfUrl); }
导出文件为图片
async function example() { await instance.ready(); const app = instance.Application; //导出文件为图片 const pdfUrl = await app.ActivePresentation.ExportAsFixedFormat({ FixedFormatType: app.Enum.PpFixedFormatType.ppFixedFormatTypeIMG, From: 0, To: 1, }); console.log(pdfUrl); }
登录操作者信息
获取登录操作者信息。
语法
表达式.ActivePresentation.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.ActivePresentation.GetOperatorsInfo(); console.log(operatorsInfo); }
缩放
窗口缩放。
语法
表达式.ActiveWindow.View.Zoom
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //文档窗口对象 const activeWindow = await app.ActiveWindow; //视图对象 const view = await activeWindow.View; //获取窗口缩放比例 const result = await view.Zoom; console.log(result); //设置窗口缩放比例 view.Zoom = 66; }
自适应
对文档窗口大小进行调整后,是否缩放视图以适应文档窗口的尺寸。
语法
表达式.ActiveWindow.View.ZoomToFit = Number
表达式:文档类型应用对象
Number
依据不同值进行调整:-1
:文档窗口大小进行调整后使页面以最佳尺寸适应活动窗口。0
:对文档窗口大小进行调整后不为适应文档窗口尺寸而缩放视图。
示例
async function example() { await instance.ready(); const app = instance.Application; //文档窗口对象 const activeWindow = await app.ActiveWindow; //视图对象 const view = await activeWindow.View; //窗口自适应 view.ZoomToFit = 0; }
保存
支持JS-SDK v1.1.9及以上版本。
保存文件的改动。
语法
表达式.ActivePresentation.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.ActivePresentation.Save(); console.log(saveResult); }
注脚信息
支持JS-SDK V1.1.15及以上版本。
获取当前页或指定页的注脚信息
语法
表达式.ActivePresentation.GetSlideRemark()
表达式:文档类型应用对象
参数
传入一个数字,表明指定页的序列号。
属性
数据类型
是否必填
描述
SlideIndex
Number
是
指定页的序列号。默认值为当前激活页的序列号。
返回值
属性
数据类型
描述
remarkList
Array
注脚信息列表。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取指定页或当前页的注脚信息 const operatorsInfo = await app.ActivePresentation.GetSlideRemark(); console.log(operatorsInfo); }
获取所有页的注脚信息
语法
表达式.ActivePresentation.GetRemarkList()
表达式:文档类型应用对象
返回值
属性
数据类型
描述
remarkList
Array
注脚信息列表。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有页的注脚信息 const operatorsInfo = await app.ActivePresentation.GetRemarkList(); console.log(operatorsInfo); }
执行触发器动画
支持JS-SDK V1.1.15及以上版本。
语法
表达式.ActivePresentation.PlayTriggerAnim()
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
TargetShapeId
number
是
触发器ID。
SlideCategory
string
是
触发器类型。
Steps
number
否
指定步数。
示例
async function example() { await instance.ready(); const app = instance.Application; //执行触发器动画 await app.ActivePresentation.PlayTriggerAnim(TargetShapeId, SlideCategory); }