API Charts
API charts in the legacy agents were declared using express routes.
In the new agent, you will need to use either the agent.addChart
or the collection.addChart
function, depending on if the chart is to be displayed on a record of a collection or a dashboard.
Code cheatsheet
Legacy agent | New agent |
---|---|
router.post | agent.addChart collection.addChart(...) |
Liana.StatSerializer | return resultBuilder.value(...) return resultBuilder.distribution(...) |
request.query?.record_id | context.recordId |
How to migrate
Migrating should be straightforward: the only differences are that:
dashboard charts are now declared using the
agent.addChart
function.collection charts are now declared using the
collection.addChart
function, and access the record id usingcontext.recordId
instead ofrequest.query?.record_id
.Both types should use the
resultBuilder
helper to return the chart data.
Last updated