TEduBoard

var teduBoard = new TEduBoard(initParams);

Members

(static, constant) EVENT :string

Properties:

Type:

• string

(static, constant) TEduBoardAccessibleOperation :number

Properties:

Type:

• number

(static, constant) TEduBoardArrowType :number

Properties:

Type:

• number

(static, constant) TEduBoardAudioStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardBackgroundH5Status :number

Properties:

Type:

• number

(static, constant) TEduBoardBackgroundType :number

Properties:

Type:

• number

(static, constant) TEduBoardClassGroupOperationType :number

Properties:

Type:

• number

(static, constant) TEduBoardContentFitMode :number

Properties:

Type:

• number

(static, constant) TEduBoardElementType :number

Properties:

Type:

• number

(static, constant) TEduBoardErasableElementType :number

Properties:

Type:

• number

(static, constant) TEduBoardErrorCode :number

Properties:

Type:

• number

(static, constant) TEduBoardFileType :number

Properties:

Type:

• number

(static, constant) TEduBoardFillType :number

Properties:

Type:

• number

(static, constant) TEduBoardH5FileStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardH5PPTMediaStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardH5PPTStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardImageFitMode :number

Properties:

Type:

• number

(static, constant) TEduBoardImageStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardLayerElementType :number

Properties:

Type:

• number

(static, constant) TEduBoardLineType :number

Properties:

Type:

• number

(static, constant) TEduBoardLogLevel :number

Properties:

Type:

• number

(static, constant) TEduBoardMathGraphCode :number

Properties:

Type:

• number

(static, constant) TEduBoardMathGraphType :number

Properties:

Type:

• number

(static, constant) TEduBoardOvalDrawMode :number

Properties:

Type:

• number

(static, constant) TEduBoardPenFittingMode :number

Properties:

Type:

• number

(static, constant) TEduBoardPosition :number

Properties:

Type:

• number

(static, constant) TEduBoardRemoteCursorAction :number

Properties:

Type:

• number

(static, constant) TEduBoardServiceType :string

Properties:

Type:

• string

(static, constant) TEduBoardTextComponentStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardTextStyle :number

Properties:

Type:

• number

(static, constant) TEduBoardToolType :number

Properties:

Type:

• number

(static, constant) TEduBoardUploadStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardVideoStatus :number

Properties:

Type:

• number

(static, constant) TEduBoardWarningCode :number

Properties:

Type:

• number

(static, constant) TEduDrawStatusCode :number

Properties:

Type:

• number

(static, constant) TEduElementOperatorType :number

Properties:

Type:

• number

(static, constant) TEduMathToolType :number

Properties:

Type:

• number

(static, constant) TEduSnapshotCode :number

Properties:

Type:

• number

Methods

(static) getVersion() → {string}

Returns:

Type

string

addAckData(data)

Parameters:

addBackupDomain(domain, backup, priorityopt)

Example

// 示例一

teduBoard.setBackgroundImage('https://test.qcloudtiw.com/raw/36d31e0d6f9d24a9b5727ab5e21b4b8c.jpg')
teduBoard.addBackupDomain('https://test.qcloudtiw.com', 'https://main.qcloudimg.com')

// 1. 当访问https://test.qcloudtiw.com/raw/36d31e0d6f9d24a9b5727ab5e21b4b8c.jpg失败时
// 2. SDK会读取预设置的域名映射表,找到https://test.qcloudtiw.com的备用域名（https://main.qcloudimg.com）
// 3. 使用备用域名URL(https://main.qcloudimg.com/raw/36d31e0d6f9d24a9b5727ab5e21b4b8c.jpg)进行重试
// 4. 若资源加载成功，后续位于主域名（https://test.qcloudtiw.com）的资源将优先使用备用域名（https://main.qcloudimg.com）进行加载
// 5. 若加载失败，则将资源域名重新设置为初始主域名（https://test.qcloudtiw.com）

Parameters:

addBoard(options) → {string}

Parameters:

Returns:

Type

string

addBoardToClassGroup(groupId, boardId)

Example

teduBoard.addBoardToClassGroup('group1', '#DEFAULT')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

addElement(type, url, options) → {string}

Examples

