├── .gitignore ├── CONTRIBUTING.md ├── ContributorAgreement.txt ├── LICENSE ├── README.md ├── SUPPORT.md └── sdk ├── content-components ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── documentation │ ├── .gitignore │ ├── docs │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ContentAreaElement.md │ │ │ ├── ContentBreadcrumbElement.md │ │ │ ├── ContentGroupElement.md │ │ │ ├── ContentLocationsElement.md │ │ │ ├── ContentTreeElement.md │ │ │ ├── Item.md │ │ │ ├── ItemIdentifier.md │ │ │ ├── LocationIdentifier.md │ │ │ ├── LogonWrapperProps.md │ │ │ └── getSASJobExecutionUrl.md │ │ ├── assets │ │ │ └── findUri.png │ │ ├── faq.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── browse-reports.md │ └── website │ │ ├── README.md │ │ ├── core │ │ └── Footer.js │ │ ├── package.json │ │ ├── pages │ │ └── en │ │ │ ├── help.js │ │ │ ├── index.js │ │ │ ├── users.js │ │ │ └── versions.js │ │ ├── sidebars.json │ │ ├── siteConfig.js │ │ ├── static │ │ ├── css │ │ │ ├── code-block-buttons.css │ │ │ ├── copy-link-translator.css │ │ │ └── custom.css │ │ ├── img │ │ │ ├── aquaBank.png │ │ │ ├── aquaBank_resize.png │ │ │ ├── favicon.ico │ │ │ ├── sas-logo-wht.png │ │ │ ├── sdk-monitor.png │ │ │ └── sdk-monitor_old.png │ │ └── js │ │ │ ├── code-block-buttons.js │ │ │ └── copy-link-translator.js │ │ ├── versioned_docs │ │ ├── version-0.1.0 │ │ │ ├── api-reference.md │ │ │ ├── api │ │ │ │ ├── ContentAreaElement.md │ │ │ │ ├── Item.md │ │ │ │ └── ItemIdentifier.md │ │ │ ├── faq.md │ │ │ └── getting-started.md │ │ ├── version-0.2.0 │ │ │ ├── api │ │ │ │ └── ContentAreaElement.md │ │ │ └── getting-started.md │ │ ├── version-0.3.0 │ │ │ ├── api │ │ │ │ └── ContentAreaElement.md │ │ │ └── guides │ │ │ │ └── browse-reports.md │ │ ├── version-0.4.0 │ │ │ ├── api-reference.md │ │ │ ├── api │ │ │ │ ├── ContentAreaElement.md │ │ │ │ ├── ContentBreadcrumbElement.md │ │ │ │ ├── ContentGroupElement.md │ │ │ │ ├── ContentTreeElement.md │ │ │ │ ├── ItemIdentifier.md │ │ │ │ ├── LocationIdentifier.md │ │ │ │ └── LogonWrapperProps.md │ │ │ ├── faq.md │ │ │ ├── getting-started.md │ │ │ └── guides │ │ │ │ └── browse-reports.md │ │ ├── version-0.5.0 │ │ │ ├── api-reference.md │ │ │ ├── api │ │ │ │ ├── ContentAreaElement.md │ │ │ │ └── ContentGroupElement.md │ │ │ └── getting-started.md │ │ ├── version-0.6.0 │ │ │ ├── api-reference.md │ │ │ ├── faq.md │ │ │ └── getting-started.md │ │ ├── version-0.7.0 │ │ │ └── api-reference.md │ │ ├── version-0.8.0 │ │ │ ├── api-reference.md │ │ │ └── api │ │ │ │ └── ContentLocationsElement.md │ │ └── version-0.9.0 │ │ │ ├── api-reference.md │ │ │ └── api │ │ │ └── getSASJobExecutionUrl.md │ │ ├── versioned_sidebars │ │ ├── version-0.1.0-sidebars.json │ │ ├── version-0.3.0-sidebars.json │ │ ├── version-0.4.0-sidebars.json │ │ ├── version-0.8.0-sidebars.json │ │ └── version-0.9.0-sidebars.json │ │ └── versions.json └── examples │ ├── ContentSDKWithJobs.html │ ├── ContentSDKWithReport.html │ └── README.md ├── sas-auth-browser ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md └── examples │ └── basic-example.html └── va-report-components ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── documentation ├── .gitignore ├── docs │ ├── api-reference.md │ ├── api │ │ ├── DataDrivenContentHandle.md │ │ ├── ExportDataOptions.md │ │ ├── ExportPDFOptions.md │ │ ├── MenuItemProvider.md │ │ ├── ObjectHandle.md │ │ ├── ReportHandle.md │ │ ├── ReportObjectResultData.md │ │ ├── SASReportElement.md │ │ ├── SASReportObjectElement.md │ │ ├── SASReportPageElement.md │ │ ├── connectToServer.md │ │ ├── registerDataDrivenContent.md │ │ ├── setFormatterLocale.md │ │ ├── setLoadingTheme.md │ │ ├── setLocale.md │ │ └── setUseHighContrastReportTheme.md │ ├── assets │ │ ├── data-driven-content.png │ │ └── report-overflow-menu.png │ ├── faq.md │ ├── getting-started.md │ └── guides │ │ ├── data-driven-content.md │ │ ├── esm.md │ │ ├── export-report-package.md │ │ └── viya-setup.md └── website │ ├── core │ └── Footer.js │ ├── package.json │ ├── pages │ └── en │ │ ├── help.js │ │ ├── index.js │ │ └── versions.js │ ├── sidebars.json │ ├── siteConfig.js │ ├── static │ ├── css │ │ ├── code-block-buttons.css │ │ ├── copy-link-translator.css │ │ └── custom.css │ ├── img │ │ ├── favicon.ico │ │ ├── sas-logo-wht.png │ │ ├── sdk-monitor-2.png │ │ └── sdk-monitor.png │ └── js │ │ ├── code-block-buttons.js │ │ └── copy-link-translator.js │ ├── versioned_docs │ ├── version-0.1.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── DataDrivenContentHandle.md │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ ├── connectToServer.md │ │ │ └── registerDataDrivenContent.md │ │ ├── faq.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── data-driven-content.md │ ├── version-0.10.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ExportPDFOptions.md │ │ │ └── ReportHandle.md │ │ └── getting-started.md │ ├── version-0.11.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.12.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.13.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.14.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.15.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.16.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── DataDrivenContentHandle.md │ │ │ ├── ReportHandle.md │ │ │ ├── registerDataDrivenContent.md │ │ │ └── setUseHighContrastReportTheme.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── data-driven-content.md │ ├── version-0.17.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.18.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ObjectHandle.md │ │ │ └── ReportHandle.md │ │ └── getting-started.md │ ├── version-0.19.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ └── setLoadingTheme.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── viya-setup.md │ ├── version-0.2.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ ├── connectToServer.md │ │ │ └── registerDataDrivenContent.md │ │ ├── faq.md │ │ └── getting-started.md │ ├── version-0.20.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ └── ReportHandle.md │ │ └── getting-started.md │ ├── version-0.3.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ ├── SASReportPageElement.md │ │ │ └── registerDataDrivenContent.md │ │ └── getting-started.md │ ├── version-0.4.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── DataDrivenContentHandle.md │ │ │ ├── ReportHandle.md │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ ├── SASReportPageElement.md │ │ │ └── registerDataDrivenContent.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── data-driven-content.md │ ├── version-0.5.0 │ │ ├── api-reference.md │ │ ├── faq.md │ │ └── getting-started.md │ ├── version-0.6.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.7.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.8.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-0.9.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── MenuItemProvider.md │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ └── SASReportPageElement.md │ │ └── getting-started.md │ ├── version-1.0.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ExportPDFOptions.md │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ └── SASReportPageElement.md │ │ ├── faq.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── export-report-package.md │ ├── version-1.1.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ExportDataOptions.md │ │ │ └── ObjectHandle.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── export-report-package.md │ ├── version-1.10.0 │ │ ├── api │ │ │ ├── SASReportElement.md │ │ │ ├── SASReportObjectElement.md │ │ │ └── SASReportPageElement.md │ │ ├── faq.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── data-driven-content.md │ ├── version-1.11.0 │ │ └── api │ │ │ ├── ObjectHandle.md │ │ │ ├── ReportObjectResultData.md │ │ │ ├── SASReportObjectElement.md │ │ │ ├── SASReportPageElement.md │ │ │ └── registerDataDrivenContent.md │ ├── version-1.12.0 │ │ ├── api-reference.md │ │ └── api │ │ │ └── setLocale.md │ ├── version-1.13.0 │ │ └── api │ │ │ └── ObjectHandle.md │ ├── version-1.15.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── setFormatterLocale.md │ │ │ └── setLocale.md │ │ └── guides │ │ │ └── viya-setup.md │ ├── version-1.2.0 │ │ ├── api-reference.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── export-report-package.md │ ├── version-1.20.0 │ │ └── guides │ │ │ └── viya-setup.md │ ├── version-1.3.0 │ │ ├── api-reference.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── export-report-package.md │ ├── version-1.4.0 │ │ ├── api-reference.md │ │ └── getting-started.md │ ├── version-1.5.0 │ │ ├── api-reference.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── viya-setup.md │ ├── version-1.6.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── ObjectHandle.md │ │ │ └── ReportHandle.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── export-report-package.md │ ├── version-1.7.0 │ │ ├── api-reference.md │ │ ├── getting-started.md │ │ └── guides │ │ │ ├── data-driven-content.md │ │ │ └── export-report-package.md │ ├── version-1.8.0 │ │ ├── api-reference.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── viya-setup.md │ ├── version-2.13.0 │ │ ├── api-reference.md │ │ ├── api │ │ │ ├── setFormatterLocale.md │ │ │ ├── setLoadingTheme.md │ │ │ └── setLocale.md │ │ ├── getting-started.md │ │ └── guides │ │ │ └── esm.md │ ├── version-2.2.0 │ │ └── getting-started.md │ ├── version-2.4.0 │ │ └── api │ │ │ └── ObjectHandle.md │ ├── version-2.6.0 │ │ └── api │ │ │ ├── ObjectHandle.md │ │ │ └── SASReportObjectElement.md │ └── version-2.7.0 │ │ └── api │ │ └── ReportHandle.md │ ├── versioned_sidebars │ ├── version-0.1.0-sidebars.json │ ├── version-0.10.0-sidebars.json │ ├── version-0.16.0-sidebars.json │ ├── version-0.18.0-sidebars.json │ ├── version-0.19.0-sidebars.json │ ├── version-0.3.0-sidebars.json │ ├── version-0.4.0-sidebars.json │ ├── version-0.9.0-sidebars.json │ ├── version-1.0.0-sidebars.json │ ├── version-1.1.0-sidebars.json │ ├── version-1.11.0-sidebars.json │ ├── version-1.12.0-sidebars.json │ ├── version-1.15.0-sidebars.json │ └── version-2.13.0-sidebars.json │ └── versions.json └── examples ├── README.md ├── SASReportElement.html ├── SASReportElementJS.html ├── SASReportObjectElement.html ├── connectToServer.html ├── getSelectedData.html └── registerDataDrivenContent.html /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .vscode 3 | 4 | node_modules 5 | .npmrc -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a signed 9 | [Contributor Agreement](ContributorAgreement.txt). 10 | You (or your employer) retain the copyright to your contribution, 11 | this simply gives us permission to use and redistribute your contributions as 12 | part of the project. 13 | 14 | ## Code reviews 15 | 16 | All submissions, including submissions by project members, require review. We 17 | use GitHub pull requests for this purpose. Consult 18 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 19 | information on using pull requests. 20 | -------------------------------------------------------------------------------- /ContributorAgreement.txt: -------------------------------------------------------------------------------- 1 | Contributor Agreement 2 | 3 | Version 1.1 4 | 5 | Contributions to this software are accepted only when they are 6 | properly accompanied by a Contributor Agreement. The Contributor 7 | Agreement for this software is the Developer's Certificate of Origin 8 | 1.1 (DCO) as provided with and required for accepting contributions 9 | to the Linux kernel. 10 | 11 | In each contribution proposed to be included in this software, the 12 | developer must include a "sign-off" that denotes consent to the 13 | terms of the Developer's Certificate of Origin. The sign-off is 14 | a line of text in the description that accompanies the change, 15 | certifying that you have the right to provide the contribution 16 | to be included. For changes provided in source code control (for 17 | example, via a Git pull request) the sign-off must be included in 18 | the commit message in source code control. For changes provided 19 | in email or issue tracking, the sign-off must be included in the 20 | email or the issue, and the sign-off will be incorporated into the 21 | permanent commit message if the contribution is accepted into the 22 | official source code. 23 | 24 | If you can certify the below: 25 | 26 | Developer's Certificate of Origin 1.1 27 | 28 | By making a contribution to this project, I certify that: 29 | 30 | (a) The contribution was created in whole or in part by me and I 31 | have the right to submit it under the open source license 32 | indicated in the file; or 33 | 34 | (b) The contribution is based upon previous work that, to the best 35 | of my knowledge, is covered under an appropriate open source 36 | license and I have the right under that license to submit that 37 | work with modifications, whether created in whole or in part 38 | by me, under the same open source license (unless I am 39 | permitted to submit under a different license), as indicated 40 | in the file; or 41 | 42 | (c) The contribution was provided directly to me by some other 43 | person who certified (a), (b) or (c) and I have not modified 44 | it. 45 | 46 | (d) I understand and agree that this project and the contribution 47 | are public and that a record of the contribution (including all 48 | personal information I submit with it, including my sign-off) is 49 | maintained indefinitely and may be redistributed consistent with 50 | this project or the open source license(s) involved. 51 | 52 | then you just add a line saying 53 | 54 | Signed-off-by: Random J Developer 55 | 56 | using your real name (sorry, no pseudonyms or anonymous contributions.) -------------------------------------------------------------------------------- /SUPPORT.md: -------------------------------------------------------------------------------- 1 | ## Support 2 | 3 | We use GitHub for tracking bugs and feature requests. 4 | Please submit a GitHub issue or pull request for support. 5 | Alternatively, you can contact SAS Technical Support by entering a [support request](https://support.sas.com/en/technical-support/submit-a-support-request.html). -------------------------------------------------------------------------------- /sdk/content-components/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.9.0 (Octover 20, 2022) 2 | 3 | - Added getSASJobExecutionUrl helper 4 | 5 | ## 0.8.0 (September 22, 2022) 6 | 7 | - Added ContentLocationsElement 8 | 9 | ## 0.7.0 (July 21, 2022) 10 | 11 | - Added support for styling components via "class" and "style" attributes. 12 | 13 | ## 0.6.0 (June 16, 2022) 14 | 15 | - Added ability to export PDFs for reports via the context menu 16 | 17 | ## 0.5.0 (March 17, 2022) 18 | 19 | - Added table view and controls to ContentAreaElement 20 | 21 | ## 0.4.0 (February 21, 2022) 22 | 23 | - Added ContentTreeElement 24 | - Added ContentBreadcrumbElement 25 | - Added ContentGroupElement 26 | - BREAKING CHANGE: Removed `folderIdentifier` and `itemIdentifiers` properties from ContentAreaElement. The `initialNavigationValue` property of ContentGroupElement is recommended instead. 27 | - Added the `authentication-type` attribute to components to specify whether to use credentials or guest authentication. 28 | 29 | ## 0.3.0 (December 15, 2021) 30 | 31 | - Internal dependency update 32 | 33 | ## 0.2.0 (November 18, 2021) 34 | 35 | - New ContentAreaElement features: 36 | - `selection-mode` attribute to choose between single and multiple selection. 37 | - `initial-selection-index` attribute to set a default initial selection when content details are not known. 38 | - `setSelectedIdentifiers` method to allow for updating the selection programmatically. 39 | 40 | ## 0.1.0 (September 20, 2021) 41 | 42 | - First release 43 | -------------------------------------------------------------------------------- /sdk/content-components/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | content-components is not open for external contributions. 4 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .vscode 3 | 4 | node_modules 5 | 6 | lib/core/metadata.js 7 | lib/core/MetadataBlog.js 8 | 9 | website/translated_docs 10 | website/build/ 11 | website/yarn.lock 12 | website/package-lock.json 13 | website/node_modules 14 | website/i18n/* 15 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: api-reference 3 | title: API Reference 4 | --- 5 | 6 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 7 | you to use SAS content items to drive your own processes or to interact with SAS Visual 8 | Analytics SDK. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`ContentAreaElement`](api/ContentAreaElement.md) 13 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 14 | - [`ContentGroupElement`](api/ContentGroupElement.md) 15 | - [`ContentLocationsElement`](api/ContentLocationsElement.md) 16 | - [`ContentTreeElement`](api/ContentTreeElement.md) 17 | - [`getSASJobExecutionUrl`](api/getSASJobExecutionUrl.md) 18 | 19 | ## Loading with a script element 20 | 21 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 22 | 23 | ```html 24 | 25 | 30 | ``` 31 | 32 | ## Styling Components 33 | 34 | The SAS Content SDK components accept CSS styles by setting the "class" or "style" attributes of a component. For example: 35 | 36 | ```html 37 | 42 | 43 | 50 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/ContentBreadcrumbElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ContentBreadcrumbElement 3 | title: ContentBreadcrumbElement 4 | --- 5 | 6 | `ContentBreadcrumbElement` is a custom HTML element that displays breadcrumb links allowing the user to navigate to previously visited folders. This element extends `HTMLElement`. 7 | 8 | ## Custom Element Tag 9 | 10 | ```html 11 | 13 | ``` 14 | 15 | ## Attributes 16 | 17 | ### `url` 18 | 19 | See [url](LogonWrapperProps.md#url). 20 | 21 | ### `authenticationType` 22 | 23 | See [authenticationType](LogonWrapperProps.md#authenticationType). 24 | 25 | ## Properties 26 | 27 | ### `onSelect: (breadcrumbPath: Item[]) => void` 28 | 29 | A callback function that can be used to respond to a breadcrumb link being selected. 30 | 31 | #### Arguments 32 | 33 | `breadcrumbPath: Item[]` 34 | 35 | An array of [Items](Item.md) representing the breadcrumb path, starting with the root. -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/ContentGroupElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ContentGroupElement 3 | title: ContentGroupElement 4 | --- 5 | 6 | `ContentGroupElement` is a custom HTML element that connects contained Content SDK components together, and enables cross component functionality, such as folder navigation, selection, and filtering. This element extends `HTMLElement`. 7 | 8 | In cases of nested grouping, components belong to the nearest ancestor group. 9 | 10 | ## Custom Element Tag 11 | 12 | ```html 13 | 14 | 15 | 16 | 17 | 18 | ``` 19 | 20 | ## Properties 21 | 22 | ### `initialNavigationValue: ContentNavigationValue` 23 | 24 | Specify initial properties related to content navigation for components in this group. 25 | 26 | ### `initialNavigationValue.location?: ItemIdentifier` 27 | 28 | The initial location that should be displayed by components such as the [ContentAreaElement](ContentAreaElement.md). See [ItemIdentifier](ItemIdentifier.md). 29 | 30 | ### `initialNavigationValue.locationContextPath?: ItemIdentifier[]` 31 | 32 | The initial location that hierarchical, path-based components should display, such as [ContentTreeElement](ContentTreeElement.md) or [ContentBreadcrumbElement](ContentBreadcrumbElement.md). See [ItemIdentifier](ItemIdentifier.md). 33 | 34 | ### `initialNavigationValue.locations?: LocationIdentifier[]` 35 | 36 | The initial set of root locations to be used by hierarchical components such as [ContentTreeElement](ContentTreeElement.md). See [LocationIdentifier](LocationIdentifier.md). 37 | 38 | ### `initialSelectionValue: ItemIdentifier[]` 39 | 40 | An array of [ItemIdentifiers](ItemIdentifier.md) which will be initially selected in the components in this group. If you specify any items that are not displayed in one of the components in the group, then those items are ignored. 41 | 42 | ### `initialFilterValue: { queryModeFilter: string; }` 43 | 44 | Specify options for filtering the content displayed in the content group. 45 | 46 | ### `initialFilterValue.queryModeFilter: string` 47 | 48 | A SAS REST filter that is forwarded to underlying service requests. For example, to filter content to only show reports, use the following vaue: `eq(contentType,'report')`. Any type that can be parented to a folder is supported. 49 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/ContentLocationsElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ContentLocationsElement 3 | title: ContentLocationsElement 4 | --- 5 | 6 | `ContentLocationsElement` is a custom HTML element that displays a customizable SAS Viya "locations" list for navigation. Locations are typically Viya folders. This element extends `HTMLElement`. 7 | 8 | ## Custom Element Tag 9 | 10 | ```html 11 | 14 | ``` 15 | 16 | ## Attributes 17 | 18 | ### `url` 19 | 20 | See [url](LogonWrapperProps.md#url). 21 | 22 | ### `authenticationType` 23 | 24 | See [authenticationType](LogonWrapperProps.md#authenticationType). 25 | 26 | ## Properties 27 | 28 | ### `onSelect: (item: Item) => void` 29 | 30 | A callback function that can be used to respond to the selection of a location in the ContentLocationsElement. 31 | 32 | #### Arguments 33 | 34 | `item: Item` 35 | 36 | The selected [Item](Item.md). 37 | 38 | ### `showSeparator: boolean | (rowIndex: number) => boolean` 39 | 40 | A boolean or function used to specify which locations should have a separator above them in the UI. When using the function version, return true for rowIndices for locations which should show a separator. -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/ContentTreeElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ContentTreeElement 3 | title: ContentTreeElement 4 | --- 5 | 6 | `ContentTreeElement` is a custom HTML element that displays a customizable SAS Viya folder tree for navigation. This element extends `HTMLElement`. 7 | 8 | ## Custom Element Tag 9 | 10 | ```html 11 | 14 | ``` 15 | 16 | ## Attributes 17 | 18 | ### `url` 19 | 20 | See [url](LogonWrapperProps.md#url). 21 | 22 | ### `authenticationType` 23 | 24 | See [authenticationType](LogonWrapperProps.md#authenticationType). 25 | 26 | ## Properties 27 | 28 | ### `onSelect: (node: Node, item: Item) => void` 29 | 30 | A callback function that can be used to respond to the selection of nodes in the ContentTreeElement. 31 | 32 | #### Arguments 33 | 34 | `node: Node` 35 | 36 | This is an internal component state item that is of limited use for consumers. 37 | 38 | `item: Item` 39 | 40 | The selected [Item](Item.md). 41 | 42 | ### `onExpand: (node: Node, expanded: boolean, item: Item) => void` 43 | 44 | A callback function that can be used to respond to the expansion of nodes in the ContentTreeElement. 45 | 46 | #### Arguments 47 | 48 | `node: Node` 49 | 50 | This is an internal component state item that is of limited use for consumers. 51 | 52 | `expanded: boolean` 53 | 54 | Whether or not the node was expanded. 55 | 56 | `item: Item` 57 | 58 | The expanded [Item](Item.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/Item.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: Item 3 | title: Item 4 | --- 5 | 6 | `Item` is a data type representing a content item returned by many Content SDK event handlers. 7 | 8 | ## Attributes 9 | 10 | `Item` comes from the sas-drive service, and has a goal of containing all attributes that could be useful to a consumer or web client. The following are most likely to be of use in the Content SDK. 11 | 12 | ### `resource.id: string` 13 | 14 | The uri of the content item, such as the report uri or folder uri. 15 | 16 | ### `resource.type.sasType: string` 17 | 18 | The SAS type of the content item, such as 'report', 'folder', or 'file'. -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/ItemIdentifier.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ItemIdentifier 3 | title: ItemIdentifier 4 | --- 5 | 6 | `ItemIdentifier` is a data type for specifying content items for use with the Content SDK components. 7 | 8 | ## Attributes 9 | 10 | ### `type: 'persistentLocation' | 'folderUri'` 11 | 12 | Specify what type of content item this is. `persistentLocation` refers to a set of pre-defined SAS Viya locations. `folderUri` can be any SAS Viya folder uri. 13 | 14 | ### `value: string` 15 | 16 | 17 | - `myFolder`: the My Folder folder in SAS Viya 18 | - `favorites`: the My Favorites folder in SAS Viya 19 | - `root`: the SAS Content folder in SAS Viya 20 | - `history`: the Recents folder in SAS Viya 21 | - `trash`: the Recycle Bin folder in SAS Viya 22 | 23 | For `type: 'folderUri'`, a SAS Viya folder uri of the form: `'/folder/folders/789d13d3-789d-4fa3-9fea-123e321f1ea1'`. You can find the URI for a Folder in SAS Drive in the Information Pane. Select the Folder, scroll down in the Information Pane to the More -> URI section and copy the URI. 24 | 25 | ![Finding folder and item URIs](assets/findUri.png) -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/LocationIdentifier.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: LocationIdentifier 3 | title: LocationIdentifier 4 | --- 5 | 6 | `LocationIdentifier` is a more limited subset of [ItemIdentifier](ItemIdentifier.md) that represents items that can be used as root locations in components such as [ContentTreeElement](ContentTreeElement.md). 7 | 8 | ## Attributes 9 | 10 | ### `type: 'persistentLocation'` 11 | 12 | Specify what type of content item this is. `persistentLocation` refers to a set of pre-defined SAS Viya locations. 13 | 14 | ### `value: string` 15 | 16 | 17 | - `myFolder`: the My Folder folder in SAS Viya 18 | - `favorites`: the My Favorites folder in SAS Viya 19 | - `root`: the SAS Content folder in SAS Viya 20 | - `history`: the Recents folder in SAS Viya 21 | - `trash`: the Recycle Bin folder in SAS Viya 22 | 23 | ### `preventExpansion: boolean` 24 | 25 | Specify whether to disable expansion for this location in the [ContentTreeElement](ContentTreeElement.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/LogonWrapperProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: LogonWrapperProps 3 | title: LogonWrapperProps 4 | --- 5 | 6 | `LogonWrapperProps` are connection-based attributes that are common to most Content SDK components. 7 | 8 | ## Attributes 9 | 10 | ### `url: string` 11 | 12 | Specify the URL of the SAS Viya server that hosts the content to display. This is the full context root, including the protocol, 13 | optional port, and host. 14 | 15 | ### `authenticationType?: 'credentials' | 'guest'` 16 | 17 | Specify how to authenticate to the SAS Viya server. 18 | 19 | #### Values 20 | 21 | `credentials` 22 | 23 | Logon using SAS Viya credentials. This will open a popup dialog where the credentials can be entered. This is the default value if no `authenticationType` is supplied. 24 | 25 | `guest` 26 | 27 | Logon automatically as a guest to the SAS Viya deployment. The deployment needs to be configured to support guest mode. 28 | 29 | For more details, see [How is authentication handled by the SAS Content SDK?](faq.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/api/getSASJobExecutionUrl.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: getSASJobExecutionUrl 3 | title: getSASJobExecutionUrl 4 | --- 5 | 6 | ``` 7 | getSASJobExecutionUrl(itemUri, url): Promise 8 | ``` 9 | 10 | This function generates a SAS Job Execution URL. You can use the URL to open a job and execute it if it is a job with an HTML prompt. This URL can be opened in a new tab or window, or embedded in an iframe if allowed by the security settings on the deployment. 11 | 12 | ## Arguments 13 | 14 | ### `itemUri: string` 15 | 16 | The URI of the target job definition [Item](Item.md), such as from an `onSelect` event. This corresponds to the `resource.id` property of the Item. 17 | 18 | ### `url: string` 19 | 20 | Specify the URL of the SAS Viya server. This is the full context root, including the protocol, optional port, and host. 21 | 22 | ## Return value 23 | 24 | `getSASJobExecutionUrl` will return a Promise that resolves to the URL representing the job in SAS Job Execution. 25 | If a problem is encountered, the Promise resolves to `undefined`. Problems could include passing in an item that does not represent a job definition, not passing in a URL string, or unexpected errors with the internal service calls that are needed to generate the URL. Consumers should handle the `undefined` case, because service call failures are always a possibility. 26 | 27 | ## Embedding in an iframe 28 | 29 | By default, your SAS Viya deployment does not allow access when embedded as a cross-origin iframe. To embed the SAS Job Execution URL within an iframe with a cross-origin ancestor, the `x-frame-options-enabled` option in `sas.commons.web.security` needs to be disabled for the SAS Job Execution definition. See SAS Help Center for more information. -------------------------------------------------------------------------------- /sdk/content-components/documentation/docs/assets/findUri.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/docs/assets/findUri.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/core/Footer.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (c) 2017-present, Facebook, Inc. 3 | * 4 | * This source code is licensed under the MIT license found in the 5 | * LICENSE file in the root directory of this source tree. 6 | */ 7 | 8 | const React = require('react'); 9 | 10 | class Footer extends React.Component { 11 | docUrl(doc, language) { 12 | const baseUrl = this.props.config.baseUrl; 13 | const docsUrl = this.props.config.docsUrl; 14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; 15 | const langPart = `${language ? `${language}/` : ''}`; 16 | return `${baseUrl}${docsPart}${langPart}${doc}`; 17 | } 18 | 19 | pageUrl(doc, language) { 20 | const baseUrl = this.props.config.baseUrl; 21 | return baseUrl + (language ? `${language}/` : '') + doc; 22 | } 23 | 24 | render() { 25 | return ( 26 | 61 | ); 62 | } 63 | } 64 | 65 | module.exports = Footer; 66 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "scripts": { 3 | "examples": "docusaurus-examples", 4 | "start": "docusaurus-start", 5 | "build": "docusaurus-build", 6 | "publish-gh-pages": "docusaurus-publish", 7 | "write-translations": "docusaurus-write-translations", 8 | "version": "docusaurus-version", 9 | "rename-version": "docusaurus-rename-version" 10 | }, 11 | "devDependencies": { 12 | "docusaurus": "^1.14.7" 13 | }, 14 | "dependencies": { 15 | "clsx": "^1.1.1" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/pages/en/help.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (c) 2017-present, Facebook, Inc. 3 | * 4 | * This source code is licensed under the MIT license found in the 5 | * LICENSE file in the root directory of this source tree. 6 | */ 7 | 8 | const React = require('react'); 9 | 10 | const CompLibrary = require('../../core/CompLibrary.js'); 11 | 12 | const Container = CompLibrary.Container; 13 | const GridBlock = CompLibrary.GridBlock; 14 | 15 | function Help(props) { 16 | const { config: siteConfig, language = '' } = props; 17 | const { baseUrl, docsUrl, communitiesUrl, repoUrl } = siteConfig; 18 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; 19 | const langPart = `${language ? `${language}/` : ''}`; 20 | const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; 21 | 22 | const supportLinks = [ 23 | { 24 | title: 'Browse docs', 25 | content: `Learn more using the [documentation on this site,](${docUrl('getting-started')}) or consult our [frequently asked questions](${docUrl('faq')}).` 26 | }, 27 | { 28 | title: 'Join the community', 29 | content: 30 | `Ask questions about the documentation and project in the SAS Visual Analytics Community. If you think you've found a bug, open an issue on GitHub.` 31 | }, 32 | { 33 | title: 'News', 34 | content: `See what's new in our latest releases.` 35 | } 36 | ]; 37 | 38 | return ( 39 |
40 | 41 |
42 |
43 |

