文档

Presentation

更新时间:

本文介绍与演示文稿Presentation相关的API。

Presentation

ActivePresentation

获取演示文稿对象。

  • 语法

    表达式.ActivePresentation

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    }

方法

ActivePresentation.ExportAsFixedFormat()

通过ExportAsFixedFormat()方法,您可以将当前演示文稿导出为对应的PDF或图片,并获取导出文件的URL。

  • 语法

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

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    RangeType

    Enum

    指定演示文稿导出的区域范围类型。更多信息,请参见PpPrintRangeType

    FrameSlides

    Enum

    指定要导出的演示文稿是否应当带有边框。更多信息,请参见MsoTriState

    FixedFormatType

    Enum

    导出的文件类型。目前仅支持导出图片和PDF,默认值为2,即默认导出为PDF。更多信息,请参见PpFixedFormatType

    ImgFormat

    Enum

    导出图片的格式。仅当导出文件类型为图片时此参数生效,默认值为2,即默认导出BMP格式的图片。更多信息,请参见PpExportImgFormatType

    Dpi

    Number

    导出的图片质量,仅当导出文件类型为图片时此参数生效。单位为ppi,取值范围为96~2048,默认值为96。

    Combine2LongPic

    Boolean

    是否输出为长图,仅当导出文件类型为图片时此参数生效。取值范围如下:

    • false(默认):否,将演示文稿按页导出为多张图片。

    • true:是,将演示文稿的指定页导出为一张图片。

    From

    Number

    导出演示文稿的起始页,仅当导出文件类型为图片时此参数生效。取值为0表示当前页。

    To

    Number

    导出演示文稿的终止页,仅当导出文件类型为图片时此参数生效。

    WaterMark

    Boolean

    导出文件是否带水印。取值范围如下:

    • false(默认):否。

    • true:是。

  • 返回值

    属性

    数据类型

    描述

    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 imgUrl = await app.ActivePresentation.ExportAsFixedFormat({
          FixedFormatType: app.Enum.PpFixedFormatType.ppFixedFormatTypeIMG,
          From: 0,
          To: 1,
        });
        console.log(imgUrl);
      }

ActivePresentation.GetOperatorsInfo()

通过GetOperatorsInfo()方法,您可以获取登录操作者的信息。

  • 语法

    表达式.ActivePresentation.GetOperatorsInfo()

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

  • 返回值

    Object object

    属性

    数据类型

    描述

    type

    String

    请求类型。

    response

    Object

    用户信息列表。

    response结构

    属性

    数据类型

    描述

    id

    String

    用户ID。

    avatar_url

    String

    用户头像。

    logined

    String

    用户登录状态。

    name

    String

    用户姓名。

  • 示例

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

ActivePresentation.GetRemarkList()

通过GetRemarkList()方法,您可以获取所有页的注脚信息。

  • 语法

    表达式.ActivePresentation.GetRemarkList()

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

  • 返回值

    属性

    数据类型

    描述

    remarkList

    Array

    注脚信息列表。

  • 示例

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

ActivePresentation.GetSlideRemark()

通过GetSlideRemark()方法,您可以获取指定页的注脚信息。

  • 语法

    表达式.ActivePresentation.GetSlideRemark()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    SlideIndex

    Number

    指定页的序列号,取值范围为大于等于1且小于演示文稿的总页数的正整数,默认值为当前页的序列号。

  • 返回值

    属性

    数据类型

    描述

    remarkList

    Array

    注脚信息列表。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取指定页的注脚信息
      const operatorsInfo = await app.ActivePresentation.GetSlideRemark();
      console.log(operatorsInfo);
    }

ActivePresentation.ExitVideoFullscreen()

通过ExitVideoFullscreen()方法,您可以退出演示视频全屏播放。

  • 语法

    表达式.ActivePresentation.ExitVideoFullscreen()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //退出演示视频全屏播放
      const operatorsInfo = await app.ActivePresentation.ExitVideoFullscreen();
      console.log(operatorsInfo);
    }

ActivePresentation.MiniThumbnailVisibleInfo()

通过MiniThumbnailVisibleInfo()方法,您可以监听指定幻灯片面板打开或关闭。

  • 语法

    表达式.ActivePresentation.MiniThumbnailVisibleInfo()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听指定幻灯片面板打开或关闭
      const operatorsInfo = await app.ActivePresentation.MiniThumbnailVisibleInfo();
      console.log(operatorsInfo);
    }

ActivePresentation.Save()

通过Save()方法,您可以保存演示文稿的改动。

重要