// 示例一：添加一个图片元素(等价于addImageElement)
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_IMAGE, 'https://main.qcloudimg.com/raw/be5d8bc407204d0e1dea30bacd6d006b.png', { left: '100px', top: '100px' })

 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例二：添加一个h5元素
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_H5, 'https://www.qq.com')

 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例三：添加一个自定义图形
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_CUSTOM_GRAPH, 'https://test-1259648581.file.myqcloud.com/%E4%B8%89%E8%A7%92%E5%BD%A2.svg')
 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例四：添加一个音频元素（归属于当前白板，带控制面板）
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_AUDIO, 'https://test-1259648581.file.myqcloud.com/%E6%A2%81%E9%9D%99%E8%8C%B9%20-%20%E6%83%85%E6%AD%8C.mp3')
 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例五：添加一个全局音频元素(全局音频元素，不带操作面板)
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GLOBAL_AUDIO, 'https://test-1259648581.file.myqcloud.com/%E6%A2%81%E9%9D%99%E8%8C%B9%20-%20%E6%83%85%E6%AD%8C.mp3')
 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例六：添加一个数学函数画板和数学图像
// 添加数学画板
const mathBoardElementId = teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_MATH_BOARD, {
  boundingbox: [-5, 5, 5, -5], // 画板显示区域的左上角和右下角, 对应 [x1, y1, x2, y2]
  axisColor: '#AEAEAE', // 画板坐标系颜色
  axis: true,  // 是否显示坐标轴
  grid: true,  // 是否显示网格
  width: '300px', // 画板宽度，支持像素或百分比，若不填写单位默认按像素计算
  height: '300px', // 画板高度，支持像素或百分比，若不填写单位默认按像素计算
  showControl: true, // 是否显示控制栏
  enableZoom: false, // 是否开启鼠标滚轮缩放（需要按住Shift）
  enablePan: false, // 是否开启鼠标拖拽平移（需要按住Shift）
})

// 添加数学图像
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_MATH_GRAPH, {
  mathBoardId: mathBoardElementId, // 数学函数画板的元素id
  expression: 'sin(x)', // 数学函数表达式
  color: '#ff0000', // 数学函数图像颜色
  selectedColor: '#00ff00', // 数学函数图像选中时的颜色
})

// 同一画板添加多个数学图像
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_MATH_GRAPH, {
  mathBoardId: mathBoardElementId, // 数学函数画板的元素id
  expression: 'sin(x) + 1', // 数学函数表达式
  color: '#0000ff', // 数学函数图像颜色
  selectedColor: '#00ff00', // 数学函数图像选中时的颜色
})

// 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例七：添加一个公式元素（确保配置初始化参数formulaEnable为true，否则会添加失败）
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_FORMULA, {
  expression: 'f(x) = \\int_{-\\infty}^\\infty \\hat{f}(\\xi)\\,e^{2 \\pi i \\xi x} \\,d\\xi'
})
 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例八：添加一个文本元素
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_TEXT, {
  textContent: 'test',   // 文本内容
  fontColor: '#ff0000',  // 文本颜色
  fontSize: 200,         // 文本大小
  fontFace: 'customFontFamily', // 文本字体库
  fontStyle: TEduBoard.TEduBoardTextStyle.TEDU_BOARD_TEXT_STYLE_NORMAL // 文本字体样式
})
 // 监听增加元素事件
teduBoard.on(TEduBoard.EVENT.TEB_ADDELEMENT, ({id, userData}) => {
  console.log('id:', id, ' userData:', userData);
});

// 示例九：添加图片水印
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_WATERMARK, {
    content: 'https://test-1259648581.file.myqcloud.com/image/logo.png', // 必须是https
    left: '50px',
    top: '50px',
    width: '100px',
    height: '100px',
    opacity: 0.8 // 透明度
})

// 示例十：添加静态文本水印（即文本位置不动）
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_WATERMARK, {
    content: '静态文本',
    opacity: 0.6, // 透明度
    deg: 30,
    fix: true, // 固定位置
    color: '#ff0000',
    textSize: '12px' // 字号支持12~48px
})