Need help?

44 |
45 |

46 | Contact SAS Technical Support by entering a support request. 47 |

48 | 49 |
50 | 51 |
52 | ); 53 | } 54 | 55 | module.exports = Help; 56 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/pages/en/users.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (c) Facebook, Inc. and its affiliates. 3 | * 4 | * This source code is licensed under the MIT license found in the 5 | * LICENSE file in the root directory of this source tree. 6 | */ 7 | 8 | const React = require('react'); 9 | 10 | const CompLibrary = require('../../core/CompLibrary.js'); 11 | 12 | const Container = CompLibrary.Container; 13 | 14 | class Users extends React.Component { 15 | render() { 16 | const {config: siteConfig} = this.props; 17 | if ((siteConfig.users || []).length === 0) { 18 | return null; 19 | } 20 | 21 | const showcase = siteConfig.users.map((user) => ( 22 | 23 | {user.caption} 24 | 25 | )); 26 | 27 | return ( 28 |
29 | 30 |
31 |
32 |

Who is Using This?

33 |

This project is used by many folks

34 |
35 |
{showcase}
36 | {siteConfig.repoUrl && ( 37 | 38 |

Are you using this project?

39 | 42 | Add your company 43 | 44 | 45 | )} 46 |
47 | 48 |
49 | ); 50 | } 51 | } 52 | 53 | module.exports = Users; 54 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docs": { 3 | "Introduction": ["getting-started"], 4 | "Guides": ["guides/browse-reports"], 5 | "API Reference": [ 6 | "api-reference", 7 | "api/ContentAreaElement", 8 | "api/ContentBreadcrumbElement", 9 | "api/ContentGroupElement", 10 | "api/ContentLocationsElement", 11 | "api/ContentTreeElement", 12 | "api/getSASJobExecutionUrl", 13 | "api/Item", 14 | "api/ItemIdentifier", 15 | "api/LocationIdentifier", 16 | "api/LogonWrapperProps" 17 | ], 18 | "Resources": ["faq"] 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/css/code-block-buttons.css: -------------------------------------------------------------------------------- 1 | /* NOTE(mikcol): this is from instructions liked from https://docusaurus.io/docs/en/doc-markdown#adding-copy-code-buttons 2 | * copied from: https://gist.github.com/yangshun/55db997ed0f8f4e6527571fc3bee4675 */ 3 | 4 | /* "Copy" code block button */ 5 | pre { 6 | position: relative; 7 | } 8 | 9 | pre .btnIcon { 10 | position: absolute; 11 | top: 4px; 12 | z-index: 2; 13 | cursor: pointer; 14 | border: 1px solid transparent; 15 | padding: 0; 16 | color: #fff; 17 | background-color: transparent; 18 | height: 30px; 19 | transition: all .25s ease-out; 20 | } 21 | 22 | pre .btnIcon:hover { 23 | text-decoration: none; 24 | } 25 | 26 | .btnIcon__body { 27 | align-items: center; 28 | display: flex; 29 | } 30 | 31 | .btnIcon svg { 32 | fill: currentColor; 33 | margin-right: .4em; 34 | } 35 | 36 | .btnIcon__label { 37 | font-size: 11px; 38 | } 39 | 40 | .btnClipboard { 41 | right: 10px; 42 | } 43 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/css/copy-link-translator.css: -------------------------------------------------------------------------------- 1 | #vdk-slt-input { 2 | resize: none; 3 | width: 100%; 4 | font-size: 0.9rem; 5 | font-family: monospace; 6 | } 7 | 8 | #vdk-slt-output[data-hide="true"] { 9 | display: none; 10 | } 11 | 12 | /* for the copy code button */ 13 | #vdk-slt-output[data-hide="true"] + .btnIcon { 14 | display: none; 15 | } -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/aquaBank.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/aquaBank.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/aquaBank_resize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/aquaBank_resize.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/favicon.ico -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/sas-logo-wht.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/sas-logo-wht.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/sdk-monitor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/sdk-monitor.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/img/sdk-monitor_old.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/content-components/documentation/website/static/img/sdk-monitor_old.png -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/static/js/code-block-buttons.js: -------------------------------------------------------------------------------- 1 | // NOTE(mikcol): this is from instructions liked from https://docusaurus.io/docs/en/doc-markdown#adding-copy-code-buttons 2 | // | copied from: https://gist.github.com/yangshun/55db997ed0f8f4e6527571fc3bee4675 3 | 4 | // Turn off ESLint for this file because it's sent down to users as-is. 5 | /* eslint-disable */ 6 | window.addEventListener('load', function() { 7 | function button(label, ariaLabel, icon, className) { 8 | const btn = document.createElement('button'); 9 | btn.classList.add('btnIcon', className); 10 | btn.setAttribute('type', 'button'); 11 | btn.setAttribute('aria-label', ariaLabel); 12 | btn.innerHTML = 13 | '
' + 14 | icon + 15 | '' + 16 | label + 17 | '' + 18 | '
'; 19 | return btn; 20 | } 21 | 22 | function addButtons(codeBlockSelector, btn) { 23 | document.querySelectorAll(codeBlockSelector).forEach(function(code) { 24 | code.parentNode.appendChild(btn.cloneNode(true)); 25 | }); 26 | } 27 | 28 | const copyIcon = 29 | ''; 30 | 31 | addButtons( 32 | '.hljs', 33 | button('Copy', 'Copy code to clipboard', copyIcon, 'btnClipboard'), 34 | ); 35 | 36 | const clipboard = new ClipboardJS('.btnClipboard', { 37 | target: function(trigger) { 38 | return trigger.parentNode.querySelector('code'); 39 | }, 40 | }); 41 | 42 | clipboard.on('success', function(event) { 43 | event.clearSelection(); 44 | const textEl = event.trigger.querySelector('.btnIcon__label'); 45 | textEl.textContent = 'Copied'; 46 | setTimeout(function() { 47 | textEl.textContent = 'Copy'; 48 | }, 2000); 49 | }); 50 | }); -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.1.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.1.0/api/ContentAreaElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-ContentAreaElement 3 | title: ContentAreaElement 4 | original_id: ContentAreaElement 5 | --- 6 | 7 | `ContentAreaElement` is a custom HTML element that renders an entire report. This element extends `HTMLElement`. 8 | 9 | ## Custom Element Tag 10 | 11 | ```html 12 | 15 | ``` 16 | 17 | ## Attributes 18 | 19 | ### `url: string` 20 | 21 | Specify the URL of the SAS Viya server that hosts the content to display. This is the full context root, including the protocol, 22 | optional port, and host. 23 | 24 | ## Properties 25 | ### `folderIdentifier: ItemIdentifier` 26 | 27 | Specify a folder on the SAS Viya server that contains the content to display. Folder can mean several things, as specified by [ItemIdentifier](ItemIdentifier.md). 28 | 29 | ### `itemIdentifiers: ItemIdentifier[]` 30 | 31 | Specify an array of individual items on the SAS Viya server to display. See [ItemIdentifier](ItemIdentifier.md) 32 | 33 | ### `contentFilterConfig: { queryModeFilter: string; }` 34 | 35 | Specify options for filtering the content displayed in the content area. 36 | 37 | ### `contentFilterConfig.queryModeFilter: string` 38 | 39 | A SAS REST filter that is forwarded to underlying service requests. For example, to filter content to only show reports, use the following vaue: `eq(contentType,'report')`. 40 | 41 | ## Methods 42 | ### `onSelect: (selectedItems: Item[], selectAll: boolean, lastSelectedItem: Item, selected?: boolean) => void` 43 | 44 | A callback function that can be used to respond to the selection of items in the ContentAreaElement. 45 | 46 | #### Arguments 47 | 48 | `selectedItems: Item[]` 49 | 50 | The [Items](Item.md) that are currently selected. 51 | 52 | `selectAll: boolean` 53 | 54 | Whether all of the items have been selected. 55 | 56 | `lastSelectedItem: Item` 57 | 58 | The most recently selected [Item](Item.md). 59 | 60 | `selected?: boolean` 61 | 62 | True if the onSelect was triggered by a selection, false if onSelect was triggered by an un-selection. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.1.0/api/Item.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-Item 3 | title: Item 4 | original_id: Item 5 | --- 6 | 7 | `Item` is a data type representing a content item returned by many Content SDK event handlers. 8 | 9 | ## Attributes 10 | 11 | `Item` comes from the sas-drive service, and has a goal of containing all attributes that could be useful to a consumer or web client. The following are most likely to be of use in the Content SDK. 12 | 13 | ### `resource.id: string` 14 | 15 | The uri of the content item, such as the report uri or folder uri. 16 | 17 | ### `resource.type.sasType: string` 18 | 19 | The SAS type of the content item, such as 'report', 'folder', or 'file'. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.1.0/api/ItemIdentifier.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-ItemIdentifier 3 | title: ItemIdentifier 4 | original_id: ItemIdentifier 5 | --- 6 | 7 | `ItemIdentifier` is a data type for specifying content items for use with the Content SDK components. 8 | 9 | ## Attributes 10 | 11 | ### `type: 'persistentLocation' | 'folderUri'` 12 | 13 | Specify what type of content item this is. `persistentLocation` refers to a set of pre-defined SAS Viya locations. `folderUri` can be any SAS Viya folder uri. 14 | 15 | ### `value: string` 16 | 17 | 18 | - `myFolder`: the My Folder folder in SAS Viya 19 | - `favorites`: the My Favorites folder in SAS Viya 20 | - `root`: the SAS Content folder in SAS Viya 21 | - `history`: the Recents folder in SAS Viya 22 | - `trash`: the Recycle Bin folder in SAS Viya 23 | 24 | For `type: 'folderUri'`, a SAS Viya folder uri of the form: `'/folder/folders/789d13d3-789d-4fa3-9fea-123e321f1ea1'`. You can find the URI for a Folder in SAS Drive in the Information Pane. Select the Folder, scroll down in the Information Pane to the More -> URI section and copy the URI. 25 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentTreeElement`](api/ContentTreeElement.md) -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/ContentAreaElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-ContentAreaElement 3 | title: ContentAreaElement 4 | original_id: ContentAreaElement 5 | --- 6 | 7 | `ContentAreaElement` is a custom HTML element that displays the contents of a SAS Viya folder as tiles. This element extends `HTMLElement`. 8 | 9 | ## Custom Element Tag 10 | 11 | ```html 12 | 17 | ``` 18 | 19 | ## Attributes 20 | 21 | ### `initial-selection-index: number` 22 | 23 | The index of the item to be initially selected. This is most useful for starting off in a selected state, without necessarily knowing the details of the content that will be displayed. This only applies to the initial display of the ContentAreaElement. Any selections by the user, or via `setSelectedIdentifiers` will override this value, and changing the value of `initial-selection-index` from that point on will have no effect. 24 | 25 | ### `selection-mode: string` 26 | 27 | Specify the selection mode for the content. 28 | 29 | #### Values 30 | 31 | `multiple` 32 | 33 | Multiple items can be selected using the checkbox. This is the default selection mode if `selection-mode` is not specified. 34 | 35 | `single` 36 | 37 | Only one item can be selected at a time. 38 | 39 | ### `url` 40 | 41 | See [url](LogonWrapperProps.md#url). 42 | 43 | ### `authenticationType` 44 | 45 | See [authenticationType](LogonWrapperProps.md#authenticationType). 46 | 47 | ## Properties 48 | 49 | ### `onSelect: (selectedItems: Item[], selectAll: boolean, lastSelectedItem: Item, selected?: boolean) => void` 50 | 51 | A callback function that can be used to respond to the selection of items in the ContentAreaElement. 52 | 53 | #### Arguments 54 | 55 | `selectedItems: Item[]` 56 | 57 | The [Items](Item.md) that are currently selected. 58 | 59 | `selectAll: boolean` 60 | 61 | Whether all of the items have been selected. 62 | 63 | `lastSelectedItem: Item` 64 | 65 | The most recently selected [Item](Item.md). 66 | 67 | `selected?: boolean` 68 | 69 | True if the onSelect was triggered by a selection, false if onSelect was triggered by a deselection. 70 | 71 | ## Methods 72 | 73 | ### `setSelectedIdentifiers: (itemIdentifiers: ItemIdentifier[]) => void` 74 | 75 | A function that can be used to programmatically select content using ItemIdentifiers. See [ItemIdentifier](ItemIdentifier.md). 76 | 77 | #### Arguments 78 | 79 | `itemIdentifiers: ItemIdentifier[]` 80 | 81 | A set of ItemIdentifiers that identify the items to select. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/ContentBreadcrumbElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-ContentBreadcrumbElement 3 | title: ContentBreadcrumbElement 4 | original_id: ContentBreadcrumbElement 5 | --- 6 | 7 | `ContentBreadcrumbElement` is a custom HTML element that displays breadcrumb links allowing the user to navigate to previously visited folders. This element extends `HTMLElement`. 8 | 9 | ## Custom Element Tag 10 | 11 | ```html 12 | 14 | ``` 15 | 16 | ## Attributes 17 | 18 | ### `url` 19 | 20 | See [url](LogonWrapperProps.md#url). 21 | 22 | ### `authenticationType` 23 | 24 | See [authenticationType](LogonWrapperProps.md#authenticationType). 25 | 26 | ## Properties 27 | 28 | ### `onSelect: (breadcrumbPath: Item[]) => void` 29 | 30 | A callback function that can be used to respond to a breadcrumb link being selected. 31 | 32 | #### Arguments 33 | 34 | `breadcrumbPath: Item[]` 35 | 36 | An array of [Items](Item.md) representing the breadcrumb path, starting with the root. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/ContentGroupElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-ContentGroupElement 3 | title: ContentGroupElement 4 | original_id: ContentGroupElement 5 | --- 6 | 7 | `ContentGroupElement` is a custom HTML element that connects contained Content SDK components together, and enables cross component functionality, such as folder navigation, selection, and filtering. This element extends `HTMLElement`. 8 | 9 | In cases of nested grouping, components belong to the nearest ancestor group. 10 | 11 | ## Custom Element Tag 12 | 13 | ```html 14 | 15 | 16 | 17 | 18 | 19 | ``` 20 | 21 | ## Properties 22 | 23 | ### `initialNavigationValue: ContentNavigationValue` 24 | 25 | Specify initial properties related to content navigation for components in this group. 26 | 27 | ### `initialNavigationValue.location?: ItemIdentifier` 28 | 29 | The initial location that should be displayed by components such as the [ContentAreaElement](ContentAreaElement.md). See [ItemIdentifier](ItemIdentifier.md). 30 | 31 | ### `initialNavigationValue.locationContextPath?: ItemIdentifier[]` 32 | 33 | The initial location that hierarchical, path-based components should display, such as [ContentTreeElement](ContentTreeElement.md) or [ContentBreadcrumbElement](ContentBreadcrumbElement.md). See [ItemIdentifier](ItemIdentifier.md). 34 | 35 | ### `initialNavigationValue.locations?: LocationIdentifier[]` 36 | 37 | The initial set of root locations to be used by hierarchical components such as [ContentTreeElement](ContentTreeElement.md). See [LocationIdentifier](LocationIdentifier.md). 38 | 39 | ### `initialSelectionValue: ItemIdentifier[]` 40 | 41 | An array of [ItemIdentifiers](ItemIdentifier.md) which will be initially selected in the components in this group. If you specify any items that are not displayed in one of the components in the group, then those items are ignored. 42 | 43 | ### `initialFilterConfig: { queryModeFilter: string; }` 44 | 45 | Specify options for filtering the content displayed in the content group. 46 | 47 | ### `initialFilterConfig.queryModeFilter: string` 48 | 49 | A SAS REST filter that is forwarded to underlying service requests. For example, to filter content to only show reports, use the following vaue: `eq(contentType,'report')`. Any type that can be parented to a folder is supported. 50 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/ContentTreeElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-ContentTreeElement 3 | title: ContentTreeElement 4 | original_id: ContentTreeElement 5 | --- 6 | 7 | `ContentTreeElement` is a custom HTML element that displays a customizable SAS Viya folder tree for navigation. This element extends `HTMLElement`. 8 | 9 | ## Custom Element Tag 10 | 11 | ```html 12 | 15 | ``` 16 | 17 | ## Attributes 18 | 19 | ### `url` 20 | 21 | See [url](LogonWrapperProps.md#url). 22 | 23 | ### `authenticationType` 24 | 25 | See [authenticationType](LogonWrapperProps.md#authenticationType). 26 | 27 | ## Properties 28 | 29 | ### `onSelect: (node: Node, item: Item) => void` 30 | 31 | A callback function that can be used to respond to the selection of nodes in the ContentTreeElement. 32 | 33 | #### Arguments 34 | 35 | `node: Node` 36 | 37 | This is an internal component state item that is of limited use for consumers. 38 | 39 | `item: Item` 40 | 41 | The selected [Item](Item.md). 42 | 43 | ### `onExpand: (node: Node, expanded: boolean, item: Item) => void` 44 | 45 | A callback function that can be used to respond to the expansion of nodes in the ContentTreeElement. 46 | 47 | #### Arguments 48 | 49 | `node: Node` 50 | 51 | This is an internal component state item that is of limited use for consumers. 52 | 53 | `expanded: boolean` 54 | 55 | Whether or not the node was expanded. 56 | 57 | `item: Item` 58 | 59 | The expanded [Item](Item.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/ItemIdentifier.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-ItemIdentifier 3 | title: ItemIdentifier 4 | original_id: ItemIdentifier 5 | --- 6 | 7 | `ItemIdentifier` is a data type for specifying content items for use with the Content SDK components. 8 | 9 | ## Attributes 10 | 11 | ### `type: 'persistentLocation' | 'folderUri'` 12 | 13 | Specify what type of content item this is. `persistentLocation` refers to a set of pre-defined SAS Viya locations. `folderUri` can be any SAS Viya folder uri. 14 | 15 | ### `value: string` 16 | 17 | 18 | - `myFolder`: the My Folder folder in SAS Viya 19 | - `favorites`: the My Favorites folder in SAS Viya 20 | - `root`: the SAS Content folder in SAS Viya 21 | - `history`: the Recents folder in SAS Viya 22 | - `trash`: the Recycle Bin folder in SAS Viya 23 | 24 | For `type: 'folderUri'`, a SAS Viya folder uri of the form: `'/folder/folders/789d13d3-789d-4fa3-9fea-123e321f1ea1'`. You can find the URI for a Folder in SAS Drive in the Information Pane. Select the Folder, scroll down in the Information Pane to the More -> URI section and copy the URI. 25 | 26 | ![Finding folder and item URIs](assets/findUri.png) -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/LocationIdentifier.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-LocationIdentifier 3 | title: LocationIdentifier 4 | original_id: LocationIdentifier 5 | --- 6 | 7 | `LocationIdentifier` is a more limited subset of [ItemIdentifier](ItemIdentifier.md) that represents items that can be used as root locations in components such as [ContentTreeElement](ContentTreeElement.md). 8 | 9 | ## Attributes 10 | 11 | ### `type: 'persistentLocation'` 12 | 13 | Specify what type of content item this is. `persistentLocation` refers to a set of pre-defined SAS Viya locations. 14 | 15 | ### `value: string` 16 | 17 | 18 | - `myFolder`: the My Folder folder in SAS Viya 19 | - `favorites`: the My Favorites folder in SAS Viya 20 | - `root`: the SAS Content folder in SAS Viya 21 | - `history`: the Recents folder in SAS Viya 22 | - `trash`: the Recycle Bin folder in SAS Viya 23 | 24 | ### `preventExpansion: boolean` 25 | 26 | Specify whether to disable expansion for this location in the [ContentTreeElement](ContentTreeElement.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.4.0/api/LogonWrapperProps.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-LogonWrapperProps 3 | title: LogonWrapperProps 4 | original_id: LogonWrapperProps 5 | --- 6 | 7 | `LogonWrapperProps` are connection-based attributes that are common to most Content SDK components. 8 | 9 | ## Attributes 10 | 11 | ### `url: string` 12 | 13 | Specify the URL of the SAS Viya server that hosts the content to display. This is the full context root, including the protocol, 14 | optional port, and host. 15 | 16 | ### `authenticationType?: 'credentials' | 'guest'` 17 | 18 | Specify how to authenticate to the SAS Viya server. 19 | 20 | #### Values 21 | 22 | `credentials` 23 | 24 | Logon using SAS Viya credentials. This will open a popup dialog where the credentials can be entered. This is the default value if no `authenticationType` is supplied. 25 | 26 | `guest` 27 | 28 | Logon automatically as a guest to the SAS Viya deployment. The deployment needs to be configured to support guest mode. 29 | 30 | For more details, see [How is authentication handled by the SAS Content SDK?](faq.md). -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.5.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.5.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentTreeElement`](api/ContentTreeElement.md) 17 | 18 | ## Loading with a script element 19 | 20 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 21 | 22 | ```html 23 | 24 | 29 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.5.0/api/ContentGroupElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.5.0-ContentGroupElement 3 | title: ContentGroupElement 4 | original_id: ContentGroupElement 5 | --- 6 | 7 | `ContentGroupElement` is a custom HTML element that connects contained Content SDK components together, and enables cross component functionality, such as folder navigation, selection, and filtering. This element extends `HTMLElement`. 8 | 9 | In cases of nested grouping, components belong to the nearest ancestor group. 10 | 11 | ## Custom Element Tag 12 | 13 | ```html 14 | 15 | 16 | 17 | 18 | 19 | ``` 20 | 21 | ## Properties 22 | 23 | ### `initialNavigationValue: ContentNavigationValue` 24 | 25 | Specify initial properties related to content navigation for components in this group. 26 | 27 | ### `initialNavigationValue.location?: ItemIdentifier` 28 | 29 | The initial location that should be displayed by components such as the [ContentAreaElement](ContentAreaElement.md). See [ItemIdentifier](ItemIdentifier.md). 30 | 31 | ### `initialNavigationValue.locationContextPath?: ItemIdentifier[]` 32 | 33 | The initial location that hierarchical, path-based components should display, such as [ContentTreeElement](ContentTreeElement.md) or [ContentBreadcrumbElement](ContentBreadcrumbElement.md). See [ItemIdentifier](ItemIdentifier.md). 34 | 35 | ### `initialNavigationValue.locations?: LocationIdentifier[]` 36 | 37 | The initial set of root locations to be used by hierarchical components such as [ContentTreeElement](ContentTreeElement.md). See [LocationIdentifier](LocationIdentifier.md). 38 | 39 | ### `initialSelectionValue: ItemIdentifier[]` 40 | 41 | An array of [ItemIdentifiers](ItemIdentifier.md) which will be initially selected in the components in this group. If you specify any items that are not displayed in one of the components in the group, then those items are ignored. 42 | 43 | ### `initialFilterValue: { queryModeFilter: string; }` 44 | 45 | Specify options for filtering the content displayed in the content group. 46 | 47 | ### `initialFilterValue.queryModeFilter: string` 48 | 49 | A SAS REST filter that is forwarded to underlying service requests. For example, to filter content to only show reports, use the following vaue: `eq(contentType,'report')`. Any type that can be parented to a folder is supported. 50 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.6.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.6.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentTreeElement`](api/ContentTreeElement.md) 17 | 18 | ## Loading with a script element 19 | 20 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 21 | 22 | ```html 23 | 24 | 29 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.7.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.7.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentTreeElement`](api/ContentTreeElement.md) 17 | 18 | ## Loading with a script element 19 | 20 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 21 | 22 | ```html 23 | 24 | 29 | ``` 30 | 31 | ## Styling Components 32 | 33 | The SAS Content SDK components accept CSS styles by setting the "class" or "style" attributes of a component. For example: 34 | 35 | ```html 36 | 41 | 42 | 49 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.8.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.8.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentLocationsElement`](api/ContentLocationsElement.md) 17 | - [`ContentTreeElement`](api/ContentTreeElement.md) 18 | 19 | ## Loading with a script element 20 | 21 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 22 | 23 | ```html 24 | 25 | 30 | ``` 31 | 32 | ## Styling Components 33 | 34 | The SAS Content SDK components accept CSS styles by setting the "class" or "style" attributes of a component. For example: 35 | 36 | ```html 37 | 42 | 43 | 50 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.8.0/api/ContentLocationsElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.8.0-ContentLocationsElement 3 | title: ContentLocationsElement 4 | original_id: ContentLocationsElement 5 | --- 6 | 7 | `ContentLocationsElement` is a custom HTML element that displays a customizable SAS Viya "locations" list for navigation. Locations are typically Viya folders. This element extends `HTMLElement`. 8 | 9 | ## Custom Element Tag 10 | 11 | ```html 12 | 15 | ``` 16 | 17 | ## Attributes 18 | 19 | ### `url` 20 | 21 | See [url](LogonWrapperProps.md#url). 22 | 23 | ### `authenticationType` 24 | 25 | See [authenticationType](LogonWrapperProps.md#authenticationType). 26 | 27 | ## Properties 28 | 29 | ### `onSelect: (item: Item) => void` 30 | 31 | A callback function that can be used to respond to the selection of a location in the ContentLocationsElement. 32 | 33 | #### Arguments 34 | 35 | `item: Item` 36 | 37 | The selected [Item](Item.md). 38 | 39 | ### `showSeparator: boolean | (rowIndex: number) => boolean` 40 | 41 | A boolean or function used to specify which locations should have a separator above them in the UI. When using the function version, return true for rowIndices for locations which should show a separator. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.9.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.9.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | The SAS Content SDK provides a set of components and APIs that enable you to render tiles representing items (such as Report and Models) stored in SAS Viya. It also enables 8 | you to use SAS content items to drive your own processes or to interact with SAS Visual 9 | Analytics SDK. 10 | 11 | ## Top-Level Exports 12 | 13 | - [`ContentAreaElement`](api/ContentAreaElement.md) 14 | - [`ContentBreadcrumbElement`](api/ContentBreadcrumbElement.md) 15 | - [`ContentGroupElement`](api/ContentGroupElement.md) 16 | - [`ContentLocationsElement`](api/ContentLocationsElement.md) 17 | - [`ContentTreeElement`](api/ContentTreeElement.md) 18 | - [`getSASJobExecutionUrl`](api/getSASJobExecutionUrl.md) 19 | 20 | ## Loading with a script element 21 | 22 | When you load the library with a script element, the Content SDK components are not ready to configure and use until all of the other assets are loaded. The `contentSdkComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 31 | ``` 32 | 33 | ## Styling Components 34 | 35 | The SAS Content SDK components accept CSS styles by setting the "class" or "style" attributes of a component. For example: 36 | 37 | ```html 38 | 43 | 44 | 51 | ``` -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_docs/version-0.9.0/api/getSASJobExecutionUrl.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.9.0-getSASJobExecutionUrl 3 | title: getSASJobExecutionUrl 4 | original_id: getSASJobExecutionUrl 5 | --- 6 | 7 | ``` 8 | getSASJobExecutionUrl(itemUri, url): Promise 9 | ``` 10 | 11 | This function generates a SAS Job Execution URL. You can use the URL to open a job and execute it if it is a job with an HTML prompt. This URL can be opened in a new tab or window, or embedded in an iframe if allowed by the security settings on the deployment. 12 | 13 | ## Arguments 14 | 15 | ### `itemUri: string` 16 | 17 | The URI of the target job definition [Item](Item.md), such as from an `onSelect` event. This corresponds to the `resource.id` property of the Item. 18 | 19 | ### `url: string` 20 | 21 | Specify the URL of the SAS Viya server. This is the full context root, including the protocol, optional port, and host. 22 | 23 | ## Return value 24 | 25 | `getSASJobExecutionUrl` will return a Promise that resolves to the URL representing the job in SAS Job Execution. 26 | If a problem is encountered, the Promise resolves to `undefined`. Problems could include passing in an item that does not represent a job definition, not passing in a URL string, or unexpected errors with the internal service calls that are needed to generate the URL. Consumers should handle the `undefined` case, because service call failures are always a possibility. 27 | 28 | ## Embedding in an iframe 29 | 30 | By default, your SAS Viya deployment does not allow access when embedded as a cross-origin iframe. To embed the SAS Job Execution URL within an iframe with a cross-origin ancestor, the `x-frame-options-enabled` option in `sas.commons.web.security` needs to be disabled for the SAS Job Execution definition. See SAS Help Center for more information. -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_sidebars/version-0.1.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.1.0-docs": { 3 | "Introduction": [ 4 | "version-0.1.0-getting-started" 5 | ], 6 | "API Reference": [ 7 | "version-0.1.0-api-reference", 8 | "version-0.1.0-api/ContentAreaElement", 9 | "version-0.1.0-api/Item", 10 | "version-0.1.0-api/ItemIdentifier" 11 | ], 12 | "Resources": [ 13 | "version-0.1.0-faq" 14 | ] 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_sidebars/version-0.3.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.3.0-docs": { 3 | "Introduction": [ 4 | "version-0.3.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.3.0-guides/browse-reports" 8 | ], 9 | "API Reference": [ 10 | "version-0.3.0-api-reference", 11 | "version-0.3.0-api/ContentAreaElement", 12 | "version-0.3.0-api/Item", 13 | "version-0.3.0-api/ItemIdentifier" 14 | ], 15 | "Resources": [ 16 | "version-0.3.0-faq" 17 | ] 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_sidebars/version-0.4.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.4.0-docs": { 3 | "Introduction": [ 4 | "version-0.4.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.4.0-guides/browse-reports" 8 | ], 9 | "API Reference": [ 10 | "version-0.4.0-api-reference", 11 | "version-0.4.0-api/ContentAreaElement", 12 | "version-0.4.0-api/ContentBreadcrumbElement", 13 | "version-0.4.0-api/ContentGroupElement", 14 | "version-0.4.0-api/ContentTreeElement", 15 | "version-0.4.0-api/Item", 16 | "version-0.4.0-api/ItemIdentifier", 17 | "version-0.4.0-api/LocationIdentifier", 18 | "version-0.4.0-api/LogonWrapperProps" 19 | ], 20 | "Resources": [ 21 | "version-0.4.0-faq" 22 | ] 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_sidebars/version-0.8.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.8.0-docs": { 3 | "Introduction": [ 4 | "version-0.8.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.8.0-guides/browse-reports" 8 | ], 9 | "API Reference": [ 10 | "version-0.8.0-api-reference", 11 | "version-0.8.0-api/ContentAreaElement", 12 | "version-0.8.0-api/ContentBreadcrumbElement", 13 | "version-0.8.0-api/ContentGroupElement", 14 | "version-0.8.0-api/ContentLocationsElement", 15 | "version-0.8.0-api/ContentTreeElement", 16 | "version-0.8.0-api/Item", 17 | "version-0.8.0-api/ItemIdentifier", 18 | "version-0.8.0-api/LocationIdentifier", 19 | "version-0.8.0-api/LogonWrapperProps" 20 | ], 21 | "Resources": [ 22 | "version-0.8.0-faq" 23 | ] 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versioned_sidebars/version-0.9.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.9.0-docs": { 3 | "Introduction": [ 4 | "version-0.9.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.9.0-guides/browse-reports" 8 | ], 9 | "API Reference": [ 10 | "version-0.9.0-api-reference", 11 | "version-0.9.0-api/ContentAreaElement", 12 | "version-0.9.0-api/ContentBreadcrumbElement", 13 | "version-0.9.0-api/ContentGroupElement", 14 | "version-0.9.0-api/ContentLocationsElement", 15 | "version-0.9.0-api/ContentTreeElement", 16 | "version-0.9.0-api/getSASJobExecutionUrl", 17 | "version-0.9.0-api/Item", 18 | "version-0.9.0-api/ItemIdentifier", 19 | "version-0.9.0-api/LocationIdentifier", 20 | "version-0.9.0-api/LogonWrapperProps" 21 | ], 22 | "Resources": [ 23 | "version-0.9.0-faq" 24 | ] 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /sdk/content-components/documentation/website/versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | "0.9.0", 3 | "0.8.0", 4 | "0.7.0", 5 | "0.6.0", 6 | "0.5.0", 7 | "0.4.0", 8 | "0.3.0", 9 | "0.2.0", 10 | "0.1.0" 11 | ] 12 | -------------------------------------------------------------------------------- /sdk/content-components/examples/README.md: -------------------------------------------------------------------------------- 1 | # SAS Content SDK Examples 2 | 3 | **Note: Replace placeholders with valid values in these examples before running them** 4 | 5 | - Folder URI should take this form: `'/folder/folders/789d13d3-789d-4fa3-9fea-123e321f1ea1'` 6 | 7 | ## Examples 8 | 9 | - [ContentSDKWithReport](./ContentSDKWithReport.html) (docs) 10 | 11 | 12 | Uses the ``, ``, and ``, along with a `` (from the VA SDK) to display a set of tiles representing reports. Selecting a report tile will update the report being displayed below. -------------------------------------------------------------------------------- /sdk/sas-auth-browser/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.2.0 (Sep 26, 2023) 2 | 3 | - Add logout function 4 | 5 | ## 0.1.2 (May 16, 2023) 6 | 7 | - fix guest authentication 8 | 9 | ## 0.1.1 (May 31, 2022) 10 | 11 | - fix esm output 12 | -------------------------------------------------------------------------------- /sdk/sas-auth-browser/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | sas-auth-browser is not open for external contributions. 4 | -------------------------------------------------------------------------------- /sdk/va-report-components/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | va-report-components is not open for external contributions. 4 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .vscode 3 | 4 | node_modules 5 | 6 | lib/core/metadata.js 7 | lib/core/MetadataBlog.js 8 | 9 | website/translated_docs 10 | website/build/ 11 | website/yarn.lock 12 | website/package-lock.json 13 | website/node_modules 14 | website/i18n/* 15 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: api-reference 3 | title: API Reference 4 | --- 5 | 6 | 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 7 | to use SAS data to drive your own components or visualizations. 8 | 9 | ## Top-Level Exports 10 | 11 | - [`SASReportElement`](api/SASReportElement.md) 12 | - [`SASReportPageElement`](api/SASReportPageElement.md) 13 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 14 | - [`connectToServer`](api/connectToServer.md) 15 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 16 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 17 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 18 | - [`setLoadingTheme`](api/setLoadingTheme.md) 19 | - [`setLocale`](api/setLocale.md) 20 | - [`setFormatterLocale`](api/setFormatterLocale.md) 21 | 22 | ## Loading with \ 23 | 24 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 25 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 26 | 27 | ```html 28 | 29 | 35 | ``` 36 | 37 | ## Loading with imports 38 | 39 | When you load the library as an ES module, APIs are available as named imports. See the [ES module imports guide](guides/esm.md) for more information about loading the library as a module. 40 | 41 | ```ts 42 | import { connectToServer } from '@sassoftware/va-report-components'; 43 | ``` 44 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/DataDrivenContentHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: DataDrivenContentHandle 3 | title: DataDrivenContentHandle 4 | --- 5 | 6 | A `DataDrivenContentHandle` is used to dispatch messages to a data-driven content object. It can be obtained by 7 | calling [`registerDataDrivenContent`.](registerDataDrivenContent.md) 8 | 9 | ## Methods 10 | 11 | ### `dispatch(message: Object): void` 12 | 13 | Send a data selection message to the data-driven content object. For more information about the message object format, see the SAS Help Center. 14 | 15 | ### `deregister(): void` 16 | 17 | Detach this handler from the attached data-driven content object. This cleans up resources and should be called when it 18 | is no longer necessary to communicate with the object. 19 | 20 | ## The `message` object 21 | 22 | The `message` object is used to update a data-driven content object by indicating a subset of its data that should be 23 | selected. 24 | 25 | ### `resultName: string` 26 | 27 | The name of the associated query result. This can be obtained from 28 | [the `receivedMessage` object](registerDataDrivenContent.md#the-receivedmessage-object) which will be sent to 29 | [the `onMessage` callback of `registerDataDrivenContent`](api/registerDataDrivenContent.md#onmessage-receivedmessage-object-void) 30 | every time the data-driven content object is updated. 31 | 32 | ### `selections: Object[]` 33 | 34 | An array of objects representing the data to be selected. Each object has a single `row` attribute which indicates the 35 | index of the row to select. 36 | 37 | ### Example 38 | 39 | ```javascript 40 | { 41 | resultName: 'dd40', 42 | selections: [{ row: 0 }, { row: 2 }] 43 | } 44 | ``` 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/ExportDataOptions.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: ExportDataOptions 3 | title: ExportDataOptions 4 | --- 5 | 6 | ExportDataOptions provides options for customizing the properties of the report data that you want to export. If no option is specified, then the default value is used. 7 | 8 | ## Options 9 | 10 | ### `columns: string[]` 11 | Determines which data columns should be exported by specifying their labels. 12 | 13 | ### `startRow: number` 14 | Determines which row the data should begin with. 15 | 16 | default value: `0` 17 | 18 | ### `endRow: number` 19 | Determines which row the data should end with. 20 | 21 | default value: `` 22 | 23 | ### `formattedData: boolean` 24 | Controls whether formatted or unformatted data is exported. For example, if a data item has a dollar format applied, then exporting the formatted data includes the dollar sign. If this option is set to false, then the data for that item is exported as a raw number. 25 | 26 | default value: `true` 27 | 28 | ### `detailedData: boolean` 29 | Specifies whether the data is aggregated (which has fewer columns, rows, or both depending on filters that have been applied) or detailed (which has all available columns and rows). 30 | 31 | default value: `false` 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/connectToServer.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: connectToServer 3 | title: connectToServer 4 | --- 5 | 6 | ``` 7 | connectToServer(url, options): void 8 | ``` 9 | 10 | Initiate the connection to the SAS Visual Analytics server specified by the URL. Using a SASReportElement or 11 | SASReportObjectElement implicitly makes the appropriate server connection. This API is used to make a server connection 12 | before any report elements are added to the DOM. `connectToServer` is intended for use in single-page applications, or 13 | in any context where report components will not necessarily be shown immediately. In these cases, calling 14 | `connectToServer` as early as possible reduces the amount of work that needs to be done upon the first interaction with 15 | the server. 16 | 17 | ## Arguments 18 | 19 | ### `url: string` 20 | 21 | Specify the URL of the SAS Viya server. This is the full context root, including the protocol, optional port, and host. 22 | 23 | ### `options: Object` 24 | 25 | Choose additional options for how to connect to the server. The following properties are supported: 26 | 27 | - `authenticationType: string`: Choose the method to authenticate requests to the SAS Viya server. 28 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 29 | - `'credentials'` `default` uses SAS Logon to establish an authenticated session. 30 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/registerDataDrivenContent.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: registerDataDrivenContent 3 | title: registerDataDrivenContent 4 | --- 5 | 6 | ``` 7 | registerDataDrivenContent(options, onMessage): DataDrivenContentHandle 8 | ``` 9 | 10 | This function is used to receive and dispatch messages to a data-driven content object. If the report is not yet 11 | opened then this call will open it and initiate data processing for this data-driven content object. 12 | 13 | To find the correct values for `url`, `reportUri`, and `objectName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 14 | 15 | ## Arguments 16 | 17 | ### `options: Object` 18 | 19 | Choose options for how to connect to the server. The following properties are supported: 20 | 21 | - `url: string`: Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including 22 | the protocol, optional port, and host. 23 | - `reportUri: string`: Specify the report URI. 24 | - `objectName: string`: Specify name of the data-driven content object. 25 | - `authenticationType: string`: Choose the method to authenticate requests to the SAS Viya server. 26 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 27 | - `'credentials'` `default` uses SAS Logon to establish an authenticated session. 28 | 29 | ### `onMessage: (receivedMessage: ReportObjectResultData) => void` 30 | 31 | Define a callback function to handle data changes for this data-driven content object. The `receivedMessage` is a [`ReportObjectResultData`](ReportObjectResultData.md) object and is passed to the `onMessage` callback every time the data-driven content object is updated. 32 | 33 | For more information about the properties of the `receivedMessage` object as well as receiving data for data driven content, see the SAS Help Center. 34 | 35 | ## Return value 36 | 37 | `registerDataDrivenContent` returns a [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) which can be used to dispatch 38 | messages to the data-driven content object. 39 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/setFormatterLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: setFormatterLocale 3 | title: setFormatterLocale 4 | --- 5 | 6 | ``` 7 | setFormatterLocale(locale): void 8 | ``` 9 | 10 | `setFormatterLocale` enables the user to set the language that is used to format numeric values and dates. If not specified, the language will fallback to the one that is specified by calling setLocale or the one is specified in the browser settings. 11 | 12 | ## Arguments 13 | 14 | ### `locale: string | null` 15 | 16 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 17 | 18 | ## Examples 19 | 20 | ### Script Tag 21 | 22 | ```javascript 23 | window.addEventListener("vaReportComponents.loaded", function() { 24 | vaReportComponents.setFormatterLocale("fr"); 25 | }); 26 | ``` 27 | 28 | ```javascript 29 | window.addEventListener("vaReportComponents.loaded", function() { 30 | vaReportComponents.setFormatterLocale("fr-CA"); 31 | }); 32 | ``` 33 | 34 | ### ESM 35 | 36 | ```javascript 37 | import { setFormatterLocale } from "@sassoftware/va-report-components"; 38 | setFormatterLocale("fr"); 39 | ``` 40 | 41 | ```javascript 42 | import { setFormatterLocale } from "@sassoftware/va-report-components"; 43 | setFormatterLocale("fr-CA"); 44 | ``` 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/setLoadingTheme.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: setLoadingTheme 3 | title: setLoadingTheme 4 | --- 5 | 6 | ``` 7 | setLoadingTheme(options): void 8 | ``` 9 | 10 | `setLoadingTheme` allows the user to set the theme of the sdk before a report loads. You might want to set the theme for the initial loading state to match the website that the SAS Visual Analytic SDK is embedded in. You also might want to set the loading theme to be consistent with the report that will be loaded. 11 | 12 | `setLoadingTheme` only affects the initial loading and logon states. It does not affect the report theme once a report has been loaded. 13 | 14 | ## Arguments 15 | 16 | ### `options: Object | 'light' | 'dark' | 'high-contrast'` 17 | 18 | When you select `'light'`, `'dark'`, or `'high-contrast'`, then the loading theme is based on one of the built-in themes. 19 | 20 | Alternatively, you can specify theme values. The following optional properties are supported: 21 | 22 | - `baseTheme: 'light' | 'dark'`: The base theme that is used for loading the theme values. The theme values are used when no defaults are provided. For example, if backgroundColor is not specified and the baseTheme is light, then the backgoundColor will be white since that is the theme's background color. **default**:`light` 23 | 24 | You can further customize the loading style with additional style properties. Some examples are provided below to show you how certain options affect the theme. The following style overrides are available: 25 | 26 | - `primary: string`: The logon button background and loading indicator. 27 | - `backgroundColor: string` 28 | - `textColor: string` 29 | - `textColorInverse: string` The button text color for the logon state. 30 | - `fontFamily: string` 31 | 32 | ## Examples 33 | 34 | ### Script Tag 35 | 36 | ```javascript 37 | window.addEventListener("vaReportComponents.loaded", function() { 38 | vaReportComponents.setLoadingTheme("dark"); 39 | }); 40 | ``` 41 | 42 | ```javascript 43 | window.addEventListener("vaReportComponents.loaded", function() { 44 | vaReportComponents.setLoadingTheme({ 45 | baseTheme: "dark", 46 | primary: "#FFA500", 47 | fontFamily: "Gothic", 48 | }); 49 | }); 50 | ``` 51 | 52 | ### ESM 53 | 54 | ```javascript 55 | import { setLoadingTheme } from "@sassoftware/va-report-components"; 56 | setLoadingTheme("dark"); 57 | ``` 58 | 59 | ```javascript 60 | import { setLoadingTheme } from "@sassoftware/va-report-components"; 61 | setLoadingTheme({ 62 | baseTheme: "dark", 63 | primary: "#FFA500", 64 | fontFamily: "Gothic", 65 | }); 66 | ``` 67 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/setLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: setLocale 3 | title: setLocale 4 | --- 5 | 6 | ``` 7 | setLocale(locale): void 8 | ``` 9 | 10 | `setLocale` enables the user to set an override for the language that is specified in the browser settings. 11 | 12 | ## Arguments 13 | 14 | ### `locale: string | null` 15 | 16 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 17 | 18 | ## Examples 19 | 20 | ### Script Tag 21 | 22 | ```javascript 23 | window.addEventListener("vaReportComponents.loaded", function() { 24 | vaReportComponents.setLocale("fr"); 25 | }); 26 | ``` 27 | 28 | ```javascript 29 | window.addEventListener("vaReportComponents.loaded", function() { 30 | vaReportComponents.setLocale("fr-CA"); 31 | }); 32 | ``` 33 | 34 | ### ESM 35 | 36 | ```javascript 37 | import { setLocale } from "@sassoftware/va-report-components"; 38 | setLocale("fr"); 39 | ``` 40 | 41 | ```javascript 42 | import { setLocale } from "@sassoftware/va-report-components"; 43 | setLocale("fr-CA"); 44 | ``` 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/api/setUseHighContrastReportTheme.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: setUseHighContrastReportTheme 3 | title: setUseHighContrastReportTheme 4 | --- 5 | 6 | ``` 7 | setUseHighContrastReportTheme(enabled): void 8 | ``` 9 | 10 | Configure whether report contents should display with the SAS High Contrast 11 | report theme. When called with `true`, all report objects are overriden to 12 | use the SAS High Contrast report theme, and any report styles that might 13 | reduce readability are ignored. When called with `false`, the override is 14 | turned off. Whenever the function is called with a new value, all report 15 | objects are reloaded to reflect the latest value of the setting. The SAS High 16 | Contrast report theme override is disabled by default. 17 | 18 | ## Arguments 19 | 20 | ### `enabled: boolean` 21 | 22 | Whether the SAS High Contrast report theme override should be enabled or 23 | disabled. 24 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/assets/data-driven-content.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/docs/assets/data-driven-content.png -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/docs/assets/report-overflow-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/docs/assets/report-overflow-menu.png -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/core/Footer.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (c) 2017-present, Facebook, Inc. 3 | * 4 | * This source code is licensed under the MIT license found in the 5 | * LICENSE file in the root directory of this source tree. 6 | */ 7 | 8 | const React = require('react'); 9 | 10 | class Footer extends React.Component { 11 | docUrl(doc, language) { 12 | const baseUrl = this.props.config.baseUrl; 13 | const docsUrl = this.props.config.docsUrl; 14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; 15 | const langPart = `${language ? `${language}/` : ''}`; 16 | return `${baseUrl}${docsPart}${langPart}${doc}`; 17 | } 18 | 19 | pageUrl(doc, language) { 20 | const baseUrl = this.props.config.baseUrl; 21 | return baseUrl + (language ? `${language}/` : '') + doc; 22 | } 23 | 24 | render() { 25 | return ( 26 | 62 | ); 63 | } 64 | } 65 | 66 | module.exports = Footer; 67 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "scripts": { 3 | "examples": "docusaurus-examples", 4 | "start": "docusaurus-start", 5 | "build": "docusaurus-build", 6 | "publish-gh-pages": "docusaurus-publish", 7 | "write-translations": "docusaurus-write-translations", 8 | "version": "docusaurus-version", 9 | "rename-version": "docusaurus-rename-version" 10 | }, 11 | "devDependencies": { 12 | "docusaurus": "^1.12.0" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/pages/en/help.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (c) 2017-present, Facebook, Inc. 3 | * 4 | * This source code is licensed under the MIT license found in the 5 | * LICENSE file in the root directory of this source tree. 6 | */ 7 | 8 | const React = require('react'); 9 | 10 | const CompLibrary = require('../../core/CompLibrary.js'); 11 | 12 | const Container = CompLibrary.Container; 13 | const GridBlock = CompLibrary.GridBlock; 14 | 15 | function Help(props) { 16 | const { config: siteConfig, language = '' } = props; 17 | const { baseUrl, docsUrl, communitiesUrl, repoUrl } = siteConfig; 18 | const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; 19 | const langPart = `${language ? `${language}/` : ''}`; 20 | const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; 21 | 22 | const supportLinks = [ 23 | { 24 | title: 'Browse docs', 25 | content: `Learn more using the [documentation on this site,](${docUrl('getting-started')}) or consult our [frequently asked questions](${docUrl('faq')}).` 26 | }, 27 | { 28 | title: 'Join the community', 29 | content: 30 | `Ask questions about the documentation and project in the SAS Visual Analytics Community. If you think you've found a bug, open an issue on GitHub.` 31 | }, 32 | { 33 | title: 'News', 34 | content: `See what's new in our latest releases.` 35 | } 36 | ]; 37 | 38 | return ( 39 |
40 | 41 |
42 |
43 |

