/visual-analytics-sdk

The SAS Visual Analytics SDK is a set of JavaScript APIs and web components that allow you to embed SAS Visual Analytics report content into a third-party application or web page.

Primary LanguageHTMLOtherNOASSERTION

SAS Visual Analytics SDK -- Archived repository

Notice: The Visual Analytics SDK has moved and is now part of the SAS Viya SDK for JavaScript. See sas-viya-sdk-js for documentation, examples and to enter new GitHub issues.

Overview

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

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

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

Getting Started

For guides and an API reference, see developer.sas.com.

Examples

Full examples are located in the examples folder of this repository.

Contributing

The SAS Visual Analytics SDK is not open for external contributions.

License

This project is licensed under this commercial license.

Additional Resources