// 示例十一：添加动态文本水印（即文本位置按时间间隔进行随机运动）
teduBoard.addElement(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_WATERMARK, {
    content: '动态文本',
    opacity: 0.8, // 透明度 [0.1, 1]
    deg: 30,
    fix: false, // 不固定位置
	   interval: 3000, // 3s自动变换一次位置，支持 [1, 10] s
    color: '#ff0000',
    textSize: '12px' // 字号支持 [12, 48] px
})

Parameters:

Returns:

Type

string

addH5File(url, titleopt, needSwitchopt, enableDrawopt) → {string}

Example

teduBoard.addH5File('https://cloud.tencent.com/document/product/1137/37901);

Parameters:

Returns:

Type

string

addImageElement(url)

Since:

• 2.6.2

Deprecated:

• 从2.6.2起此接口被废弃，请使用 添加白板元素 接口添加图片元素

Examples

// 示例一：设置在线图片
teduBoard.addImageElement('https://main.qcloudimg.com/raw/be5d8bc407204d0e1dea30bacd6d006b.png')

// 示例二：从本地上传一个图片
teduBoard.addImageElement({
   data: document.getElementById('file_input').files[0],
   userData: 'tiw'
})

Parameters:

addImagesFile(urls, titleopt, needSwitchopt) → {string}

Example

teduBoard.addImagesFile([
    'https://test-1259648581.file.myqcloud.com/image/1.jpg',
    'https://test-1259648581.file.myqcloud.com/image/2.jpg',
    'https://test-1259648581.file.myqcloud.com/image/3.jpg',
    'https://test-1259648581.file.myqcloud.com/image/4.jpg',
    'https://test-1259648581.file.myqcloud.com/image/5.jpg',
    'https://test-1259648581.file.myqcloud.com/image/6.jpg',
])

Parameters:

Returns:

Type

string

addSnapshotMark()

Example

// 示例一
teduBoard.addSnapshotMark()

addSyncData(data)

Parameters:

addTextFontFamily(fontFace, fontUrl)

Example

teduBoard.addTextFontFamily('myFont', 'https://test.com/myfont.ttf');

Parameters:

addTranscodeFile(needSwitchopt) → {string}

Examples

// 示例一：添加文件后立刻跳转到该文件
teduBoard.addTranscodeFile({
    pages: 20,
    resolution: "960x1230",
    title: "JavaScript设计模式_带页码-1-20.pdf",
    url: "https://test-1259648581.file.myqcloud.com/ppt/gt7rongov3gvpvb3rr5c/"
})

// 示例二：添加文件后不跳转
teduBoard.addTranscodeFile({
    pages: 20,
    resolution: "960x1230",
    title: "JavaScript设计模式_带页码-1-20.pdf",
    url: "https://test-1259648581.file.myqcloud.com/ppt/gt7rongov3gvpvb3rr5c/"
}, false)

// 示例三：添加H5转码文件
teduBoard.addTranscodeFile({
    pages: 23,
    resolution: "960x540",
    title: "欢迎新同学 - 序号'.ppt",
    url: "https://test-1259648581.file.myqcloud.com/ppt/0dfmongov3gvpfs3mr5c/index.html"
})

// 示例四：2.6.0版本起，支持cos转码
teduBoard.addTranscodeFile({
    title: "欢迎新同学", // 文件标题
    url: "https://testci-1257307760.cos.ap-guangzhou.myqcloud.com/%E6%AC%A2%E8%BF%8E%E6%96%B0%E5%90%8C%E5%AD%A6%20-%20%E5%BA%8F%E5%8F%B7.ppt?for_tiw=1" // cos资源的url，且携带for_tiw=1的参数
})

Parameters:

Returns:

Type

string

addUserToClassGroup(groupId, userId)

Example

teduBoard.addUserToClassGroup('group1', 'user_2')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

addVideoFile(url, titleopt, needSwitchopt) → {string}

<script src="https://res.qcloudtiw.com/board/third/videojs/1.0.0/video.min.js"></script>
<link href="https://res.qcloudtiw.com/board/third/videojs/1.0.0/video-js.min.css" rel="stylesheet">

Example

// 示例一
teduBoard.addVideoFile('https://test-1259648581.file.myqcloud.com/%E8%85%BE%E8%AE%AF%E6%95%99%E8%82%B2.mp4')

Parameters:

Returns:

Type

string

applyFileTranscode()

Since:

• 2.6.5

Deprecated:

• 从2.6.5起此接口被废弃，请使用腾讯云文档转码服务进行文档转码

autoSelectedElement(elementId)

Parameters:

cancelSelect(type)

Example

// 示例一 取消所有画线涂鸦的选框
teduBoard.cancelSelect(TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE)

Parameters:

clear(clearBackground, clearSelectedOnly)

Parameters:

clearFileDraws(fileId)

Parameters:

deleteBoard(boardId)

Parameters:

deleteFile(fileId)

Parameters:

destroy()

disablePermissionChecker(permissions)

Example

// 去掉添加白板的权限校验（允许所有人添加白板）
teduBoard.disablePermissionChecker(['Board::Add']);

Parameters:

disablePointerEventResponding(disable)

Parameters:

enableAudioControl(enable)

Parameters:

enableMultiTouch(enable)

Parameters:

enablePenAutoFit(enable, delayopt)

Example

// 示例一：启用自动拟合
teduBoard.enablePenAutoFit(true, 2000);

Parameters:

enablePermissionChecker(permissions, filters)

Example

// 场景1：房间里有教师T、学生A。赋予 T 文件，白板，元素操作权限，禁用 A 的全部权限
teduBoard.enablePermissionChecker(['File::*::*', 'Board::*::*', 'Element::*::*'], ['operator/T']);

// 场景2：房间里有教师T、学生A、学生B。TAB 均赋予元素的操作权限
// 方式一 : 三人均设置
teduBoard.enablePermissionChecker(['Element::*::*'], ['operator/A,B,T']);  // T，A，B用户都调用
// 方式二： 分别设置
teduBoard.enablePermissionChecker(['Element::*::*'], ['operator/T']); // T用户调用
teduBoard.enablePermissionChecker(['Element::*::*'], ['operator/A']); // A用户调用
teduBoard.enablePermissionChecker(['Element::*::*'], ['operator/B']); // B用户调用

// 场景3：房间里有教师T、学生A、学生B。T能删除所有人创建的元素（T自己、A、B），A只能删除A自己创建的元素, 不能删除其他人的创建的元素, B不能删除任何人的元素；
teduBoard.enablePermissionChecker(['Element::Delete::*'], ['creator/*']); // T用户调用
teduBoard.enablePermissionChecker(['Element::Delete::*'], ['creator/A']); // A用户调用
teduBoard.enablePermissionChecker(['Element::Delete::*'], ['creator/']); // B用户调用

// 场景4：房间里有学生A、学生B、学生C。只允许 A 删除 A 和 B 创建的元素, 不能删除 C 创建元素；
// 只允许操作人是A && 创建人是A|B
teduBoard.enablePermissionChecker(['Element::Delete::*'], ['operator/A', 'creator/A,B']); // A B C用户均按下面方式设置


// 场景5：房间里有教师T、学生A、学生B。T 只能操作 B 创建的元素,
teduBoard.enablePermissionChecker(['Element::*::*'], ['creator/B']); // T用户调用

// 场景6：禁用当前用户的全部操作
// 'operator/' 表示对于操作者（operator）这个条件，符合的值是空的，意味着没有操作者能够被允许通过这个权限校验
teduBoard.enablePermissionChecker(['*::*::*'], ['operator/']);


// 场景7：启用当前用户的全部操作
// 'operator/*' 表示对于操作者（operator）这个条件，符合的值是任意的，意味着所有操作者能够被允许通过这个权限校验
teduBoard.enablePermissionChecker(['*::*::*'], ['operator/*']);


// 场景8：房间里有学生A。学生A允许跳转动画步数，但不能翻页
teduBoard.enablePermissionChecker(['Board::Switch::Step'], ['operator/A']);
teduBoard.enablePermissionChecker(['Board::Switch::Page'], ['operator/']);

// 场景9：房间内有学生A。不允许学生A操作尺规工具，只允许观看
teduBoard.enablePermissionChecker(['Element::Update::MathTool'], ['operator/']);

Parameters:

enableShowGraffiti(enable)

Parameters:

exportData()

Deprecated:

• 废弃接口，请使用 exportInLocalMode

exportInLocalMode(filter)

Example

// 示例一： 只导出指定的元素类型
teduBoard.exportInLocalMode({
    include: {
        // 只导出画笔涂鸦和图片元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE, TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_IMAGE]
    }
})
// 示例二： 只导出指定的元素类型和元素ID
teduBoard.exportInLocalMode({
    include: {
        // 只导出画笔涂鸦类型和元素id为xxxxxxx的元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE],
        ids: ['xxxxxxx']
    }
})
// 示例三：所有元素都不要导出
teduBoard.exportInLocalMode({
    include: {
        // 传一个不存在的元素类型，就可以实现不导出所有元素
        types: [-1],
    }
})
// 示例四：不导出画笔涂鸦
teduBoard.exportInLocalMode({
    exclude: {
        // 排除画笔涂鸦
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    }
})
// 示例五：导出画笔涂鸦，并将其隐藏
teduBoard.exportInLocalMode({
    hide: {
        // 隐藏元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    }
})
// 示例六：导出画笔元素，不导出图片元素
teduBoard.exportInLocalMode({
   include: {
        // 只导出画笔涂鸦
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    },
  exclude: {
       // 不导出图片元素
       types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_IMAGE]
  }
})

Parameters:

getAllClassGroupIds() → {Array.<string>}

Example

teduBoard.getAllClassGroupIds()

Returns:

Type

Array.<string>

getAudioVolume(elementId) → {number}

Parameters:

Returns:

Type

number

getBackgroundColor() → {string}

Returns:

Type

string

getBackgroundImage(boardId) → {BackgroundImageInfo}

Parameters:

Returns:

Type

BackgroundImageInfo

getBoardClientSize()

Returns:

getBoardContentFitMode() → {number}

Returns:

Type

number

getBoardElementList(boardId, includeHideElement) → {Array.<Element>}

Parameters:

Returns:

Type

Array.<Element>

getBoardList() → {Array.<string>}

Returns:

Type

Array.<string>

getBoardRatio() → {string}

Returns:

Type

string

getBoardRemark(boardId) → {Object}

Example

// 示例一
// 获取指定的白板备注
teduBoard.getBoardRemark(teduBoard.getCurrentBoard())

// 示例二
// 获取所有设置过白板备注
const boardRemark = teduBoard.getBoardRemark(); // {'boardId1': 'remark1', ''boardId2': 'remark2'}

Parameters:

Returns:

Type

Object

getBoardScale() → {number}

Returns:

Type

number

getBoardScroll() → {Object}

Example

// scrollLeft, scrollTop 以百分比形式展示，范围在 [0,1]
const { scrollLeft, scrollTop } = teduBoard.getBoardScroll();

Returns:

Type

Object

getBrushColor() → {string}

Returns:

Type

string

getBrushThin() → {number}

Returns:

Type

number

getClassGroupEnable() → {boolean}

Example

teduBoard.getClassGroupEnable()

Returns:

Type

boolean

getClassGroupIdByUserId(userId) → {Array.<string>}

Example

teduBoard.getClassGroupIdByUserId('user_1')

Parameters:

Returns:

Type

Array.<string>

getClassGroupInfoByGroupId(groupId) → {object}

Example

const data = teduBoard.getClassGroupInfoByGroupId('group1');
const { classGroupId, boardIds, userIds, currentBoardId, title, currentPage, currentStep } = data;

Parameters:

Returns:

Type

object

getCurrentBoard() → {string}

Returns:

Type

string

getCurrentFile() → {string}

Returns:

Type

string

getElementById(elementId) → {TEduBoardElement}

Parameters:

Returns:

Type

TEduBoardElement

getEraserSize() → {number}

Returns:

Type

number

getFileBoardList(fileId) → {Array.<string>}

Parameters:

Returns:

Type

Array.<string>

getFileInfo(fileId) → {FileInfo}

Parameters:

Returns:

Type

FileInfo

getFileInfoList() → {Array.<FileInfo>}

Returns:

Type

Array.<FileInfo>

getFileScale(fid)

Parameters:

getGlobalBackgroundColor() → {string}

Returns:

Type

string

getGlobalBackgroundPic() → {object}

Returns:

Type

object

getGraphStyle() → {graphStyle}

Returns:

Type

graphStyle

getHighlighterColor() → {string}

Returns:

Type

string

getLineStyle()

Deprecated:

• 从2.7.7起此接口被废弃，请使用getGraphStyle接口

getOvalDrawMode() → {number}

Returns:

Type

number

getPPTRemarks(fid, pageIndex) → {Object}

Example

teduBoard.on(TEduBoard.EVENT.TEB_H5PPT_STATUS_CHANGED, (status, data) => {
  if (status === TEduBoard.TEduBoardH5PPTStatus.TEDU_BOARD_H5_PPT_STATUS_LOADED) {
  // 示例一：获取指定课件的所有备注
  teduBoard.getPPTRemarks(fid, -1);

   // 示例二：获取指定页的备注，如获取第5页
  teduBoard.getPPTRemarks(fid, 4);
  }
});

Parameters:

Returns:

Type

Object

getSyncTime() → {Number}

Returns:

Type

Number

getTextColor() → {string}

Returns:

Type

string

getTextFontFamily() → {string}

Example

const fontFamily = teduBoard.getTextFontFamily();

Returns:

Type

string

getTextLineHeight() → {number}

Returns:

Type

number

getTextSize() → {number}

Returns:

Type

number

getTextStyle() → {number}

Returns:

Type

number

getThumbnailImages(fileId) → {Array.<string>}

Parameters:

Returns:

Type

Array.<string>

getToolType() → {number}

Returns:

Type

number

gotoBoard(boardId, resetStepopt)

Parameters:

gotoClassGroupBoard(boardId)

Example

teduBoard.gotoClassGroupBoard('#DEFAULT')

Parameters:

gotoStep(boardId, step)

Example

teduBoard.gotoStep(boardId, 1);

Parameters:

importData()

Deprecated:

• 废弃接口，请使用 importInLocalMode

importInLocalMode(data, filter, Array, Array, Array, Array, Array, Array)

Example

// 示例一： 只导入指定的元素类型
teduBoard.importInLocalMode({
    include: {
        // 只导入画笔涂鸦和图片元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE, TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_IMAGE]
    }
})
// 示例二： 只导入指定的元素类型和元素ID
teduBoard.importInLocalMode({
    include: {
        // 只导入画笔涂鸦类型和元素id为xxxxxxx的元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE],
        ids: ['xxxxxxx']
    }
})
// 示例三：所有元素都不要导入
teduBoard.importInLocalMode({
    include: {
        // 传一个不存在的元素类型，就可以实现不导入所有元素
        types: [-1],
    }
})
// 示例四：不导入画笔涂鸦
teduBoard.importInLocalMode({
    exclude: {
        // 排除画笔涂鸦
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    }
})
// 示例五：导入画笔涂鸦，并将其隐藏
teduBoard.importInLocalMode({
    hide: {
        // 隐藏元素
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    }
})
// 示例六：导入画笔元素，不导入图片元素
teduBoard.exportInLocalMode({
   include: {
        // 只导入画笔涂鸦
        types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_GRAFFITI_LINE]
    },
  exclude: {
       // 不导入图片元素
       types: [TEduBoard.TEduBoardElementType.TEDU_BOARD_ELEMENT_IMAGE]
  }
})

