Skip to content

Commit

Permalink
Insights dependency and documentation improvements (#9815)
Browse files Browse the repository at this point in the history
  • Loading branch information
DenysVuika committed Jun 14, 2024
1 parent c7592c5 commit 04f82fa
Show file tree
Hide file tree
Showing 25 changed files with 227 additions and 509 deletions.
18 changes: 8 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -578,21 +578,19 @@ for more information about installing and using the source code.
## Insights API

Contains components for Process Services analytics and diagrams.
See the library's
[README file](../lib/insights/README.md)
for more information about installing and using the source code.
See the library [README](../lib/insights/README.md) for more details.

<!--insights start-->

### Components

| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) |
| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) |
| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) |
| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/src/lib/diagram/components/diagram.component.ts) |
| [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts) |
| Name | Description |
|----------------------------------------------------------------------------------------|----------------------------------------------------------|
| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts |
| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports |
| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input |
| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. |
| [Widget component](core/services/widget.component.md) | Base class for standard and custom widget classes. |

<!--insights end-->

Expand Down
2 changes: 1 addition & 1 deletion docs/core/services/form-rendering.service.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Last reviewed: 2018-11-20

# [Form Rendering service](../../../lib/core/src/lib/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts")

Maps a form field type string onto the corresponding form [widget component](../../insights/components/widget.component.md) type.
Maps a form field type string onto the corresponding form [widget component](widget.component.md) type.

## Class members

Expand Down
42 changes: 42 additions & 0 deletions docs/core/services/widget.component.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Widget Component

Base class for all standard and custom form widgets. All widgets must extend this class.

## 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 {}
```

## Class members

### Properties

| Name | Type | Default value | Description |
|-------|-------|---------------|-------------|
| field | `any` | | field. |

### Events

| Name | Type | Description |
|--------------|---------------------|---------------|
| fieldChanged | `EventEmitter<any>` | fieldChanged. |

## Details

The `WidgetComponent` is the base class for all standard and custom form widgets.
See the [Form Extensibility and Customisation](../../user-guide/extensibility.md) page for full details about
implementing custom widgets.

## See also

- [Extensibility](../../user-guide/extensibility.md)
Binary file not shown.
60 changes: 0 additions & 60 deletions docs/getting-started.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/insights/components/analytics-generator.component.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/insights/components/analytics-generator.component.md
35 changes: 0 additions & 35 deletions docs/insights/components/analytics-report-list.component.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/insights/components/analytics.component.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/insights/components/analytics.component.md
48 changes: 0 additions & 48 deletions docs/insights/components/diagram.component.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/insights/components/diagram.component.md
49 changes: 0 additions & 49 deletions docs/insights/components/widget.component.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Github only: true
| --- | --- | --- |
| [**Prerequisites and the requirements**](creating-your-first-adf-application.md) | Basic | In this tutorial you are going to learn how to create a very basic (and almost “empty”) ADF-based application that you can start enriching with features, behaviors and customizations. The creation of this basic ADF-based application is possible through a scaffolding tool called [Yeoman]\(https://yeoman.io/ "https://yeoman.io/"), which makes this task very straightforward. |
| [**Creating your Alfresco JavaScript application**](creating-javascript-app-using-alfresco-js-api.md) | Basic | In this tutorial you will learn how to create an application in JavaScript from scratch to interact with Alfresco. |
| [**Adding a new component**](new-component.md) | Basic | In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. |
| [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. |
| [**Using ADF Components**](using-components.md) | Basic | In this tutorial, you will learn how to extend, use, and configure ADF Components. |
| [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. |
| [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. |
Expand Down
Loading

0 comments on commit 04f82fa

Please sign in to comment.