类名 VhallDoc

说明:此接口包含两部分,2-9为对画笔的操作,10-17为对文档的操作。

方法

1. 初始化


	var doc = new VhallDoc({
		docNode:'my-doc',//文档容器
		width:'800',//文档显示的宽度,非必填
		height:'450',//文档显示的高度,非必填
		roomId:'',//直播房间Id,如果是带视频回放的文档,roomId为直播录制时对应的房间ID
		success:function(){},//成功回调
		//翻页事件,参数slideIndex为当页索引,从0开始计数,
		slideChange:function(slideIndex){},
		//动画步骤改变事件,参数stepIndex为当前步骤索引,从0开始计数
		stepChange: function(stepIndex){}
	});

参数说明

name type require description
docNode string yes 文档容器
width string no 文档显示的宽度
height string no 文档显示的高度

2. setSize

设置画笔大小

	/**
     * 设置画笔大小
     * @param {int} size 画笔大小值
     */
    doc.setSize(size); 
	

设置画笔大小, 参数为int型,如:doc.setSize(10);

3. setColor

设置画笔颜色


    /**
     * 设置画笔颜色
     * @param {string} color 画笔色值
     */
    doc.setColor(color)
	

color的值以#号开头的RGB值,如:doc.setColor("#000000")

4. setText

设置文字


    /**
     * 设置文字
     * @param {string} text 文字内容
     */
    doc.setText(text)
	

设置文字, 如:doc.setText("Hello word!")

5. setEraser

设置橡皮擦

    /**
     * 设置橡皮擦
     * @param {int} size 橡皮擦大小值
     */
    doc.setEraser(size)
	

设置橡皮擦, 参数为int型,如:doc.setEraser(10);

6. highlighters

荧光笔

    /**
     * 荧光笔,简单调用
     */
    doc.highlighters()
	
    /**
     * 荧光笔,设置画笔大小值(粗细)方式调用
     * @param {object} 参数,目前只接收size,如: { size: 12 }
     */
    doc.highlighters({
		size:12
	})
	

参数对象里,目前只接收size,如: { size: 12 }

7. reset

重置画笔

    /**
     * 重置画笔			
     * @param  {int} size  画笔尺寸
     * @param  {[int]} color [画笔颜色]
     */		
    doc.reset(size,color)
	

重新设置画笔,如:doc.reset(10,"#000000")

8. clear

清除画板


    /**
     * 清除画板
     * @return {[type]} [description]
     */
    doc.clear();
	

执行此方法后,整个画布清空。

9. cancelPencil

取消画笔


	/**
	 * 取消画笔		
	 * @param  {boolean} isCancel 是否取消,默认true
	 */	
	doc.cancelPencil();
	

执行此方法后,就取消画笔操作,恢复文档点击翻页操作。

10. preSlide

上一张◀️


	/**
	 * 上一张◀️
	 */
	doc.preSlide();
	

执行此方法,文档向上翻一张

11. nextSlide

下一张▶️


	/**
	 * 下一张▶️
	 */
	doc.nextSlide();
	

执行此方法,文档向下翻一张

12. preStep

上一步


	/**
	 * 上一步
	 */
	doc.preStep()
	

如果文档为ppt,执行此方法,文档动画向上一步,文档为非PPT,执行方法不进行任何操作。

13. nextStep

下一步


	/**
	 * 下一步
	 */
	doc.nextStep();
	

如果文档为ppt,执行此方法,文档动画向下一步,文档为非PPT,执行方法不进行任何操作。

14. gotoSlide

调转至第N页


	/**
	 * 调转至第N页
	 * @param  {[int]} index [页数索引]
	 */
	doc.gotoSlide(index);
	

执行此方法,文档跳转至第N页,参数index为页数索引,从1开始计数。

15. getThumImgList

获取缩略图列表


	/**
	 * 获取缩略图列表
	 * @return {[Array]} [缩略图列表]
	 */
	doc.getThumImgList();
	

此方法可获取当前文档缩略图列表,返回值为数组,数组元素为缩略图地址。

16. reSizeBorad

动态设置画板大小


    /**
     * 动态设置画板大小
     * @param  {number} width  画板宽度
     * @param  {number} height 画板高度
     */
    doc.reSizeBorad(width,height)
	

动态设置画板大小,参数为宽和高,建议此宽高比列为16:9,且与观看端一致。

17. loadDoc

加载文档


    /**
     * 加载文档,支持动态加载,简单调用
     * @param  {string} docId  文档ID
     * @param  {string} channelId 频道ID
     */
    doc.loadDoc(docId,channelId)
	
	
    /**
     * 加载文档,支持动态加载,带回调调用
     * @param  {string} docId  文档ID
     * @param  {string} channelId 频道ID
     */
    doc.loadDoc(docId,channelId,function(){
	
	},function(){
	
	})
	

此方法支持动态更换文档。

18. destroy

销毁文档对象

//销毁文档对象
doc.destroy();

19. setDoubleArrow

双向箭头工具

	doc.setDoubleArrow()

20. setSingleArrow

单向箭头工具

	doc.setSingleArrow()

21. setSquare

四边形工具

	doc.setSquare()

22. setCircle

圆形工具

	doc.setCircle()

23. setRightTriangle

直角三角形工具

	doc.setRightTriangle()

24. setIsoscelesTriangle

等腰三角形工具

	doc.setIsoscelesTriangle()

25. setBackgroundColor

设置背景颜色,色值支持RGB颜色与RGBA颜色 如:'#FF0000', '#FF0000FF'

	doc.setBackgroundColor(color)

26. setEditable

设置是否具有权限编辑, true | false, 该版本仅支持同时一个用户进行操作。记得合理设置编辑权限

	doc.setEditable(bool)

27. setCacheable

设置是否进行数据缓存 true | false

	doc.setCacheable(bool)