JS-SDK V1.1.9及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.Save()

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

  • 返回值

    属性

    数据类型

    描述

    result

    String

    保存状态。

    size

    Number

    文件大小,单位为字节。

    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);
    }

ActivePresentation.PlayTriggerAnim()

通过PlayTriggerAnim()方法,您可以执行触发器动画。

  • 语法

    表达式.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);
    }

ActivePresentation.GetDiagramContainer()

通过GetDiagramContainer()方法,您可以获取关系图组的容器DOM(需先选中关系图组)。

  • 操作方法

    1. 单击选中关系图组。

    2. 执行APIActivePresentation.GetDiagramContainer()

    3. 获取DOM信息。

  • 语法

    表达式.ActivePresentation.GetDiagramContainer()

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

  • 返回值

    null或者选中的DOM节点对应的ID(String形式)

  • 示例

    //@file=base.pptx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取关系图组的容器DOM(需先选中关系图组)
      const d = await app.ActivePresentation.GetDiagramContainer();
      console.log('获取到的内容:', d);
    }

ActivePresentation.GetDiagramInfo()

通过GetDiagramInfo()方法,您可以获取选中的关系图组信息。

  • 操作方法

    1. 单击选中关系图。

    2. 执行APIActivePresentation.GetDiagramInfo()

    3. 获取选中关系图组的信息。

  • 语法

    表达式.ActivePresentation.GetDiagramInfo()

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

  • 返回值

    null或者选中的DOM节点

  • 示例

    //@file=base.pptx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取选中的关系图组信息
      const info = await app.ActivePresentation.GetDiagramInfo();
      console.log('获取到的内容:', info);
    }

ActivePresentation.SetOpenMarkerInkEdit()

通过SetOpenMarkerInkEdit()方法,您可以开启画笔或保存并关闭画笔。

  • 语法

    表达式.ActivePresentation.SetOpenMarkerInkEdit({ Open })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Open

    Boolean

    开启画笔或保存并关闭画笔。取值范围如下:

    • true(默认):开启画笔。

    • false:保存并关闭画笔。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //开启画笔
      await app.ActivePresentation.SetOpenMarkerInkEdit(true);
    
      setTimeout(async () => {
        //5000 ms后保存并关闭画笔
        await app.ActivePresentation.SetOpenMarkerInkEdit(false);
      }, 5000);
    }

ActivePresentation.GetDiagramPPTInfo()

通过GetDiagramPPTInfo()方法,您可以获取当前关系图组形成的单页幻灯片的下载地址。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.GetDiagramPPTInfo({ Type })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Number

    获取下载地址的目的。取值范围如下:

    • 1(默认):获取预览信息。

    • 2:获取信息用以美化。

  • 返回值

    属性

    数据类型

    描述

    id

    String

    文件ID。

    connid

    String

    连接ID。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取当前关系图组所形成的单页幻灯片的下载地址
      await app.ActivePresentation.GetDiagramPPTInfo({ Type: 2 });
    }

ActivePresentation.BeautifyDiagram()

通过BeautifyDiagram()方法,您可以替换当前页的关系图。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 操作方法

    1. 选中关系图。

    2. 单击按钮组中的样式

    3. 选中其中一个样式,美化当前幻灯片,并获取UploadId。

    4. 通过ActivePresentation.BeautifyDiagram替换当前页的关系图。

  • 语法

    表达式.ActivePresentation.BeautifyDiagram({ UploadId })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    UploadId

    String

    美化后的幻灯片的ID。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //替换当前页的关系图
      await app.ActivePresentation.BeautifyDiagram('xxx');
    }

ActivePresentation.InsertDiagram()

通过InsertDiagram()方法,您可以插入关系图。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.InsertDiagram({ Url })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Url

    String

    关系图地址。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //插入关系图
      await app.ActivePresentation.InsertDiagram('xxx');
    }

ActivePresentation.GetActiveShapeImg()

通过GetActiveShapeImg()方法,您可以获取当前选中图片的原图或原图链接。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.GetActiveShapeImg({ IsOrigin })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    IsOrigin

    Boolean

    是否获取原图的链接。取值范围如下:

    • false(默认):否。

    • true:是。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前选中图片的原图或原图链接
      await app.ActivePresentation.GetActiveShapeImg(true);
    }

ActivePresentation.FetchDownloadUrl()

通过FetchDownloadUrl()方法,您可以获取演示文稿的源文件链接。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.FetchDownloadUrl()

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

  • 返回值

    返回String类型的URL表示演示文稿的源文件链接。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿的源文件链接
      const url = await app.ActivePresentation.FetchDownloadUrl();
    }

