Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to reflect changes with Base/Advanced API page

...

&showShare=true

&showShare=false



...


Embedding stories

From Yellowfin 9.4, you can embed a story with the publish UUID of the story. The embed URL would look like this:

<script src="http://pathToYourYellowfinServer/JsAPI/v3?StoryUUID=A-Story-UUID">>

This creates an element for the story to render into. 

Note that although the code includes 'StoryUUID', this is actually the publish UUID. Using a story's StoryUUID is possible, but it points to a unique instance of the story, so if the story is edited, the embedded story would not be updated. 

A number of options, such as story width and the display of the toolbar and other elements, can be added to the embed link. Please see the section below for further details.



...


Embedding Using the Advanced API

The advanced API provides developers access to a number of objects and functions that allow fine-grained control over the look and feel of the embedded content.

...

<script src='localhost:8080/JsAPI/v3'/></script>
<script>
         window.yellowfin.init().then(() => {
               //The API has loaded

         })
</script>





...


Embedding stories with the Advanced API

From Yellowfin 9.4, you can embed a story with the publish UUID of the story, as described earlier on this page. For full details, visit the wiki page for the Advanced API.