@revealbi/ui
Version:
169 lines (167 loc) • 6.82 kB
TypeScript
import { DashboardFilters } from './interfaces/dashboard-filters';
import { RevealViewOptions } from './options/reveal-view-options';
import { LitElement, PropertyValueMap } from 'lit';
import { DashboardLinkRequestedArgs, DataLoadingArgs, DataPointClickedArgs, DataSourceDialogOpeningArgs, DataSourcesRequestedArgs, EditorClosedArgs, EditorClosingArgs, EditorOpenedArgs, EditorOpeningArgs, FieldsInitializingArgs, ImageExportedArgs, LinkSelectionDialogOpeningArgs, MenuOpeningArgs, SavingArgs, SeriesColorRequestedArgs, TooltipShowingArgs } from './reveal-view.callback-args';
export declare class RvRevealView extends LitElement {
static styles: import('lit').CSSResult;
private _revealView;
private _mergedOptions;
/**
* Gets or sets the dashboard to display in the RevealView component.
*/
dashboard: string | unknown;
/**
* Gets or sets the options for the RevealView component.
*/
options: RevealViewOptions;
/**
* Gets the dashboard date filter.
*/
get dateFilter(): any;
/**
* Gets the dashboard filters.
*/
get filters(): DashboardFilters;
/**
* Callback triggered when data is loading.
* @param {DataLoadingArgs} args - Arguments for data loading.
*/
dataLoading?: (args: DataLoadingArgs) => void;
/**
* Callback triggered when a data point is clicked.
* @param {DataPointClickedArgs} args - Arguments for data point clicked.
*/
dataPointClicked?: (args: DataPointClickedArgs) => void;
/**
* Callback triggered when the data source dialog is opening.
* @param {DataSourceDialogOpeningArgs} args - Arguments for data source dialog opening.
*/
dataSourceDialogOpening?: (args: DataSourceDialogOpeningArgs) => void;
/**
* Callback triggered when data sources are requested.
* @param {DataSourcesRequestedArgs} args - Arguments for data sources requested.
*
* @example
* ```typescript
* 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: [] };
* }
* ```
*/
dataSourcesRequested?: (args: DataSourcesRequestedArgs) => any;
/**
* Callback triggered when a dashboard link is requested.
* @param {DashboardLinkRequestedArgs} args - Arguments for dashboard link requested.
*/
dashboardLinkRequested?: (args: DashboardLinkRequestedArgs) => string;
/**
* Callback triggered when the editor is closed.
* @param {EditorClosedArgs} args - Arguments for editor closed.
*/
editorClosed?: (args: EditorClosedArgs) => void;
/**
* Callback triggered when the editor is closing.
* @param {EditorClosingArgs} args - Arguments for editor closing.
*/
editorClosing?: (args: EditorClosingArgs) => void;
/**
* Callback triggered when the editor is opened.
* @param {EditorOpenedArgs} args - Arguments for editor opened.
*/
editorOpened?: (args: EditorOpenedArgs) => void;
/**
* Callback triggered when the editor is opening.
* @param {EditorOpeningArgs} args - Arguments for editor opening.
*/
editorOpening?: (args: EditorOpeningArgs) => void;
/**
* Callback triggered when fields are initializing.
* @param {FieldsInitializingArgs} args - Arguments for fields initializing.
*/
fieldsInitializing?: (args: FieldsInitializingArgs) => void;
/**
* Callback triggered when an image is exported.
* @param {ImageExportedArgs} args - Arguments for image exported.
*/
imageExported?: (image: ImageExportedArgs) => void;
/**
* Callback triggered when the RevealView component is initialized.
*/
initialized?: () => void;
/**
* Callback triggered when a link selection dialog is opening.
* @param {LinkSelectionDialogOpeningArgs} args - Arguments for link selection dialog opening.
*/
linkSelectionDialogOpening?: (args: LinkSelectionDialogOpeningArgs) => void;
/**
* Callback triggered when a menu is opening.
* @param {MenuOpeningArgs} args - Arguments for menu opening.
*/
menuOpening?: (args: MenuOpeningArgs) => void;
/**
* Callback triggered when a dashboard is saving.
* @param {SavingArgs} args - Arguments for saving.
*/
saving?: (args: SavingArgs) => void;
/**
* Callback triggered when a series color is requested.
* @param {SeriesColorRequestedArgs} args - Arguments for series color requested.
*/
seriesColorRequested?: (args: SeriesColorRequestedArgs) => string;
/**
* Callback triggered when a tooltip is showing.
* @param {TooltipShowingArgs} args - Arguments for tooltip showing.
*/
tooltipShowing?: (args: TooltipShowingArgs) => void;
protected firstUpdated(changedProperties: Map<PropertyKey, unknown>): void;
private init;
private loadRVDashboard;
private updateOptions;
private updateDashboard;
private initializeEvents;
private assignHandler;
/**
* Gets the RVDashboard instance from the underlying RevealView object.
* @returns The RVDashboard instance.
*/
getRVDashboard(): any;
/**
* Export the dashboard to Excel.
*/
exportToExcel(): void;
/**
* Export the dashboard to an image.
* @param showDialog - If true, the export dialog will be shown. If false, the image will be exported directly.
* @returns A promise that resolves to the exported image element or null.
*/
exportToImage(showDialog?: boolean): void | Promise<Element | null>;
/**
* Export the dashboard to PDF.
*/
exportToPdf(): void;
/**
* Export the dashboard to PowerPoint.
*/
exportToPowerPoint(): void;
/**
* 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.
* @param input The ID or index of the visualization to refresh, or nothing to refresh the entire dashboard.
*/
refreshData(input?: string | number): void;
protected updated(changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
protected render(): unknown;
}
declare global {
interface HTMLElementTagNameMap {
'rv-reveal-view': RvRevealView;
}
}