Parameters:

isDataSyncEnable() → {boolean}

Returns:

Type

boolean

isDrawEnable() → {boolean}

Returns:

Type

boolean

isHandwritingEnable() → {boolean}

Returns:

Type

boolean

isPiecewiseErasureEnable()

Returns:

lockElements(elementIds, locked)

Parameters:

muteAudio(elementId, muted)

Parameters:

muteVideo(muted)

Parameters:

nextBoard(resetStepopt)

Parameters:

nextStep()

off(name, callback)

Examples

// 示例一：注销TEduBoard.EVENT.TEB_INIT的指定的事件监听
teduBoard.off(TEduBoard.EVENT.TEB_INIT, cb)

// 示例二: 注销TEduBoard.EVENT.TEB_INIT的所有事件监听
teduBoard.off(TEduBoard.EVENT.TEB_INIT)

// 示例三：注销所有的事件监听
teduBoard.off()

Parameters:

on(name, callback)

Example

var cb = (code, message) => { };
teduBoard.on(TEduBoard.EVENT.TEB_INIT, cb)

Parameters:

pauseAudio(elementId)

Parameters:

pauseH5PPTAudio(videoIDs)

Example

// 暂停当前页第一个音频
teduBoard.pauseH5PPTAudio(teduBoard.getFileInfo().pptMediaInfo.audioIDList)