ActivePresentation.ReplaceActiveSlide()

通过ReplaceActiveSlide()方法,您可以替换当前幻灯片。

  • 语法

    表达式.ActivePresentation.ReplaceActiveSlide({ UploadId, FileKey })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    UploadId

    String

    文件上传后服务端返回数据。

    FileKey

    String

    用于内核解密加密文档。

  • 返回值

    成功:{ type: 'success' }

    失败:{ type: 'error' }

  • 示例

    //@file=base.ppt
    async function example() {
      await instance.ready()
    
      const app = instance.Application
    
      await app.ActivePresentation.ReplaceActiveSlide({
        UploadId: 'xxx',
        FileKey: 'xxx',
      })
    }

属性

ActivePresentation.ReadOnly

通过ReadOnly属性,您可以查看当前演示文稿是否只读。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.ReadOnly

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看演示文稿是否只读
      const ReadOnly = await app.ActivePresentation.ReadOnly;
    }

ActivePresentation.ReadOnlyComment

通过ReadOnlyComment属性,您可以查看当前演示文稿是否只读可评论。

重要

JS-SDK V1.1.15及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.ReadOnlyComment

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看当前演示文稿是否只读可评论
      const ReadOnlyComment = await app.ActivePresentation.ReadOnlyComment;
    }

ActivePresentation.SupportReadOnlyComment

通过SupportReadOnlyComment属性,您可以查看当前演示文稿是否支持只读可评论。

重要

JS-SDK V1.1.15及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SupportReadOnlyComment

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //查看当前演示文稿是否支持只读可评论
      const SupportReadOnlyComment = await app.ActivePresentation.SupportReadOnlyComment;
    }

Slides

ActivePresentation.Slides

获取幻灯片对象。

  • 语法

    表达式.ActivePresentation.Slides

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取幻灯片对象
      const view = await presentation.Slides;
    }

方法

ActivePresentation.Slides.AddSlide()

通过AddSlide()方法,您可以插入新的幻灯片。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.Slides.AddSlide()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Index

    Number

    新幻灯片插入的位置。

    不填或填写的参数小于0时插入到当前幻灯片的后面。

    CustomLayout

    Object

    本地版式的类型。

    不填写时默认插入空白幻灯片。

    LayoutUrl

    String

    在线幻灯片文件的链接。

    如果填写了该参数,则参数CustomlayoutType会被忽略,优先使用在线幻灯片文件内的版式,并返回一个promise通知结果。

    LayoutIndex

    Number

    表示新建的幻灯片需要使用在线文件的第几个版式。

    不填写参数layoutUrl时,该参数无效。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      //插入新的空白幻灯片
      const Index = app.ActivePresentation.SlideShowWindow.View.Slide.SlideIndex;
      await app.ActivePresentation.Slides.AddSlide(Index);
    }

ActivePresentation.Slides.FindBySlideID()

通过FindBySlideID()方法,您可以根据SlideID获取对应幻灯片的信息。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.Slides.FindBySlideID()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    SlideID

    Number

    SlideID,可通过Slide属性中的ActivePresentation.SlideShowWindow.View.Slide.SlideID获取。

  • 返回值

    返回对应的幻灯片信息。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前页幻灯片的SlideID
      const slideId = await app.ActivePresentation.SlideShowWindow.View.Slide.SlideID;
      console.log(slideId);
    
      //根据SlideID获取对应幻灯片的信息
      const info = await app.ActivePresentation.Slides.FindBySlideID(slideId);
      console.log(info);
    }

ActivePresentation.Slides.Item()

通过Item()方法,您可以获取单个幻灯片对象。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.Slides.Item()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Index

    Number

    幻灯片序列。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      //获取单个幻灯片对象
      await app.ActivePresentation.Slides.Item(1);
    }

属性

ActivePresentation.Slides.Count

通过Count属性,您可以获取幻灯片总页数。

  • 语法

    表达式.ActivePresentation.Slides.Count

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

  • 返回值

    返回幻灯片的总页数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取幻灯片对象
      const slides = await presentation.Slides;
    
      //获取幻灯片总页数
      const count = await slides.Count;
      console.log(count);
    }

ActivePresentation.Slides.Comments

通过Comments属性,您可以获取Comments评论对象。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.Slides.Comments

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取幻灯片对象
      const view = await presentation.Slides;
    
      //获取评论对象
      await slides.Comments;
    }

Slide

属性

ActivePresentation.SlideShowWindow.View.Slide.SlideID

