-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
documentation/website/versioned_docs/version-1.8.0/api-reference.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
id: version-1.8.0-api-reference | ||
title: API Reference | ||
original_id: api-reference | ||
--- | ||
|
||
The SAS Visual Analytics SDK provides a set of components and APIs that enable you to render reports and report parts. It also enables you | ||
to use SAS data to drive your own components or visualizations. | ||
|
||
## Top-Level Exports | ||
|
||
- [`SASReportElement`](api/SASReportElement.md) | ||
- [`SASReportPageElement`](api/SASReportPageElement.md) | ||
- [`SASReportObjectElement`](api/SASReportObjectElement.md) | ||
- [`connectToServer`](api/connectToServer.md) | ||
- [`registerDataDrivenContent`](api/registerDataDrivenContent.md) | ||
- [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) | ||
- [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) | ||
- [`setLoadingTheme`](api/setLoadingTheme.md) | ||
|
||
## Loading with \<script\> | ||
|
||
When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other | ||
assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. | ||
|
||
```html | ||
<script async src="https://cdn.developer.sas.com/packages/va-report-components/latest/dist/umd/va-report-components.js"></script> | ||
<script> | ||
window.addEventListener('vaReportComponents.loaded', function() { | ||
// The SAS Visual Analytics SDK is loaded and ready | ||
const connectToServer = vaReportComponents.connectToServer; | ||
}); | ||
</script> | ||
``` |
78 changes: 78 additions & 0 deletions
78
documentation/website/versioned_docs/version-1.8.0/getting-started.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
id: version-1.8.0-getting-started | ||
title: Getting started | ||
original_id: getting-started | ||
--- | ||
|
||
The SAS Visual Analytics SDK enables you to use the power of SAS Visual Analytics in your own websites and HTML applications. | ||
You can embed entire reports with the `<sas-report>` custom HTML element, embed a single object with the | ||
`<sas-report-object>` element, or connect to your reports with our JavaScript API. | ||
|
||
## Installation | ||
|
||
### NPM | ||
|
||
The <a target="_blank" href="https://www.npmjs.com/package/@sassoftware/va-report-components">`@sassoftware/va-report-components`</a> library is published to NPM and can be installed by running the `npm install` command as shown below. `va-report-components` does not support ES6 imports. Therefore, the contents of the `va-report-components/dist` folder must be deployed with your page, and then loaded using a `script` tag. | ||
|
||
```bash | ||
# From the root directory of your project | ||
npm install @sassoftware/va-report-components | ||
|
||
# Copy the contents of the package to an asset folder for deployment | ||
cp -r ./node_modules/@sassoftware/va-report-components ./sdk-assets | ||
``` | ||
|
||
The library can then be loaded out of the deployed assets folder using a `script` tag. | ||
|
||
```html | ||
<script async src="./sdk-assets/dist/umd/va-report-components.js"></script> | ||
``` | ||
|
||
### CDN (Content Delivery Network) | ||
|
||
Accessing the `va-report-components` library from the SAS CDN is easy. It does not require installation or | ||
hosting of the library code and assets. Here is an example of loading the latest version of `va-report-components` from the CDN using an HTML `script` tag. | ||
|
||
```html | ||
<script async src="https://cdn.developer.sas.com/packages/va-report-components/latest/dist/umd/va-report-components.js"></script> | ||
``` | ||
|
||
When the library is used in production, consider pinning it to an explicit version. This is done with a URL like `https://cdn.developer.sas.com/packages/va-report-components/${VERSION}/dist/umd/va-report-components.js`, where `${VERSION}` is the full `major.minor.patch` semantic version. | ||
|
||
## SAS Viya setup | ||
|
||
The SAS Visual Analytics SDK requires either connecting directly to SAS Viya or exporting a SAS Report Package. Server setup requirements for connecting to SAS Viya are covered in the [SAS Viya Setup Guide](guides/viya-setup.md). | ||
|
||
## Create a custom HTML tag | ||
|
||
To build the custom HTML tag that you will embed in your web page: | ||
|
||
1. Open a report in SAS Visual Analytics. | ||
1. Open the menu in the report toolbar (which is displayed in the image below) or right-click an individual object, and then select Copy Link. The Copy Link window is displayed. | ||
1. If you are using guest access, expand the Options heading and select the Guest access check box. | ||
1. Click Copy Link. | ||
|
||
![Report Overflow Menu](assets/report-overflow-menu.png) | ||
|
||
Once the report link or object link has been copied to your clipboard, paste it below, and the output will show a custom HTML | ||
tag that is ready to use. | ||
|
||
<link rel="stylesheet" href="/sdk/va/css/copy-link-translator.css"> | ||
<form> | ||
<textarea id="vdk-slt-input" | ||
rows="5" | ||
style="resize: none; width: 100%;" | ||
placeholder="Paste the link from SAS Visual Analytics here." | ||
aria-label="Paste the link from SAS Visual Analytics here." | ||
></textarea> | ||
<pre><code id="vdk-slt-output" class="hljs" data-hide="true"></code></pre> | ||
</form> | ||
<script type="module" src="/sdk/va/js/copy-link-translator.js"></script> | ||
|
||
For a complete list of options, see the documentation for [`SASReportElement`](api/SASReportElement.md) and | ||
[`SASReportObjectElement`](api/SASReportObjectElement.md) | ||
|
||
## See our examples | ||
|
||
<a target="_blank" href="https://github.com/sassoftware/visual-analytics-sdk/tree/master/examples">Our examples</a> demonstrate a few different | ||
ways to start using the SAS Visual Analytics SDK in your HTML application. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
[ | ||
"1.8.0", | ||
"1.7.0", | ||
"1.6.0", | ||
"1.5.0", | ||
|