nuxeo-development-framework 5.7.2 → 5.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundles/nuxeo-development-framework.umd.js +1 -0
- package/bundles/nuxeo-development-framework.umd.js.map +1 -1
- package/esm2015/lib/components/reports/ndf-reports/base/base-custom-report.js +3 -2
- package/fesm2015/nuxeo-development-framework.js +1 -0
- package/fesm2015/nuxeo-development-framework.js.map +1 -1
- package/lib/components/reports/ndf-reports/base/base-custom-report.d.ts +2 -1
- package/package.json +1 -1
- package/src/docs/ndf-reports.doc.md +27 -17
|
@@ -4,13 +4,14 @@ import { BehaviorSubject, ReplaySubject } from 'rxjs';
|
|
|
4
4
|
import { DestroySubject } from '../../../../shared/components';
|
|
5
5
|
import Chart from 'chart.js/auto';
|
|
6
6
|
import { CriteriaModel, CustomChart, CustomChartDefinition, ReportResponseModel } from '../models';
|
|
7
|
-
import { ChartManagerService } from '../services';
|
|
7
|
+
import { ChartManagerService, ChartThemeService } from '../services';
|
|
8
8
|
import * as i0 from "@angular/core";
|
|
9
9
|
export declare abstract class BaseCustomReport extends DestroySubject {
|
|
10
10
|
readonly injector: Injector;
|
|
11
11
|
protected chart: Chart;
|
|
12
12
|
protected _printListener: EventListener;
|
|
13
13
|
abstract print(): void;
|
|
14
|
+
protected _chartThemeService: ChartThemeService;
|
|
14
15
|
protected _chartHelperService: ChartManagerService;
|
|
15
16
|
direction: Direction;
|
|
16
17
|
definition: CustomChartDefinition;
|
package/package.json
CHANGED
|
@@ -260,28 +260,35 @@ type NdfReportsFilters = {
|
|
|
260
260
|
fields: FieldConfigModel[];
|
|
261
261
|
visible?: boolean;
|
|
262
262
|
togglePanel?: boolean;
|
|
263
|
-
|
|
263
|
+
reload?: NdfReportsFiltersReloadConfig;
|
|
264
264
|
};
|
|
265
265
|
```
|
|
266
266
|
|
|
267
267
|
### Properties
|
|
268
268
|
|
|
269
|
-
| Property
|
|
270
|
-
|
|
|
271
|
-
| mode
|
|
272
|
-
| payload
|
|
273
|
-
| params
|
|
274
|
-
| fields
|
|
275
|
-
| visible
|
|
276
|
-
| togglePanel
|
|
277
|
-
|
|
|
278
|
-
|
|
279
|
-
### Reload
|
|
269
|
+
| Property | Type | Required | Description |
|
|
270
|
+
| ----------- | ------------------------------- | -------- | ---------------------------------------------- |
|
|
271
|
+
| mode | `'payload' \| 'params'` | ✅ | Where to apply filter values |
|
|
272
|
+
| payload | `Record<string, any>` | ❌ | Default payload values |
|
|
273
|
+
| params | `Record<string, any>` | ❌ | Default query parameters |
|
|
274
|
+
| fields | `FieldConfigModel[]` | ✅ | Filter field configurations |
|
|
275
|
+
| visible | `boolean` | ❌ | Initial visibility of filter UI |
|
|
276
|
+
| togglePanel | `boolean` | ❌ | Allow users to show/hide filter panel |
|
|
277
|
+
| reload | `NdfReportsFiltersReloadConfig` | ❌ | When to reload field data after filter changes |
|
|
278
|
+
|
|
279
|
+
### Reload
|
|
280
|
+
```ts
|
|
281
|
+
type NdfReportsFiltersReloadConfig =
|
|
282
|
+
| { strategy: 'always' }
|
|
283
|
+
| { strategy: 'never' }
|
|
284
|
+
| { strategy: 'onChange'; triggerFields: string[] }
|
|
285
|
+
```
|
|
280
286
|
|
|
281
|
-
|Strategy|Description|
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
287
|
+
| Strategy | Description |
|
|
288
|
+
| ---------- | ------------------------------------------------- |
|
|
289
|
+
| `always` | Reload field data every time filters are applied |
|
|
290
|
+
| `never` | Only reload on programmatic configuration changes |
|
|
291
|
+
| `onChange` | Reload only when specific fields changed |
|
|
285
292
|
|
|
286
293
|
### Example Usage
|
|
287
294
|
|
|
@@ -291,7 +298,10 @@ type NdfReportsFilters = {
|
|
|
291
298
|
"mode": "payload",
|
|
292
299
|
"visible": true,
|
|
293
300
|
"togglePanel": true,
|
|
294
|
-
|
|
301
|
+
"reload": {
|
|
302
|
+
"strategy": "onChange",
|
|
303
|
+
"triggerFields": ["dc:title", "dc:category"]
|
|
304
|
+
},
|
|
295
305
|
"fields": [
|
|
296
306
|
{
|
|
297
307
|
"type": "predicate",
|