通过SlideID属性,您可以获取当前页幻灯片的SlideID。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.SlideID

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

  • 返回值

    返回Number类型的ID值。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前页幻灯片的SlideID
      const slideId = await app.ActivePresentation.SlideShowWindow.View.Slide.SlideID;
      console.log(slideId);
    }

ActivePresentation.SlideShowWindow.View.Slide.SlideIndex

通过SlideIndex属性,您可以获取当前页幻灯片的页码。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.SlideIndex

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

  • 返回值

    返回Number类型的当前页幻灯片的页码。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前页幻灯片的页码
      const curryPage = await app.ActivePresentation.SlideShowWindow.View.Slide.SlideIndex;
      console.log(curryPage);
    }

ActivePresentation.SlideShowWindow.View.Slide.Tags

通过Tags属性,您可以获取当前页幻灯片的标签。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Tags

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取当前页幻灯片的标签
      const Tags = app.ActivePresentation.SlideShowWindow.View.Slide.Tags;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes

通过Shapes属性,您可以获取放置或插入到指定幻灯片、幻灯片母版或幻灯片组的所有绘图层中的对象。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取放置或插入到指定幻灯片、幻灯片母版或幻灯片组的所有绘图层中的对象
      const Shapes = app.ActivePresentation.SlideShowWindow.View.Slide.Shapes;
    }

ActivePresentation.SlideShowWindow.View.Slide.Hyperlinks

通过Hyperlinks属性,您可以获取指定幻灯片中的所有超链接。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Hyperlinks

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取指定幻灯片中的所有超链接
      const Hyperlinks = app.ActivePresentation.SlideShowWindow.View.Slide.Hyperlinks;
    }

SlideShowSettings

ActivePresentation.SlideShowSettings

获取放映设置对象。

  • 语法

    表达式.ActivePresentation.SlideShowSettings

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映设置对象
      const slideShowSettings = await presentation.SlideShowSettings;
    }

方法

ActivePresentation.SlideShowSettings.Run()

通过Run()方法,您可以切换到幻灯片全屏播放状态。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Run()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    }

ActivePresentation.SlideShowSettings.SetMiniThumbnailVisible()

通过SetMiniThumbnailVisible()方法,您可以设置打开或关闭播放缩略图。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.SetMiniThumbnailVisible()

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Visible

    Boolean

    设置打开或关闭播放缩略图。取值范围如下:

    • false(默认):关闭。

    • true:打开。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //打开播放缩略图
      await app.ActivePresentation.SlideShowSettings.SetMiniThumbnailVisible(true);
    }

ActivePresentation.SlideShowSettings.SetPlayToolbarPosition()

通过SetPlayToolbarPosition()方法,您可以修改播放模式下工具栏的样式。

重要
  • JS-SDK V1.1.14及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 该API自由度较高,为了避免样式的修改影响功能的使用,请尽量使用topleftrightbottomtranslate修改样式。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.SetPlayToolbarPosition({ Style })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Style

    Object

    工具栏样式。

    • Show:显示时的样式,传入参数类似为{ left: '100px' }

    • Hidden:隐藏时的样式。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //修改工具栏样式
      await SlideShowSettings.SetPlayToolbarPosition({
        Style: {
          Show: { top: '10px' }, //工具栏显示时的位置
          Hidden: { top: '-100px' }, //工具栏隐藏时的位置
        },
      });
    }

ActivePresentation.SlideShowSettings.SetPlayInkPosition()

通过SetPlayInkPosition()方法,您可以修改播放模式下画笔工具的样式。

重要
  • JS-SDK V1.1.14及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.SetPlayInkPosition({ Style })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Style

    Object

    画笔工具样式,以JSON格式表示,例如{ background: 'deepskyblue' }

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //修改画笔工具样式
      await SlideShowSettings.SetPlayInkPosition({
        Style: { background: 'deepskyblue' },
      });
    }

ActivePresentation.SlideShowSettings.OpenRemarkSpeaker()

通过OpenRemarkSpeaker()方法,您可以设置打开播放模式下的备注视图。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.OpenRemarkSpeaker()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //打开备注视图
      await SlideShowSettings.OpenRemarkSpeaker();
    }

ActivePresentation.SlideShowSettings.SetCountDown()

通过SetCountDown()方法,您可以设置打开播放模式下的倒计时。

重要
  • JS-SDK V1.1.14及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.SetCountDown()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //打开倒计时
      await SlideShowSettings.SetCountDown();
    }

ActivePresentation.SlideShowSettings.StartAutoPlay()

通过StartAutoPlay()方法,您可以设置在播放模式下开启自动播放。

