Skip to content

演示组件页面操作相关 API

导出

ActivePresentation.ExportAsFixedFormat()

导出文件为 PDF 或者图片

语法

表达式.ActivePresentation.ExportAsFixedFormat({ RangeType, FrameSlides, FixedFormatType, ImgFormat, Dpi, Combine2LongPic, From, To, WaterMark })

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

参数

属性数据类型默认值必填说明
RangeType
Enum
可选
幻灯片范围的类型,详细可参考 Enum.PpPrintRangeType
FrameSlides
Enum
可选
要导出的幻灯片是否应当带有边框,详细可参考 Enum.MsoTriState
FixedFormatType
Enum
2
可选
导出的类型,详细可参考 Enum.PpFixedFormatType,目前仅支持导出图片和导出 PDF
ImgFormat
Enum
0
可选
【仅导出图片格式生效】导出图片的格式,详细可参考 Enum.PpExportImgFormatType
Dpi
Number
96
可选
【仅导出图片格式生效】导出的图片质量
Combine2LongPic
Boolean
false
可选
【仅导出图片格式生效】是否输出为长图
From
Number
0
可选
【仅导出图片格式生效】从哪一页导出到哪一页,起始
To
Number
0
可选
【仅导出图片格式生效】 从哪一页导出到哪一页,结束
WaterMark
Boolean
false
可选
带水印还是无水印

返回值

返回打印的 url

属性数据类型说明
url
string
打印的 url

示例 1:导出 PDF

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

  const app = instance.Application;
  
  // 导出文件为 PDF
  const pdfUrl = await app.ActivePresentation.ExportAsFixedFormat();
  console.log(pdfUrl);
}

示例 2:导出图片

//@file=base.pptx
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.GetRemarkList()

所有页的注脚信息

语法

表达式.ActivePresentation.GetRemarkList()

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

返回值

属性数据类型说明
remarkList
Array
注脚信息列表

示例

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

  const app = instance.Application;
  
  // 获取所有页的注脚信息
  const operatorsInfo = await app.ActivePresentation.GetRemarkList();
  console.log(operatorsInfo);
}

当前页的注脚信息

ActivePresentation.GetSlideRemark()

获取指定页/当前页的注脚信息

语法

表达式.ActivePresentation.GetSlideRemark()

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

参数

传入一个数字,表明指定页的序列号。

属性数据类型默认值必填说明
SlideIndex
Number
当前激活页的序列号
指定页的序列号

返回值

属性数据类型说明
remarkList
Array
注脚信息列表

示例

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

  const app = instance.Application;
  
  // 获取指定页/当前页的注脚信息
  const operatorsInfo = await app.ActivePresentation.GetSlideRemark();
  console.log(operatorsInfo);
}

登录操作者信息

ActivePresentation.GetOperatorsInfo()

获取登录操作者信息

语法

表达式.ActivePresentation.GetOperatorsInfo()

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

返回值

Object object

属性数据类型说明
type
String
请求类型
response
Object
用户信息列表

response 结构

属性数据类型说明
id
String
用户 id
avatar_url
Object
用户头像
logined
Object
用户登录状态
name
Object
用户姓名

示例

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

  const app = instance.Application;
  
  // 获取登录操作者信息
  const operatorsInfo = await app.ActivePresentation.GetOperatorsInfo();
  console.log(operatorsInfo);
}

保存

ActivePresentation.Save()

JSSDK: v1.1.9+、WebOffice v2.3.1+ 支持

保存文件的改动

语法

表达式.ActivePresentation.Save()

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

返回值

属性数据类型说明
result
String
保存状态
size
Number
文件大小,单位 byte
version
Number
版本

保存状态说明

保存状态说明
ok
版本保存成功,可在历史版本中查看
nochange
文档无更新,无需保存版本
SavedEmptyFile
暂不支持保存空文件 触发场景:内核保存完后文件为空
SpaceFull
空间已满
QueneFull
保存中请勿频繁操作 触发场景:服务端处理保存队列已满,正在排队
fail
保存失败

示例

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

  const app = instance.Application;
  
  // 保存文件的改动
  const saveResult = await app.ActivePresentation.Save();
  console.log(saveResult);
}

自适应

ActiveWindow.View.ZoomToFit

对文档窗口大小进行调整后,是否缩放视图以适应文档窗口的尺寸

语法

表达式.ActiveWindow.View.ZoomToFit = Number

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

Number 依据不同值进行调整:

  • -1:文档窗口大小进行调整后使页面以最佳尺寸适应活动窗口
  • 0:对文档窗口大小进行调整后不为适应文档窗口尺寸而缩放视图

示例

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

  const app = instance.Application;
  
  // 文档窗口对象
  const activeWindow = await app.ActiveWindow;

  // 视图对象
  const view = await activeWindow.View;

  // 窗口自适应
  view.ZoomToFit = 0;
}

触发器动画

ActivePresentation.PlayTriggerAnim()

JSSDK: v1.1.9+、WebOffice v2.3.1+ 支持

执行触发器动画

语法

表达式.ActivePresentation.PlayTriggerAnim()

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

参数

属性数据类型默认值必填说明
TargetShapeId
number
-
触发器ID
SlideCategory
string
-
触发器类型
Steps
number
-
指定步数

示例

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

  const app = instance.Application;
  
  // 执行触发器动画
  await app.ActivePresentation.PlayTriggerAnim(TargetShapeId, SlideCategory);
}

缩放

ActiveWindow.View.Zoom

窗口缩放

语法

表达式.ActiveWindow.View.Zoom

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

示例

//@file=base.pptx
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;
}