Get started

Live is a plugin for Diagrams webapp (opens new window) made by Zenetys (opens new window). Plugin allows to create dynamic graphs which update periodically according to data received by remote APIs.

To do this, graph nodes fetch data from remote APIs & use it to update their properties.

Go to Diagrams documentation (opens new window) to add a plugin to the webapp & see plugin GitHub repository (opens new window).

How it works

1. At the start of a cycle, an XHR request is made to an API given by the API Object live attribute stored in the graph node.
2. The API response is fetched & parsed by Live plugin.
3. Parsed data is used by Live Properties to update the live node.
4. This operation is made in each Live node & data received by one can be accessible by others thanks to API ID live attribute.
5. Cycle ends when all updates are done & restarts after a time interval set by Refresh live attribute.

Keyword definitions

Here is a list of keywords used throughout this documentation:

Graph

A graph is the diagram's field where you handle graph nodes.

Live nodes

Graph nodes which use Live plugin features. To do this, graph nodes must store at least one live attribute.

Live attributes

Attributes added to a graph node - or directly to the graph root - that defines a behavior related to the Live plugin.

Live properties

Special kind of live attributes that are added to Live nodes to edit node properties & update it.