mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2463] Moved doc files to subfolders (#3070)
* [ADF-2463] Moved doc files to subfolders * [ADF-2463] Fixed broken image links * [ADF-2463] Moved doc files to subfolders * [ADF-2463] Fixed broken image links
This commit is contained in:
committed by
Eugenio Romano
parent
d4780d41ce
commit
ba905acf13
30
docs/insights/analytics-generator.component.md
Normal file
30
docs/insights/analytics-generator.component.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Analytics Generator Component
|
||||
|
||||
Generates and shows charts
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics-generator
|
||||
[reportId]="reportId"
|
||||
[reportParamQuery]="reportParamQuery">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| reportId | `number` | | |
|
||||
| reportParamQuery | `ReportQuery` | `undefined` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
31
docs/insights/analytics-report-list.component.md
Normal file
31
docs/insights/analytics-report-list.component.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Activiti Analytics List Component
|
||||
|
||||
Shows a list of all available reports
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<analytics-report-list
|
||||
[layoutType]="'LIST'">
|
||||
</analytics-report-list>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| layoutType | `string` | `AnalyticsReportListComponent.LAYOUT_LIST` | |
|
||||
| appId | `number` | | |
|
||||
| selectFirst | `boolean` | `false` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| reportClick | `EventEmitter<ReportParametersModel>` | |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
34
docs/insights/analytics.component.md
Normal file
34
docs/insights/analytics.component.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Activiti Analytics Component
|
||||
|
||||
Shows the charts related to the reportId passed as input
|
||||
|
||||

|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-analytics
|
||||
[appId]="1001"
|
||||
[reportId]="2006">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appId | `number` | | |
|
||||
| reportId | `number` | | |
|
||||
| hideParameters | `boolean` | `false` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| editReport | `EventEmitter<{}>` | |
|
||||
| reportSaved | `EventEmitter<{}>` | |
|
||||
| reportDeleted | `EventEmitter<{}>` | |
|
43
docs/insights/diagram.component.md
Normal file
43
docs/insights/diagram.component.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Diagram Component
|
||||
|
||||
Displays process diagrams.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
This component shows the diagram of a process.
|
||||
|
||||
```html
|
||||
<adf-diagram
|
||||
[processDefinitionId]="processDefinitionId">
|
||||
</adf-diagram>
|
||||
```
|
||||
|
||||
The below component shows the diagram of a running process instance with the activities highlighted according to their state (Active/Completed/Pending).
|
||||
|
||||
```html
|
||||
<adf-diagram
|
||||
[processInstanceId]="processInstanceId">
|
||||
</adf-diagram>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | -- |
|
||||
| metricPercentages | any | The array that contains the percentage of time for each element |
|
||||
| processInstanceId | any | |
|
||||
| metricColor | any | The array that contains the color for each element |
|
||||
| metricType | any | The string that specifies the metric type |
|
||||
| width | number | |
|
||||
| height | number | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| success | Raised when the diagrams elements are loaded |
|
||||
| error | Raised when an error occurs during loading |
|
39
docs/insights/widget.component.md
Normal file
39
docs/insights/widget.component.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# Widget component
|
||||
|
||||
Base class for standard and custom widget classes.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```ts
|
||||
import { Component } from '@angular/core';
|
||||
import { WidgetComponent } from '@alfresco/adf-core';
|
||||
|
||||
@Component({
|
||||
selector: 'custom-editor',
|
||||
template: `
|
||||
<div style="color: red">Look, I'm a custom editor!</div>
|
||||
`
|
||||
})
|
||||
export class CustomEditorComponent extends WidgetComponent {}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| readOnly | boolean | false | Does the widget show a read-only value? (ie, can't be edited) |
|
||||
| field | [FormFieldModel](../form-field.model.md) | | Data to be displayed in the field |
|
||||
|
||||
## Details
|
||||
|
||||
The Widget component is the base class for all standard and custom form widgets. See the
|
||||
[Form Extensibility and Customisation](../extensibility.md) page for full details about
|
||||
implementing custom widgets.
|
||||
|
||||
## See also
|
||||
|
||||
- [Extensibility](../extensibility.md)
|
Reference in New Issue
Block a user