Need help?

44 |
45 |

46 | Contact SAS Technical Support by entering a support request. 47 |

48 | 49 |
50 | 51 |
52 | ); 53 | } 54 | 55 | module.exports = Help; 56 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "docs": { 3 | "Introduction": ["getting-started"], 4 | "Guides": [ 5 | "guides/viya-setup", 6 | "guides/export-report-package", 7 | "guides/data-driven-content", 8 | "guides/esm" 9 | ], 10 | "API Reference": [ 11 | "api-reference", 12 | "api/SASReportElement", 13 | "api/SASReportPageElement", 14 | "api/SASReportObjectElement", 15 | "api/ReportHandle", 16 | "api/ObjectHandle", 17 | "api/ExportPDFOptions", 18 | "api/ExportDataOptions", 19 | "api/MenuItemProvider", 20 | "api/connectToServer", 21 | "api/registerDataDrivenContent", 22 | "api/DataDrivenContentHandle", 23 | "api/ReportObjectResultData", 24 | "api/setUseHighContrastReportTheme", 25 | "api/setLoadingTheme", 26 | "api/setLocale", 27 | "api/setFormatterLocale" 28 | ], 29 | "Resources": ["faq"] 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/css/code-block-buttons.css: -------------------------------------------------------------------------------- 1 | /* NOTE(mikcol): this is from instructions liked from https://docusaurus.io/docs/en/doc-markdown#adding-copy-code-buttons 2 | * copied from: https://gist.github.com/yangshun/55db997ed0f8f4e6527571fc3bee4675 */ 3 | 4 | /* "Copy" code block button */ 5 | pre { 6 | position: relative; 7 | } 8 | 9 | pre .btnIcon { 10 | position: absolute; 11 | top: 4px; 12 | z-index: 2; 13 | cursor: pointer; 14 | border: 1px solid transparent; 15 | padding: 0; 16 | color: #fff; 17 | background-color: transparent; 18 | height: 30px; 19 | transition: all .25s ease-out; 20 | } 21 | 22 | pre .btnIcon:hover { 23 | text-decoration: none; 24 | } 25 | 26 | .btnIcon__body { 27 | align-items: center; 28 | display: flex; 29 | } 30 | 31 | .btnIcon svg { 32 | fill: currentColor; 33 | margin-right: .4em; 34 | } 35 | 36 | .btnIcon__label { 37 | font-size: 11px; 38 | } 39 | 40 | .btnClipboard { 41 | right: 10px; 42 | } 43 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/css/copy-link-translator.css: -------------------------------------------------------------------------------- 1 | #vdk-slt-input { 2 | resize: none; 3 | width: 100%; 4 | font-size: 0.9rem; 5 | font-family: monospace; 6 | } 7 | 8 | #vdk-slt-output[data-hide="true"] { 9 | display: none; 10 | } 11 | 12 | /* for the copy code button */ 13 | #vdk-slt-output[data-hide="true"] + .btnIcon { 14 | display: none; 15 | } -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/img/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/website/static/img/favicon.ico -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/img/sas-logo-wht.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/website/static/img/sas-logo-wht.png -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/img/sdk-monitor-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/website/static/img/sdk-monitor-2.png -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/img/sdk-monitor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sassoftware/sas-viya-sdk-js/fc214789029f9c0f80235b05440830b9845e6c62/sdk/va-report-components/documentation/website/static/img/sdk-monitor.png -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/static/js/code-block-buttons.js: -------------------------------------------------------------------------------- 1 | // NOTE(mikcol): this is from instructions liked from https://docusaurus.io/docs/en/doc-markdown#adding-copy-code-buttons 2 | // | copied from: https://gist.github.com/yangshun/55db997ed0f8f4e6527571fc3bee4675 3 | 4 | // Turn off ESLint for this file because it's sent down to users as-is. 5 | /* eslint-disable */ 6 | window.addEventListener('load', function() { 7 | function button(label, ariaLabel, icon, className) { 8 | const btn = document.createElement('button'); 9 | btn.classList.add('btnIcon', className); 10 | btn.setAttribute('type', 'button'); 11 | btn.setAttribute('aria-label', ariaLabel); 12 | btn.innerHTML = 13 | '
' + 14 | icon + 15 | '' + 16 | label + 17 | '' + 18 | '
'; 19 | return btn; 20 | } 21 | 22 | function addButtons(codeBlockSelector, btn) { 23 | document.querySelectorAll(codeBlockSelector).forEach(function(code) { 24 | code.parentNode.appendChild(btn.cloneNode(true)); 25 | }); 26 | } 27 | 28 | const copyIcon = 29 | ''; 30 | 31 | addButtons( 32 | '.hljs', 33 | button('Copy', 'Copy code to clipboard', copyIcon, 'btnClipboard'), 34 | ); 35 | 36 | const clipboard = new ClipboardJS('.btnClipboard', { 37 | target: function(trigger) { 38 | return trigger.parentNode.querySelector('code'); 39 | }, 40 | }); 41 | 42 | clipboard.on('success', function(event) { 43 | event.clearSelection(); 44 | const textEl = event.trigger.querySelector('.btnIcon__label'); 45 | textEl.textContent = 'Copied'; 46 | setTimeout(function() { 47 | textEl.textContent = 'Copy'; 48 | }, 2000); 49 | }); 50 | }); -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.1.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 14 | - [`connectToServer`](api/connectToServer.md) 15 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 16 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 17 | 18 | ## Loading with \ 19 | 20 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 21 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 22 | 23 | ```html 24 | 25 | 31 | ``` 32 | 33 | ## Importing 34 | 35 | All top-level exports can be imported like this: 36 | 37 | ### ES5 (UMD) 38 | 39 | ```javascript 40 | const connectToServer = vaReportComponents.connectToServer; 41 | ``` 42 | 43 | ### ES6 44 | 45 | ```javascript 46 | import { connectToServer } from '@sassoftware/va-report-components'; 47 | ``` -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.1.0/api/DataDrivenContentHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-DataDrivenContentHandle 3 | title: DataDrivenContentHandle 4 | original_id: DataDrivenContentHandle 5 | --- 6 | 7 | A `DataDrivenContentHandle` is used to dispatch messages to a data-driven content object. It can be obtained by 8 | calling [`registerDataDrivenContent`.](registerDataDrivenContent.md) 9 | 10 | ## Methods 11 | 12 | ### `dispatch(message: Object): void` 13 | 14 | Send a data selection message to the data-driven content object. The message object should be of the form specified in 15 | the SAS documentation for Selection Handling. 16 | 17 | ### `deregister(): void` 18 | 19 | Detach this handler from the attached data-driven content object. This cleans up resources and should be called when it 20 | is no longer necessary to communicate with the object. 21 | 22 | ## The `message` object 23 | 24 | The `message` object is used to update a data-driven content object by indicating a subset of its data that should be 25 | selected. 26 | 27 | ### `resultName: string` 28 | 29 | The name of the associated query result. This can be obtained from 30 | [the `receivedMessage` object](registerDataDrivenContent.md#the-receivedmessage-object) which will be sent to 31 | [the `onMessage` callback of `registerDataDrivenContent`](api/registerDataDrivenContent.md#onmessage-receivedmessage-object-void) 32 | every time the data-driven content object is updated. 33 | 34 | ### `selections: Object[]` 35 | 36 | An array of objects representing the data to be selected. Each object has a single `row` attribute which indicates the 37 | index of the row to select. 38 | 39 | ### Example 40 | 41 | ```javascript 42 | { 43 | resultName: 'dd40', 44 | selections: [{ row: 0 }, { row: 2 }] 45 | } 46 | ``` 47 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.1.0/api/SASReportObjectElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-SASReportObjectElement 3 | title: SASReportObjectElement 4 | original_id: SASReportObjectElement 5 | --- 6 | 7 | `SASReportObjectElement` is a custom HTML element that renders a report object. This could be a single object or a 8 | container of multiple objects. This element extends `HTMLElement`. 9 | 10 | Check out [the Getting Started page](getting-started.md#create-a-custom-html-tag) to learn how to find 11 | the correct values for `url`, `reportUri`, and `objectName`. 12 | 13 | ## Custom Element Tag 14 | 15 | ```html 16 | 22 | ``` 23 | 24 | ## Attributes 25 | 26 | ### `authenticationType: string` 27 | 28 | Choose the method that will be used to authenticate requests to the SAS Viya server. 29 | 30 | Currently the only valid value is `"guest"`. This attribute is required to support a future update where `"credential"` 31 | will be the default. 32 | 33 | ### `url: string` 34 | 35 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 36 | optional port, and host. 37 | 38 | ### `reportUri: string` 39 | 40 | Specify the report URI. 41 | 42 | ### `objectName: string` 43 | 44 | Specify the name of the object from the report to display. 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.1.0/api/connectToServer.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.1.0-connectToServer 3 | title: connectToServer 4 | original_id: connectToServer 5 | --- 6 | 7 | ``` 8 | connectToServer(url, options): void 9 | ``` 10 | 11 | Initiate the connection to the SAS Visual Analytics server specified by the URL. Using a SASReportElement or 12 | SASReportObjectElement implicitly makes the appropriate server connection. This API is used to make a server connection 13 | before any report elements are added to the DOM. `connectToServer` is intended for use in single-page applications, or 14 | in any context where report components will not necessarily be shown immediately. In these cases, calling 15 | `connectToServer` as early as possible reduces the amount of work that needs to be done upon the first interaction with 16 | the server. 17 | 18 | ## Arguments 19 | 20 | ### `url: string` 21 | 22 | Specify the URL of the SAS Viya server. This is the full context root, including the protocol, optional port, and host. 23 | 24 | ### `options: Object` 25 | 26 | Choose additional options for how to connect to the server. The following properties are supported: 27 | 28 | - `authenticationType: string`: Choose the method that will be used to authenticate requests to the SAS Viya server. 29 | - Currently the only valid value is `"guest"`. This attribute is required to support a future update where 30 | `"credential"` will be the default. 31 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.10.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.10.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.11.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.11.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.12.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.12.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.13.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.13.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.14.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.14.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.15.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.15.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.16.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.16.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | 20 | ## Loading with \ 21 | 22 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 23 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 24 | 25 | ```html 26 | 27 | 33 | ``` 34 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.16.0/api/DataDrivenContentHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.16.0-DataDrivenContentHandle 3 | title: DataDrivenContentHandle 4 | original_id: DataDrivenContentHandle 5 | --- 6 | 7 | A `DataDrivenContentHandle` is used to dispatch messages to a data-driven content object. It can be obtained by 8 | calling [`registerDataDrivenContent`.](registerDataDrivenContent.md) 9 | 10 | ## Methods 11 | 12 | ### `dispatch(message: Object): void` 13 | 14 | Send a data selection message to the data-driven content object. For more information about the message object format, see the SAS Help Center. 15 | 16 | ### `deregister(): void` 17 | 18 | Detach this handler from the attached data-driven content object. This cleans up resources and should be called when it 19 | is no longer necessary to communicate with the object. 20 | 21 | ## The `message` object 22 | 23 | The `message` object is used to update a data-driven content object by indicating a subset of its data that should be 24 | selected. 25 | 26 | ### `resultName: string` 27 | 28 | The name of the associated query result. This can be obtained from 29 | [the `receivedMessage` object](registerDataDrivenContent.md#the-receivedmessage-object) which will be sent to 30 | [the `onMessage` callback of `registerDataDrivenContent`](api/registerDataDrivenContent.md#onmessage-receivedmessage-object-void) 31 | every time the data-driven content object is updated. 32 | 33 | ### `selections: Object[]` 34 | 35 | An array of objects representing the data to be selected. Each object has a single `row` attribute which indicates the 36 | index of the row to select. 37 | 38 | ### Example 39 | 40 | ```javascript 41 | { 42 | resultName: 'dd40', 43 | selections: [{ row: 0 }, { row: 2 }] 44 | } 45 | ``` 46 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.16.0/api/setUseHighContrastReportTheme.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.16.0-setUseHighContrastReportTheme 3 | title: setUseHighContrastReportTheme 4 | original_id: setUseHighContrastReportTheme 5 | --- 6 | 7 | ``` 8 | setUseHighContrastReportTheme(enabled): void 9 | ``` 10 | 11 | Configure whether report contents should display with the SAS High Contrast 12 | report theme. When called with `true`, all report objects are overriden to 13 | use the SAS High Contrast report theme, and any report styles that might 14 | reduce readability are ignored. When called with `false`, the override is 15 | turned off. Whenever the function is called with a new value, all report 16 | objects are reloaded to reflect the latest value of the setting. The SAS High 17 | Contrast report theme override is disabled by default. 18 | 19 | ## Arguments 20 | 21 | ### `enabled: boolean` 22 | 23 | Whether the SAS High Contrast report theme override should be enabled or 24 | disabled. 25 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.17.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.17.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | 20 | ## Loading with \ 21 | 22 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 23 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 24 | 25 | ```html 26 | 27 | 33 | ``` 34 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.18.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.18.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | 20 | ## Loading with \ 21 | 22 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 23 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 24 | 25 | ```html 26 | 27 | 33 | ``` 34 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.18.0/api/ObjectHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.18.0-ObjectHandle 3 | title: ObjectHandle 4 | original_id: ObjectHandle 5 | --- 6 | 7 | An `ObjectHandle` is used to perform actions on a single object in an open 8 | report. An object's handle can be obtained using the `getObjectHandle` method 9 | on a [`ReportHandle`](ReportHandle.md). 10 | 11 | When a report element is assigned new attribute values or removed from the DOM, 12 | any `ObjectHandles` obtained from that element are invalidated and should be 13 | discarded. 14 | 15 | ## Methods 16 | 17 | ### refreshData(): void 18 | 19 | Refreshes the data for the report object that is controlled by the 20 | `ObjectHandle`. 21 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.19.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.19.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.19.0/api/setLoadingTheme.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.19.0-setLoadingTheme 3 | title: setLoadingTheme 4 | original_id: setLoadingTheme 5 | --- 6 | 7 | ``` 8 | setLoadingTheme(options): void 9 | ``` 10 | 11 | `setLoadingTheme` allows the user to set the theme of the sdk before a report loads. You might want to set the theme for the initial loading state to match the website that the SAS Visual Analytic SDK is embedded in. You also might want to set the loading theme to be consistent with the report that will be loaded. 12 | 13 | 14 | `setLoadingTheme` only affects the initial loading and logon states. It does not affect the report theme once a report has been loaded. 15 | 16 | ## Arguments 17 | 18 | ### `options: Object | 'light' | 'dark' | 'high-contrast'` 19 | 20 | When you select `'light'`, `'dark'`, or `'high-contrast'`, then the loading theme is based on one of the built-in themes. 21 | 22 | 23 | Alternatively, you can specify theme values. The following optional properties are supported: 24 | 25 | - `baseTheme: 'light' | 'dark'`: The base theme that is used for loading the theme values. The theme values are used when no defaults are provided. For example, if backgroundColor is not specified and the baseTheme is light, then the backgoundColor will be white since that is the theme's background color. **default**:`light` 26 | 27 | You can further customize the loading style with additional style properties. Some examples are provided below to show you how certain options affect the theme. The following style overrides are available: 28 | - `primary: string`: The logon button background and loading indicator. 29 | - `backgroundColor: string` 30 | - `textColor: string` 31 | - `textColorInverse: string` The button text color for the logon state. 32 | - `fontFamily: string` 33 | 34 | 35 | ### Examples 36 | 37 | ```javascript 38 | window.addEventListener('vaReportComponents.loaded', function() { 39 | vaReportComponents.setLoadingTheme('dark'); 40 | }); 41 | ``` 42 | 43 | ```javascript 44 | window.addEventListener('vaReportComponents.loaded', function() { 45 | vaReportComponents.setLoadingTheme({ 46 | baseTheme: 'dark', 47 | primary: '#FFA500', 48 | fontFamily: 'Gothic', 49 | }); 50 | }); 51 | ``` -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.2.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.2.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 14 | - [`connectToServer`](api/connectToServer.md) 15 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 16 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 17 | 18 | ## Loading with \ 19 | 20 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 21 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 22 | 23 | ```html 24 | 25 | 31 | ``` 32 | 33 | ## Importing 34 | 35 | All top-level exports can be imported like this: 36 | 37 | ### ES5 (UMD) 38 | 39 | ```javascript 40 | const connectToServer = vaReportComponents.connectToServer; 41 | ``` 42 | 43 | ### ES6 44 | 45 | ```javascript 46 | import { connectToServer } from '@sassoftware/va-report-components'; 47 | ``` -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.2.0/api/SASReportObjectElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.2.0-SASReportObjectElement 3 | title: SASReportObjectElement 4 | original_id: SASReportObjectElement 5 | --- 6 | 7 | `SASReportObjectElement` is a custom HTML element that renders a report object. This could be a single object or a 8 | container of multiple objects. This element extends `HTMLElement`. 9 | 10 | Check out [the Getting Started page](getting-started.md#create-a-custom-html-tag) to learn how to find 11 | the correct values for `url`, `reportUri`, and `objectName`. 12 | 13 | ## Custom Element Tag 14 | 15 | ```html 16 | 22 | ``` 23 | 24 | ## Attributes 25 | 26 | ### `authenticationType: string` 27 | 28 | Choose the method to authenticate requests to the SAS Viya server. 29 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 30 | - `'credentials'` uses SAS Logon to establish an authenticated session. 31 | 32 | default value: `'credentials'` 33 | 34 | ### `url: string` 35 | 36 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 37 | optional port, and host. 38 | 39 | ### `reportUri: string` 40 | 41 | Specify the report URI. 42 | 43 | ### `objectName: string` 44 | 45 | Specify the name of the object from the report to display. 46 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.2.0/api/connectToServer.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.2.0-connectToServer 3 | title: connectToServer 4 | original_id: connectToServer 5 | --- 6 | 7 | ``` 8 | connectToServer(url, options): void 9 | ``` 10 | 11 | Initiate the connection to the SAS Visual Analytics server specified by the URL. Using a SASReportElement or 12 | SASReportObjectElement implicitly makes the appropriate server connection. This API is used to make a server connection 13 | before any report elements are added to the DOM. `connectToServer` is intended for use in single-page applications, or 14 | in any context where report components will not necessarily be shown immediately. In these cases, calling 15 | `connectToServer` as early as possible reduces the amount of work that needs to be done upon the first interaction with 16 | the server. 17 | 18 | ## Arguments 19 | 20 | ### `url: string` 21 | 22 | Specify the URL of the SAS Viya server. This is the full context root, including the protocol, optional port, and host. 23 | 24 | ### `options: Object` 25 | 26 | Choose additional options for how to connect to the server. The following properties are supported: 27 | 28 | - `authenticationType: string`: Choose the method to authenticate requests to the SAS Viya server. 29 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 30 | - `'credentials'` `default` uses SAS Logon to establish an authenticated session. 31 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.20.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.20.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.3.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.3.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 14 | - [`connectToServer`](api/connectToServer.md) 15 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 16 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 17 | 18 | ## Loading with \ 19 | 20 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 21 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 22 | 23 | ```html 24 | 25 | 31 | ``` 32 | 33 | ## Importing 34 | 35 | All top-level exports can be imported like this: 36 | 37 | ### ES5 (UMD) 38 | 39 | ```javascript 40 | const connectToServer = vaReportComponents.connectToServer; 41 | ``` 42 | 43 | ### ES6 44 | 45 | ```javascript 46 | import { connectToServer } from '@sassoftware/va-report-components'; 47 | ``` -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.3.0/api/SASReportObjectElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.3.0-SASReportObjectElement 3 | title: SASReportObjectElement 4 | original_id: SASReportObjectElement 5 | --- 6 | 7 | `SASReportObjectElement` is a custom HTML element that renders a report object. This could be a single object or a 8 | container of multiple objects. This element extends `HTMLElement`. 9 | 10 | To find the correct values for `url`, `reportUri`, and `objectName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 11 | 12 | ## Custom Element Tag 13 | 14 | ```html 15 | 21 | ``` 22 | 23 | ## Attributes 24 | 25 | ### `authenticationType: string` 26 | 27 | Choose the method to authenticate requests to the SAS Viya server. 28 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 29 | - `'credentials'` uses SAS Logon to establish an authenticated session. 30 | 31 | default value: `'credentials'` 32 | 33 | ### `url: string` 34 | 35 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 36 | optional port, and host. 37 | 38 | ### `reportUri: string` 39 | 40 | Specify the report URI. 41 | 42 | ### `objectName: string` 43 | 44 | Specify the name of the object from the report to display. 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.3.0/api/SASReportPageElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.3.0-SASReportPageElement 3 | title: SASReportPageElement 4 | original_id: SASReportPageElement 5 | --- 6 | 7 | `SASReportPageElement` is a custom HTML element that renders a report page. This element extends `HTMLElement`. 8 | 9 | To find the correct values for `url`, `reportUri`, and `pageName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 10 | 11 | ## Custom Element Tag 12 | 13 | ```html 14 | 20 | ``` 21 | 22 | ## Attributes 23 | 24 | ### `authenticationType: string` 25 | 26 | Choose the method to authenticate requests to the SAS Viya server. 27 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 28 | - `'credentials'` uses SAS Logon to establish an authenticated session. 29 | 30 | default value: `'credentials'` 31 | 32 | ### `url: string` 33 | 34 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 35 | optional port, and host. 36 | 37 | ### `reportUri: string` 38 | 39 | Specify the report URI. 40 | 41 | ### `pageName: string` 42 | 43 | Specify the name of the report page that you want to display. Either `pageName` or `pageIndex` can be used, but not both. 44 | 45 | ### `pageIndex: number` 46 | 47 | Specify the index of the report page that you want to display. `0` is the first page. Either `pageName` or `pageIndex` can be used, but not both. 48 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.4.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | 34 | ## Importing 35 | 36 | All top-level exports can be imported like this: 37 | 38 | ### ES5 (UMD) 39 | 40 | ```javascript 41 | const connectToServer = vaReportComponents.connectToServer; 42 | ``` 43 | 44 | ### ES6 45 | 46 | ```javascript 47 | import { connectToServer } from '@sassoftware/va-report-components'; 48 | ``` -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.4.0/api/DataDrivenContentHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-DataDrivenContentHandle 3 | title: DataDrivenContentHandle 4 | original_id: DataDrivenContentHandle 5 | --- 6 | 7 | A `DataDrivenContentHandle` is used to dispatch messages to a data-driven content object. It can be obtained by 8 | calling [`registerDataDrivenContent`.](registerDataDrivenContent.md) 9 | 10 | ## Methods 11 | 12 | ### `dispatch(message: Object): void` 13 | 14 | Send a data selection message to the data-driven content object. The message object should be of the form specified in 15 | the SAS documentation for Selection Handling. 16 | 17 | ### `deregister(): void` 18 | 19 | Detach this handler from the attached data-driven content object. This cleans up resources and should be called when it 20 | is no longer necessary to communicate with the object. 21 | 22 | ## The `message` object 23 | 24 | The `message` object is used to update a data-driven content object by indicating a subset of its data that should be 25 | selected. 26 | 27 | ### `resultName: string` 28 | 29 | The name of the associated query result. This can be obtained from 30 | [the `receivedMessage` object](registerDataDrivenContent.md#the-receivedmessage-object) which will be sent to 31 | [the `onMessage` callback of `registerDataDrivenContent`](api/registerDataDrivenContent.md#onmessage-receivedmessage-object-void) 32 | every time the data-driven content object is updated. 33 | 34 | ### `selections: Object[]` 35 | 36 | An array of objects representing the data to be selected. Each object has a single `row` attribute which indicates the 37 | index of the row to select. 38 | 39 | ### Example 40 | 41 | ```javascript 42 | { 43 | resultName: 'dd40', 44 | selections: [{ row: 0 }, { row: 2 }] 45 | } 46 | ``` 47 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.4.0/api/SASReportObjectElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-SASReportObjectElement 3 | title: SASReportObjectElement 4 | original_id: SASReportObjectElement 5 | --- 6 | 7 | `SASReportObjectElement` is a custom HTML element that renders a report object. This could be a single object or a 8 | container of multiple objects. This element extends `HTMLElement`. 9 | 10 | To find the correct values for `url`, `reportUri`, and `objectName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 11 | 12 | ## Custom Element Tag 13 | 14 | ```html 15 | 21 | ``` 22 | 23 | ## Attributes 24 | 25 | ### `authenticationType: string` 26 | 27 | Choose the method to authenticate requests to the SAS Viya server. 28 | 29 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 30 | - `'credentials'` uses SAS Logon to establish an authenticated session. 31 | 32 | default value: `'credentials'` 33 | 34 | ### `url: string` 35 | 36 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 37 | optional port, and host. 38 | 39 | ### `reportUri: string` 40 | 41 | Specify the report URI. 42 | 43 | ### `objectName: string` 44 | 45 | Specify the name of the object from the report to display. 46 | 47 | ## Methods 48 | 49 | ### `getReportHandle(): Promise` 50 | 51 | Get a [ReportHandle](ReportHandle.md) for controlling the state of the 52 | current report. 53 | 54 | If called before the element is added to the DOM, the promise will resolve 55 | after the object begins to load. 56 | 57 | The [ReportHandle](ReportHandle.md) is invalidated when attributes on the 58 | `SASReportObjectElement` are changed and when the element is removed from the 59 | DOM. To obtain another [ReportHandle](ReportHandle.md), discard the previous 60 | result and call `getReportHandle` again. 61 | 62 | [ReportHandles](ReportHandle.md) from `SASReportObjectElement` are shared 63 | between objects from the same report. 64 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.4.0/api/SASReportPageElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.4.0-SASReportPageElement 3 | title: SASReportPageElement 4 | original_id: SASReportPageElement 5 | --- 6 | 7 | `SASReportPageElement` is a custom HTML element that renders a report page. This element extends `HTMLElement`. 8 | 9 | To find the correct values for `url`, `reportUri`, and `pageName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 10 | 11 | ## Custom Element Tag 12 | 13 | ```html 14 | 20 | ``` 21 | 22 | ## Attributes 23 | 24 | ### `authenticationType: string` 25 | 26 | Choose the method to authenticate requests to the SAS Viya server. 27 | 28 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 29 | - `'credentials'` uses SAS Logon to establish an authenticated session. 30 | 31 | default value: `'credentials'` 32 | 33 | ### `url: string` 34 | 35 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 36 | optional port, and host. 37 | 38 | ### `reportUri: string` 39 | 40 | Specify the report URI. 41 | 42 | ### `pageName: string` 43 | 44 | Specify the name of the report page that you want to display. Either `pageName` or `pageIndex` can be used, but not both. 45 | 46 | ### `pageIndex: number` 47 | 48 | Specify the index of the report page that you want to display. `0` is the first page. Either `pageName` or `pageIndex` can be used, but not both. 49 | 50 | ## Methods 51 | 52 | ### `getReportHandle(): Promise` 53 | 54 | Get a [ReportHandle](ReportHandle.md) for controlling the state of the 55 | current report. 56 | 57 | If called before the element is added to the DOM, the promise will resolve 58 | after the page begins to load. 59 | 60 | A [ReportHandle](ReportHandle.md) are invalidated when attributes on the 61 | `SASReportPageElement` are changed and when the element is removed from the 62 | DOM. To obtain another [ReportHandle](ReportHandle.md), discard the previous 63 | result and call `getReportHandle` again. 64 | 65 | [ReportHandles](ReportHandle.md) from `SASReportPageElements` are not shared 66 | with other elements. 67 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.5.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.5.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.6.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.6.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.7.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.7.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.8.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.8.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.9.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.9.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | 19 | ## Loading with \ 20 | 21 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 22 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 23 | 24 | ```html 25 | 26 | 32 | ``` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.9.0/api/SASReportObjectElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.9.0-SASReportObjectElement 3 | title: SASReportObjectElement 4 | original_id: SASReportObjectElement 5 | --- 6 | 7 | `SASReportObjectElement` is a custom HTML element that renders a report object. This could be a single object or a 8 | container of multiple objects. This element extends `HTMLElement`. 9 | 10 | To find the correct values for `url`, `reportUri`, and `objectName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 11 | 12 | ## Custom Element Tag 13 | 14 | ```html 15 | 21 | ``` 22 | 23 | ## Attributes 24 | 25 | ### `authenticationType: string` 26 | 27 | Choose the method to authenticate requests to the SAS Viya server. 28 | 29 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 30 | - `'credentials'` uses SAS Logon to establish an authenticated session. 31 | 32 | default value: `'credentials'` 33 | 34 | ### `url: string` 35 | 36 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 37 | optional port, and host. 38 | 39 | ### `reportUri: string` 40 | 41 | Specify the report URI. 42 | 43 | ### `objectName: string` 44 | 45 | Specify the name of the object from the report to display. 46 | 47 | ## Properties 48 | 49 | ### `menuItemProvider: MenuItemProvider` 50 | 51 | A [`MenuItemProvider`](MenuItemProvider.md) function that generates custom menu content for this element. 52 | 53 | ## Methods 54 | 55 | ### `getReportHandle(): Promise` 56 | 57 | Get a [ReportHandle](ReportHandle.md) for controlling the state of the 58 | current report. 59 | 60 | If called before the element is added to the DOM, the promise will resolve 61 | after the object begins to load. 62 | 63 | The [ReportHandle](ReportHandle.md) is invalidated when attributes on the 64 | `SASReportObjectElement` are changed and when the element is removed from the 65 | DOM. To obtain another [ReportHandle](ReportHandle.md), discard the previous 66 | result and call `getReportHandle` again. 67 | 68 | [ReportHandles](ReportHandle.md) from `SASReportObjectElement` are shared 69 | between objects from the same report. 70 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-0.9.0/api/SASReportPageElement.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-0.9.0-SASReportPageElement 3 | title: SASReportPageElement 4 | original_id: SASReportPageElement 5 | --- 6 | 7 | `SASReportPageElement` is a custom HTML element that renders a report page. This element extends `HTMLElement`. 8 | 9 | To find the correct values for `url`, `reportUri`, and `pageName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 10 | 11 | ## Custom Element Tag 12 | 13 | ```html 14 | 20 | ``` 21 | 22 | ## Attributes 23 | 24 | ### `authenticationType: string` 25 | 26 | Choose the method to authenticate requests to the SAS Viya server. 27 | 28 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 29 | - `'credentials'` uses SAS Logon to establish an authenticated session. 30 | 31 | default value: `'credentials'` 32 | 33 | ### `url: string` 34 | 35 | Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, 36 | optional port, and host. 37 | 38 | ### `reportUri: string` 39 | 40 | Specify the report URI. 41 | 42 | ### `pageName: string` 43 | 44 | Specify the name of the report page that you want to display. Either `pageName` or `pageIndex` can be used, but not both. 45 | 46 | ### `pageIndex: number` 47 | 48 | Specify the index of the report page that you want to display. `0` is the first page. Either `pageName` or `pageIndex` can be used, but not both. 49 | 50 | ## Properties 51 | 52 | ### `menuItemProvider: MenuItemProvider` 53 | 54 | A [`MenuItemProvider`](MenuItemProvider.md) function that generates custom menu content for this element. 55 | 56 | ## Methods 57 | 58 | ### `getReportHandle(): Promise` 59 | 60 | Get a [ReportHandle](ReportHandle.md) for controlling the state of the 61 | current report. 62 | 63 | If called before the element is added to the DOM, the promise will resolve 64 | after the page begins to load. 65 | 66 | A [ReportHandle](ReportHandle.md) are invalidated when attributes on the 67 | `SASReportPageElement` are changed and when the element is removed from the 68 | DOM. To obtain another [ReportHandle](ReportHandle.md), discard the previous 69 | result and call `getReportHandle` again. 70 | 71 | [ReportHandles](ReportHandle.md) from `SASReportPageElements` are not shared 72 | with other elements. 73 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.0.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.0.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.1.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.1.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.1.0/api/ExportDataOptions.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.1.0-ExportDataOptions 3 | title: ExportDataOptions 4 | original_id: ExportDataOptions 5 | --- 6 | 7 | ExportDataOptions provides options for customizing the properties of the report data that you want to export. If no option is specified, then the default value is used. 8 | 9 | ## Options 10 | 11 | ### `columns: string[]` 12 | Determines which data columns should be exported by specifying their labels. 13 | 14 | ### `startRow: number` 15 | Determines which row the data should begin with. 16 | 17 | default value: `0` 18 | 19 | ### `endRow: number` 20 | Determines which row the data should end with. 21 | 22 | default value: `` 23 | 24 | ### `formattedData: boolean` 25 | Controls whether formatted or unformatted data is exported. For example, if a data item has a dollar format applied, then exporting the formatted data includes the dollar sign. If this option is set to false, then the data for that item is exported as a raw number. 26 | 27 | default value: `true` 28 | 29 | ### `detailedData: boolean` 30 | Specifies whether the data is aggregated (which has fewer columns, rows, or both depending on filters that have been applied) or detailed (which has all available columns and rows). 31 | 32 | default value: `false` 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.1.0/api/ObjectHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.1.0-ObjectHandle 3 | title: ObjectHandle 4 | original_id: ObjectHandle 5 | --- 6 | 7 | An `ObjectHandle` is used to perform actions on a single object in an open 8 | report. An object's handle can be obtained using the `getObjectHandle` method 9 | on a [`ReportHandle`](ReportHandle.md). 10 | 11 | When a report element is assigned new attribute values or removed from the DOM, 12 | any `ObjectHandles` obtained from that element are invalidated and should be 13 | discarded. 14 | 15 | ## Methods 16 | 17 | ### exportData(format: string, options?: ExportDataOptions): Promise\ 18 | Exports a file that contains the object's data, and returns a URL to the file. 19 | 20 | `format` defines the format of the data output file. 21 | Supported formats: 22 | - `"XLSX"` 23 | - `"CSV"` 24 | - `"TSV"` 25 | 26 | `options` is an [`ExportDataOptions`](ExportDataOptions.md) bundle that modifies properties of the exported data file. 27 | 28 | If no `options` parameter is supplied, the data will be exported using the default option values. 29 | 30 | ### refreshData(): void 31 | 32 | Refreshes the data for the report object that is controlled by the 33 | `ObjectHandle`. 34 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.11.0/api/registerDataDrivenContent.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.11.0-registerDataDrivenContent 3 | title: registerDataDrivenContent 4 | original_id: registerDataDrivenContent 5 | --- 6 | 7 | ``` 8 | registerDataDrivenContent(options, onMessage): DataDrivenContentHandle 9 | ``` 10 | 11 | This function is used to receive and dispatch messages to a data-driven content object. If the report is not yet 12 | opened then this call will open it and initiate data processing for this data-driven content object. 13 | 14 | To find the correct values for `url`, `reportUri`, and `objectName`, see [the Getting Started page](getting-started.md#create-a-custom-html-tag). 15 | 16 | ## Arguments 17 | 18 | ### `options: Object` 19 | 20 | Choose options for how to connect to the server. The following properties are supported: 21 | 22 | - `url: string`: Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including 23 | the protocol, optional port, and host. 24 | - `reportUri: string`: Specify the report URI. 25 | - `objectName: string`: Specify name of the data-driven content object. 26 | - `authenticationType: string`: Choose the method to authenticate requests to the SAS Viya server. 27 | - `'guest'` automatically signs in to the SAS Viya server as the guest user. 28 | - `'credentials'` `default` uses SAS Logon to establish an authenticated session. 29 | 30 | ### `onMessage: (receivedMessage: ReportObjectResultData) => void` 31 | 32 | Define a callback function to handle data changes for this data-driven content object. The `receivedMessage` is a [`ReportObjectResultData`](ReportObjectResultData.md) object and is passed to the `onMessage` callback every time the data-driven content object is updated. 33 | 34 | For more information about the properties of the `receivedMessage` object as well as receiving data for data driven content, see the SAS Help Center. 35 | 36 | ## Return value 37 | 38 | `registerDataDrivenContent` returns a [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) which can be used to dispatch 39 | messages to the data-driven content object. 40 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.12.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.12.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | - [`setLocale`](api/setLocale.md) 21 | 22 | ## Loading with \ 23 | 24 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 25 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 26 | 27 | ```html 28 | 29 | 35 | ``` 36 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.12.0/api/setLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.12.0-setLocale 3 | title: setLocale 4 | original_id: setLocale 5 | --- 6 | 7 | ``` 8 | setLocale(locale): void 9 | ``` 10 | 11 | `setLocale` enables the user to set an override for the language that is specified in the browser settings. 12 | 13 | ## Arguments 14 | 15 | ### `locale: string` 16 | 17 | The locale should be specified as a language code and optional country code. This is the same format used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 18 | 19 | ### Examples 20 | 21 | ```javascript 22 | window.addEventListener("vaReportComponents.loaded", function () { 23 | vaReportComponents.setLocale("fr"); 24 | }); 25 | ``` 26 | 27 | ```javascript 28 | window.addEventListener("vaReportComponents.loaded", function () { 29 | vaReportComponents.setLocale("fr-CA"); 30 | }); 31 | ``` 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.15.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.15.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | - [`setLocale`](api/setLocale.md) 21 | - [`setFormatterLocale`](api/setFormatterLocale.md) 22 | 23 | ## Loading with \ 24 | 25 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 26 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 27 | 28 | ```html 29 | 30 | 36 | ``` 37 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.15.0/api/setFormatterLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.15.0-setFormatterLocale 3 | title: setFormatterLocale 4 | original_id: setFormatterLocale 5 | --- 6 | 7 | ``` 8 | setFormatterLocale(locale): void 9 | ``` 10 | 11 | `setFormatterLocale` enables the user to set the language that is used to format numeric values and dates. If not specified, the language will fallback to the one that is specified by calling setLocale or the one is specified in the browser settings. 12 | 13 | ## Arguments 14 | 15 | ### `locale: string | null` 16 | 17 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 18 | 19 | ### Examples 20 | 21 | ```javascript 22 | window.addEventListener("vaReportComponents.loaded", function () { 23 | vaReportComponents.setFormatterLocale("fr"); 24 | }); 25 | ``` 26 | 27 | ```javascript 28 | window.addEventListener("vaReportComponents.loaded", function () { 29 | vaReportComponents.setFormatterLocale("fr-CA"); 30 | }); 31 | ``` 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.15.0/api/setLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.15.0-setLocale 3 | title: setLocale 4 | original_id: setLocale 5 | --- 6 | 7 | ``` 8 | setLocale(locale): void 9 | ``` 10 | 11 | `setLocale` enables the user to set an override for the language that is specified in the browser settings. 12 | 13 | ## Arguments 14 | 15 | ### `locale: string | null` 16 | 17 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 18 | 19 | ### Examples 20 | 21 | ```javascript 22 | window.addEventListener("vaReportComponents.loaded", function () { 23 | vaReportComponents.setLocale("fr"); 24 | }); 25 | ``` 26 | 27 | ```javascript 28 | window.addEventListener("vaReportComponents.loaded", function () { 29 | vaReportComponents.setLocale("fr-CA"); 30 | }); 31 | ``` 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.2.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.2.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.3.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.3.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.4.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.4.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.5.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.5.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.6.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.6.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.6.0/api/ObjectHandle.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.6.0-ObjectHandle 3 | title: ObjectHandle 4 | original_id: ObjectHandle 5 | --- 6 | 7 | An `ObjectHandle` is used to perform actions on a single object in an open 8 | report. An object's handle can be obtained using the `getObjectHandle` method 9 | on a [`ReportHandle`](ReportHandle.md). 10 | 11 | When a report element is assigned new attribute values or removed from the DOM, 12 | any `ObjectHandles` obtained from that element are invalidated and should be 13 | discarded. 14 | 15 | ## Methods 16 | 17 | ### exportData(format: string, options?: ExportDataOptions): Promise\ 18 | Exports a file that contains the object's data, and returns a URL to the file. 19 | 20 | `format` defines the format of the data output file. 21 | Supported formats: 22 | - `"XLSX"` 23 | - `"CSV"` 24 | - `"TSV"` 25 | 26 | `options` is an [`ExportDataOptions`](ExportDataOptions.md) bundle that modifies properties of the exported data file. 27 | 28 | If no `options` parameter is supplied, the data will be exported using the default option values. 29 | 30 | ### exportPDF(options?: ExportPDFOptions): Promise\ 31 | 32 | Exports a PDF of the report object and returns a URL to the PDF document. 33 | 34 | `options` is an [`ExportPDFOptions`](ExportPDFOptions.md) that controls the format of the exported PDF document. The option `includedReportObjects` does not apply when exporting a report object. 35 | 36 | If no `options` parameter is supplied, the report is exported using the default options values. 37 | 38 | ### refreshData(): void 39 | 40 | Refreshes the data for the report object that is controlled by the 41 | `ObjectHandle`. 42 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.7.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.7.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-1.8.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-1.8.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | 21 | ## Loading with \ 22 | 23 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 24 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 25 | 26 | ```html 27 | 28 | 34 | ``` 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-2.13.0/api-reference.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-2.13.0-api-reference 3 | title: API Reference 4 | original_id: api-reference 5 | --- 6 | 7 | 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 8 | to use SAS data to drive your own components or visualizations. 9 | 10 | ## Top-Level Exports 11 | 12 | - [`SASReportElement`](api/SASReportElement.md) 13 | - [`SASReportPageElement`](api/SASReportPageElement.md) 14 | - [`SASReportObjectElement`](api/SASReportObjectElement.md) 15 | - [`connectToServer`](api/connectToServer.md) 16 | - [`registerDataDrivenContent`](api/registerDataDrivenContent.md) 17 | - [`DataDrivenContentHandle`](api/DataDrivenContentHandle.md) 18 | - [`setUseHighContrastReportTheme`](api/setUseHighContrastReportTheme.md) 19 | - [`setLoadingTheme`](api/setLoadingTheme.md) 20 | - [`setLocale`](api/setLocale.md) 21 | - [`setFormatterLocale`](api/setFormatterLocale.md) 22 | 23 | ## Loading with \ 24 | 25 | When you load the library with a script element, the `vaReportComponents` global variable is not ready to use until all of the other 26 | assets are loaded. The `vaReportComponents.loaded` event is dispatched once it is ready. 27 | 28 | ```html 29 | 30 | 36 | ``` 37 | 38 | ## Loading with imports 39 | 40 | When you load the library as an ES module, APIs are available as named imports. See the [ES module imports guide](guides/esm.md) for more information about loading the library as a module. 41 | 42 | ```ts 43 | import { connectToServer } from '@sassoftware/va-report-components'; 44 | ``` 45 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-2.13.0/api/setFormatterLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-2.13.0-setFormatterLocale 3 | title: setFormatterLocale 4 | original_id: setFormatterLocale 5 | --- 6 | 7 | ``` 8 | setFormatterLocale(locale): void 9 | ``` 10 | 11 | `setFormatterLocale` enables the user to set the language that is used to format numeric values and dates. If not specified, the language will fallback to the one that is specified by calling setLocale or the one is specified in the browser settings. 12 | 13 | ## Arguments 14 | 15 | ### `locale: string | null` 16 | 17 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 18 | 19 | ## Examples 20 | 21 | ### Script Tag 22 | 23 | ```javascript 24 | window.addEventListener("vaReportComponents.loaded", function() { 25 | vaReportComponents.setFormatterLocale("fr"); 26 | }); 27 | ``` 28 | 29 | ```javascript 30 | window.addEventListener("vaReportComponents.loaded", function() { 31 | vaReportComponents.setFormatterLocale("fr-CA"); 32 | }); 33 | ``` 34 | 35 | ### ESM 36 | 37 | ```javascript 38 | import { setFormatterLocale } from "@sassoftware/va-report-components"; 39 | setFormatterLocale("fr"); 40 | ``` 41 | 42 | ```javascript 43 | import { setFormatterLocale } from "@sassoftware/va-report-components"; 44 | setFormatterLocale("fr-CA"); 45 | ``` 46 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-2.13.0/api/setLoadingTheme.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-2.13.0-setLoadingTheme 3 | title: setLoadingTheme 4 | original_id: setLoadingTheme 5 | --- 6 | 7 | ``` 8 | setLoadingTheme(options): void 9 | ``` 10 | 11 | `setLoadingTheme` allows the user to set the theme of the sdk before a report loads. You might want to set the theme for the initial loading state to match the website that the SAS Visual Analytic SDK is embedded in. You also might want to set the loading theme to be consistent with the report that will be loaded. 12 | 13 | `setLoadingTheme` only affects the initial loading and logon states. It does not affect the report theme once a report has been loaded. 14 | 15 | ## Arguments 16 | 17 | ### `options: Object | 'light' | 'dark' | 'high-contrast'` 18 | 19 | When you select `'light'`, `'dark'`, or `'high-contrast'`, then the loading theme is based on one of the built-in themes. 20 | 21 | Alternatively, you can specify theme values. The following optional properties are supported: 22 | 23 | - `baseTheme: 'light' | 'dark'`: The base theme that is used for loading the theme values. The theme values are used when no defaults are provided. For example, if backgroundColor is not specified and the baseTheme is light, then the backgoundColor will be white since that is the theme's background color. **default**:`light` 24 | 25 | You can further customize the loading style with additional style properties. Some examples are provided below to show you how certain options affect the theme. The following style overrides are available: 26 | 27 | - `primary: string`: The logon button background and loading indicator. 28 | - `backgroundColor: string` 29 | - `textColor: string` 30 | - `textColorInverse: string` The button text color for the logon state. 31 | - `fontFamily: string` 32 | 33 | ## Examples 34 | 35 | ### Script Tag 36 | 37 | ```javascript 38 | window.addEventListener("vaReportComponents.loaded", function() { 39 | vaReportComponents.setLoadingTheme("dark"); 40 | }); 41 | ``` 42 | 43 | ```javascript 44 | window.addEventListener("vaReportComponents.loaded", function() { 45 | vaReportComponents.setLoadingTheme({ 46 | baseTheme: "dark", 47 | primary: "#FFA500", 48 | fontFamily: "Gothic", 49 | }); 50 | }); 51 | ``` 52 | 53 | ### ESM 54 | 55 | ```javascript 56 | import { setLoadingTheme } from "@sassoftware/va-report-components"; 57 | setLoadingTheme("dark"); 58 | ``` 59 | 60 | ```javascript 61 | import { setLoadingTheme } from "@sassoftware/va-report-components"; 62 | setLoadingTheme({ 63 | baseTheme: "dark", 64 | primary: "#FFA500", 65 | fontFamily: "Gothic", 66 | }); 67 | ``` 68 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_docs/version-2.13.0/api/setLocale.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: version-2.13.0-setLocale 3 | title: setLocale 4 | original_id: setLocale 5 | --- 6 | 7 | ``` 8 | setLocale(locale): void 9 | ``` 10 | 11 | `setLocale` enables the user to set an override for the language that is specified in the browser settings. 12 | 13 | ## Arguments 14 | 15 | ### `locale: string | null` 16 | 17 | The locale should be specified as a language code and an optional country code. This is the same format that is used by [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) 18 | 19 | ## Examples 20 | 21 | ### Script Tag 22 | 23 | ```javascript 24 | window.addEventListener("vaReportComponents.loaded", function() { 25 | vaReportComponents.setLocale("fr"); 26 | }); 27 | ``` 28 | 29 | ```javascript 30 | window.addEventListener("vaReportComponents.loaded", function() { 31 | vaReportComponents.setLocale("fr-CA"); 32 | }); 33 | ``` 34 | 35 | ### ESM 36 | 37 | ```javascript 38 | import { setLocale } from "@sassoftware/va-report-components"; 39 | setLocale("fr"); 40 | ``` 41 | 42 | ```javascript 43 | import { setLocale } from "@sassoftware/va-report-components"; 44 | setLocale("fr-CA"); 45 | ``` 46 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.1.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.1.0-docs": { 3 | "Introduction": [ 4 | "version-0.1.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.1.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.1.0-api-reference", 11 | "version-0.1.0-api/SASReportElement", 12 | "version-0.1.0-api/SASReportObjectElement", 13 | "version-0.1.0-api/connectToServer", 14 | "version-0.1.0-api/registerDataDrivenContent", 15 | "version-0.1.0-api/DataDrivenContentHandle" 16 | ], 17 | "Resources": [ 18 | "version-0.1.0-faq" 19 | ] 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.10.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.10.0-docs": { 3 | "Introduction": [ 4 | "version-0.10.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.10.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.10.0-api-reference", 11 | "version-0.10.0-api/SASReportElement", 12 | "version-0.10.0-api/SASReportPageElement", 13 | "version-0.10.0-api/SASReportObjectElement", 14 | "version-0.10.0-api/ReportHandle", 15 | "version-0.10.0-api/ExportPDFOptions", 16 | "version-0.10.0-api/MenuItemProvider", 17 | "version-0.10.0-api/connectToServer", 18 | "version-0.10.0-api/registerDataDrivenContent", 19 | "version-0.10.0-api/DataDrivenContentHandle" 20 | ], 21 | "Resources": [ 22 | "version-0.10.0-faq" 23 | ] 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.16.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.16.0-docs": { 3 | "Introduction": [ 4 | "version-0.16.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.16.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.16.0-api-reference", 11 | "version-0.16.0-api/SASReportElement", 12 | "version-0.16.0-api/SASReportPageElement", 13 | "version-0.16.0-api/SASReportObjectElement", 14 | "version-0.16.0-api/ReportHandle", 15 | "version-0.16.0-api/ExportPDFOptions", 16 | "version-0.16.0-api/MenuItemProvider", 17 | "version-0.16.0-api/connectToServer", 18 | "version-0.16.0-api/registerDataDrivenContent", 19 | "version-0.16.0-api/DataDrivenContentHandle", 20 | "version-0.16.0-api/setUseHighContrastReportTheme" 21 | ], 22 | "Resources": [ 23 | "version-0.16.0-faq" 24 | ] 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.18.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.18.0-docs": { 3 | "Introduction": [ 4 | "version-0.18.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.18.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.18.0-api-reference", 11 | "version-0.18.0-api/SASReportElement", 12 | "version-0.18.0-api/SASReportPageElement", 13 | "version-0.18.0-api/SASReportObjectElement", 14 | "version-0.18.0-api/ReportHandle", 15 | "version-0.18.0-api/ObjectHandle", 16 | "version-0.18.0-api/ExportPDFOptions", 17 | "version-0.18.0-api/MenuItemProvider", 18 | "version-0.18.0-api/connectToServer", 19 | "version-0.18.0-api/registerDataDrivenContent", 20 | "version-0.18.0-api/DataDrivenContentHandle", 21 | "version-0.18.0-api/setUseHighContrastReportTheme" 22 | ], 23 | "Resources": [ 24 | "version-0.18.0-faq" 25 | ] 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.19.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.19.0-docs": { 3 | "Introduction": [ 4 | "version-0.19.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.19.0-guides/viya-setup", 8 | "version-0.19.0-guides/data-driven-content" 9 | ], 10 | "API Reference": [ 11 | "version-0.19.0-api-reference", 12 | "version-0.19.0-api/SASReportElement", 13 | "version-0.19.0-api/SASReportPageElement", 14 | "version-0.19.0-api/SASReportObjectElement", 15 | "version-0.19.0-api/ReportHandle", 16 | "version-0.19.0-api/ObjectHandle", 17 | "version-0.19.0-api/ExportPDFOptions", 18 | "version-0.19.0-api/MenuItemProvider", 19 | "version-0.19.0-api/connectToServer", 20 | "version-0.19.0-api/registerDataDrivenContent", 21 | "version-0.19.0-api/DataDrivenContentHandle", 22 | "version-0.19.0-api/setUseHighContrastReportTheme", 23 | "version-0.19.0-api/setLoadingTheme" 24 | ], 25 | "Resources": [ 26 | "version-0.19.0-faq" 27 | ] 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.3.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.3.0-docs": { 3 | "Introduction": [ 4 | "version-0.3.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.3.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.3.0-api-reference", 11 | "version-0.3.0-api/SASReportElement", 12 | "version-0.3.0-api/SASReportPageElement", 13 | "version-0.3.0-api/SASReportObjectElement", 14 | "version-0.3.0-api/connectToServer", 15 | "version-0.3.0-api/registerDataDrivenContent", 16 | "version-0.3.0-api/DataDrivenContentHandle" 17 | ], 18 | "Resources": [ 19 | "version-0.3.0-faq" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.4.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.4.0-docs": { 3 | "Introduction": [ 4 | "version-0.4.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.4.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.4.0-api-reference", 11 | "version-0.4.0-api/SASReportElement", 12 | "version-0.4.0-api/SASReportPageElement", 13 | "version-0.4.0-api/SASReportObjectElement", 14 | "version-0.4.0-api/ReportHandle", 15 | "version-0.4.0-api/connectToServer", 16 | "version-0.4.0-api/registerDataDrivenContent", 17 | "version-0.4.0-api/DataDrivenContentHandle" 18 | ], 19 | "Resources": [ 20 | "version-0.4.0-faq" 21 | ] 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-0.9.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-0.9.0-docs": { 3 | "Introduction": [ 4 | "version-0.9.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-0.9.0-guides/data-driven-content" 8 | ], 9 | "API Reference": [ 10 | "version-0.9.0-api-reference", 11 | "version-0.9.0-api/SASReportElement", 12 | "version-0.9.0-api/SASReportPageElement", 13 | "version-0.9.0-api/SASReportObjectElement", 14 | "version-0.9.0-api/ReportHandle", 15 | "version-0.9.0-api/MenuItemProvider", 16 | "version-0.9.0-api/connectToServer", 17 | "version-0.9.0-api/registerDataDrivenContent", 18 | "version-0.9.0-api/DataDrivenContentHandle" 19 | ], 20 | "Resources": [ 21 | "version-0.9.0-faq" 22 | ] 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-1.0.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-1.0.0-docs": { 3 | "Introduction": [ 4 | "version-1.0.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-1.0.0-guides/viya-setup", 8 | "version-1.0.0-guides/export-report-package", 9 | "version-1.0.0-guides/data-driven-content" 10 | ], 11 | "API Reference": [ 12 | "version-1.0.0-api-reference", 13 | "version-1.0.0-api/SASReportElement", 14 | "version-1.0.0-api/SASReportPageElement", 15 | "version-1.0.0-api/SASReportObjectElement", 16 | "version-1.0.0-api/ReportHandle", 17 | "version-1.0.0-api/ObjectHandle", 18 | "version-1.0.0-api/ExportPDFOptions", 19 | "version-1.0.0-api/MenuItemProvider", 20 | "version-1.0.0-api/connectToServer", 21 | "version-1.0.0-api/registerDataDrivenContent", 22 | "version-1.0.0-api/DataDrivenContentHandle", 23 | "version-1.0.0-api/setUseHighContrastReportTheme", 24 | "version-1.0.0-api/setLoadingTheme" 25 | ], 26 | "Resources": [ 27 | "version-1.0.0-faq" 28 | ] 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-1.1.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-1.1.0-docs": { 3 | "Introduction": [ 4 | "version-1.1.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-1.1.0-guides/viya-setup", 8 | "version-1.1.0-guides/export-report-package", 9 | "version-1.1.0-guides/data-driven-content" 10 | ], 11 | "API Reference": [ 12 | "version-1.1.0-api-reference", 13 | "version-1.1.0-api/SASReportElement", 14 | "version-1.1.0-api/SASReportPageElement", 15 | "version-1.1.0-api/SASReportObjectElement", 16 | "version-1.1.0-api/ReportHandle", 17 | "version-1.1.0-api/ObjectHandle", 18 | "version-1.1.0-api/ExportPDFOptions", 19 | "version-1.1.0-api/ExportDataOptions", 20 | "version-1.1.0-api/MenuItemProvider", 21 | "version-1.1.0-api/connectToServer", 22 | "version-1.1.0-api/registerDataDrivenContent", 23 | "version-1.1.0-api/DataDrivenContentHandle", 24 | "version-1.1.0-api/setUseHighContrastReportTheme", 25 | "version-1.1.0-api/setLoadingTheme" 26 | ], 27 | "Resources": [ 28 | "version-1.1.0-faq" 29 | ] 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-1.11.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-1.11.0-docs": { 3 | "Introduction": [ 4 | "version-1.11.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-1.11.0-guides/viya-setup", 8 | "version-1.11.0-guides/export-report-package", 9 | "version-1.11.0-guides/data-driven-content" 10 | ], 11 | "API Reference": [ 12 | "version-1.11.0-api-reference", 13 | "version-1.11.0-api/SASReportElement", 14 | "version-1.11.0-api/SASReportPageElement", 15 | "version-1.11.0-api/SASReportObjectElement", 16 | "version-1.11.0-api/ReportHandle", 17 | "version-1.11.0-api/ObjectHandle", 18 | "version-1.11.0-api/ExportPDFOptions", 19 | "version-1.11.0-api/ExportDataOptions", 20 | "version-1.11.0-api/MenuItemProvider", 21 | "version-1.11.0-api/connectToServer", 22 | "version-1.11.0-api/registerDataDrivenContent", 23 | "version-1.11.0-api/DataDrivenContentHandle", 24 | "version-1.11.0-api/ReportObjectResultData", 25 | "version-1.11.0-api/setUseHighContrastReportTheme", 26 | "version-1.11.0-api/setLoadingTheme" 27 | ], 28 | "Resources": [ 29 | "version-1.11.0-faq" 30 | ] 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-1.12.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-1.12.0-docs": { 3 | "Introduction": [ 4 | "version-1.12.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-1.12.0-guides/viya-setup", 8 | "version-1.12.0-guides/export-report-package", 9 | "version-1.12.0-guides/data-driven-content" 10 | ], 11 | "API Reference": [ 12 | "version-1.12.0-api-reference", 13 | "version-1.12.0-api/SASReportElement", 14 | "version-1.12.0-api/SASReportPageElement", 15 | "version-1.12.0-api/SASReportObjectElement", 16 | "version-1.12.0-api/ReportHandle", 17 | "version-1.12.0-api/ObjectHandle", 18 | "version-1.12.0-api/ExportPDFOptions", 19 | "version-1.12.0-api/ExportDataOptions", 20 | "version-1.12.0-api/MenuItemProvider", 21 | "version-1.12.0-api/connectToServer", 22 | "version-1.12.0-api/registerDataDrivenContent", 23 | "version-1.12.0-api/DataDrivenContentHandle", 24 | "version-1.12.0-api/ReportObjectResultData", 25 | "version-1.12.0-api/setUseHighContrastReportTheme", 26 | "version-1.12.0-api/setLoadingTheme", 27 | "version-1.12.0-api/setLocale" 28 | ], 29 | "Resources": [ 30 | "version-1.12.0-faq" 31 | ] 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-1.15.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-1.15.0-docs": { 3 | "Introduction": [ 4 | "version-1.15.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-1.15.0-guides/viya-setup", 8 | "version-1.15.0-guides/export-report-package", 9 | "version-1.15.0-guides/data-driven-content" 10 | ], 11 | "API Reference": [ 12 | "version-1.15.0-api-reference", 13 | "version-1.15.0-api/SASReportElement", 14 | "version-1.15.0-api/SASReportPageElement", 15 | "version-1.15.0-api/SASReportObjectElement", 16 | "version-1.15.0-api/ReportHandle", 17 | "version-1.15.0-api/ObjectHandle", 18 | "version-1.15.0-api/ExportPDFOptions", 19 | "version-1.15.0-api/ExportDataOptions", 20 | "version-1.15.0-api/MenuItemProvider", 21 | "version-1.15.0-api/connectToServer", 22 | "version-1.15.0-api/registerDataDrivenContent", 23 | "version-1.15.0-api/DataDrivenContentHandle", 24 | "version-1.15.0-api/ReportObjectResultData", 25 | "version-1.15.0-api/setUseHighContrastReportTheme", 26 | "version-1.15.0-api/setLoadingTheme", 27 | "version-1.15.0-api/setLocale", 28 | "version-1.15.0-api/setFormatterLocale" 29 | ], 30 | "Resources": [ 31 | "version-1.15.0-faq" 32 | ] 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versioned_sidebars/version-2.13.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "version-2.13.0-docs": { 3 | "Introduction": [ 4 | "version-2.13.0-getting-started" 5 | ], 6 | "Guides": [ 7 | "version-2.13.0-guides/viya-setup", 8 | "version-2.13.0-guides/export-report-package", 9 | "version-2.13.0-guides/data-driven-content", 10 | "version-2.13.0-guides/esm" 11 | ], 12 | "API Reference": [ 13 | "version-2.13.0-api-reference", 14 | "version-2.13.0-api/SASReportElement", 15 | "version-2.13.0-api/SASReportPageElement", 16 | "version-2.13.0-api/SASReportObjectElement", 17 | "version-2.13.0-api/ReportHandle", 18 | "version-2.13.0-api/ObjectHandle", 19 | "version-2.13.0-api/ExportPDFOptions", 20 | "version-2.13.0-api/ExportDataOptions", 21 | "version-2.13.0-api/MenuItemProvider", 22 | "version-2.13.0-api/connectToServer", 23 | "version-2.13.0-api/registerDataDrivenContent", 24 | "version-2.13.0-api/DataDrivenContentHandle", 25 | "version-2.13.0-api/ReportObjectResultData", 26 | "version-2.13.0-api/setUseHighContrastReportTheme", 27 | "version-2.13.0-api/setLoadingTheme", 28 | "version-2.13.0-api/setLocale", 29 | "version-2.13.0-api/setFormatterLocale" 30 | ], 31 | "Resources": [ 32 | "version-2.13.0-faq" 33 | ] 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /sdk/va-report-components/documentation/website/versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | "2.22.0", 3 | "2.21.0", 4 | "2.20.0", 5 | "2.19.0", 6 | "2.18.0", 7 | "2.17.0", 8 | "2.16.0", 9 | "2.15.0", 10 | "2.14.0", 11 | "2.13.0", 12 | "2.12.0", 13 | "2.11.0", 14 | "2.10.0", 15 | "2.9.0", 16 | "2.8.0", 17 | "2.7.0", 18 | "2.6.0", 19 | "2.5.0", 20 | "2.4.0", 21 | "2.3.0", 22 | "2.2.0", 23 | "2.1.0", 24 | "2.0.0", 25 | "1.21.0", 26 | "1.20.0", 27 | "1.19.0", 28 | "1.18.0", 29 | "1.17.0", 30 | "1.16.0", 31 | "1.15.0", 32 | "1.14.0", 33 | "1.13.0", 34 | "1.12.0", 35 | "1.11.0", 36 | "1.10.0", 37 | "1.9.0", 38 | "1.8.0", 39 | "1.7.0", 40 | "1.6.0", 41 | "1.5.0", 42 | "1.4.0", 43 | "1.3.0", 44 | "1.2.0", 45 | "1.1.0", 46 | "1.0.0", 47 | "0.20.0", 48 | "0.19.0", 49 | "0.18.0", 50 | "0.17.0", 51 | "0.16.0", 52 | "0.15.0", 53 | "0.14.0", 54 | "0.13.0", 55 | "0.12.0", 56 | "0.11.0", 57 | "0.10.0", 58 | "0.9.0", 59 | "0.8.0", 60 | "0.7.0", 61 | "0.6.0", 62 | "0.5.0", 63 | "0.4.0", 64 | "0.3.0", 65 | "0.2.0", 66 | "0.1.0" 67 | ] 68 | -------------------------------------------------------------------------------- /sdk/va-report-components/examples/README.md: -------------------------------------------------------------------------------- 1 | # SAS Visual Analytics SDK Examples 2 | 3 | **Note: Replace placeholders with valid values in these examples before running them** 4 | 5 | - Report URI should take this form: `'/reports/reports/789d13d3-789d-4fa3-9fea-123e321f1ea1'` 6 | 7 | - Object name should take this form: `'ve123'` 8 | 9 | To support Edge, a polyfill for HTML custom elements is also needed. 10 | See our documentation here. 11 | 12 | ## Examples 13 | 14 | - [SASReportElement](./SASReportElement.html) (docs) 15 | 16 | Uses the `` custom element to display full reports. Styles report viewer in CSS with the `sas-report` 17 | selector. 18 | 19 | - [SASReportElementJS](./SASReportElementJS.html) 20 | (docs) 21 | 22 | Uses JavaScript `SASReportElement` to display a report on SDK load. Styles report with inline styles. 23 | 24 | - [SASReportObjectElement](./SASReportObjectElement.html) 25 | (docs) 26 | 27 | Uses the `` custom element to display a report object. Styles report object with CSS classes. 28 | 29 | - [registerDataDrivenContent](./registerDataDrivenContent.html) (docs) 30 | 31 | Uses `registerDataDrivenContent` and `DataDrivenContentHandle` to connect to a data-driven content report object and harness the data from SAS Visual Analytics to augment the html page. 32 | 33 | - [connectToServer](./connectToServer.html) (docs) 34 | 35 | Uses `connectToServer` to establish a connection to a SAS Viya server before adding reports to the page. 36 | 37 | - [getSelectedData](./getSelectedData.html) (docs) 38 | 39 | Uses `getSelectedData` and `addEventListener` from `ObjectHandle` to retrieve user selection data from a report object, then displays the data in a table. 40 | -------------------------------------------------------------------------------- /sdk/va-report-components/examples/SASReportElement.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /sdk/va-report-components/examples/SASReportElementJS.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 9 | 10 | 11 | 23 | 24 | -------------------------------------------------------------------------------- /sdk/va-report-components/examples/SASReportObjectElement.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 15 | 16 | 17 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /sdk/va-report-components/examples/connectToServer.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 9 | 10 | 11 | 16 | 17 | --------------------------------------------------------------------------------