Parameters:

pauseH5PPTVideo(videoIDs)

Example

// 暂停当前页第一个视频
teduBoard.pauseH5PPTVideo(teduBoard.getFileInfo().pptMediaInfo.videoIDList)

Parameters:

pauseVideo()

playAudio(elementId)

Parameters:

playH5PPTAudio(videoIDs)

Example

// 播放当前页第一个音频
teduBoard.playH5PPTAudio(teduBoard.getFileInfo().pptMediaInfo.audioIDList)

Parameters:

playH5PPTVideo(videoIDs)

Example

// 播放当前页第一个视频
teduBoard.playH5PPTVideo(teduBoard.getFileInfo().pptMediaInfo.videoIDList)

Parameters:

playVideo()

prevBoard(resetStepopt)

Parameters:

prevStep()

redo()

refresh()

Example

// =================  通常结合白板错误码使用 ===============

var notifyBoardException = function() {
 // 注意： 以下几行代码主要演示监听到异常，引导用户手动触发refresh接口重新渲染白板，这几行代码在您的环境中运行通不过，是正常现象
        MessageBridge.showMessageBox({
          title: '检测到白板页面异常，请刷新后继续使用',
          options: ['刷新', '取消'],
          callback: index => {
            if (index === 0) {
              teduBoard.refresh();
            }
          }
        })
        // 以上几行代码主要演示监听到异常，引导用户手动触发refresh接口重新渲染白板，这几行代码在您的环境中运行通不过，是正常现象
      };

