NGX Oracle Data Visualization
The NGX Oracle Data Visualization module allows you to seamlessly integrate Oracle Analytics Visualizations into your angular applications.
Installation
To install the ngx-oracle-dv module, follow these steps:
- Install
ngx-oracle-dvmodule in your project
npm install ngx-oracle-dv
- Next, you need to add the Oracle Analytics Visualizations embedding script to the
index.htmlfile of your project. Add the following code snippet within the<head>section:
<script
src="<oac instance url>/dv/ui/api/v1/plugins/embedding/standalone/embedding.js"
type="application/javascript">
</script>
- Import the NgxOracleDvModule into your application module. Open the module file (e.g.,
app.module.ts) and add the import statement:
import { NgxOracleDvModule } from 'ngx-oracle-dv';
...
@NgModule({
...
imports: [
...
NgxOracleDvModule
],
...
})
- Finally, you can use the
ngx-oracle-dvcomponent within your project's HTML files. Place the following code snippet wherever you want to display the visualization:
<ngx-oracle-dv project-path="/@Catalog/users/john_doe/sample_workbook"></ngx-oracle-dv>
You can also customize the component's behavior by providing additional properties like active-age, active-tab-id, filters, and project-ptions. Refer to the "Props" section below for more details.
Note: This component requires Single Sign-On to be enabled between Oracle Analytics Cloud and your application. During testing, you can run the application in the same browser where you are signed into Oracle Analytics Cloud to bypass the Single Sign-On requirement.
Props
project-path (required):
Specifies the repository path of the workbook that you want to render.
active-page (optional):
Specifies whether a canvas or insight other than the default is rendered. Valid values are 'canvas' and 'insight'.
active-tab-id (optional):
Specifies the ID of the canvas or the story page that you want to show. It can be either a string or a number.
filters (optional):
Specifies the filters that you want to apply to the visualization. It can be either a string or an array of strings.
project-options (optional):
Specifies the project options that you want to apply to the visualization. It can be either a string or an array of strings.
These properties allow you to customize the displayed visualization according to your requirements.
Contributors
Manuel Pinto (manuel@pinto.dev)
Joella Fernandes (fernandes@joella.dev)