重要
  • JS-SDK V1.1.14及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.StartAutoPlay()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //开启自动播放
      await SlideShowSettings.StartAutoPlay();
    }

ActivePresentation.SlideShowWindow.View.StopAutoPlay()

通过StopAutoPlay()方法,您可以停止自动播放。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.StopAutoPlay()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //关闭自动播放
      await SlideShowSettings.StopAutoPlay();
    }

属性

ActivePresentation.SlideShowSettings.ShowPlayToolbar

通过ShowPlayToolbar属性,您可以在播放模式下设置显示或隐藏工具栏。

重要
  • JS-SDK V1.1.14及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.ShowPlayToolbar = Boolean

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

    Boolean取值为true时,表示显示工具栏,取值为false时,表示隐藏工具栏。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //隐藏工具栏
      app.ActivePresentation.SlideShowSettings.ShowPlayToolbar = false;
    }

Ink

ActivePresentation.SlideShowSettings.Ink

获取画笔对象。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Ink

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取画笔对象
      await app.ActivePresentation.SlideShowSettings.Ink;
    }

方法

ActivePresentation.SlideShowSettings.Ink.Delete

通过Delete方法,您可以删除画笔(橡皮擦)。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Ink.Delete

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Number

    擦除方式,取值范围如下:

    • 0:擦除某条墨迹。

    • 1(默认):擦除整页墨迹。

    • 2::擦除文档全部墨迹。

    Position

    Object

    擦出范围,格式为{clientX: number, clientY: number}

    说明

    当参数Type取值为0,即擦除方式为擦除某条墨迹时此参数生效,相对于视窗位置。

  • 示例

    //@file=base.pptx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //删除画笔(橡皮擦)
      await app.ActivePresentation.SlideShowSettings.Ink.Delete;
        
    }

属性

ActivePresentation.SlideShowSettings.Ink.Color

通过Color属性,您可以设置画笔颜色。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Ink.Color

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Color

    String

    十六进制颜色码。例如#FFFFFF,表示白色。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置画笔颜色
      await app.ActivePresentation.SlideShowSettings.Ink.Color = '#8bc34a';
    }

ActivePresentation.SlideShowSettings.Ink.Width

通过Width属性,您可以设置画笔宽度。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Ink.Width

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Width

    Number

    画笔宽度。取值范围如下:

    • 当客户端为PC端时,取值范围为1~16。

    • 当客户端为移动端时,取值范围为1~30。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //设置画笔宽度为10
      await app.ActivePresentation.SlideShowSettings.Ink.Width = 10;
    }
    

ActivePresentation.SlideShowSettings.Ink.Type

通过Type属性,您可以设置画笔类型。

重要

JS-SDK V1.1.14及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowSettings.Ink.Type

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

  • 参数

属性

数据类型

必填

说明

Type

Number

画笔类型:0: 水彩笔;1:荧光笔;2:智能笔

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 设置画笔类型为荧光笔
      await app.ActivePresentation.SlideShowSettings.Ink.Type = 1;
    }

SlideShowWindow

ActivePresentation.SlideShowWindow

获取演示文稿的放映窗口。

  • 语法

    表达式.ActivePresentation.SlideShowWindow

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    }

属性

ActivePresentation.SlideShowWindow.IsFullScreen

通过IsFullScreen属性,您可以设置放映窗口全屏。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.IsFullScreen

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //设置全屏
      SlideShowWindow.IsFullScreen = true;
    
      setTimeout(() => {
        //3000 ms后退出全屏
        SlideShowWindow.IsFullScreen = false;
      }, 3000)
    }

SlideShowView

ActivePresentation.SlideShowWindow.View

获取演示文稿放映窗口中的视图。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取放映窗口中的视图
      const slideShowView = await slideShowWindow.View;
    }

方法

ActivePresentation.SlideShowWindow.View.Exit()

通过Exit()方法,您可以退出幻灯片全屏播放状态。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Exit()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //5000 ms后退出幻灯片全屏播放状态
      setTimeout(async () => {
        await app.ActivePresentation.SlideShowWindow.View.Exit();
      }, 5000);
    }

ActivePresentation.SlideShowWindow.View.GetClickCount()

通过GetClickCount()方法,您可以获取当前页幻灯片的动画个数。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GetClickCount()

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

  • 返回值

    返回Number类型的值表示当前页幻灯片的动画个数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //获取当前页幻灯片的动画个数
      const clickCount = await app.ActivePresentation.SlideShowWindow.View.GetClickCount();
      console.log(clickCount);
    }

ActivePresentation.SlideShowWindow.View.GetClickIndex()

