[ADF-3745] Updates for doc review (#4291)

* [ADF-3745] Updates for doc review

* [ADF-3745] Fixed bad links to Content node selector page

* [ADF-3745] Updated index files
This commit is contained in:
Andy Stark
2019-02-08 21:21:06 +00:00
committed by Eugenio Romano
parent 581a0c5177
commit 1079361c2c
24 changed files with 277 additions and 180 deletions
@@ -64,9 +64,9 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
@Input()
dropdownHideMyFiles: boolean = false;
/** Custom site for site dropdown same as siteList. See the
* [Sites Dropdown component](sites-dropdown.component.md)
* for more information.
/** Custom site for site dropdown. This is the same as the `siteList`.
* property of the Sites Dropdown component (see its doc page
* for more information).
*/
@Input()
dropdownSiteList: SitePaging = null;
@@ -74,14 +74,15 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
_rowFilter: RowFilter = defaultValidation;
/** Custom *where* filter function. See the
* [Document List component](document-list.component.md)
* Document List component
* for more information.
*/
@Input()
where: string;
/** Custom row filter function. See the
* [Document List component](document-list.component.md#custom-row-filter)
/**
* Custom row filter function. See the
* [Row Filter Model](row-filter.model.md) page
* for more information.
*/
@Input()
@@ -108,8 +109,9 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
return this._excludeSiteContent;
}
/** Custom image resolver function. See the
* [Document List component](document-list.component.md#custom-row-filter)
/**
* Custom image resolver function. See the
* [Image Resolver Model](image-resolver.model.md) page
* for more information.
*/
@Input()
@@ -197,10 +197,15 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
@Input()
loading: boolean = false;
/** Custom row filter */
/** @hidden */
@Input()
_rowFilter: RowFilter | null = null;
/**
* Custom function to choose whether to show or hide rows.
* See the [Row Filter Model](row-filter.model.md) page for
* more information.
*/
@Input()
set rowFilter(rowFilter: RowFilter) {
this._rowFilter = rowFilter;
@@ -216,7 +221,11 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
return this._rowFilter;
}
/** Custom image resolver */
/**
* Custom function to choose image file paths to show. See the
* [Image Resolver Model](image-resolver.model.md) page for
* more information.
*/
@Input()
imageResolver: any | null = null;
@@ -246,7 +255,7 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
@Input()
node: NodePaging = null;
/** Default value is stored into user preference settings use it only if you are not using the pagination */
/** Default value is stored in the user preference settings. Use this only if you are not using pagination. */
@Input()
maxItems: number = this.DEFAULT_PAGINATION.maxItems;
@@ -255,6 +255,11 @@ export class SearchQueryBuilderService {
return [];
}
/**
* Gets the query group.
* @param query Target query
* @returns Query group
*/
getQueryGroup(query) {
return query.group || this.config.facetQueries.label || 'Facet Queries';
}
+1
View File
@@ -35,6 +35,7 @@ export class IconComponent {
private _value = '';
private _isCustom = false;
/** Theme color palette for the component. */
@Input()
color: ThemePalette;
+1 -1
View File
@@ -31,7 +31,7 @@ export class LoginDialogService {
/**
* Opens a dialog to choose a file to upload.
* @param action Name of the action to show in the title
* @param actionName Name of the action to show in the title
* @param title Title for the dialog
* @returns Information about the chosen file(s)
*/
@@ -302,6 +302,12 @@ export class IdentityUserService {
return hasAnyRole;
}
/**
* Checks if a user has one of the roles from a list.
* @param userId ID of the target user
* @param roleNames Array of roles to check for
* @returns True if the user has one of the roles, false otherwise
*/
checkUserHasRole(userId: string, roleNames: string[]): Observable<boolean> {
return this.getUserRoles(userId).pipe(map((userRoles: IdentityRoleModel[]) => {
let hasRole = false;
@@ -65,9 +65,9 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
state: string;
/** The assignment of the process. Possible values are: "assignee" (the current user
* is the assignee), candidate (the current user is a task candidate", "group_x" (the task
* is the assignee), "candidate" (the current user is a task candidate, "group_x" (the task
* is assigned to a group where the current user is a member,
* no value(the current user is involved).
* no value (the current user is involved).
*/
@Input()
assignment: string;
@@ -91,7 +91,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
/**
* Data source object that represents the number and the type of the columns that
* you want to show.
* @deprecated 2.4.0
*/
@Input()
data: DataTableAdapter;
@@ -119,7 +118,7 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
@Input()
includeProcessInstance: boolean;
/** Starting point of the */
/** Starting point of the list within the full set of tasks. */
@Input()
start: number;
@@ -151,11 +150,11 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
@Input()
size: number = PaginationComponent.DEFAULT_PAGINATION.maxItems;
/** Filter the tasks. Display only tasks with created_date after dueAfter. */
/** Filter the tasks. Display only tasks with `created_date` after `dueAfter`. */
@Input()
dueAfter: string;
/** Filter the tasks. Display only tasks with created_date before dueBefore. */
/** Filter the tasks. Display only tasks with `created_date` before `dueBefore`. */
@Input()
dueBefore: string;