[]
        
(Showing Draft Content)

仪表板参数传递方法

仪表板设计中经常需要设置仪表板参数用于过滤数据。

如果仪表板带有参数,那么您在进行URL集成时可以通过在URL中追加参数信息的方式直接将参数值传给仪表板。

操作方法

追加到URL中的仪表板参数形式与报表参数相同,具体如下:

&dp={"参数1名称":["参数1值1","参数1值2","参数1值3"],"参数2名称":["参数2值1","参数2值2","参数2值3"]}

其中:

  • (a)&dp={}是固定的QueryString内容,大括号内为参数内容。

  • (b)多个参数之间使用逗号分隔。

  • (c)参数名与参数值之间以冒号分隔。

  • (d)参数名与参数值须用双引号括起来(若参数值为整型则不需要引号)。

  • (e)即使是单值参数,其参数值也需要用方括号括起来。

  • (f)追加到URL字串之前,应使用工具或代码,对追加内容进行URL编码。

例1:

&dp={"TypeID":[1,3,6],"pname":["汁"]}

以上字串设置了两个参数:TypeID和pname,前者是多值参数,参数值为三个整数(1,3,和6)构成的数组;后者是单值参数,参数值为字符串“汁”。

例2:

&dp={"p1":["华东"],"date1":["2017-03-10T00:00:00"],"date2":["2017-05-10T00:00:00"]}

以上字串设置了三个参数:p1、date1和date2。其中date1和date2是日期时间型参数,对于日期时间型参数,参数值必须使用上例中所示的格式即yyyy-MM-ddTHH:mm:ss的形式。

而对于日期型的参数,参数值也需使用yyyy-MM-dd的形式进行传递。

注意

为了防止参数串中的内容导致URL非法,必须将参数字串经过URLEncode编码。在线URL编码工具,例如:http://tool.chinaz.com/tools/urlencode.aspx

上面的字串{"TypeID":[1,3,6],"pname":["汁"]}经过URL编码,结果如下:

%7b%22TypeID%22%3a%5b1%2c3%2c6%5d%2c%22pname%22%3a%5b%22%e6%b1%81%22%5d%7d

在原始默认的URL末尾追加参数内容之后,得到的URL字串形如:

http://localhost:51980/dashboards/view/0bead052-d56a-4fac-897b-a2984c0208e3?theme=default&lng=zh&dp=%7b%22TypeID%22%3a%5b1%2c3%2c6%5d%2c%22pname%22%3a%5b%22%e6%b1%81%22%5d%7d