...
EN | ES
A partir de la versión 1.4.0-commando, la plataforma permite la generación de un screenshot de un dashbaord dashboard en formato imagen png y en formato documento pdf, a través de un api rest una API REST habilitada para ello.
...
Como se puede observar, hay dos endpoints con dicha funcionalidad:
- generateDashboardImage
generateDashboadImage → Permite la generación
rest enREST del dashboard como una imagen png
del dashboard. Los parámetros son los siguientes:
Dashboard
IDID → id del dashboard, puede obtenerse de la
urlURL del propio dashboard:
- waittime
waittime → tiempo que se da para el renderizado del dashboard en backend
, puede ocurrir que ciertas. Ciertas queries o elementos
tardenpueden tardar en acabar, por lo que habrá que aumentar este parámetro.
height/width/
fullpage →fullpage → altura
,y anchura en píxeles, y flag para priorizar el renderizado fullscreen de la imagen resultante. Se deberán configurar estos parámetros para obtener un screenshot correcto de cada dashboard.
Params → Cuando un dashboard presenta parametría custom, puede incluirse aquí en formato url (param1=value1¶m2=value2):
- Authorization
Authorization → Token
oauthOAuth de un usuario con permisos al menos de lectura sobre el mismo.
- generatePDFImage
generatePDFImage → Permite la generación de un documento PDF Vectorial sobre el dashboard. El soporte vectorial del mismo dependerá de las librerías usadas en el dashboard
, por. Por ejemplo, una librería canvas (chartjs, echarts con render canvas, ...) nunca será vectorial
,; en cambio un librería SVG lo será (echarts con render svg, D3,...).
LoLos parámetros son análogos al de imagen, salvo el de fullscreen, que no aplica en este caso.
Finalmente invocando desde swagger el cliente Swagger o un cliente rest REST podemos obtener la imagen renderizada:
...