@revealbi/ui
Version:
938 lines (937 loc) • 27.9 kB
JSON
{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "src/components/dialog/dialog.component.ts",
"declarations": [
{
"kind": "class",
"description": "",
"name": "RvDialog",
"members": [
{
"kind": "field",
"name": "styles",
"static": true,
"default": "styles"
},
{
"kind": "field",
"name": "title",
"type": {
"text": "string"
},
"default": "\"\""
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "_closeResolver",
"type": {
"text": "(value: string | PromiseLike<any>) => void | undefined"
},
"privacy": "private"
},
{
"kind": "method",
"name": "show",
"return": {
"type": {
"text": "Promise<any>"
}
}
},
{
"kind": "method",
"name": "close",
"parameters": [
{
"name": "source",
"type": {
"text": "any | \"close-button\" | \"overlay\""
}
}
]
},
{
"kind": "method",
"name": "render",
"privacy": "protected",
"return": {
"type": {
"text": "unknown"
}
}
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "RvDialog",
"declaration": {
"name": "RvDialog",
"module": "src/components/dialog/dialog.component.ts"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/visualization-viewer/visualization-viewer.component.ts",
"declarations": [
{
"kind": "class",
"description": "",
"name": "RvVisualizationViewer",
"members": [
{
"kind": "field",
"name": "styles",
"static": true,
"default": "styles"
},
{
"kind": "field",
"name": "_revealView",
"type": {
"text": "any"
},
"privacy": "private",
"default": "null"
},
{
"kind": "field",
"name": "_mergedOptions",
"type": {
"text": "VisualizationViewerOptions"
},
"privacy": "private",
"default": "{}"
},
{
"kind": "field",
"name": "dashboard",
"type": {
"text": "string | unknown"
},
"default": "\"\""
},
{
"kind": "field",
"name": "options",
"type": {
"text": "VisualizationViewerOptions"
},
"default": "{}"
},
{
"kind": "field",
"name": "visualization",
"type": {
"text": "string | number"
},
"default": "0"
},
{
"kind": "method",
"name": "firstUpdated",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "changedProperties",
"type": {
"text": "PropertyValueMap<any> | Map<PropertyKey, unknown>"
}
}
]
},
{
"kind": "method",
"name": "init",
"privacy": "private",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "dashboard",
"optional": true,
"type": {
"text": "string | unknown"
}
},
{
"name": "visualization",
"optional": true,
"type": {
"text": "string | number"
}
},
{
"name": "options",
"optional": true,
"type": {
"text": "VisualizationViewerOptions"
}
}
]
},
{
"kind": "method",
"name": "setVisualization",
"privacy": "private",
"parameters": [
{
"name": "dashboard",
"type": {
"text": "any"
}
},
{
"name": "visualization",
"type": {
"text": "string | number | undefined"
}
}
]
},
{
"kind": "method",
"name": "updateDashboard",
"privacy": "private",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "dashboard",
"type": {
"text": "string | unknown"
}
},
{
"name": "visualization",
"optional": true,
"type": {
"text": "string | number"
}
}
]
},
{
"kind": "method",
"name": "updateOptions",
"privacy": "private",
"parameters": [
{
"name": "options",
"type": {
"text": "VisualizationViewerOptions | undefined"
}
}
]
},
{
"kind": "method",
"name": "updateVisualization",
"privacy": "private",
"parameters": [
{
"name": "visualization",
"optional": true,
"type": {
"text": "string | number"
}
}
]
},
{
"kind": "method",
"name": "loadRVDashboard",
"privacy": "private",
"return": {
"type": {
"text": "Promise<any | null>"
}
},
"parameters": [
{
"name": "dashboard",
"optional": true,
"type": {
"text": "string | unknown"
}
}
]
},
{
"kind": "method",
"name": "updated",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "changedProperties",
"type": {
"text": "PropertyValueMap<any> | Map<PropertyKey, unknown>"
}
}
]
},
{
"kind": "method",
"name": "render",
"privacy": "protected",
"return": {
"type": {
"text": "unknown"
}
}
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "RvVisualizationViewer",
"declaration": {
"name": "RvVisualizationViewer",
"module": "src/components/visualization-viewer/visualization-viewer.component.ts"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/reveal-view/reveal-view.component.ts",
"declarations": [
{
"kind": "class",
"description": "",
"name": "RvRevealView",
"members": [
{
"kind": "field",
"name": "styles",
"static": true,
"default": "styles"
},
{
"kind": "field",
"name": "_revealView",
"type": {
"text": "any"
},
"privacy": "private",
"default": "null"
},
{
"kind": "field",
"name": "_mergedOptions",
"type": {
"text": "RevealViewOptions"
},
"privacy": "private",
"default": "{}"
},
{
"kind": "field",
"name": "dashboard",
"type": {
"text": "string | unknown"
},
"default": "\"\"",
"description": "Gets or sets the dashboard to display in the RevealView component."
},
{
"kind": "field",
"name": "options",
"type": {
"text": "RevealViewOptions"
},
"default": "{}",
"description": "Gets or sets the options for the RevealView component."
},
{
"kind": "field",
"name": "dateFilter",
"type": {
"text": "any"
},
"description": "Gets the dashboard date filter.",
"readonly": true
},
{
"kind": "field",
"name": "filters",
"type": {
"text": "DashboardFilters"
},
"description": "Gets the dashboard filters.",
"readonly": true
},
{
"kind": "field",
"name": "dataLoading",
"type": {
"text": "(args: DataLoadingArgs) => void | undefined"
},
"description": "Callback triggered when data is loading.",
"parameters": [
{
"description": "Arguments for data loading.",
"name": "args",
"type": {
"text": "DataLoadingArgs"
}
}
]
},
{
"kind": "field",
"name": "dataPointClicked",
"type": {
"text": "(args: DataPointClickedArgs) => void | undefined"
},
"description": "Callback triggered when a data point is clicked.",
"parameters": [
{
"description": "Arguments for data point clicked.",
"name": "args",
"type": {
"text": "DataPointClickedArgs"
}
}
]
},
{
"kind": "field",
"name": "dataSourceDialogOpening",
"type": {
"text": "(args: DataSourceDialogOpeningArgs) => void | undefined"
},
"description": "Callback triggered when the data source dialog is opening.",
"parameters": [
{
"description": "Arguments for data source dialog opening.",
"name": "args",
"type": {
"text": "DataSourceDialogOpeningArgs"
}
}
]
},
{
"kind": "field",
"name": "dataSourcesRequested",
"type": {
"text": "(args: DataSourcesRequestedArgs) => any | undefined"
},
"description": "Callback triggered when data sources are requested.",
"parameters": [
{
"description": "Arguments for data sources requested.",
"name": "args",
"type": {
"text": "DataSourcesRequestedArgs"
}
}
]
},
{
"kind": "field",
"name": "dashboardLinkRequested",
"type": {
"text": "(args: DashboardLinkRequestedArgs) => string | undefined"
},
"description": "Callback triggered when a dashboard link is requested.",
"parameters": [
{
"description": "Arguments for dashboard link requested.",
"name": "args",
"type": {
"text": "DashboardLinkRequestedArgs"
}
}
]
},
{
"kind": "field",
"name": "editorClosed",
"type": {
"text": "(args: EditorClosedArgs) => void | undefined"
},
"description": "Callback triggered when the editor is closed.",
"parameters": [
{
"description": "Arguments for editor closed.",
"name": "args",
"type": {
"text": "EditorClosedArgs"
}
}
]
},
{
"kind": "field",
"name": "editorClosing",
"type": {
"text": "(args: EditorClosingArgs) => void | undefined"
},
"description": "Callback triggered when the editor is closing.",
"parameters": [
{
"description": "Arguments for editor closing.",
"name": "args",
"type": {
"text": "EditorClosingArgs"
}
}
]
},
{
"kind": "field",
"name": "editorOpened",
"type": {
"text": "(args: EditorOpenedArgs) => void | undefined"
},
"description": "Callback triggered when the editor is opened.",
"parameters": [
{
"description": "Arguments for editor opened.",
"name": "args",
"type": {
"text": "EditorOpenedArgs"
}
}
]
},
{
"kind": "field",
"name": "editorOpening",
"type": {
"text": "(args: EditorOpeningArgs) => void | undefined"
},
"description": "Callback triggered when the editor is opening.",
"parameters": [
{
"description": "Arguments for editor opening.",
"name": "args",
"type": {
"text": "EditorOpeningArgs"
}
}
]
},
{
"kind": "field",
"name": "fieldsInitializing",
"type": {
"text": "(args: FieldsInitializingArgs) => void | undefined"
},
"description": "Callback triggered when fields are initializing.",
"parameters": [
{
"description": "Arguments for fields initializing.",
"name": "args",
"type": {
"text": "FieldsInitializingArgs"
}
}
]
},
{
"kind": "field",
"name": "imageExported",
"type": {
"text": "(image: ImageExportedArgs) => void | undefined"
},
"description": "Callback triggered when an image is exported.",
"parameters": [
{
"description": "Arguments for image exported.",
"name": "args",
"type": {
"text": "ImageExportedArgs"
}
}
]
},
{
"kind": "field",
"name": "initialized",
"type": {
"text": "() => void | undefined"
},
"description": "Callback triggered when the RevealView component is initialized."
},
{
"kind": "field",
"name": "linkSelectionDialogOpening",
"type": {
"text": "(args: LinkSelectionDialogOpeningArgs) => void | undefined"
},
"description": "Callback triggered when a link selection dialog is opening.",
"parameters": [
{
"description": "Arguments for link selection dialog opening.",
"name": "args",
"type": {
"text": "LinkSelectionDialogOpeningArgs"
}
}
]
},
{
"kind": "field",
"name": "menuOpening",
"type": {
"text": "(args: MenuOpeningArgs) => void | undefined"
},
"description": "Callback triggered when a menu is opening.",
"parameters": [
{
"description": "Arguments for menu opening.",
"name": "args",
"type": {
"text": "MenuOpeningArgs"
}
}
]
},
{
"kind": "field",
"name": "saving",
"type": {
"text": "(args: SavingArgs) => void | undefined"
},
"description": "Callback triggered when a dashboard is saving.",
"parameters": [
{
"description": "Arguments for saving.",
"name": "args",
"type": {
"text": "SavingArgs"
}
}
]
},
{
"kind": "field",
"name": "seriesColorRequested",
"type": {
"text": "(args: SeriesColorRequestedArgs) => string | undefined"
},
"description": "Callback triggered when a series color is requested.",
"parameters": [
{
"description": "Arguments for series color requested.",
"name": "args",
"type": {
"text": "SeriesColorRequestedArgs"
}
}
]
},
{
"kind": "field",
"name": "tooltipShowing",
"type": {
"text": "(args: TooltipShowingArgs) => void | undefined"
},
"description": "Callback triggered when a tooltip is showing.",
"parameters": [
{
"description": "Arguments for tooltip showing.",
"name": "args",
"type": {
"text": "TooltipShowingArgs"
}
}
]
},
{
"kind": "method",
"name": "firstUpdated",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "changedProperties",
"type": {
"text": "Map<PropertyKey, unknown>"
}
}
]
},
{
"kind": "method",
"name": "init",
"privacy": "private",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "dashboard",
"optional": true,
"type": {
"text": "string | unknown"
}
},
{
"name": "options",
"optional": true,
"type": {
"text": "RevealViewOptions"
}
}
]
},
{
"kind": "method",
"name": "loadRVDashboard",
"privacy": "private",
"return": {
"type": {
"text": "Promise<unknown>"
}
},
"parameters": [
{
"name": "dashboard",
"optional": true,
"type": {
"text": "string | unknown"
}
}
]
},
{
"kind": "method",
"name": "updateOptions",
"privacy": "private",
"parameters": [
{
"name": "options",
"type": {
"text": "RevealViewOptions | undefined"
}
}
]
},
{
"kind": "method",
"name": "updateDashboard",
"privacy": "private",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "dashboard",
"type": {
"text": "string | unknown"
}
}
]
},
{
"kind": "method",
"name": "initializeEvents",
"privacy": "private"
},
{
"kind": "method",
"name": "assignHandler",
"privacy": "private",
"parameters": [
{
"name": "eventProperty",
"type": {
"text": "Function | undefined"
}
},
{
"name": "eventListenerName",
"type": {
"text": "string"
}
},
{
"name": "handler",
"type": {
"text": "Function"
}
}
]
},
{
"kind": "method",
"name": "getRVDashboard",
"return": {
"type": {
"text": ""
}
},
"description": "Gets the RVDashboard instance from the underlying RevealView object."
},
{
"kind": "method",
"name": "exportToExcel",
"return": {
"type": {
"text": "void"
}
},
"description": "Export the dashboard to Excel."
},
{
"kind": "method",
"name": "exportToImage",
"return": {
"type": {
"text": ""
}
},
"parameters": [
{
"name": "showDialog",
"default": "true",
"description": "If true, the export dialog will be shown. If false, the image will be exported directly."
}
],
"description": "Export the dashboard to an image."
},
{
"kind": "method",
"name": "exportToPdf",
"return": {
"type": {
"text": "void"
}
},
"description": "Export the dashboard to PDF."
},
{
"kind": "method",
"name": "exportToPowerPoint",
"return": {
"type": {
"text": "void"
}
},
"description": "Export the dashboard to PowerPoint."
},
{
"kind": "method",
"name": "refreshData",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "input",
"optional": true,
"type": {
"text": "string | number"
},
"description": "The ID or index of the visualization to refresh, or nothing to refresh the entire dashboard."
}
],
"description": "Refreshes the data in the dashboard.\nIf no parameter is provided, the entire dashboard is refreshed.\nIf a string ID is provided, the visualization with that ID is refreshed.\nIf a number index is provided, the visualization at that index is refreshed."
},
{
"kind": "method",
"name": "updated",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "changedProperties",
"type": {
"text": "PropertyValueMap<any> | Map<PropertyKey, unknown>"
}
}
]
},
{
"kind": "method",
"name": "render",
"privacy": "protected",
"return": {
"type": {
"text": "unknown"
}
}
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "RvRevealView",
"declaration": {
"name": "RvRevealView",
"module": "src/components/reveal-view/reveal-view.component.ts"
}
}
]
}
]
}