SDK说明文档

概述

Tiger BI的SDK是面向网页开发者提供的JS网页开发工具包。通过使用SDK,网页开发者只需几分钟、几行代码,即可轻松地为任何三方平台接入Tiger BI的看板,以满足不同的应用场景。此文档面向网页开发者介绍SDK如何使用及相关注意事项。

步骤一:创建看板

先注册并登录Tiger BI平台,按照帮助文档的步骤创建并编辑好自己需要接入的看板,每个看板都会有一个分享码。

步骤二:引入JS文件

在需要接入看板的项目页面中引入JS文件:https://bi.tigerbi.cn/tigerbi.sdk.js

<html>
    <head>
        <script src="https://bi.tigerbi.cn/tigerbi.sdk.js"></script>
    </head>
    <body>
    </body>
</html>

步骤三:初始化并成功接入看板

创建一个object标签,然后通过SDK提供的TigerbiInsertUrl方法传入步骤一的分享码获取url即可成功接入看板。以VUE为例:

<template>
    <object :data="tigerUrl"></object>
</template>

<script>
export default {
    data() {
        return {
            tigerUrl: ""
        }
    },
    mounted() {
        this.tigerUrl = TigerbiInsertUrl({shareNumber: "5MXEAVF4"})
    }
}
</script>

TigerbiInsertUrl方法参数说明

TigerbiInsertUrl方法可以接收两个参数,数据参数和样式参数,详情如下:

参数字段类型是否必须说明
数据参数shareNumberstring步骤一中的看板分享码
paramsobject请求看板时,sql语句中的字段替换值,支持多字段
样式参数headerboolean是否显示Tiger BI页面头部
paddingstring看板边距
backgroundColorstring看板背景色
overflowYstring看板纵向滚动条设置

例如:

TigerbiInsertUrl(
    {
        shareNumber: "5MXEAVF4",
        params: {
            userId: 1
        }
    },
    {
        header: false,
        padding: "10px 20px",
        backgroundColor: "transparent",
        overflowY: "scroll"
    }
)