Command API ​

executePrevSlide ​

  • 描述：切换至上一个幻灯片

  • 语法：unippt.command.executePrevSlide();

  • 示例：

js
unippt.command.executePrevSlide();
  • 输出:

executeNextSlide ​

  • 描述：切换至下一个幻灯片

  • 语法：unippt.command.executeNextSlide()

  • 示例：

ts
unippt.command.executeNextSlide();

executeSwitchSlide ​

  • 描述：切换至指定幻灯片 （自然顺序 1 2 3 ...）

  • 语法：unippt.command.executeSwitchSlide(slideIndex:number)

  • 参数：slideIndex: number

  • 示例：

js
// 切换至幻灯片 1
unippt.command.executeSwitchSlide(1);

// 切换至幻灯片 3
unippt.command.executeSwitchSlide(3);
  • 输出:

executeAddSlide ​

  • 描述：添加新的幻灯片

  • 语法：unippt.command.executeAddSlide();

  • 示例：

js
unippt.command.executeAddSlide()

getSlideImage ​

  • 描述：获取幻灯片缩略图

  • 语法：unippt.command.getSlideImage()

  • 返回值：string[]

  • 示例：

js
// 实现的底层方法是 layer.toDataURL()，返回值是 base64
unippt.command.getSlideImage();
  • 输出:

executePreviewBeginning ​

  • 描述：从头开始预览

  • 语法：unippt.command.executePreviewBeginning()

  • 示例：

js
unippt.command.executePreviewBeginning()

executePreviewCurrent ​

  • 描述：从当前幻灯片开始预览

  • 语法：unippt.command.executePreviewCurrent()

  • 示例：

js
unippt.command.executePreviewCurrent()

executePreviewSlide ​

  • 描述：从指定幻灯片开始预览 (自然顺序 1 2 3 ...)

  • 语法：unippt.command.executePreviewSlide(slideIndex:number)

  • 参数：slideIndex:number

  • 示例：

js
// 用于幻灯片缩略图的预览按钮使用，用户可不用。
unippt.command.executePreviewSlide(1);

executeRecord ​

  • 描述：进行屏幕录制

  • 语法：unippt.command.executeRecord()

executeSetBackground ​

  • 描述：添加网格线

  • 语法：unippt.command.executeSetBackground(payload: IBackgroundLayerOptions)

  • 参数：

ts
/** 背景图层管理器参数 */
export interface IBackgroundLayerOptions {
  global?: boolean; // 是否应用全部 - 特指背景颜色等属性是否应用到全局
  grid?: boolean; // 是否添加网格
  gridColor?: string; // 网格颜色
  ruler?: boolean; // 是否添加标尺
  bgType?: "fill" | "image"; // 背景类型
  fill?: string; // 背景填充颜色
  stroke?: string; // 背景边框颜色
  image?: string; // 背景图片
}
  • 示例：
ts
unippt.command.executeSetBackground({grid: true}) // 添加网格线
unippt.command.executeSetBackground({grid: false}) // 移除网格线

unippt.command.executeSetBackground({fill: 'red'}) // 设置背景颜色为红色
unippt.command.executeSetBackground({stroke: '#000'}) // 设置边框颜色为黑色

unippt.command.executeSetBackground({image: 'https://xxx.jpg'}) // 设置图片为背景
unippt.command.executeSetBackground({image: 'data:image/png;base64,xxx'}) // 设置 base64 图片为背景
unippt.command.executeSetBackground({bgType: "fill"}) // 移除背景图片

unippt.command.executeSetBackground({fill: "#00ff00", global: true}) // 应用到全局
  • 输出:

executeDeleteSlide ​

  • 描述：删除幻灯片 (自然顺序)

  • 语法：unippt.command.executeDeleteSlide(index?: number)

  • 参数：@param index 幻灯片索引 默认为当前

  • 示例：

ts
unippt.command.executeDeleteSlide(); // 删除当前幻灯片
unippt.command.executeDeleteSlide(1); // 删除第一张幻灯片

executeRename ​

  • 描述：对文件进行重命名

  • 语法：unippt.command.executeRename()

executeImportPptx ​

  • 描述：导入PPTX

  • 语法：unipptx.command.executeImportPptx()

executeExportPptx ​

  • 描述：导出PPTX

  • 语法：unipptx.command.executeExportPptx()

