@sassoftware/va-report-components NPM

SAS Visual Analytics SDK

The SAS Visual Analytics SDK is a set of JavaScript APIs and web components that enable SAS Visual Analytics report content to be easily embedded in a third-party application or web page. Entire reports or individual report objects can be embedded, and the content is fully interactive. This functionality is delivered as the va-report-components JavaScript library.

Prerequisites

Access to a deployment of SAS Visual Analytics 8.4 (or later) is necessary in order to use the SDK. For more information about server set up, see SAS Viya setup.

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