// 图片状态加载回调
     teduBoard.on(TEduBoard.EVENT.TEB_IMAGE_STATUS_CHANGED, (status, data) => {
        switch(status) {
          case TEduBoard.TEduBoardImageStatus.TEDU_BOARD_IMAGE_STATUS_LOAD_ERROR:  //背景图片加载错误
          case TEduBoard.TEduBoardImageStatus.TEDU_BOARD_IMAGE_STATUS_LOAD_TIMEOUT:  //背景图片加载超时
            this.notifyBoardException();
            break;
        }
      });
  
     // h5ppt加载状态
     teduBoard.on(TEduBoard.EVENT.TEB_H5PPT_STATUS_CHANGED, (status, data) => {
        switch (status) {
          case TEduBoard.TEduBoardH5PPTStatus.TEDU_BOARD_H5_PPT_STATUS_TIMEOUT: // 动画ppt加载超时
          case TEduBoard.TEduBoardH5PPTStatus.TEDU_BOARD_H5_PPT_STATUS_RESOURCES_LOADING_ERROR: // 动画ppt加载错误
          case TEduBoard.TEduBoardH5PPTStatus.TEDU_BOARD_H5_PPT_STATUS_RUNTIME_ERROR: // 动画ppt内部错误
            this.notifyBoardException();
            break;
        }
      });
  
     // mp4文件
     teduBoard.on(TEduBoard.EVENT.TEB_VIDEO_STATUS_CHANGED, data => {
        let status = data.status;
        switch (status) {
          case TEduBoard.VIDEO_STATUS.TEDU_BOARD_VIDEO_STATUS_ERROR: // 播放视频错误
            this.notifyBoardException();
            break;
        }
      });