executeExportPdf ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeExportImage ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeShare ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeEncrypt ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executePrint ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeHelp ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeSave ​

  • 描述：执行保存操作

  • 语法：unipptx.command.executeSave()

  • 返回值：幻灯片的JSON字符串数组, 例如 [layer1.json,layer2.json]

  • 输出:

executeUndo ​

  • 描述：撤销 （快捷键 Ctrl + Z）

  • 语法：unippt.command.executeUndo()

  • 输出:

executeRedo ​

  • 描述：重做 （快捷键 Ctrl + Y）

  • 语法：unippt.command.executeRedo()

executeCut ​

  • 描述：剪切 （快捷键 Ctrl + X）

  • 语法：unippt.command.executeCut()

executeCopy ​

  • 描述：复制 （快捷键 Ctrl + C）

  • 语法：unippt.command.executeCopy()

executePaste ​

  • 描述：粘贴 （快捷键 Ctrl + V）

  • 语法：unippt.command.executePaste()

温馨提示

executeCut、executeCopy、executePaste 推荐使用快捷键完成操作， 复制粘贴的对象是幻灯片，需要鼠标悬浮到幻灯片上才可实现。

具体操作可见下示例：

executeTop ​

  • 描述：元素置顶

  • 语法：unippt.command.executeTop()

executeHoldUp ​

  • 描述：元素上移一层

  • 语法：unippt.command.executeHoldUp()

executePutDown ​

  • 描述：元素下移一层

  • 语法：unippt.command.executePutDown()

executeBottom ​

  • 描述：元素置底

  • 语法：unippt.command.executeBottom()

温馨提示

元素层级的设置，需要先有元素被选中哈！

executeHorizontLeft ​

  • 描述：元素水平居左

  • 语法：unippt.command.executeHorizontLeft()

executeHorizonCenter ​

  • 描述：元素水平居中

  • 语法：unippt.command.executeHorizonCenter()

executeHorizonRight ​

  • 描述：元素水平居右

  • 语法：unippt.command.executeHorizonRight()

executeVerticalTop ​

  • 描述：元素垂直置顶

  • 语法：unippt.command.executeVerticalTop()

executeVerticalCenter ​

  • 描述：元素垂直居中

  • 语法：unippt.command.executeVerticalCenter()

executeVerticalBottom ​

  • 描述：元素垂直置底

  • 语法：unippt.command.executeVerticalBottom()

温馨提示

设置元素的水平垂直位置时，需要先选中元素哈！

executeAnimation ​

  • 描述：打开动画设置面板

  • 语法：unippt.common.executeAnimation()

  • 输出:

温馨提示

该方法仅用于打开动画设置面板哈，具体的动画设置需要在面板中进行操作。

executeOpenSetting ​

  • 描述：打开属性设置面板

  • 语法：unippt.command.executeOpenSetting()

  • 输出:

温馨提示

该方法仅用于打开属性设置面板哈，具体的属性设置需要在面板中进行操作。

executeUpdateShapeOptions ​

  • 描述：更新元素属性

  • 语法：unippt.command.executeUpdateShapeOptions(options: IShapeOptions)

  • 参数：

ts
/** 更新元素属性 */
export type IShapeOptions = {
  x?: number;
  y?: number;
  text?: string;
  fill?: string;
  width?: number;
  height?: number;
  stroke?: string;
  fontSize?: number;
  textColor?: string;
  strokeWidth?: number;
  hiddenStroke?: boolean;
  strokeType?: "dash" | "solid";
};
  • 示例：
ts
// 设置元素属性也是需要先选中元素哈！
unippt.command.executeUpdateShapeOptions({x:100}) // 更新元素位置 x
unippt.command.executeUpdateShapeOptions({text:"hello world"}) // 更新元素文本
  • 输出:

executeInsertImage ​

  • 描述：插入图片

  • 语法：unippt.command.executeInsertImage()

  • 输出:

注意

在线图片资源会出现请求跨域问题，因此不提供直接式URL图片插入，请先保存本地后再执行插入。

executeInsertMedia ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeInsertLatex ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeInsertTable ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeInsertChart ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeInsertRichText ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出:

executeDeleteGraph ​

  • 描述：

  • 语法：

  • 参数：

  • 返回值：

  • 示例：

  • 输出: