メインコンテンツまでスキップ

Reveal View

Product in Beta

The Reveal SDK Web Component Wrappers are currently under development, and we welcome your feedback to help us improve for the final release.

The documentation for the Wrappers are under construciton, but we didn't want to wait until they were done before sharing.

<rv-reveal-view dashboard="Sales"></rv-reveal-view>
CODEPEN

Properties

dashboard

Type: string | unknown

Gets or sets the dashboard to display in the RevealView component.

dashboardLinkRequested

Type: (args: DashboardLinkRequestedArgs) => string

Callback triggered when a dashboard link is requested.

dataLoading

Type: (args: DataLoadingArgs) => void

Callback triggered when data is loading.

dataPointClicked

Type: (args: DataPointClickedArgs) => void

Callback triggered when a data point is clicked.

dataSourceDialogOpening

Type: (args: DataSourceDialogOpeningArgs) => void

Callback triggered when the data source dialog is opening.

dataSourcesRequested

Type: (args: DataSourcesRequestedArgs) => any

Callback triggered when data sources are requested.

revealView.dataSourcesRequested = (args: DataSourcesRequestedArgs) => {
const restDataSource = new $.ig.RVRESTDataSource();
restDataSource.url = "https://excel2json.io/api/share/6e0f06b3-72d3-4fec-7984-08da43f56bb9";
restDataSource.title = "Sales by Category";
restDataSource.subtitle = "Excel2Json";
restDataSource.useAnonymousAuthentication = true;

return { dataSources: [restDataSource], dataSourceItems: [] };
}

dateFilter

Type: any

Gets the dashboard date filter.

editModeEntered

Type: (args: EditModeEnteredArgs) => void

Callback triggered when edit mode is entered.

revealView.editModeEntered = (e: EditModeEnteredArgs) => {
console.log("Edit mode entered", e.dashboard);
}

editModeExited

Type: (args: EditModeExitedArgs) => void

Callback triggered when edit mode is exited.

revealView.editModeExited = (e: EditModeExitedArgs) => {
console.log("Edit mode exited", e.dashboard);
}

editorClosed

Type: (args: EditorClosedArgs) => void

Callback triggered when the editor is closed.

editorClosing

Type: (args: EditorClosingArgs) => void

Callback triggered when the editor is closing.

editorOpened

Type: (args: EditorOpenedArgs) => void

Callback triggered when the editor is opened.

editorOpening

Type: (args: EditorOpeningArgs) => void

Callback triggered when the editor is opening.

fieldsInitializing

Type: (args: FieldsInitializingArgs) => void

Callback triggered when fields are initializing.

filters

Type: DashboardFilters

Gets the dashboard filters.

imageExported

Type: (image: ImageExportedArgs) => void

Callback triggered when an image is exported.

initialized

Type: () => void

Callback triggered when the RevealView component is initialized.

linkSelectionDialogOpening

Type: (args: LinkSelectionDialogOpeningArgs) => void

Callback triggered when a link selection dialog is opening.

Type: (args: MenuOpeningArgs) => void

Callback triggered when a menu is opening.

options

Type: RevealViewOptions

Gets or sets the options for the RevealView component.

saving

Type: (args: SavingArgs) => void

Callback triggered when a dashboard is saving.

seriesColorRequested

Type: (args: SeriesColorRequestedArgs) => string

Callback triggered when a series color is requested.

tooltipShowing

Type: (args: TooltipShowingArgs) => void

Callback triggered when a tooltip is showing.

Methods

addTextBoxVisualization

Adds a textbox visualization to the dashboard.

addTextBoxVisualization()

Returns: void

addVisualization

Adds a visualization to the dashboard.

addVisualization()

Returns: void

enterEditMode

Places the component in edit mode.

enterEditMode()

Returns: void

exitEditMode

Exits edit mode.

exitEditMode(applyChanges: boolean)

Parameters:

NameTypeDescription
applyChangesbooleanIf true, the changes made in edit mode will be applied. If false, the changes will be discarded.

Returns: void

exportToExcel

Export the dashboard to Excel.

exportToExcel()

Returns: void

exportToImage

Export the dashboard to an image.

exportToImage(showDialog: boolean = true)

Parameters:

NameTypeDescription
showDialogbooleanIf true, the export dialog will be shown. If false, the image will be exported directly.

Returns: void | Promise<Element | null> - A promise that resolves to the exported image element or null.

exportToPdf

Export the dashboard to PDF.

exportToPdf()

Returns: void

exportToPowerPoint

Export the dashboard to PowerPoint.

exportToPowerPoint()

Returns: void

getRVDashboard

Gets the RVDashboard instance from the underlying RevealView object.

getRVDashboard()

Returns: RVDashboard - The RVDashboard instance.

refreshData

Refreshes the data in the dashboard. If no parameter is provided, the entire dashboard is refreshed. If a string ID is provided, the visualization with that ID is refreshed. If a number index is provided, the visualization at that index is refreshed.

refreshData(input?: string | number)

Parameters:

NameTypeDescription
inputstring | numberThe ID or index of the visualization to refresh, or nothing to refresh the entire dashboard.

Returns: void