removeBackupDomain(domain, backupopt)

Example

// 示例一
// 删除https://test.qcloudtiw.com的备用域名https://main.qcloudimg.com
teduBoard.removeBackupDomain('https://test.qcloudtiw.com', 'https://main.qcloudimg.com')

// 示例二
// 删除https://test.qcloudtiw.com的所有备用域名
teduBoard.removeBackupDomain('https://test.qcloudtiw.com')

Parameters:

removeBoardInClassGroup(groupId, boardId)

Example

teduBoard.removeBoardInClassGroup('group1', '#DEFAULT')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

removeClassGroup(groupId)

Example

teduBoard.removeClassGroup('group1')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

removeElement(id) → {boolean}

Parameters:

Returns:

Type

boolean

removeUserInClassGroup(groupId, userId)

Example

teduBoard.removeUserInClassGroup('group1', 'user_2')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

reset()

resetClassGroup()

Example

teduBoard.resetClassGroup()

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

resetPermissionChecker(permissions)

Parameters:

resize()

seekAudio(elementId, progress)

Parameters:

seekVideo(time)

Parameters:

setAccessibleUsers(users, operationType)

Deprecated:

• 接口自2.8.0版本开始废弃，请使用enablePermissionChecker接口代替，请参考互动白板权限控制文档。

