Activiti Analytics library
Contains the Activiti Analytics component and other related components.
- Activiti Analytics Component
- Activiti Analytics List Component
- Analytics Generator Component
- Project Information
Activiti Analytics Component
The component shows the charts related to the reportId passed as input
Basic Usage
<adf-analytics
[appId]="1001"
[reportId]="2006">
</adf-analytics>
Properties
| Name | Type | Description |
|---|---|---|
| appId | string | The application id |
| reportId | string | The report id |
| hideParameters | boolean | Toggle the analytics parameters |
You can also hide chart parameters UI by setting the hideParameters to true:
<adf-analytics
[appId]="appId"
[reportId]="reportId"
[hideParameters]="true">
</adf-analytics>
Events
| Name | Description |
|---|---|
| onSuccess | The event is emitted when the report parameters are loaded |
| onError | The event is emitted when an error occurs during the loading |
| reportSaved | The event is emitted when a report is saved |
| reportDeleted | The event is emitted when a report is deleted |
Activiti Analytics List Component
The component shows the list of all the available reports
Basic Usage
<analytics-report-list
[layoutType]="'LIST'">
</analytics-report-list>
Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| appId | string | optional | The application id | |
| layoutType | string | required | Define the layout of the apps. There are two possible values: GRID or LIST. LIST is the default value | |
| selectFirst | boolean | optional | false | Change the value to true if you want to select the first item in the list as default |
Events
| Name | Description |
|---|---|
| onSuccess | The event is emitted when the report list is loaded |
| onError | The event is emitted when an error occurs during the loading |
| reportClick | The event is emitted when the report in the list is selected |
Analytics Generator Component
The component generates and shows the charts
Basic Usage
<adf-analytics-generator
[reportId]="reportId"
[reportParamQuery]="reportParamQuery">
</adf-analytics>
Properties
| Name | Type | Description |
|---|---|---|
| reportId | string | The report id |
| reportParamQuery | ReportQuery | The object contains all the parameters that the report needs |
Events
| Name | Description |
|---|---|
| onSuccess | Raised when the charts are loaded |
| onError | Raised when an error occurs during the loading |
Project Information
Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the necessary configurations, see this page.
If you plan to use this component with projects generated by Angular CLI, you can read more in Using ADF with Angular CLI
Install
npm install ng2-activiti-analytics
Build from sources
You can build the component from sources with the following commands:
npm install
npm run build
The
buildtask rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.
NPM scripts
| Command | Description |
|---|---|
| npm run build | Build component |
| npm run test | Run unit tests in the console |
| npm run test-browser | Run unit tests in the browser |
| npm run coverage | Run unit tests and display code coverage report |
Demo
Please check the demo folder for a demo project
cd demo
npm install
npm start