通过GetClickIndex()方法,您可以获取正在幻灯片播放或刚播放完的当前鼠标单击动画的索引号。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GetClickIndex()

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

  • 返回值

    返回Number类型的值表示当前鼠标单击动画的索引号。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //获取当前鼠标单击动画的索引号
      const index = await app.ActivePresentation.SlideShowWindow.View.GetClickIndex();
      console.log(index);
    }

ActivePresentation.SlideShowWindow.View.GotoNextClick()

通过GotoNextClick()方法,您可以切换到下一步动画。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GotoNextClick()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //2000 ms后切换到下一步动画
      setTimeout(async () => {
        await app.ActivePresentation.SlideShowWindow.View.GotoNextClick();
      }, 2000);
    }

ActivePresentation.SlideShowWindow.View.GotoPreClick()

通过GotoPreClick()方法,您可以切换到上一步动画。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GotoPreClick()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
    
      //切换到幻灯片全屏播放状态
      await SlideShowSettings.Run();
    
      //2000 ms后切换到上一步动画
      setTimeout(async () => {
        await app.ActivePresentation.SlideShowWindow.View.GotoPreClick();
      }, 2000);
    }

ActivePresentation.SlideShowWindow.View.GotoSlide()

通过GotoSlide()方法,您可以跳转到指定页。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GotoSlide({ Index })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Index

    Number

    跳转到第Index个页面。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //跳转到第三页
      await app.ActivePresentation.SlideShowWindow.View.GotoSlide(3);
    }

ActivePresentation.SlideShowWindow.View.GotoClick()

通过GotoClick()方法,您可以执行跳转幻灯片动画。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.GotoClick(number)

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

  • 参数

    属性

    数据类型

    描述

    number

    Number

    当前幻灯片动画的下标。

  • 示例

    //@file=base.ppt
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //Slide设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;
      //进入幻灯片播放模式
      await SlideShowSettings.Run();
    
      //窗口对象
      const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
    
      //视图对象
      const view = await SlideShowWindow.View;
    
      //执行跳转幻灯片第二个动画
      await view.GotoClick(2);
    }

ActivePresentation.SlideShowWindow.View.Play()

通过Play()方法,您可以播放指定幻灯片的指定动画。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Play(slideIndex, animateIndex)

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

  • 参数

    属性

    数据类型

    描述

    slideIndex

    Number

    指定幻灯片的索引号。

    animateIndex

    Number

    指定幻灯片动画的索引号。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;  
      
      //进入幻灯片播放模式
      await SlideShowSettings.Run();
    
      //获取放映窗口
      const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
    
      //获取放映窗口中的视图
      const view = await slideShowWindow.View;
    
      //从第一张幻灯片的第一个动画开始播放
      await view.Play(1, 1);
    }

ActivePresentation.SlideShowWindow.View.SetLaserPenData()

通过SetLaserPenData()方法,您可以同步激光笔信息。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.SetLaserPenData(Data)

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

  • 参数

    属性

    数据类型

    描述

    Data

    Object

    激光笔信息。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;  
      
      //进入幻灯片播放模式
      await SlideShowSettings.Run();
    
      //获取放映窗口
      const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
    
      //获取放映窗口中的视图
      const view = await slideShowWindow.View;
    
      //设置发送激光笔的墨迹监听事件
      app.Sub.SlideLaserPenInkPointsChanged = async (e) => {
        const { Data } = e;
        console.log(Data);
    
        //同步激光笔信息
        await view.SetLaserPenData(Data);
      }
    }

ActivePresentation.SlideShowWindow.View.SetMediaObj()

通过SetMediaObj()方法,您可以同步视频播放信息。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.SetMediaObj(Data)

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

  • 参数

    属性

    数据类型

    描述

    Data

    Object

    视频播放信息。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;  
      
      //进入幻灯片播放模式
      await SlideShowSettings.Run();
    
      //获取放映窗口
      const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
    
      //获取放映窗口中的视图
      const view = await slideShowWindow.View;
    
      //设置视频播放改变监听事件
      app.Sub.SlideMediaChanged = async (e) => {
        const { Data } = e;
        console.log(Data);
    
        //同步视频播放信息
        await view.SetMediaObj(Data);
      }
    }

ActivePresentation.SlideShowWindow.View.DestroyMediaPlayer()

