SASReportPageElement · SAS® Visual Analytics SDK

SASReportPageElement is a custom HTML element that renders a report page. This element extends HTMLElement.

To find the correct values for url, reportUri, and pageName, see the Getting Started page.

Custom Element Tag

<sas-report-page
  authenticationType="guest"
  url="http://my-viya-server.com"
  reportUri="/reports/reports/c3c6befb-3981-4c9e-b011-7dc11dec5e37"
  pageName="vi20"
></sas-report-page>

Attributes

`authenticationType: string`

Choose the method to authenticate requests to the SAS Viya server.

'guest' automatically signs in to the SAS Viya server as the guest user.
'credentials' uses SAS Logon to establish an authenticated session.

default value: 'credentials'

`url: string`

Specify the URL of the SAS Viya server that hosts the report. This is the full context root, including the protocol, optional port, and host.

`reportUri: string`

Specify the report URI.

`packageUri: string`

Specify the base location of the SAS report package that was exported from SAS Visual Analytics. This can be absolute or relative to the page. authenticationType, url, and reportUri are ignored when you set this property.

See Export Report Package

`pageName: string`

Specify the name of the report page that you want to display. Either pageName or pageIndex can be used, but not both.

`pageIndex: number`

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.

`restrictViewportGestures: boolean`

When true, report objects that support zooming require a modifier key be used in addition to the scroll wheel. Enable restrictViewportGestures when embedding elements in a layout that causes overflow. This reserves the scroll-wheel action for page scrolling.

default value: true

Properties

`menuItemProvider: MenuItemProvider`

A MenuItemProvider function that generates custom menu content for this element.

Methods

`getReportHandle(): Promise<ReportHandle>`

Get a ReportHandle for controlling the state of the current report.

If called before the element is added to the DOM, the promise will resolve after the page begins to load.

A ReportHandle are invalidated when attributes on the SASReportPageElement are changed and when the element is removed from the DOM. To obtain another ReportHandle, discard the previous result and call getReportHandle again.

ReportHandles from SASReportPageElements are not shared with other elements.