Page History
| Table of Contents | ||
|---|---|---|
|
About the Yellowfin JavaScript API
The Yellowfin JavaScript API can be used for two main purposesto:
- It can be used to create custom logic in a Code Mode dashboard from within Yellowfin - this can allow customization of (to customize the user experience within Yellowfin, or can be used to embed application logic into a dashboard.); and,
- It can be used to embed Yellowfin content into your other web application applications and to manipulate that content . Yellowfin content that can be embedded in this way includes — including reports (tables, charts and canvas) as well as entire dashboards (both Canvas canvas and traditional grid style).
...
| Note |
|---|
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 here. |
About this guide
This guide is divided into the following broad sections:
- An overview of how the JS API components are set up
- Using the JSAPI JS API in a Code Mode Dashboard
- Using the JSAPI JS API to embed Yellowfin content. This section describes the basic prerequisites required to use the JSAPIJS API, and then provides detail on how to embed content using the Embed Link method and the Advanced API method.
- Detailed API references for each sub-API, including:
- The Base Advanced API
- Dashboards API
- Sub Tabs API
- Reports Report API
- Filters APIFilter Objects
- LoaderEvents API
- Widget API
Each API reference contains:- An overview and a description of the purpose of the API
- Any properties if applicable
- A function reference (Description, parameters, returns, code snippet)
- An event reference
- Limitations - such as whether a feature can be used in code moremode, embedding mode or both.
Prerequisites
Enabling CORS
The Yellowfin JavaScript API is dependent on Cross Origin Resource Sharing(CORS). By default, any CORS request that is made to the Yellowfin server will be rejected. The first thing you will need to do is enable CORS requests from the server you will be using the JsAPI JS API on.
You can do this by going to the Admin Console in Yellowfin and adding the server URL(s) to the general configuration options Allowed Origins field. This can be found in Administration -> Configuration -> System -> General Settings
You may enter more than one URL.
Once this is enabled on your Yellowfin server you can start to embed your content.
Creating Yellowfin Content
Any content that you want to embed, will first need to be created to be embedded must first exist in Yellowfin. The various techniques involved in creating Yellowfin content, such as Data Source Connections, Views, Reports, Charts and Dashboards - data source connections, views, reports, charts and dashboards, are all fully described elsewhere in the this wiki.