白板

开始编辑

可选参数Betalk.annotate包括()API请求

名称 描述
IFRAME True or false 默认为false。指定要启动时间轴中iframe或在一个新的窗口
binder_id binderID 可选:如果使用的binderID启动注释
binder_name binder名称 可选:如果使用的binder名称,而不是binderID启动注释
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“假”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“真”
iframewidth iFrame的宽度 宽度注释的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为1024px。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 在注释的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为768px。如果容器控制的高度,请设置为100%

Betalk开始通过侦听器处理注释回调事件

事件 描述 属性
start_annotate 触发注释的成功的开始 SESSION_ID,binder_id
stop_annotate 在注释结束时触发 binder_id,share_url,DOWNLOAD_URL
error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE

示例代码(使用binder ID)开始注释:

var options = {
    binder_id: BINDER_ID,
    iframe: true,
    tagid4iframe: "container",
    iframewidth: "1020px",
    iframeheight: "650px",
    start_annotate: function(event) {
        alert("Annotate start: " +
        " session id: " + event.session_id +
        " binder id: " + event.binder_id);
    },
    stop_annotate: function(event) {
        alert("Annotate stop: download URL: " + event.download_url +
        " share URL: " + event.share_url +
        " binder id: " + event.binder_id);
    },
    error: function(event) {
        alert("Annotate error code: " + event.error_code + " error message: " + event.error_message);
    }
};

Betalk.annotate(options);