Parameters:

setAudioVolume(elementId, volume)

Parameters:

setBackgroundColor(color)

Examples

// 示例一
teduBoard.setBackgroundColor('#ff0000')

// 示例二
teduBoard.setBackgroundColor('rgba(ff, 00, 00, 0.5)')

Parameters:

setBackgroundH5(url)

Example

teduBoard.setBackgroundH5('https://cloud.tencent.com/document/product/1137/37901')

Parameters:

setBackgroundImage(url, modeopt)

Examples

// 示例一: 图片居中显示
teduBoard.setBackgroundImage('https://main.qcloudimg.com/raw/d3f7c4fe9096f86fe11db9c75d6f5ebc.png', TEduBoard.TEduBoardImageFitMode.TEDU_BOARD_IMAGE_FIT_MODE_CENTER)

// 示例二：图片居左显示
teduBoard.setBackgroundImage('https://main.qcloudimg.com/raw/20db9863af9f7e57a7be64dbac685691.png', TEduBoard.TEduBoardImageFitMode.TEDU_BOARD_IMAGE_FIT_MODE_LEFT)

Parameters:

setBackgroundImageAngle(angle)

Parameters:

setBoardContentFitMode(mode)

Deprecated:

• since version 2.0.0

Example

teduBoard.setBoardContentFitMode(TEduBoard.TEduBoardContentFitMode.TEDU_BOARD_FILE_FIT_MODE_NONE)

Parameters:

setBoardRatio(ratio)

Example

teduBoard.setBoardRatio('16:9')

Parameters:

setBoardRemark(boardId, remark)

Example

// 示例一
// 为某个白板设置备注, 当前白板可省略boardId参数
const boardId = teduBoard.getCurrentBoard()
teduBoard.setBoardRemark(boardId, 'remark')

Parameters:

setBoardScale(scale)

Parameters:

setBrushColor(color)

Examples

// 示例一
teduBoard.setBrushColor('#ff0000')

// 示例二
teduBoard.setBrushColor('rgba(255, 00, 00, 1)')

Parameters:

setBrushThin(thin)

Parameters:

setClassGroup(groupId, boards, users, titleopt, currentBoardIdopt)

Example

teduBoard.setClassGroup('group1', ['#DEFAULT'], ['user_1'], 'test_group', '#DEFAULT')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

setClassGroupEnable(enable)

Example

teduBoard.setClassGroupEnable(true)

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

setClassGroupTitle(groupId, title)

Example

teduBoard.setClassGroupTitle('group1', 'test_group2')

teduBoard.on(TEduBoard.EVENT.TEB_CLASS_GROUP_STATUS_CHANGED, (data) => {
  console.log('======================:  ', 'TEB_CLASS_GROUP_STATUS_CHANGED', data);
});

Parameters:

setCursorIcon(toolType, cursorIcon)

Examples

// 示例一：设置自定义橡皮擦
teduBoard.setCursorIcon(TEduBoard.TEduBoardToolType.TEDU_BOARD_TOOL_TYPE_ERASER, {
    cursor: 'url',
    url: 'https://res.qcloudtiw.com/board/icons/eraser.png',
    offsetX: 0,
    offsetY: 0
})

// 示例二：将移动工具设置为内置鼠标move样式
teduBoard.setCursorIcon(TEduBoard.TEduBoardToolType.TEDU_BOARD_TOOL_TYPE_ZOOM_DRAG, {
    cursor: 'move'
})

Parameters: