Harmony

Hierarchy

---

• DocumentPlayer

Index

---

Methods

addPage	canOperatePage	changePage
clearShapes	clientPrev	clientNext
deleteSelectShapes	destroy	dispatchEvent
fire	getCurrentPage	getCurrentStep
getStepCount	getTotalPage	hasPrev
hasNext	isAnimationDocument	prev
next	one	on
off	reload	removePage
sendEvent	sendMessage	setPage
setCanDrawing	setQuality	snapshot
setScale	getScale	enableSyncScroll

Methods

---

isAnimatedDocument
判断当前文档是否是动态文档

isAnimatedDocument(): boolean

返回

• boolean

---

changePage
同步翻页，翻页之后所有端会同步

changePage(page: number, step: number): Promise‹void›

参数

Name	Type	Default	Description
page	number	-	指定页码
step	number	0	指定步数（动态文档特有）

返回

• Promise‹void›

---

setPage
本地翻页，只会自己本地生效

setPage(page: number, step?: number, force?: boolean): void

参数

Name	Type	Description
page	number	指定页码
step	number	指定步数（动态文档特有）
force	boolean

返回

• void

---

sendEvent
同步事件

sendEvent(page: number, step: number, event: PPTEvent): Promise‹object›

参数

Name	Type
page	number
step	number
event	PPTEvent

返回

• Promise‹object›

---

dispatchEvent
放置一个事件

dispatchEvent(event: PPTEvent): void

参数

Name	Type	Description
event	PPTEvent

返回

• Promise‹void›

---

sendMessage
给动态文档 post 一个 message

sendMessage(message: any): void

参数

Name	Type	Description
message	any

返回

• Promise‹void›

---

reload
重新加载文档，可用于 resize 的时候调用

reload(): void

返回

• void

---

hasPrev
是否有上一步

hasPrev(): boolean

返回

• boolean

---

hasNext
是否有下一步

hasNext(): boolean

返回

• boolean

---

clientPrev
本地翻上一步，对于静态文档则翻到上一页

clientPrev(): void

返回

• void

---

clientNext
本地翻下一步，对于静态文档则翻到下一页

clientNext(): void

返回

• void

---

setCanDrawing
设置是否可以使用画笔，用于控制画笔权限

setCanDrawing(enable: boolean): void

参数

Name	Type	Description
enable	boolean

返回

• void

---

clearShapes
清空所有 shape

clearShapes(): void

返回

• void

---

deleteSelectShapes
删除选中的 shape

deleteSelectShapes(): void

返回

• void

---

getTotalPage
获取总页数

getTotalPage(): number

返回

• number

---

getCurrentPage
获取当前页码

getCurrentPage(): number

返回

• number

---

getCurrentStep
获取当前步数

getCurrentStep(): number

返回

• number

---

getStepCount
获取总步数

getStepCount(): number

返回

• number

---

canOperatePage
获取是否可以添加删除页码

canOperatePage(): boolean

返回

• boolean

---

addPage
添加一页

addPage(): Promise‹number›

返回

• Promise‹number› 添加的页码

---

removePage
删除指定的一页

emovePage(page: number): Promise‹void›

参数

Name	Type	Description
page	number	删除的页码

返回

• Promise‹void›

---

snapshot
获取文档快照（base64）

snapshot(hasImg: boolean, type: "png" | "jpeg" | "webp", quality: number): string

参数

Name	Type	Default	Description
hasImg	boolean	true	是否需要文档图片
type	"png" | "jpeg" | "webp"	"png"	生成图片格式
quality	number	1	生成图片质量

详情

• 静态文档可选择导出文档和画笔
• 动态文档只能导出画笔

返回

• string

---

destroy
销毁 DocumentPlayer 实例

destroy(): void

返回

• void

---

fire
触发一个事件

fire(type: string, data?: any): void

参数

Name	Type	Description
type	string	事件类型
data?	any	事件数据

返回

• Promise‹void›

---

next
同步翻下一步，对于静态文档则翻到下一页

next(): void

返回

• void

---

off
取消事件监听

off(type: string, listener?: Function): this

参数

Name	Type	Description
type	string	-
listener?	Function	-

返回

• this

---

on

设置事件监听

on(type: string, listener: Function, options: EmitterOptions): this

参数

Name	Type	Description
type	string	-
listener?	Function	-
options	EmitterOptions	{}

返回

• this

---

one
设置一次事件监听

one(type: string, listener: Function, options: EmitterOptions): this

参数

Name	Type	Description
type	string	-
listener?	Function	-
options	EmitterOptions	{}

返回

• this

---

prev
同步翻上一步，对于静态文档则翻到上一页

prev(): void

返回

• void

---

setQuality
设置静态文档图片质量

setQuality(quality: number): void

参数

Name	Type	Default	Description
quality	number	1	取值范围 [0.1, 1]

返回

• void

---

setScale
设置文档缩放倍数

setScale(scale: number): void

参数

Name	Type	Default	Description
scale	number	1	取值范围 [1, 3]

返回

• void

---

getScale
获取文档缩放倍数

getScale(): number

参数

返回

• number

---

enableSyncScroll
设置文档是否开启滚动同步，开启时滚动文档会同步到其他用户；否则只是自己本地滚动。建议老师开启，学生关闭

enableSyncScroll(enable: boolean): void

参数

Name	Type	Default	Description
enable	boolean	false

返回

• void

DocumentPlayerEvents

Index

---

DRAWING_END	DRAWING_START	IMAGE_SHAPE_LOAD_FAIL
LOADING_ENDED	LOADING_START	MOUSE_MOVE
PAGE_CHANGED	PAGE_COUNT_CHANGED	SELECTING_END
STEP_CHANGED

Variables

---

结束绘制

documentPlayer.on('drawing-end', () => {
  console.log('绘制结束')
});

---

开始绘制

documentPlayer.on('drawing-start', () => {
  console.log('绘制开始')
});

---

图片加载失败

documentPlayer.on('image-shape-load-fail', (event) => {
  console.log('图片添加失败', event.image)
});

---

加载结束

documentPlayer.on('loading-ended', (event) => {
  console.log('结束加载资源', event)
});

---

鼠标移动事件

documentPlayer.on('mouse-move', (event) => {
  if (event.drawing) {
     console.log(`正在绘制点 (${event.x}, ${event.y})`)
  }
});

---

页码更改

documentPlayer.on('page-changed', (event) => {
  console.log('页码更改', event)
});

---

总页数更改

documentPlayer.on('page-count-changed', (totalPage) => {
  console.log('总页数更改', totalPage)
});

---

选取结束

documentPlayer.on('selecting-end', (event) => {
  if (event.hasActive) {
     console.log('有标注被选中')
  }
});

---

步数更改

documentPlayer.on('step-changed', (event) => {
  console.log('步数更改', event)
});