2.13.0

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 @sassoftware/va-report-components library is published to NPM and can be installed by running the npm install command as shown below. va-report-components can then be loaded with either a script tag or with an ES module import.

# From the root directory of your project
npm install @sassoftware/va-report-components

When using a script tag, the contents of the va-report-components/dist folder must be deployed with your page.

# 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.

<script async src="./sdk-assets/dist/umd/va-report-components.js"></script>

If your site is built using a code bundler, it might be more convenient to load the library through ES module imports. See the ES module guide for more details.

import "@sassoftware/va-report-components"

CDN (Content Delivery Network)

Accessing the va-report-components library from the SAS Developer 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.

<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.

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.
  2. 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.
  3. If you are using guest access, expand the Options heading and select the Guest access check box.
  4. Click Copy Link.

Report Overflow Menu

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.

For a complete list of options, see the documentation for SASReportElement and SASReportObjectElement

See our examples

Our examples demonstrate a few different ways to start using the SAS Visual Analytics SDK in your HTML application.

SAS Viya Setup →