Page History
...
Ends the current user session.
yellowfin.newSession(token, org);
Returns
Promise
Description
This function logs out the current user and sends a request to the Yellowfin JS API to login a new user using the passed webservice session token. Along with the session token, this function accepts an optional client org ID so that the user can be logged into a specific client org.
When the login action has successfully completed, the function will return a promise, and any reports or dashboards on the page will be re-run.
loadReport(reportOptions)
| Anchor | ||||
|---|---|---|---|---|
|
Returns
Promise
Description
Waits for the init() promise to load and then loads a report with the passed options. Once the report has been loaded it will be appended to the passed element and the report will begin to run.
...
yellowfin.loadReport({ reportId: ‘a report id’, interactions: { drillDown: false, drillAnywhere: false, drillThrough: false, unitSelection: false, brushing: false, timeSlider: false, drillBreadcrumbs: false, seriesSelection: false, annotations: false }, element: document.querySelector(‘#reportElement’) }). |
| Styleclass | ||
|---|---|---|
| ||
loadDashboard(dashboardOptions)
Returns
Promise
Description
Waits for the init() promise to load and then loads a dashboard with the passed options. Once the dashboard has been loaded it will be appended to the passed element and the content on the dashboard will begin to run.
...
//Load the dashboard with showGlobalContentContainer option set to false |
| Styleclass | ||
|---|---|---|
| ||
| Anchor | ||||
|---|---|---|---|---|
|
...
Promise parameters: storyAPI
Description
This function loads the story associated with the passed options.storyUUID, and returns a promise that is resolved once complete.
...
Embed link option: ?StoryUUID=uuid (This is the PublishUUID for the story to be embedded: if this appears later in your query string, don't forget to change the ? to a &.)
Description
This option is required: if it is not passed, the loadStory call will fail.
...
Embed link parameter: &showToolbar=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the JS API toolbar is shown for the embedded story.
...
Embed link parameter: &showInfo=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's info dropdown is visible.
...
Embed link parameter: &showExport=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's PDF export options are visible to the story viewer.
...
Embed link parameter: &showBannerImage=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's banner image is shown.
...
Embed link parameter: &showHeader=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines if the embedded story's header is shown.
...
Embed link parameter: &showAuthor=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's author is shown. Even if it's set to true, it will only be displayed if the showHeader option is also present and set to true.
...
Embed link parameter: &showDateContainer=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's publication date is shown. Even if it's set to true, it will only be displayed if the showHeader option is also present and set to true.
...
Embed link parameter: &showLikeButton=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the story's 'Like' button is shown. Even if it's set to true, it will only be displayed if the showHeader option is also present and set to true. Guests who are not authenticated will not be able to use this button.
...
Embed link parameter: &showReadBy=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the list of people who have read the embedded story is shown. Even if it's set to true, it will only be displayed if the showHeader option is also present and set to true.
...
Embed link parameter: &showStoryTitle=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's title is displayed.
...
Embed link parameter: &showFooter=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the embedded story's footer is displayed.
...
Embed link parameter: &showContributors=true (Or if it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: true
Description
This option determines whether the list of story contributors is shown when embedded. Even if it's set to true, it will only be displayed if the showFooter option is also present and set to true.
...
Default value: element width
Description
This option sets the total width of the embedded story.
...
Default value: 3/4 of width
Description
This option sets the full width of the embedded story's body (which doesn’t include the banner). The width of most of the story's contents will be 200px less, unless it is set to display at full width (eg, an image in wide mode).
...
Embed link parameter: &bannerImageHeight=xxx (Where xxx is a number. If it's the first element in the query string, change the prefix from & to ? like any other query string.)
Default value: 300px
Description
This option sets the custom height that should be applied to the banner image container. For best results, we recommend that you also set the banner width if you use this setting.
...
Default value: Value of width
Description
This option sets the custom width that should be applied to the banner image. For best results, we recommend that you also set the banner height if you use this setting.
...
| Code Block | ||
|---|---|---|
| ||
window.yellowfin.loadStoryAPI().then(() => {
window.yellowfin.stories.loadStory(
{ storyUUID: '<%=Story Publish UUID%>', element: 'div#storyContainer' }
).then((storyAPI) =>
{ console.log(storyAPI); window.storyAPI = storyAPI; }
);
}); |
| Styleclass | ||
|---|---|---|
| ||