通过DestroyMediaPlayer()方法,您可以设置销毁视频播放工具。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅移动端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.DestroyMediaPlayer()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取放映设置对象
      const SlideShowSettings = await app.ActivePresentation.SlideShowSettings;  
      
      //进入幻灯片播放模式
      await SlideShowSettings.Run();
    
      //获取放映窗口
      const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
    
      //获取放映窗口中的视图
      const view = await slideShowWindow.View;
    
      //设置视频播放改变监听事件
      app.Sub.SlideMediaChanged = async (e) => {
        const { Data } = e;
        console.log(Data);
        setTimeout(async () => {
          //3000 ms后销毁视频播放工具
          await view.DestroyMediaPlayer(Data);
        }, 3000); 
      }
    }

ActivePresentation.SlideShowWindow.View.SetToolVisible()

通过SetToolVisible()方法,您可以设置进入播放模式后隐藏指定的工具。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.SetToolVisible(toolName, flag)

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

  • 参数

    属性

    数据类型

    说明

    toolName

    String

    需要设置的工具的名称。

    flag

    Boolean

    显示或隐藏。取值范围如下:

    • false:隐藏。

    • true:显示。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
     
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await slideShowWindow.View;
    
      const linkTip = app.Enum.PpToolType.pcPlayHoverLink //hover超链接
      const imageTip = app.Enum.PpToolType.pcImageHoverTip //hover图片
      const menu = app.Enum.PpToolType.pcPlayingMenu //右键菜单 
    
      //2000 ms后设置隐藏
      setTimeout(() => {
        //设置进入播放模式后隐藏指定的工具
        view.SetToolVisible(linkTip, false);
        view.SetToolVisible(imageTip, false);
        view.SetToolVisible(menu, false);
      }, 2000)
    }

属性

ActivePresentation.SlideShowWindow.View.State

通过State属性,您可以获取当前幻灯片的状态。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.State

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

  • 返回值

    属性

    数据类型

    说明

    state

    String

    当前幻灯片的状态。

    • edit:编辑。

    • play:播放。

    • masterView:母版视图。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取当前幻灯片的状态
      const getState = () => {
        return app.ActivePresentation.SlideShowWindow.View.State;
      }

ActivePresentation.SlideShowWindow.View.CoreReadonly

通过CoreReadonly属性,您可以设置是否进入预览模式。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.CoreReadonly

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await SlideShowWindow.View;
    
      //进入预览模式
      view.CoreReadonly = true;
    }

ActivePresentation.SlideShowWindow.View.MarkerEditVisible

通过MarkerEditVisible属性,您可以设置打开或关闭标注工具栏。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.MarkerEditVisible

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await SlideShowWindow.View;
    
      //打开标注工具栏
      view.MarkerEditVisible = true;
    
      setTimeout(() => {
        //3000 ms后关闭标注工具栏
        view.MarkerEditVisible = false;
      }, 3000)
    }

ActivePresentation.SlideShowWindow.View.PointerVisible

通过PointerVisible属性,您可以设置显示或关闭标注内容。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.PointerVisible

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await SlideShowWindow.View;
    
      //监听标注内容是否显示事件
      app.Sub.SlideInkVisible = async (e) => {
        const { Data } = e;
        console.log(Data.showmark);
        
        setTimeout(() => {
          //3000 ms后设置隐藏标注内容
          view.PointerVisible = false;
        }, 3000)
      }
    }

ActivePresentation.SlideShowWindow.View.IsBanSlideChange

通过IsBanSlideChange属性,您可以设置是否禁止翻页。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.IsBanSlideChange

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await SlideShowWindow.View;
    
      //禁止翻页
      view.IsBanSlideChange = true;
    
      setTimeout(() => {
        //3000 ms后允许翻页
        view.IsBanSlideChange = false;
      }, 3000)
    }

ActivePresentation.SlideShowWindow.View.ShowPage

通过ShowPage属性,您可以设置在播放模式下显示或隐藏页码。

重要
  • JS-SDK V1.1.11及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.ShowPage

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取放映窗口
      const slideShowWindow = await presentation.SlideShowWindow;
    
      //获取视图对象
      const view = await SlideShowWindow.View;
    
      //设置显示页码
      view.ShowPage = true;
    }

PageSetup

ActivePresentation.PageSetup

获取页面设置对象。

  • 语法

    表达式.ActivePresentation.PageSetup

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    }

属性

ActivePresentation.PageSetup.SlideHeight

通过SlideHeight属性,您可以获取页面高度。

  • 语法

    表达式.ActivePresentation.PageSetup.SlideHeight

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    
      //获取页面高度
      const slideHeight = await pageSetup.SlideHeight;
      console.log(slideHeight);
    }

ActivePresentation.PageSetup.SlideWidth

通过SlideWidth属性,您可以获取页面宽度。

  • 语法

    表达式.ActivePresentation.PageSetup.SlideWidth

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    
      //获取页面宽度
      const slideWidth = await pageSetup.SlideWidth;
      console.log(slideWidth);
    }

