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

1 初始化


var doc = new VhallDoc({
	docNode:'my-doc',//文档容器
	width:'800'//文档显示的宽度,非必填
	height:'450'//文档显示的高度,非必填
});

参数说明

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

2 设置画笔大小

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

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

3 设置画笔颜色


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

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

4 设置文字


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

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

5 设置橡皮擦

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

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

6 重置画笔

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

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

7 清除画板


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

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

8 取消画笔


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

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

9 上一张◀️


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

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

10 下一张▶️


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

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

11 上一步


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

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

12 下一步


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

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

13 调转至第N页


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

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

14 获取缩略图列表


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

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

15 动态设置画板大小


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

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

16 加载文档


    /**
     * 加载文档,支持动态加载
     * @param  {string} docId  文档ID
     * @param  {string} channelId 频道ID
     */
    _self.loadDoc(docId,channelId)
	

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