About the Yellowfin JavaScript API
The Yellowfin JavaScript API can be used for two main purposes:-
- It can be used to create custom logic in a Code-Mode Dashboard from within Yellowfin - this can allow customisation of the User Experience within Yellowfin, or can be used to embed application logic into a Dashboard.
- It can be used to embed Yellowfin content into your web application and to manipulate that content. Yellowfin content that can be embedded in this way includes Reports (tables, charts and canvas) as well as entire dashboards (both Canvas and traditional grid style).
The API supports two broad methods for embedding content:-
- Embed links - this link can be obtained from within the Yellowfin application, and used to simply embed a report, chart or dashboard into your application. Various parameters can be appended to the link to provide some control over the look and behaviour of the embedded content.
- Advanced API - the advanced API allows more dynamic and flexible control over embedded content. A rich set of API functions are available that allow many elements of embedded content to be programmatically controlled.
Note: Version 3 of this API was first released with Yellowfin Version 9, and supersedes and replaces the existing Version 2 API. Until otherwise advised, the Version 2 API will continue to be supported but will not be enhanced. Information on this legacy API can be found by searching previous versions of the wiki.