Documentation update 3.6.0 (#5257)

* documentation update 3.6.0 * documentation update 3.6.0 * update missing doc
2026-09-09 18:03:21 +00:00 · 2019-11-18 12:34:28 +00:00
parent 7ca2f5d1e9
commit a6ad7a5ad0
113 changed files with 421 additions and 374 deletions
@@ -161,6 +161,14 @@ export class DocumentListService implements DocumentListLoader {
        return this.customResourcesService.isCustomSource(nodeId);
    }

+    /**
+     * Load a folder by Node Id.
+     * @param nodeId ID of the folder node
+     * @param pagination
+     * @param includeFields List of data field names to include in the results
+     * @param where  Optionally filter the list
+     * @returns Details of the folder
+     */
    loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[], where?: string): Observable<DocumentLoaderNode> {
        if (this.customResourcesService.isCustomSource(nodeId)) {
            return this.customResourcesService.loadFolderByNodeId(nodeId, pagination, includeFields).pipe(
@@ -70,6 +70,7 @@ export class DataColumnComponent implements OnInit {
    @Input()
    copyContent: boolean;

+    /**  Toggles the editing support of the column data. */
    @Input()
    editable: boolean = false;

@@ -51,6 +51,7 @@ export class HeaderLayoutComponent implements OnInit {
    /** Emitted when the sidenav button is clicked. */
    @Output() clicked = new EventEmitter<boolean>();

+    /** expandedSidenav: Toggles the expanded state of the component. */
    @Input() expandedSidenav: boolean = true;

    /** The side of the page that the drawer is attached to (can be 'start' or 'end') */
@@ -53,22 +53,28 @@ export class SearchTextInputComponent implements OnInit, OnDestroy {
    @Input()
    liveSearchEnabled: boolean = true;

+    /** Trigger autocomplete results on input change. */
    @Input()
    searchAutocomplete: any = false;

+    /** Search term preselected */
    @Input()
    searchTerm: string = '';

+    /** Debounce time in milliseconds. */
    @Input()
    debounceTime: number = 0;

+     /** Listener for results-list events (focus, blur and focusout). */
    @Input()
    focusListener: Observable<FocusEvent>;

+    /** Collapse search bar on submit. */
    @Input()
    collapseOnSubmit: boolean = true;

-    @Input()
+    /** Default state expanded or Collapsed. */
+     @Input()
    defaultState: SearchTextStateEnum = SearchTextStateEnum.collapsed;

    /** Emitted when the search term is changed. The search term is provided
@@ -85,9 +91,11 @@ export class SearchTextInputComponent implements OnInit, OnDestroy {
    @Output()
    submit: EventEmitter<any> = new EventEmitter();

+    /**  Emitted when the result list is selected */
    @Output()
    selectResult: EventEmitter<any> = new EventEmitter();

+    /**  Emitted when the result list is reset */
    @Output()
    reset: EventEmitter<boolean> = new EventEmitter();

@@ -169,6 +169,8 @@ export class ThumbnailService {
    /**
     * Gets a thumbnail URL for the given document node.
     * @param node Node or Node ID to get URL for.
+     * @param attachment Toggles whether to retrieve content as an attachment for download
+     * @param ticket Custom ticket to use for authentication
     * @returns URL string
     */
    getDocumentThumbnailUrl(node: NodeEntry | string, attachment?: boolean, ticket?: string): string {
@@ -28,15 +28,19 @@ import { AnalyticsService } from '../services/analytics.service';
 })
 export class AnalyticsGeneratorComponent implements OnChanges {

+    /** reportId. */
    @Input()
    reportId: number;

+    /** reportParamQuery. */
    @Input()
    reportParamQuery: ReportQuery = undefined;

+    /** success. */
    @Output()
    success = new EventEmitter();

+    /** error. */
    @Output()
    error = new EventEmitter();

@@ -25,12 +25,15 @@ import { AnalyticsService } from '../services/analytics.service';
 })
 export class AnalyticsReportHeatMapComponent implements  OnInit {

+    /** reportId. */
    @Input()
    report: any;

+    /** success. */
    @Output()
    success = new EventEmitter();

+    /** error. */
    @Output()
    error = new EventEmitter();

@@ -32,21 +32,27 @@ export class AnalyticsReportListComponent implements OnInit {
    public static LAYOUT_LIST: string = 'LIST';
    public static LAYOUT_GRID: string = 'GRID';

+    /** layout Type LIST or GRID. */
    @Input()
    layoutType: string = AnalyticsReportListComponent.LAYOUT_LIST;

+    /** appId ID of the target app. */
    @Input()
    appId: number;

+    /** selectFirst. */
    @Input()
    selectFirst: boolean = false;

+    /** report Click. */
    @Output()
    reportClick: EventEmitter<ReportParametersModel> = new EventEmitter<ReportParametersModel>();

+    /** success. */
    @Output()
    success = new EventEmitter();

+    /** error. */
    @Output()
    error = new EventEmitter();

@@ -50,30 +50,39 @@ export class AnalyticsReportParametersComponent implements OnInit, OnChanges, On

    public static FORMAT_DATE_ACTIVITI: string = 'YYYY-MM-DD';

+    /** appId ID of the target app. */
    @Input()
    appId: number;

+    /** reportId. */
    @Input()
    reportId: string;

+    /** hideComponent. */
    @Input()
    hideComponent: boolean = false;

+    /** success. */
    @Output()
    success = new EventEmitter();

+    /** error. */
    @Output()
    error = new EventEmitter();

+    /** edit. */
    @Output()
    edit = new EventEmitter();

+    /** form Value Changed. */
    @Output()
    formValueChanged = new EventEmitter();

+    /** save Report Success. */
    @Output()
    saveReportSuccess = new EventEmitter();

+    /** delete Report Success. */
    @Output()
    deleteReportSuccess = new EventEmitter();

@@ -27,21 +27,27 @@ import { AnalyticsGeneratorComponent } from './analytics-generator.component';
 })
 export class AnalyticsComponent implements OnChanges {

+    /** appId ID of the target app. */
    @Input()
    appId: number;

+    /** reportId. */
    @Input()
    reportId: number;

+    /** hideParameters. */
    @Input()
    hideParameters: boolean = false;

+    /** emitted when editReport. */
    @Output()
    editReport = new EventEmitter();

+    /** emitted when reportSaved. */
    @Output()
    reportSaved = new EventEmitter();

+    /** emitted when reportDeleted. */
    @Output()
    reportDeleted = new EventEmitter();

@@ -19,9 +19,11 @@ import { EventEmitter, Input, OnChanges, Output, SimpleChanges } from '@angular/

 export class WidgetComponent implements OnChanges {

+    /** field. */
    @Input()
    field: any;

+    /** fieldChanged. */
    @Output()
    fieldChanged: EventEmitter<any> = new EventEmitter<any>();

@@ -28,30 +28,40 @@ import { RaphaelService } from './raphael/raphael.service';
    templateUrl: './diagram.component.html'
 })
 export class DiagramComponent implements OnChanges {
+
+    /** processDefinitionId. */
    @Input()
    processDefinitionId: any;

+    /** processInstanceId. */
    @Input()
    processInstanceId: any;

+    /** metricPercentages. */
    @Input()
    metricPercentages: any;

+    /** metricColor. */
    @Input()
    metricColor: any;

+    /** metricType. */
    @Input()
    metricType: string = '';

+    /** width. */
    @Input()
    width: number = 1000;

+    /** height. */
    @Input()
    height: number = 500;

+    /** success. */
    @Output()
    success = new EventEmitter();

+    /** error. */
    @Output()
    error = new EventEmitter();

@@ -52,6 +52,7 @@ export class FormCloudComponent extends FormBaseComponent implements OnChanges,
    @Input()
    appName: string;

+    /** The application version to use when fetching data */
    @Input()
    appVersion?: number;