ActivePresentation.PageSetup.SlideRatio

通过SlideRatio属性,您可以获取页面比例。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.PageSetup.SlideRatio

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

  • 返回值

    属性

    数据类型

    描述

    Ratio

    Number

    页面比例。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    
      //获取页面比例
      const slideRatio = await pageSetup.SlideRatio;
      console.log(slideRatio);
    }

ActivePresentation.PageSetup.SlideTop

通过SlideTop属性,您可以获取页面顶部距离。

  • 语法

    表达式.ActivePresentation.PageSetup.SlideTop

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    
      //获取顶部距离
      const SlideTop = await pageSetup.SlideTop;
      console.log(SlideTop);
    }

ActivePresentation.PageSetup.SlideLeft

通过SlideLeft属性,您可以获取页面左侧距离。

  • 语法

    表达式.ActivePresentation.PageSetup.SlideLeft

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取演示文稿对象
      const presentation = await app.ActivePresentation;
    
      //获取页面设置对象
      const pageSetup = await presentation.PageSetup;
    
      //获取左侧距离
      const SlideLeft = await pageSetup.SlideLeft;
      console.log(SlideLeft);
    }

FillFormat

ActivePresentation.SlideMaster.Background.Fill

获取形状的填充对象。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideMaster.Background.Fill

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取形状的填充对象
      const fillFormat = await app.ActivePresentation.SlideMaster.Background.Fill;
    }

属性

ActivePresentation.SlideMaster.Background.Fill.Transparency

通过Transparency属性,您可以查询/设置填充透明度。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideMaster.Background.Fill.Transparency

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

    设置 Transparency 的值在[0, 1]之间可以调整背板的透明度。

    设置 0 为完全透明,设置 1 为不透明。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 设置幻灯片透明度
      app.ActivePresentation.SlideMaster.Background.Fill.Transparency = 0.5;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.Visible

通过Visible属性,您可以查询/设置填充是否可见。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.Visible

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询填充是否可见
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.Visible;
    
      // 设置填充是否可见
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.Visible = true;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.BackColor

通过BackColor属性,您可以查询/设置填充背景色。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.BackColor

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 查询填充背景色
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.BackColor.RGB;
    
      // 设置填充背景色
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.BackColor = '#ff0000';
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.ForeColor

通过ForeColor属性,您可以查询/设置填充前景色。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.ForeColor

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 查询填充前景色
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.ForeColor.RGB;
    
      // 设置填充前景色
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.ForeColor = '#ff0000';
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.Type

通过Type属性,您可以查询填充类型。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Fill.Type

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询填充类型
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Fill.Type;
    }

LineFormat

ActivePresentation.SlideMaster.Background.Line

获取形状的描边对象。

重要

JS-SDK V1.1.11及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideMaster.Background.Line

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取形状的描边对象
      const lineFormat = await app.ActivePresentation.SlideMaster.Background.Line;
    }

属性

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Transparency

通过Transparency属性,您可以查询/设置填充透明度。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Transparency

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

    设置 Transparency 的值在[0, 1]之间可以调整透明度。

    设置 0 为不透明,设置 1 为完全透明。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询透明度
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Transparency;
    
      // 设置透明度
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Transparency = 0.5;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Visible

通过Visible属性,您可以查询/设置描边是否可见。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Visible

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询描边是否可见
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Visible;
    
      // 设置描边是否可见
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Visible = true;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.BackColor

通过BackColor属性,您可以查询/设置描边背景色。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.BackColor

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询描边背景色
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.BackColor.RGB
    
      // 设置描边背景色
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.BackColor = '#ff0000';
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Style

通过Style属性,您可以查询/设置描边类型。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Style

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询描边线条类型
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Style;
    
      // 设置描边线条类型
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Style = await app.Enum.MsoLineStyle.msoLineThickThin;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.DashStyle

通过DashStyle属性,您可以查询/设置描边虚线类型。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.DashStyle

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询描边虚线类型
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.DashStyle;
    
      // 设置描边虚线类型
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.DashStyle = await app.Enum.MsoLineDashStyle.msoLineDashDot;
    }

ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Weight

通过Weight属性,您可以查询/设置描边宽度。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(Index).Line.Weight

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // 查询描边宽度
      await app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Weight;
    
      // 设置描边宽度
      app.ActivePresentation.SlideShowWindow.View.Slide.Shapes.Item(1).Line.Weight = 10;
    }

  • 本页导读 (1)
文档反馈