mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
[ADF-1769] Added prop tables and fixed script (#2896)
* [ADF-1769] Added prop tables and fixed script * [ADF-1769] Corrected JSDoc formatting errors * [ADF-1769] Restored default column to prop tables
This commit is contained in:
Andy Stark
Eugenio Romano
parent
8a4959d172
commit
900fd70d63
294
docs/README.md
294
docs/README.md
@ -41,111 +41,91 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
|
||||
| [Accordion group component](accordion-group.component.md) | Adds a collapsible panel to an [accordion menu](accordion.component.md). | [Source](../lib/core/collapsable/accordion-group.component.ts) |
|
||||
| [Accordion component](accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) |
|
||||
| [Data column component](data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) |
|
||||
| [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
|
||||
| [Form field component](form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
|
||||
| [Form list component](form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) |
|
||||
| [Form component](form.component.md) | Shows a Form from APS (see it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) | [Source](../lib/core/form/components/form.component.ts) |
|
||||
| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) |
|
||||
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
|
||||
| [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
|
||||
| [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
|
||||
| [Language menu component](language-menu.component.md) | Displays all the languages that are present in the "app.config.json" or the default one (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) |
|
||||
| [Login component](login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) |
|
||||
| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
|
||||
| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) |
|
||||
| [Host settings component](host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) |
|
||||
| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
|
||||
| [Toolbar divider component](toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
|
||||
| [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
|
||||
| [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) |
|
||||
| [User info component](user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) |
|
||||
| [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) |
|
||||
| _Card view component_ | _Not currently documented_ | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
|
||||
| _Accordion group component_ | _Not currently documented_ | [Source](../lib/core/collapsable/accordion-group.component.ts) |
|
||||
| _Accordion component_ | _Not currently documented_ | [Source](../lib/core/collapsable/accordion.component.ts) |
|
||||
| _Data column component_ | _Not currently documented_ | [Source](../lib/core/data-column/data-column.component.ts) |
|
||||
| _Datatable component_ | _Not currently documented_ | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
|
||||
| _Form field component_ | _Not currently documented_ | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
|
||||
| _Form list component_ | _Not currently documented_ | [Source](../lib/core/form/components/form-list.component.ts) |
|
||||
| _Form component_ | _Not currently documented_ | [Source](../lib/core/form/components/form.component.ts) |
|
||||
| _Start form component_ | _Not currently documented_ | [Source](../lib/core/form/components/start-form.component.ts) |
|
||||
| _Text mask component_ | _Not currently documented_ | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
|
||||
| _Info drawer layout component_ | _Not currently documented_ | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
|
||||
| _Info drawer component_ | _Not currently documented_ | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
|
||||
| _Language menu component_ | _Not currently documented_ | [Source](../lib/core/language-menu/language-menu.component.ts) |
|
||||
| _Login component_ | _Not currently documented_ | [Source](../lib/core/login/components/login.component.ts) |
|
||||
| _Infinite pagination component_ | _Not currently documented_ | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
|
||||
| _Pagination component_ | _Not currently documented_ | [Source](../lib/core/pagination/pagination.component.ts) |
|
||||
| _Sidebar action menu component_ | _Not currently documented_ | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
|
||||
| _Toolbar divider component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
|
||||
| _Toolbar title component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
|
||||
| _Toolbar component_ | _Not currently documented_ | [Source](../lib/core/toolbar/toolbar.component.ts) |
|
||||
| _User info component_ | _Not currently documented_ | [Source](../lib/core/userinfo/components/user-info.component.ts) |
|
||||
|
||||
## Directives
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Context menu directive](context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) |
|
||||
| [Highlight directive](highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) |
|
||||
| [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) |
|
||||
| [Node delete directive](node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) |
|
||||
| [Node favorite directive](node-favorite.directive.md) | Selectively toggles nodes as favorite | [Source](../lib/core/directives/node-favorite.directive.ts) |
|
||||
| [Node permission directive](node-permission.directive.md) | Selectively disables an HTML element or Angular component | [Source](../lib/core/directives/node-permission.directive.ts) |
|
||||
| [Node restore directive](node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) |
|
||||
| [Upload directive](upload.directive.md) | Allows your components or common HTML elements reacting on File drag and drop in order to upload content. | [Source](../lib/core/directives/upload.directive.ts) |
|
||||
|
||||
## Models
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Form field model](form-field.model.md) | Contains the value and metadata for a field of an [ADF Form](form.component.md). | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) |
|
||||
| [Comment process model](comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../lib/core/models/comment-process.model.ts) |
|
||||
| [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) |
|
||||
| [User process model](user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) |
|
||||
| [Bpm user model](bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/userinfo/models/bpm-user.model.ts) |
|
||||
| [Ecm user model](ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/userinfo/models/ecm-user.model.ts) |
|
||||
| _Highlight directive_ | _Not currently documented_ | [Source](../lib/core/directives/highlight.directive.ts) |
|
||||
| _Logout directive_ | _Not currently documented_ | [Source](../lib/core/directives/logout.directive.ts) |
|
||||
| _Node delete directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-delete.directive.ts) |
|
||||
| _Node favorite directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-favorite.directive.ts) |
|
||||
| _Node permission directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-permission.directive.ts) |
|
||||
| _Node restore directive_ | _Not currently documented_ | [Source](../lib/core/directives/node-restore.directive.ts) |
|
||||
| _Upload directive_ | _Not currently documented_ | [Source](../lib/core/directives/upload.directive.ts) |
|
||||
|
||||
## Pipes
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [File size pipe](file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) |
|
||||
| [Mime type icon pipe](mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) |
|
||||
| [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) |
|
||||
| [Text highlight pipe](text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) |
|
||||
| [Time ago pipe](time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) |
|
||||
| [User initial pipe](user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) |
|
||||
| _File size pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/file-size.pipe.ts) |
|
||||
| _Mime type icon pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) |
|
||||
| _Node name tooltip pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) |
|
||||
| _Text highlight pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/text-highlight.pipe.ts) |
|
||||
| _Time ago pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/time-ago.pipe.ts) |
|
||||
| _User initial pipe_ | _Not currently documented_ | [Source](../lib/core/pipes/user-initial.pipe.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](card-view.component.md). | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
|
||||
| [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
|
||||
| [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
|
||||
| [Form service](form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) |
|
||||
| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) |
|
||||
| [Process content service](process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) |
|
||||
| [Alfresco api service](alfresco-api.service.md) | Provides access to initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) |
|
||||
| [Apps process service](apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) |
|
||||
| [Auth guard bpm service](auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
|
||||
| [Auth guard ecm service](auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
|
||||
| [Auth guard service](auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
|
||||
| [Authentication service](authentication.service.md) | Provides authentication for use with the Login component. | [Source](../lib/core/services/authentication.service.ts) |
|
||||
| [Comment process service](comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) |
|
||||
| [Content service](content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) |
|
||||
| [Cookie service](cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) |
|
||||
| [Deleted nodes api service](deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) |
|
||||
| [Discovery api service](discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) |
|
||||
| [Favorites api service](favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) |
|
||||
| [Highlight transform service](highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) |
|
||||
| [Log service](log.service.md) | Provide a log functionality for your ADF application. | [Source](../lib/core/services/log.service.ts) |
|
||||
| [Nodes api service](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) |
|
||||
| [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) |
|
||||
| [Page title service](page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) |
|
||||
| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) |
|
||||
| [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) |
|
||||
| [Renditions service](renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) |
|
||||
| [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) |
|
||||
| [Shared links api service](shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) |
|
||||
| [Sites service](sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) |
|
||||
| [Storage service](storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) |
|
||||
| [Thumbnail service](thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) |
|
||||
| [Translation service](translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) |
|
||||
| [Upload service](upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) |
|
||||
| [User preferences service](user-preferences.service.md) | Stores preferences for components. | [Source](../lib/core/services/user-preferences.service.ts) |
|
||||
| [Bpm user service](bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
|
||||
| [Ecm user service](ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/userinfo/services/ecm-user.service.ts) |
|
||||
|
||||
## Widgets
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Content widget](content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) |
|
||||
| _Card view update service_ | _Not currently documented_ | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
|
||||
| _Activiti alfresco service_ | _Not currently documented_ | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
|
||||
| _Form rendering service_ | _Not currently documented_ | [Source](../lib/core/form/services/form-rendering.service.ts) |
|
||||
| _Form service_ | _Not currently documented_ | [Source](../lib/core/form/services/form.service.ts) |
|
||||
| _Node service_ | _Not currently documented_ | [Source](../lib/core/form/services/node.service.ts) |
|
||||
| _Process content service_ | _Not currently documented_ | [Source](../lib/core/form/services/process-content.service.ts) |
|
||||
| _Alfresco api service_ | _Not currently documented_ | [Source](../lib/core/services/alfresco-api.service.ts) |
|
||||
| _Apps process service_ | _Not currently documented_ | [Source](../lib/core/services/apps-process.service.ts) |
|
||||
| _Auth guard bpm service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
|
||||
| _Auth guard ecm service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
|
||||
| _Auth guard service_ | _Not currently documented_ | [Source](../lib/core/services/auth-guard.service.ts) |
|
||||
| _Authentication service_ | _Not currently documented_ | [Source](../lib/core/services/authentication.service.ts) |
|
||||
| _Comment process service_ | _Not currently documented_ | [Source](../lib/core/services/comment-process.service.ts) |
|
||||
| _Content service_ | _Not currently documented_ | [Source](../lib/core/services/content.service.ts) |
|
||||
| _Cookie service_ | _Not currently documented_ | [Source](../lib/core/services/cookie.service.ts) |
|
||||
| _Deleted nodes api service_ | _Not currently documented_ | [Source](../lib/core/services/deleted-nodes-api.service.ts) |
|
||||
| _Discovery api service_ | _Not currently documented_ | [Source](../lib/core/services/discovery-api.service.ts) |
|
||||
| _Favorites api service_ | _Not currently documented_ | [Source](../lib/core/services/favorites-api.service.ts) |
|
||||
| _Highlight transform service_ | _Not currently documented_ | [Source](../lib/core/services/highlight-transform.service.ts) |
|
||||
| _Log service_ | _Not currently documented_ | [Source](../lib/core/services/log.service.ts) |
|
||||
| _Nodes api service_ | _Not currently documented_ | [Source](../lib/core/services/nodes-api.service.ts) |
|
||||
| _Notification service_ | _Not currently documented_ | [Source](../lib/core/services/notification.service.ts) |
|
||||
| _Page title service_ | _Not currently documented_ | [Source](../lib/core/services/page-title.service.ts) |
|
||||
| _People content service_ | _Not currently documented_ | [Source](../lib/core/services/people-content.service.ts) |
|
||||
| _People process service_ | _Not currently documented_ | [Source](../lib/core/services/people-process.service.ts) |
|
||||
| _Renditions service_ | _Not currently documented_ | [Source](../lib/core/services/renditions.service.ts) |
|
||||
| _Search configuration service_ | _Not currently documented_ | [Source](../lib/core/services/search-configuration.service.ts) |
|
||||
| _Shared links api service_ | _Not currently documented_ | [Source](../lib/core/services/shared-links-api.service.ts) |
|
||||
| _Sites service_ | _Not currently documented_ | [Source](../lib/core/services/sites.service.ts) |
|
||||
| _Storage service_ | _Not currently documented_ | [Source](../lib/core/services/storage.service.ts) |
|
||||
| _Thumbnail service_ | _Not currently documented_ | [Source](../lib/core/services/thumbnail.service.ts) |
|
||||
| _Translation service_ | _Not currently documented_ | [Source](../lib/core/services/translation.service.ts) |
|
||||
| _Upload service_ | _Not currently documented_ | [Source](../lib/core/services/upload.service.ts) |
|
||||
| _User preferences service_ | _Not currently documented_ | [Source](../lib/core/services/user-preferences.service.ts) |
|
||||
| _Bpm user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
|
||||
| _Ecm user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/ecm-user.service.ts) |
|
||||
|
||||
<!--core end-->
|
||||
|
||||
@ -172,53 +152,44 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Breadcrumb component](breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
|
||||
| [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
|
||||
| [Content metadata component](content-metadata.component.md) | Allows a user to display and edit metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) |
|
||||
| [Content node selector panel component](content-node-selector-panel.component.md) | Opens a [Content Node Selector](content-node-selector.component.md) in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
|
||||
| [Content node selector component](content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
|
||||
| [Content action component](content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
|
||||
| [Document list component](document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
|
||||
| [Search control component](search-control.component.md) | Displays a input text which shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) |
|
||||
| [Search component](search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) |
|
||||
| [Sites dropdown component](sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
|
||||
| [Like component](like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) |
|
||||
| [Rating component](rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) |
|
||||
| [Tag actions component](tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) |
|
||||
| [Tag list component](tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) |
|
||||
| [Tag node list component](tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) |
|
||||
| [File uploading dialog component](file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) |
|
||||
| [Upload button component](upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) |
|
||||
| [Upload drag area component](upload-drag-area.component.md) | Adds a drag and drop area to upload files to Alfresco. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) |
|
||||
| [Version list component](version-list.component.md) | Displays the version history of a node in a [Version Manager component](version-manager.component.md) | [Source](../lib/content-services/version-manager/version-list.component.ts) |
|
||||
| [Version manager component](version-manager.component.md) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
|
||||
| [Webscript component](webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) |
|
||||
| _Breadcrumb component_ | _Not currently documented_ | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
|
||||
| _Dropdown breadcrumb component_ | _Not currently documented_ | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
|
||||
| _Content node selector panel component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
|
||||
| _Content node selector component_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
|
||||
| _Content action component_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
|
||||
| _Document list component_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
|
||||
| _Search control component_ | _Not currently documented_ | [Source](../lib/content-services/search/components/search-control.component.ts) |
|
||||
| _Search component_ | _Not currently documented_ | [Source](../lib/content-services/search/components/search.component.ts) |
|
||||
| _Sites dropdown component_ | _Not currently documented_ | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
|
||||
| _Like component_ | _Not currently documented_ | [Source](../lib/content-services/social/like.component.ts) |
|
||||
| _Rating component_ | _Not currently documented_ | [Source](../lib/content-services/social/rating.component.ts) |
|
||||
| _Tag actions component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-actions.component.ts) |
|
||||
| _Tag list component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-list.component.ts) |
|
||||
| _Tag node list component_ | _Not currently documented_ | [Source](../lib/content-services/tag/tag-node-list.component.ts) |
|
||||
| _Upload button component_ | _Not currently documented_ | [Source](../lib/content-services/upload/components/upload-button.component.ts) |
|
||||
| _Upload drag area component_ | _Not currently documented_ | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) |
|
||||
| _Version list component_ | _Not currently documented_ | [Source](../lib/content-services/version-manager/version-list.component.ts) |
|
||||
| _Version manager component_ | _Not currently documented_ | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
|
||||
| _Webscript component_ | _Not currently documented_ | [Source](../lib/content-services/webscript/webscript.component.ts) |
|
||||
|
||||
## Directives
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Folder create directive](folder-create.directive.md) | Allows folders to be created. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
|
||||
| [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
|
||||
| [File draggable directive](file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
|
||||
|
||||
## Models
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Document library model](document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) |
|
||||
| [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a [Document List](document-list.component.md) according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) |
|
||||
| _Folder create directive_ | _Not currently documented_ | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
|
||||
| _Folder edit directive_ | _Not currently documented_ | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
|
||||
| _File draggable directive_ | _Not currently documented_ | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Content node dialog service](content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
|
||||
| [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
|
||||
| [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
|
||||
| [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
|
||||
| [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) |
|
||||
| [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) |
|
||||
| _Content node dialog service_ | _Not currently documented_ | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
|
||||
| _Document actions service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
|
||||
| _Document list service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
|
||||
| _Folder actions service_ | _Not currently documented_ | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
|
||||
| _Rating service_ | _Not currently documented_ | [Source](../lib/content-services/social/services/rating.service.ts) |
|
||||
| _Tag service_ | _Not currently documented_ | [Source](../lib/content-services/tag/services/tag.service.ts) |
|
||||
|
||||
<!--content-services end-->
|
||||
|
||||
@ -237,52 +208,45 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) |
|
||||
| [Create process attachment component](create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) |
|
||||
| [Create task attachment component](create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) |
|
||||
| [Process attachment list component](process-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) |
|
||||
| [Task attachment list component](task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) |
|
||||
| [Comment list component](comment-list.component.md) | Shows a list of comments. | [Source](../lib/process-services/comments/comment-list.component.ts) |
|
||||
| [Comments component](comments.component.md) | Displays comments from users involved in a specified task and allows an involved user to add a comment to the task. | [Source](../lib/process-services/comments/comments.component.ts) |
|
||||
| [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments | [Source](../lib/process-services/comments/process-comments.component.ts) |
|
||||
| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/people-list.component.ts) |
|
||||
| [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/people-search.component.ts) |
|
||||
| [People component](people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/people.component.ts) |
|
||||
| [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) |
|
||||
| [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) |
|
||||
| [Process instance header component](process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) |
|
||||
| [Process instance tasks component](process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
|
||||
| [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/process-list/components/process-list.component.ts) |
|
||||
| [Start process component](start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) |
|
||||
| [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.component.ts) |
|
||||
| [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../lib/process-services/task-list/components/start-task.component.ts) |
|
||||
| [Task details component](task-details.component.md) | Shows the details of the task id passed in input | [Source](../lib/process-services/task-list/components/task-details.component.ts) |
|
||||
| [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) |
|
||||
| [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) |
|
||||
| [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/task-list/components/task-list.component.ts) |
|
||||
| _Apps list component_ | _Not currently documented_ | [Source](../lib/process-services/app-list/apps-list.component.ts) |
|
||||
| _Create process attachment component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) |
|
||||
| _Create task attachment component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) |
|
||||
| _Process attachment list component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) |
|
||||
| _Task attachment list component_ | _Not currently documented_ | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) |
|
||||
| _Comment list component_ | _Not currently documented_ | [Source](../lib/process-services/comments/comment-list.component.ts) |
|
||||
| _Comments component_ | _Not currently documented_ | [Source](../lib/process-services/comments/comments.component.ts) |
|
||||
| _Process comments component_ | _Not currently documented_ | [Source](../lib/process-services/comments/process-comments.component.ts) |
|
||||
| _People list component_ | _Not currently documented_ | [Source](../lib/process-services/people/people-list.component.ts) |
|
||||
| _People search component_ | _Not currently documented_ | [Source](../lib/process-services/people/people-search.component.ts) |
|
||||
| _People component_ | _Not currently documented_ | [Source](../lib/process-services/people/people.component.ts) |
|
||||
| _Process filters component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-filters.component.ts) |
|
||||
| _Process instance details component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) |
|
||||
| _Process instance header component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) |
|
||||
| _Process instance tasks component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
|
||||
| _Start process component_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/start-process.component.ts) |
|
||||
| _Checklist component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/checklist.component.ts) |
|
||||
| _Start task component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/start-task.component.ts) |
|
||||
| _Task details component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-details.component.ts) |
|
||||
| _Task filters component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-filters.component.ts) |
|
||||
| _Task header component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-header.component.ts) |
|
||||
| _Task list component_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-list.component.ts) |
|
||||
|
||||
## Directives
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information in the pdf or json format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) |
|
||||
| [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) |
|
||||
|
||||
## Models
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) |
|
||||
| [Task details model](task-details.model.md) | Information about a task. | [Source](../lib/process-services/task-list/models/task-details.model.ts) |
|
||||
| _Process audit directive_ | _Not currently documented_ | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) |
|
||||
| _Task audit directive_ | _Not currently documented_ | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Process filter service](process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
|
||||
| [Process service](process.service.md) | Manage Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) |
|
||||
| [Task filter service](task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
|
||||
| [Tasklist service](tasklist.service.md) | Manage Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) |
|
||||
| _Process filter service_ | _Not currently documented_ | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
|
||||
| _Process service_ | _Not currently documented_ | [Source](../lib/process-services/process-list/services/process.service.ts) |
|
||||
| _Task filter service_ | _Not currently documented_ | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
|
||||
| _Tasklist service_ | _Not currently documented_ | [Source](../lib/process-services/task-list/services/tasklist.service.ts) |
|
||||
|
||||
<!--process-services end-->
|
||||
|
||||
@ -301,11 +265,7 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
|
||||
| [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
|
||||
| [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
|
||||
| [Analytics component](analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) |
|
||||
| [Diagram component](diagram.component.md) | This component shows the diagram of a process. | [Source](../lib/insights/diagram/components/diagram.component.ts) |
|
||||
| _Widget component_ | _Not currently documented_ | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
|
||||
|
||||
<!--insights end-->
|
||||
|
||||
|
||||
@ -31,14 +31,14 @@ export class MyComponent implements OnInit {
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| heading | `string` | Title heading for the group. |
|
||||
| headingIcon | `string` | The material design icon. |
|
||||
| headingIconTooltip | `string` | Tooltip message to be shown for headingIcon |
|
||||
| hasAccordionIcon | `boolean` | Should the (expanded) accordion icon be shown? <br/> Default value: `true` |
|
||||
| isOpen | `boolean` | Is this group currently open? |
|
||||
| isSelected | `boolean` | Is this group currently selected? |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| heading | `string` | | Title heading for the group. |
|
||||
| headingIcon | `string` | | The material design icon. |
|
||||
| headingIconTooltip | `string` | | Tooltip message to be shown for headingIcon |
|
||||
| hasAccordionIcon | `boolean` | `true` | Should the (expanded) accordion icon be shown? |
|
||||
| isOpen | `boolean` | | Is this group currently open? |
|
||||
| isSelected | `boolean` | | Is this group currently selected? |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -63,4 +63,3 @@ the following example:
|
||||
## See also
|
||||
|
||||
- [Accordion group component](accordion-group.component.md)
|
||||
|
||||
|
||||
@ -13,14 +13,14 @@ Generates and shows charts
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| reportId | string | The report id |
|
||||
| reportParamQuery | ReportQuery | The object contains all the parameters that the report needs |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| reportId | `number` | | |
|
||||
| reportParamQuery | `ReportQuery` | `undefined` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the charts are loaded |
|
||||
| error | Raised when an error occurs during the loading |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
||||
|
||||
@ -12,16 +12,16 @@ Shows a list of all available reports
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Default | Description |
|
||||
| ---- | ---- | -------- | ------- | ----------- |
|
||||
| appId | string | optional | | The application id |
|
||||
| layoutType | string | required | | Define the layout of the apps. There are two possible values: GRID or LIST. LIST is the default value |
|
||||
| selectFirst | boolean | optional | false | Change the value to true if you want to select the first item in the list as default |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| layoutType | `string` | `AnalyticsReportListComponent.LAYOUT_LIST` | |
|
||||
| appId | `number` | | |
|
||||
| selectFirst | `boolean` | `false` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | The event is emitted when the report list is loaded |
|
||||
| error | The event is emitted when an error occurs during the loading |
|
||||
| reportClick | The event is emitted when the report in the list is selected |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| reportClick | `EventEmitter<ReportParametersModel>` | |
|
||||
| success | `EventEmitter<{}>` | |
|
||||
| error | `EventEmitter<{}>` | |
|
||||
|
||||
@ -15,29 +15,16 @@ Shows the charts related to the reportId passed as input
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| appId | string | The application id |
|
||||
| reportId | string | The report id |
|
||||
| hideParameters | boolean | Toggle the analytics parameters |
|
||||
|
||||
You can also hide chart parameters UI by setting the `hideParameters` to `true`:
|
||||
|
||||
```html
|
||||
<adf-analytics
|
||||
[appId]="appId"
|
||||
[reportId]="reportId"
|
||||
[hideParameters]="true">
|
||||
</adf-analytics>
|
||||
```
|
||||
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appId | `number` | | |
|
||||
| reportId | `number` | | |
|
||||
| hideParameters | `boolean` | `false` | |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | The event is emitted when the report parameters are loaded |
|
||||
| error | The event is emitted when an error occurs during the loading |
|
||||
| reportSaved | The event is emitted when a report is saved |
|
||||
| reportDeleted | The event is emitted when a report is deleted |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| editReport | `EventEmitter<{}>` | |
|
||||
| reportSaved | `EventEmitter<{}>` | |
|
||||
| reportDeleted | `EventEmitter<{}>` | |
|
||||
|
||||
@ -14,10 +14,10 @@ Shows all available apps.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| layoutType | `string` | (\*\*required\*\*) Defines the layout of the apps. There are two possible values, "GRID" and "LIST".<br/> Default value: `AppsListComponent.LAYOUT_GRID` |
|
||||
| filtersAppId | `any[]` | Provides a way to filter the apps to show. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| layoutType | `string` | `AppsListComponent.LAYOUT_GRID` | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
|
||||
| filtersAppId | `any[]` | | Provides a way to filter the apps to show. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -15,12 +15,12 @@ Indicates the current position within a navigation hierarchy.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | Active node, builds UI based on folderNode.path.elements collection. <br/> Default value: `null` |
|
||||
| root | `string` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value.<br/> Default value: `null` |
|
||||
| rootId | `string` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with.<br/> Default value: `null` |
|
||||
| target | `DocumentListComponent` | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
|
||||
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
|
||||
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -14,11 +14,11 @@ Shows the checklist task functionality.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| taskId | `string` | (required) The id of the parent task to which subtasks are attached. |
|
||||
| readOnly | `boolean` | Toggle readonly state of the form. All form widgets will render as readonly if enabled.<br/> Default value: `false` |
|
||||
| assignee | `string` | (required) The assignee id that the subtasks are assigned to. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. |
|
||||
| readOnly | `boolean` | `false` | Toggle readonly state of the form. All form widgets will render as readonly if enabled. |
|
||||
| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -54,9 +54,9 @@ In the component template use the comment list component:
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| comments | `any[]` | The comments data used to populate the list. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| comments | `any[]` | | The comments data used to populate the list. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -15,10 +15,10 @@ Displays comments from users involved in a specified task and allows an involved
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| taskId | `string` | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | Are the comments read only? <br/> Default value: `false` |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | `false` | Are the comments read only? |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -74,15 +74,15 @@ export class MyView {
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| title | `string` | The title of the action as shown in the menu. <br/> Default value: `'Action'` |
|
||||
| icon | `string` | The name of the icon to display next to the menu command (can be left blank). |
|
||||
| handler | `string` | System actions. Can be "delete", "download", "copy" or "move". |
|
||||
| target | `string` | Type of item that the action appies to. Can be "document" or "folder" |
|
||||
| permission | `string` | The permission type. |
|
||||
| disableWithNoPermission | `boolean` | Should this action be disabled in the menu if the user doesn't have permission for it? |
|
||||
| disabled | `boolean` | Is the menu item disabled? <br/> Default value: `false` |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | `'Action'` | The title of the action as shown in the menu. |
|
||||
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
|
||||
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
|
||||
| target | `string` | | Type of item that the action appies to. Can be "document" or "folder" |
|
||||
| permission | `string` | | The permission type. |
|
||||
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
|
||||
| disabled | `boolean` | `false` | Is the menu item disabled? |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -16,9 +16,9 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | `string` | (required) The ID of the process instance to display. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (required) The ID of the process instance to display. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -33,16 +33,16 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| key | `string` | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
|
||||
| type | `string` | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'.<br/> Default value: `'text'` |
|
||||
| format | `string` | Value format (if supported by the parent component), for example format of the date. |
|
||||
| sortable | `boolean` | Toggles ability to sort by this column, for example by clicking the column header. <br/> Default value: `true` |
|
||||
| title | `string` | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically.<br/> Default value: `''` |
|
||||
| formatTooltip | `Function` | Custom tooltip formatter function. |
|
||||
| srTitle | `string` | Title to be used for screen readers. |
|
||||
| cssClass | `string` | Additional CSS class to be applied to column (header and cells). |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. |
|
||||
| type | `string` | `'text'` | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'. |
|
||||
| format | `string` | | Value format (if supported by the parent component), for example format of the date. |
|
||||
| sortable | `boolean` | `true` | Toggles ability to sort by this column, for example by clicking the column header. |
|
||||
| title | `string` | `''` | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. |
|
||||
| formatTooltip | `Function` | | Custom tooltip formatter function. |
|
||||
| srTitle | `string` | | Title to be used for screen readers. |
|
||||
| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -47,32 +47,32 @@ Displays the documents from a repository.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| permissionsStyle | `PermissionStyleModel[]` | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples.<br/> Default value: `[]` |
|
||||
| locationFormat | `string` | The default route for all the location-based columns (if declared). <br/> Default value: `'/'` |
|
||||
| navigate | `boolean` | Toggles navigation to folder content or file preview <br/> Default value: `true` |
|
||||
| navigationMode | `string` | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". <br/> Default value: `DocumentListComponent.DOUBLE_CLICK_NAVIGATION` |
|
||||
| thumbnails | `boolean` | Show document thumbnails rather than icons <br/> Default value: `false` |
|
||||
| selectionMode | `string` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.<br/> Default value: `'single'` |
|
||||
| multiselect | `boolean` | Toggles multiselect mode <br/> Default value: `false` |
|
||||
| contentActions | `boolean` | Toggles content actions for each row <br/> Default value: `false` |
|
||||
| contentActionsPosition | `string` | Position of the content actions dropdown menu. Can be set to "left" or "right". <br/> Default value: `'right'` |
|
||||
| contextMenuActions | `boolean` | Toggles context menus for each row <br/> Default value: `false` |
|
||||
| emptyFolderImageUrl | `string` | Custom image for empty folder <br/> Default value: `'./assets/images/empty_doc_lib.svg'` |
|
||||
| allowDropFiles | `boolean` | Toggle file drop support for rows (see Upload Directive for further details <br/> Default value: `false` |
|
||||
| sorting | `string[]` | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
|
||||
| rowStyle | `string` | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
|
||||
| rowStyleClass | `string` | The CSS class to apply to every row |
|
||||
| loading | `boolean` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication.<br/> Default value: `false` |
|
||||
| rowFilter | `any` | Custom row filter <br/> Default value: `null` |
|
||||
| imageResolver | `any` | Custom image resolver <br/> Default value: `null` |
|
||||
| currentFolderId | `string` | The ID of the folder node to display or a reserved string alias for special sources <br/> Default value: `null` |
|
||||
| folderNode | `MinimalNodeEntryEntity` | Currently displayed folder node <br/> Default value: `null` |
|
||||
| node | `NodePaging` | The Document list will show all the nodes contained in the NodePaging entity <br/> Default value: `null` |
|
||||
| maxItems | `number` | Default value is stored into user preference settings |
|
||||
| skipCount | `number` | Number of elements to skip over for pagination purposes <br/> Default value: `0` |
|
||||
| enableInfiniteScrolling | `boolean` | Set document list to work in infinite scrolling mode <br/> Default value: `false` |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| permissionsStyle | `PermissionStyleModel[]` | `[]` | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples. |
|
||||
| locationFormat | `string` | `'/'` | The default route for all the location-based columns (if declared). |
|
||||
| navigate | `boolean` | `true` | Toggles navigation to folder content or file preview |
|
||||
| navigationMode | `string` | `DocumentListComponent.DOUBLE_CLICK_NAVIGATION` | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". |
|
||||
| thumbnails | `boolean` | `false` | Show document thumbnails rather than icons |
|
||||
| selectionMode | `string` | `'single'` | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
| multiselect | `boolean` | `false` | Toggles multiselect mode |
|
||||
| contentActions | `boolean` | `false` | Toggles content actions for each row |
|
||||
| contentActionsPosition | `string` | `'right'` | Position of the content actions dropdown menu. Can be set to "left" or "right". |
|
||||
| contextMenuActions | `boolean` | `false` | Toggles context menus for each row |
|
||||
| emptyFolderImageUrl | `string` | `'./assets/images/empty_doc_lib.svg'` | Custom image for empty folder |
|
||||
| allowDropFiles | `boolean` | `false` | Toggle file drop support for rows (see Upload Directive for further details |
|
||||
| sorting | `string[]` | | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
|
||||
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
|
||||
| rowStyleClass | `string` | | The CSS class to apply to every row |
|
||||
| loading | `boolean` | `false` | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
|
||||
| rowFilter | `any` | `null` | Custom row filter |
|
||||
| imageResolver | `any` | `null` | Custom image resolver |
|
||||
| currentFolderId | `string` | `null` | The ID of the folder node to display or a reserved string alias for special sources |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Currently displayed folder node |
|
||||
| node | `NodePaging` | `null` | The Document list will show all the nodes contained in the NodePaging entity |
|
||||
| maxItems | `number` | | Default value is stored into user preference settings |
|
||||
| skipCount | `number` | `0` | Number of elements to skip over for pagination purposes |
|
||||
| enableInfiniteScrolling | `boolean` | `false` | Set document list to work in infinite scrolling mode |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -15,25 +15,20 @@ Indicates the current position within a navigation hierarchy using a dropdown me
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| target | DocumentListComponent | (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update. |
|
||||
| folderNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | Active node, builds UI based on `folderNode.path.elements` collection. |
|
||||
| root | string | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use i18n resource key for the property value. |
|
||||
| rootId | string | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
|
||||
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
|
||||
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
||||
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Returned Type | Description |
|
||||
| ---- | ------------- | ----------- |
|
||||
| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb |
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
|
||||
<!-- seealso start -->
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
|
||||
|
||||
## See also
|
||||
|
||||
- [Document list component](document-list.component.md)
|
||||
- [Breadcrumb component](breadcrumb.component.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
@ -10,9 +10,9 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| position | string | 'right' | Dialog position. Accepted values are 'left' or 'right' |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| position | `string` | `'right'` | Dialog position. Can be 'left' or 'right'. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -16,9 +16,9 @@ based on the field type or the metadata information.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| field | FormFieldModel | | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| field | `FormFieldModel` | `null` | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -12,8 +12,6 @@ Shows APS forms as a list.
|
||||
|
||||
### Properties
|
||||
|
||||
The recommended set of properties can be found in the following table:
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| forms | any | | The array that contains the information to show inside the list. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| forms | `any[]` | `[]` | The array that contains the information to show inside the list. |
|
||||
|
||||
@ -101,45 +101,39 @@ and store the form field as metadata. The param nameNode is optional.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| taskId | string | | Task id to fetch corresponding form and values. |
|
||||
| formId | string | | The id of the form definition to load and display with custom values. |
|
||||
| formName | string | | Name of the form definition to load and display with custom values. |
|
||||
| data | FormValues | | Custom form values map to be used with the rendered form. |
|
||||
| showTitle | boolean | true | Toggle rendering of the form title. |
|
||||
| showCompleteButton | boolean | true | Toggle rendering of the `Complete` outcome button. |
|
||||
| disableCompleteButton | boolean | false | The `Complete` outcome button is shown but it will be disabled. |
|
||||
| disableStartProcessButton | boolean | false | The `Start Process` outcome button is shown but it will be disabled. |
|
||||
| showSaveButton | boolean | true | Toggle rendering of the `Save` outcome button. |
|
||||
| readOnly | boolean | false | Toggle readonly state of the form. Enforces all form widgets render readonly if enabled. |
|
||||
| showRefreshButton | boolean | true | Toggle rendering of the `Refresh` button. |
|
||||
| showValidationIcon | boolean | true | Toggle rendering of the validation icon next form title. |
|
||||
| saveMetadata | boolean | false | Store the value of the form as metadata. |
|
||||
| path | string | | Path of the folder where to store the metadata. |
|
||||
| nameNode | string | true | Name to assign to the new node where the metadata are stored. |
|
||||
| fieldValidators | FormFieldValidator\[] | See [Field Validators](#field-validators) section below | Contains a list of form field validator instances. |
|
||||
|
||||
### Advanced properties
|
||||
|
||||
The following properties are for complex customisation purposes:
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| form | FormModel | | Underlying form model instance. |
|
||||
| showDebugButton | boolean | false | Toggle debug options. |
|
||||
| debugMode | boolean | false | Toggle debug mode, allows displaying additional data for development and debugging purposes. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| form | `FormModel` | | Underlying form model instance. |
|
||||
| taskId | `string` | | Task id to fetch corresponding form and values. |
|
||||
| nodeId | `string` | | Content Services node ID for the form metadata. |
|
||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||
| saveMetadata | `boolean` | `false` | Toggle saving of form metadata. |
|
||||
| data | `FormValues` | | Custom form values map to be used with the rendered form. |
|
||||
| path | `string` | | Path of the folder where the metadata will be stored. |
|
||||
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
|
||||
| showTitle | `boolean` | `true` | Toggle rendering of the form title. |
|
||||
| showCompleteButton | `boolean` | `true` | Toggle rendering of the `Complete` outcome button. |
|
||||
| disableCompleteButton | `boolean` | `false` | If true then the `Complete` outcome button is shown but it will be disabled. |
|
||||
| disableStartProcessButton | `boolean` | `false` | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||
| showSaveButton | `boolean` | `true` | Toggle rendering of the `Save` outcome button. |
|
||||
| showDebugButton | `boolean` | `false` | Toggle debug options. |
|
||||
| readOnly | `boolean` | `false` | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggle rendering of the `Refresh` button. |
|
||||
| showValidationIcon | `boolean` | `true` | Toggle rendering of the validation icon next to the form title. |
|
||||
| fieldValidators | `FormFieldValidator[]` | `[]` | Contains a list of form field validator instances. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Return Type | Description |
|
||||
| ---- | ----------- | ----------- |
|
||||
| formLoaded | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is loaded or reloaded. |
|
||||
| formSaved | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is submitted with `Save` or custom outcomes. |
|
||||
| formCompleted | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form is submitted with `Complete` outcome. |
|
||||
| formDataRefreshed | [FormModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) | Invoked when form values are refreshed due to a data property change |
|
||||
| executeOutcome | [FormOutcomeEvent](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-form/src/components/widgets/core/form-outcome-event.model.ts) | Invoked when any outcome is executed, default behaviour can be prevented via `event.preventDefault()` |
|
||||
| error | any | Invoked at any error |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||
| formCompleted | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||
| formContentClicked | `EventEmitter<ContentLinkModel>` | Emitted when form content is clicked. |
|
||||
| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
|
||||
| formDataRefreshed | `EventEmitter<FormModel>` | Emitted when form values are refreshed due to a data property change. |
|
||||
| executeOutcome | `EventEmitter<FormOutcomeEvent>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
||||
| onError | `EventEmitter<any>` | Emitted when any error occurs. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -13,12 +13,12 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default Value | Description |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| providers | string | ALL | Possible valid values are ECM, BPM or ALL. It indicate which URL configurations show |
|
||||
| providers | `string` | `'ALL'` | Determines which configurations are shown. Possible valid values are "ECM", "BPM" or "ALL". |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Returned Type | Description |
|
||||
| ---- | ------------- | ----------- |
|
||||
| error | string | emitted when the url inserted is wrong |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<string>` | Emitted when the URL is invalid. |
|
||||
|
||||
@ -27,19 +27,18 @@ Adds "infinite" pagination to the component it is used with.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| pagination | Pagination | `InfinitePaginationComponent.DEFAULT_PAGINATION` | Pagination object |
|
||||
| pageSize | number | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event |
|
||||
| loading | boolean | false | |
|
||||
| target | PaginatedComponent | | Component that provides custom pagination support |
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| pagination | `Pagination` | | Pagination object. |
|
||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
||||
| pageSize | `number` | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event. |
|
||||
| isLoading | `boolean` | `false` | Is a new page loading? |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| loadMore | Emitted when the "Load More" button is clicked |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| loadMore | `EventEmitter<Pagination>` | Emitted when the "Load More" button is clicked. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -26,11 +26,16 @@ Displays a sidebar-style information panel with tabs.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| title | string | null | The title of the info drawer |
|
||||
| selectedIndex | number | 0 | The selected index tab |
|
||||
| currentTab | any | null | The currently active tab |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| title | `string` | `null` | The title of the info drawer. |
|
||||
| selectedIndex | `number` | `0` | The selected index tab. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| currentTab | `EventEmitter<number>` | Emitted when the currently active tab changes. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -12,15 +12,15 @@ Allows a user to add "likes" to an item.
|
||||
|
||||
### Properties
|
||||
|
||||
| Attribute | Type | Default | Description |
|
||||
| --------- | ---- | ------- | ----------- |
|
||||
| nodeId | string | | The identifier of a node. |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| nodeId | `string` | | Identifier of a node to apply likes to. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| changeVote | Raised when vote gets changed |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| changeVote | `EventEmitter<{}>` | Emitted when the "vote" gets changed. |
|
||||
|
||||
## See also
|
||||
|
||||
|
||||
@ -32,27 +32,27 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default Value | Description |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| providers | string | | Possible valid values are ECM, BPM or ALL. The default behaviour of this component will log in only in the ECM . If you want to log in in both systems the correct value to use is ALL. |
|
||||
| successRoute | string | | Route to redirect to upon successful login. |
|
||||
| disableCsrf | boolean | false | To prevent the CSRF Token from being submitted. Only for Alfresco Process Services call |
|
||||
| needHelpLink | string | | It will change the url of the NEED HELP link in the footer |
|
||||
| registerLink | string | | It will change the url of the REGISTER link in the footer |
|
||||
| logoImageUrl | string | \\<ADF logo image> | To change the logo image with a customised image |
|
||||
| copyrightText | string | \\<ADF copyright string> | The copyright text below the login box |
|
||||
| backgroundImageUrl | string | \\<ADF background image> | To change the background image with a customised image |
|
||||
| fieldsValidation | { [key: string]: any; }, extra?: { [key: string]: any; } | | Use it to customise the validation rules of the login form |
|
||||
| showRememberMe | boolean | false | Toggle `Remember me` checkbox visibility |
|
||||
| showLoginActions | boolean | false | Toggle extra actions visibility (`Need Help`, `Register`, etc.) |
|
||||
| showRememberMe | `boolean` | `true` | Should the `Remember me` checkbox be shown? |
|
||||
| showLoginActions | `boolean` | `true` | Should the extra actions (`Need Help`, `Register`, etc) be shown? |
|
||||
| needHelpLink | `string` | `''` | Sets the URL of the NEED HELP link in the footer. |
|
||||
| registerLink | `string` | `''` | Sets the URL of the REGISTER link in the footer. |
|
||||
| logoImageUrl | `string` | `'./assets/images/alfresco-logo.svg'` | Path to a custom logo image. |
|
||||
| backgroundImageUrl | `string` | `'./assets/images/background.svg'` | Path to a custom background image. |
|
||||
| copyrightText | `string` | `'\u00A9 2016 Alfresco Software, Inc. All Rights Reserved.'` | The copyright text below the login box. |
|
||||
| providers | `string` | | Possible valid values are ECM, BPM or ALL. By default, this component will log in only to ECM. If you want to log in in both systems then use ALL. |
|
||||
| fieldsValidation | `any` | | Custom validation rules for the login form. |
|
||||
| disableCsrf | `boolean` | | Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. |
|
||||
| successRoute | `string` | `null` | Route to redirect to on successful login. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the login is done |
|
||||
| error | Raised when the login fails |
|
||||
| executeSubmit | Raised when the form is submitted |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| success | `EventEmitter<LoginSuccessEvent>` | Emitted when the login is successful. |
|
||||
| error | `EventEmitter<LoginErrorEvent>` | Emitted when the login fails. |
|
||||
| executeSubmit | `EventEmitter<LoginSubmitEvent>` | Emitted when the login form is submitted. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -29,21 +29,21 @@ Adds pagination to the component it is used with.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| pagination | Pagination | | Pagination object |
|
||||
| supportedPageSizes | Array<number> | [ 25, 50, 100 ] | An array of page sizes |
|
||||
| target | PaginatedComponent | | Component that provides custom pagination support |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
||||
| supportedPageSizes | `number[]` | `[5, 25, 50, 100]` | An array of page sizes. |
|
||||
| pagination | `Pagination` | | Pagination object. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| change | EventEmitter<PaginationQueryParams> | Triggered for any action in pagination |
|
||||
| nextPage | EventEmitter<Pagination> | Triggered on next page action |
|
||||
| prevPage | EventEmitter<Pagination> | Triggered on previous page action |
|
||||
| changePageSize | EventEmitter<Pagination> | Triggered on page size change action |
|
||||
| changePageNumber | EventEmitter<Pagination> | Triggered on page change action |
|
||||
| change | `EventEmitter<PaginationQueryParams>` | Emitted when paginaton changes in any way. |
|
||||
| changePageNumber | `EventEmitter<Pagination>` | Emitted when the page number changes. |
|
||||
| changePageSize | `EventEmitter<Pagination>` | Emitted when the page size changes. |
|
||||
| nextPage | `EventEmitter<Pagination>` | Emitted when the next page is requested. |
|
||||
| prevPage | `EventEmitter<Pagination>` | Emitted when the previous page is requested. |
|
||||
|
||||
## Details
|
||||
|
||||
@ -71,3 +71,7 @@ export interface PaginatedComponent {
|
||||
|
||||
Your component needs to provide a `pagination` subject to allow Pagination component to reflect to changes.
|
||||
Every time user interacts with the Pagination, it will call the `updatePagination` method and pass the parameters.
|
||||
|
||||
## See also
|
||||
|
||||
- [Infinite Pagination component](infinite-pagination.component.md)
|
||||
|
||||
@ -60,18 +60,18 @@ In the component template use the people list component:
|
||||
</adf-people-list>
|
||||
```
|
||||
|
||||
Note that the people list component is based on the `<adf-datatable` component.
|
||||
Note that the people list component is based on the [Datatable component](datatable.component.md).
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| users | UserProcessModel\[] | | The array of user data that should be used to populate the people list |
|
||||
| actions | boolean | false | true if actions should be visible, i.e. the 'Three-Dots' menu |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| users | `any[]` | | The array of user data used to populate the people list. |
|
||||
| actions | `boolean` | `false` | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| clickRow | Emitted when the user clicks a row in the people list. |
|
||||
| clickAction | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| clickRow | `EventEmitter<any>` | Emitted when the user clicks a row in the people list. |
|
||||
| clickAction | `EventEmitter<UserEventModel>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
|
||||
|
||||
@ -10,17 +10,17 @@ Searches users/people.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| results | Observable<User\[]> | The params to show people list |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| results | `Observable<any[]>` | | The parameters to show people list. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| searchPeople | Raised when the search people with new keyword |
|
||||
| success | Raised when select the user and click action button |
|
||||
| closeSearch | Raised when click the clse button |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. |
|
||||
| success | `EventEmitter<any>` | Emitted when a user is selected and the action button is clicked. |
|
||||
| closeSearch | `EventEmitter<{}>` | Emitted when the "close" button is clicked. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -31,15 +31,11 @@ Displays users involved with a specified task
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| people | User\[] | The array of User object to display |
|
||||
| taskId | string | The numeric ID of the task |
|
||||
| readOnly | boolean | The boolean flag |
|
||||
|
||||
### Events
|
||||
|
||||
No Events
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| people | `any[]` | `[]` | The array of User objects to display. |
|
||||
| taskId | `string` | `''` | The numeric ID of the task. |
|
||||
| readOnly | `boolean` | `false` | Should the data be read-only? |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@ -18,8 +18,8 @@ If the List is empty, a default no content template is displayed.
|
||||
|
||||
|
||||
Make sure to override the UploadService with the ProcessUploadService
|
||||
```ts
|
||||
|
||||
```ts
|
||||
import { UploadService } from '@alfresco/adf-core';
|
||||
import { ProcessUploadService } from '@alfresco/adf-process-services';
|
||||
|
||||
@ -34,9 +34,26 @@ export class MyCustomProcessAttachmentComponent {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (**required**) The ID of the process instance to display. |
|
||||
| disabled | `boolean` | `false` | Disable/Enable read-only mode for attachment list. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked. |
|
||||
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
|
||||
| error | `EventEmitter<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
|
||||
|
||||
## Details
|
||||
|
||||
### How to Add Drag and Drop Functionality
|
||||
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom *no content template* as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
If we want user to be able to upload attachments for empty lists, We can wrap our component with upload drag area component. In that case, We should also pass a custom _no content template_ as shown below with our component urging the user to drag files to upload whenever the list is empty.
|
||||
|
||||
```html
|
||||
<adf-upload-drag-area
|
||||
@ -60,18 +77,3 @@ If we want user to be able to upload attachments for empty lists, We can wrap ou
|
||||
If the List is empty, the custom no-content template we passed is displayed.
|
||||
|
||||
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | -- |
|
||||
| processInstanceId | string | | (**required**): The ID of the process instance to display |
|
||||
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| attachmentClick | Raised when the attachment double clicked or selected view option from context menu by the user from within the component and return a Blob obj of the object clicker|
|
||||
| success | Raised when the attachment list fetch all the attach and return a list of attachments |
|
||||
| error | Raised when the attachment list is not able to fetch the attachments for example network error |
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Process Instance Comments component
|
||||
|
||||
Displays comments associated with a particular process instance and allows the user to add new comments
|
||||
Displays comments associated with a particular process instance and allows the user to add new comments.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@ -12,6 +12,13 @@ Displays comments associated with a particular process instance and allows the u
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. |
|
||||
| readOnly | `boolean` | `true` | Should the comments be read-only? |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | string | (**required**): The numeric ID of the process instance to display comments for |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
|
||||
@ -12,22 +12,20 @@ Collection of criteria used to filter process instances, which may be customized
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
|
||||
| appId | string | Display filters available to the current user for the application with the specified ID. |
|
||||
| appName | string | Display filters available to the current user for the application with the specified name. |
|
||||
| hasIcon | boolean | Toggle to show or not the filter's icon. |
|
||||
|
||||
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| filterParam | `FilterProcessRepresentationModel` | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. |
|
||||
| appId | `number` | | Display filters available to the current user for the application with the specified ID. |
|
||||
| appName | `string` | | Display filters available to the current user for the application with the specified name. |
|
||||
| showIcon | `boolean` | `true` | Toggle to show or hide the filter's icon. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| success | Raised when the list of filters has been successfully loaded from the server |
|
||||
| error | Raised when an error occurs |
|
||||
| filterClick | Raised when the user selects a filter from the list |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| filterClick | `EventEmitter<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. |
|
||||
| success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
|
||||
## Details
|
||||
|
||||
@ -37,6 +35,8 @@ filter as the active filter.
|
||||
The most common usage is in driving a process instance list to allow the user to choose which
|
||||
process instances are displayed in the list.
|
||||
|
||||
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
|
||||
|
||||
### How filter the activiti process filters
|
||||
|
||||
```html
|
||||
|
||||
@ -12,14 +12,17 @@ Displays detailed information on a specified process instance
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | string | (required): The numeric ID of the process instance to display |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. |
|
||||
| showTitle | `boolean` | `true` | Toggles whether to show or hide the title. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggles whether to show or hide the refresh button. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| processCancelledEmitter | Raised when the current process is cancelled by the user from within the component |
|
||||
| taskFormCompletedEmitter | Raised when the form associated with an active task is completed from within the component |
|
||||
| showProcessDiagram | Raised when the show diagram button is clicked |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |
|
||||
| showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. |
|
||||
|
||||
@ -14,10 +14,6 @@ Sub-component of the process details component, which renders some general infor
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstance | [ProcessInstanceModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-processlist/src/models/process-instance.model.ts) | (**required**): Full details of the process instance to display information about |
|
||||
|
||||
#### Events
|
||||
|
||||
This component does not define any events.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstance | `ProcessInstance` | | (**required**) Full details of the process instance to display information about. |
|
||||
|
||||
@ -13,13 +13,14 @@ Lists both the active and completed tasks associated with a particular process i
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| processInstanceId | string | (**required**): The ID of the process instance to display tasks for |
|
||||
| showRefreshButton | boolean | (default: `true`): Whether to show a refresh button next to the list of tasks to allow this to be updated from the server |
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstanceDetails | `ProcessInstance` | | (**required**) The ID of the process instance to display tasks for. |
|
||||
| showRefreshButton | `boolean` | `true` | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| taskFormCompletedEmitter | Raised when the form associated with an active task is completed from within the component |
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|
||||
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |
|
||||
|
||||
@ -38,8 +38,11 @@ function updatePhase(tree, pathname, aggData) {
|
||||
});
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
exports.updatePhase = updatePhase;
|
||||
function initialCap(str) {
|
||||
@ -87,14 +90,15 @@ function getPropDataFromClassChain(checker, classDec, inputs, outputs) {
|
||||
// Main class
|
||||
getPropDataFromClass(checker, classDec, inputs, outputs);
|
||||
// Inherited classes
|
||||
for (var _i = 0, _a = classDec.heritageClauses; _i < _a.length; _i++) {
|
||||
var hc = _a[_i];
|
||||
var hcType = checker.getTypeFromTypeNode(hc.types[0]);
|
||||
console.log(checker.getFullyQualifiedName(hcType.symbol));
|
||||
for (var _b = 0, _c = hcType.symbol.declarations; _b < _c.length; _b++) {
|
||||
var dec = _c[_b];
|
||||
if (typescript_1.isClassDeclaration(dec)) {
|
||||
getPropDataFromClassChain(checker, dec, inputs, outputs);
|
||||
if (classDec.heritageClauses) {
|
||||
for (var _i = 0, _a = classDec.heritageClauses; _i < _a.length; _i++) {
|
||||
var hc = _a[_i];
|
||||
var hcType = checker.getTypeFromTypeNode(hc.types[0]);
|
||||
for (var _b = 0, _c = hcType.symbol.declarations; _b < _c.length; _b++) {
|
||||
var dec = _c[_b];
|
||||
if (typescript_1.isClassDeclaration(dec)) {
|
||||
getPropDataFromClassChain(checker, dec, inputs, outputs);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -147,7 +151,7 @@ function buildInputsTable(inputs) {
|
||||
unist.makeTableRow([
|
||||
unist.makeTableCell([unist.makeText("Name")]),
|
||||
unist.makeTableCell([unist.makeText("Type")]),
|
||||
// unist.makeTableCell([unist.makeText("Default value")]),
|
||||
unist.makeTableCell([unist.makeText("Default value")]),
|
||||
unist.makeTableCell([unist.makeText("Description")])
|
||||
])
|
||||
];
|
||||
@ -161,15 +165,23 @@ function buildInputsTable(inputs) {
|
||||
pDesc = pDesc.replace(/[\n\r]+/, " ");
|
||||
}
|
||||
var descCellContent = remark().parse(pDesc).children;
|
||||
var defaultCellContent;
|
||||
if (pDefault) {
|
||||
/*
|
||||
descCellContent.push(unist.makeHTML("<br/>"));
|
||||
descCellContent.push(unist.makeText(" Default value: "));
|
||||
descCellContent.push(unist.makeInlineCode(pDefault));
|
||||
*/
|
||||
defaultCellContent = unist.makeInlineCode(pDefault);
|
||||
}
|
||||
else {
|
||||
defaultCellContent = unist.makeText("");
|
||||
}
|
||||
var cells = [
|
||||
unist.makeTableCell([unist.makeText(pName)]),
|
||||
unist.makeTableCell([unist.makeInlineCode(pType)]),
|
||||
//unist.makeTableCell([unist.makeText(pDefault)]),
|
||||
//unist.makeTableCell([unist.makeInlineCode(pDefault)]),
|
||||
unist.makeTableCell([defaultCellContent]),
|
||||
unist.makeTableCell(descCellContent)
|
||||
];
|
||||
rows.push(unist.makeTableRow(cells));
|
||||
|
||||
@ -47,9 +47,13 @@ export function updatePhase(tree, pathname, aggData) {
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
|
||||
}
|
||||
|
||||
|
||||
@ -122,14 +126,14 @@ function getPropDataFromClassChain(
|
||||
getPropDataFromClass(checker, classDec, inputs, outputs);
|
||||
|
||||
// Inherited classes
|
||||
for(const hc of classDec.heritageClauses) {
|
||||
let hcType = checker.getTypeFromTypeNode(hc.types[0]);
|
||||
|
||||
console.log(checker.getFullyQualifiedName(hcType.symbol));
|
||||
|
||||
for (const dec of hcType.symbol.declarations) {
|
||||
if (isClassDeclaration(dec)) {
|
||||
getPropDataFromClassChain(checker, dec, inputs, outputs);
|
||||
if (classDec.heritageClauses) {
|
||||
for(const hc of classDec.heritageClauses) {
|
||||
let hcType = checker.getTypeFromTypeNode(hc.types[0]);
|
||||
|
||||
for (const dec of hcType.symbol.declarations) {
|
||||
if (isClassDeclaration(dec)) {
|
||||
getPropDataFromClassChain(checker, dec, inputs, outputs);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -201,7 +205,7 @@ function buildInputsTable(inputs: any[]) {
|
||||
unist.makeTableRow([
|
||||
unist.makeTableCell([unist.makeText("Name")]),
|
||||
unist.makeTableCell([unist.makeText("Type")]),
|
||||
// unist.makeTableCell([unist.makeText("Default value")]),
|
||||
unist.makeTableCell([unist.makeText("Default value")]),
|
||||
unist.makeTableCell([unist.makeText("Description")])
|
||||
])
|
||||
];
|
||||
@ -219,16 +223,24 @@ function buildInputsTable(inputs: any[]) {
|
||||
|
||||
var descCellContent = remark().parse(pDesc).children;
|
||||
|
||||
var defaultCellContent;
|
||||
|
||||
if (pDefault) {
|
||||
/*
|
||||
descCellContent.push(unist.makeHTML("<br/>"));
|
||||
descCellContent.push(unist.makeText(" Default value: "));
|
||||
descCellContent.push(unist.makeInlineCode(pDefault));
|
||||
*/
|
||||
defaultCellContent = unist.makeInlineCode(pDefault);
|
||||
} else {
|
||||
defaultCellContent = unist.makeText("");
|
||||
}
|
||||
|
||||
|
||||
var cells = [
|
||||
unist.makeTableCell([unist.makeText(pName)]),
|
||||
unist.makeTableCell([unist.makeInlineCode(pType)]),
|
||||
//unist.makeTableCell([unist.makeText(pDefault)]),
|
||||
//unist.makeTableCell([unist.makeInlineCode(pDefault)]),
|
||||
unist.makeTableCell([defaultCellContent]),
|
||||
unist.makeTableCell(descCellContent)
|
||||
];
|
||||
|
||||
|
||||
@ -26,10 +26,11 @@ import { RatingService } from './services/rating.service';
|
||||
encapsulation: ViewEncapsulation.None
|
||||
})
|
||||
export class LikeComponent implements OnChanges {
|
||||
|
||||
/** Identifier of a node to apply likes to. */
|
||||
@Input()
|
||||
nodeId: string;
|
||||
|
||||
/** Emitted when the "vote" gets changed. */
|
||||
@Output()
|
||||
changeVote = new EventEmitter();
|
||||
|
||||
|
||||
@ -32,6 +32,7 @@ export class FileUploadingDialogComponent implements OnInit, OnDestroy {
|
||||
@ViewChild(FileUploadingListComponent)
|
||||
uploadList: FileUploadingListComponent;
|
||||
|
||||
/** Dialog position. Can be 'left' or 'right'. */
|
||||
@Input()
|
||||
position: string = 'right';
|
||||
|
||||
|
||||
@ -54,6 +54,11 @@ export class FormFieldComponent implements OnInit, OnDestroy {
|
||||
@ViewChild('container', { read: ViewContainerRef })
|
||||
container: ViewContainerRef;
|
||||
|
||||
/** Contains all the necessary data needed to determine what UI Widget
|
||||
* to use when rendering the field in the form. You would typically not
|
||||
* create this data manually but instead create the form in APS and export
|
||||
* it to get to all the `FormFieldModel` definitions.
|
||||
*/
|
||||
@Input()
|
||||
field: FormFieldModel = null;
|
||||
|
||||
|
||||
@ -26,6 +26,7 @@ import { FormService } from './../services/form.service';
|
||||
})
|
||||
export class FormListComponent implements OnChanges {
|
||||
|
||||
/** The array that contains the information to show inside the list. */
|
||||
@Input()
|
||||
forms: any [] = [];
|
||||
|
||||
|
||||
@ -41,81 +41,109 @@ export class FormComponent implements OnInit, OnChanges {
|
||||
static COMPLETE_BUTTON_COLOR: string = 'primary';
|
||||
static COMPLETE_OUTCOME_NAME: string ='Complete'
|
||||
|
||||
/** Underlying form model instance. */
|
||||
@Input()
|
||||
form: FormModel;
|
||||
|
||||
/** Task id to fetch corresponding form and values. */
|
||||
@Input()
|
||||
taskId: string;
|
||||
|
||||
/** Content Services node ID for the form metadata. */
|
||||
@Input()
|
||||
nodeId: string;
|
||||
|
||||
/** The id of the form definition to load and display with custom values. */
|
||||
@Input()
|
||||
formId: string;
|
||||
|
||||
/** Name of the form definition to load and display with custom values. */
|
||||
@Input()
|
||||
formName: string;
|
||||
|
||||
/** Toggle saving of form metadata. */
|
||||
@Input()
|
||||
saveMetadata: boolean = false;
|
||||
|
||||
/** Custom form values map to be used with the rendered form. */
|
||||
@Input()
|
||||
data: FormValues;
|
||||
|
||||
/** Path of the folder where the metadata will be stored. */
|
||||
@Input()
|
||||
path: string;
|
||||
|
||||
/** Name to assign to the new node where the metadata are stored. */
|
||||
@Input()
|
||||
nameNode: string;
|
||||
|
||||
/** Toggle rendering of the form title. */
|
||||
@Input()
|
||||
showTitle: boolean = true;
|
||||
|
||||
/** Toggle rendering of the `Complete` outcome button. */
|
||||
@Input()
|
||||
showCompleteButton: boolean = true;
|
||||
|
||||
/** If true then the `Complete` outcome button is shown but it will be disabled. */
|
||||
@Input()
|
||||
disableCompleteButton: boolean = false;
|
||||
|
||||
/** If true then the `Start Process` outcome button is shown but it will be disabled. */
|
||||
@Input()
|
||||
disableStartProcessButton: boolean = false;
|
||||
|
||||
/** Toggle rendering of the `Save` outcome button. */
|
||||
@Input()
|
||||
showSaveButton: boolean = true;
|
||||
|
||||
/** Toggle debug options. */
|
||||
@Input()
|
||||
showDebugButton: boolean = false;
|
||||
|
||||
/** Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. */
|
||||
@Input()
|
||||
readOnly: boolean = false;
|
||||
|
||||
/** Toggle rendering of the `Refresh` button. */
|
||||
@Input()
|
||||
showRefreshButton: boolean = true;
|
||||
|
||||
/** Toggle rendering of the validation icon next to the form title. */
|
||||
@Input()
|
||||
showValidationIcon: boolean = true;
|
||||
|
||||
/** Contains a list of form field validator instances. */
|
||||
@Input()
|
||||
fieldValidators: FormFieldValidator[] = [];
|
||||
|
||||
/** Emitted when the form is submitted with the `Save` or custom outcomes. */
|
||||
@Output()
|
||||
formSaved: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when the form is submitted with the `Complete` outcome. */
|
||||
@Output()
|
||||
formCompleted: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when form content is clicked. */
|
||||
@Output()
|
||||
formContentClicked: EventEmitter<ContentLinkModel> = new EventEmitter<ContentLinkModel>();
|
||||
|
||||
/** Emitted when the form is loaded or reloaded. */
|
||||
@Output()
|
||||
formLoaded: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when form values are refreshed due to a data property change. */
|
||||
@Output()
|
||||
formDataRefreshed: EventEmitter<FormModel> = new EventEmitter<FormModel>();
|
||||
|
||||
/** Emitted when any outcome is executed. Default behaviour can be prevented
|
||||
* via `event.preventDefault()`.
|
||||
*/
|
||||
@Output()
|
||||
executeOutcome: EventEmitter<FormOutcomeEvent> = new EventEmitter<FormOutcomeEvent>();
|
||||
|
||||
/** Emitted when any error occurs. */
|
||||
@Output()
|
||||
onError: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
@ -34,12 +34,15 @@ export class InfoDrawerTabComponent {
|
||||
host: { 'class': 'adf-info-drawer' }
|
||||
})
|
||||
export class InfoDrawerComponent {
|
||||
/** The title of the info drawer. */
|
||||
@Input()
|
||||
title: string|null = null;
|
||||
|
||||
/** The selected index tab. */
|
||||
@Input()
|
||||
selectedIndex: number = 0;
|
||||
|
||||
/** Emitted when the currently active tab changes. */
|
||||
@Output()
|
||||
currentTab: EventEmitter<number> = new EventEmitter<number>();
|
||||
|
||||
|
||||
@ -55,61 +55,61 @@ export class LoginComponent implements OnInit {
|
||||
|
||||
isPasswordShow: boolean = false;
|
||||
|
||||
/* Should the `Remember me` checkbox be shown? */
|
||||
/** Should the `Remember me` checkbox be shown? */
|
||||
@Input()
|
||||
showRememberMe: boolean = true;
|
||||
|
||||
/* Should the extra actions (`Need Help`, `Register`, etc) be shown? */
|
||||
/** Should the extra actions (`Need Help`, `Register`, etc) be shown? */
|
||||
@Input()
|
||||
showLoginActions: boolean = true;
|
||||
|
||||
/* Sets the URL of the NEED HELP link in the footer */
|
||||
/** Sets the URL of the NEED HELP link in the footer. */
|
||||
@Input()
|
||||
needHelpLink: string = '';
|
||||
|
||||
/* Sets the URL of the REGISTER link in the footer */
|
||||
/** Sets the URL of the REGISTER link in the footer. */
|
||||
@Input()
|
||||
registerLink: string = '';
|
||||
|
||||
/* Path to a custom logo image */
|
||||
/** Path to a custom logo image. */
|
||||
@Input()
|
||||
logoImageUrl: string = './assets/images/alfresco-logo.svg';
|
||||
|
||||
/* Path to a custom background image */
|
||||
/** Path to a custom background image. */
|
||||
@Input()
|
||||
backgroundImageUrl: string = './assets/images/background.svg';
|
||||
|
||||
/* The copyright text below the login box */
|
||||
/** The copyright text below the login box. */
|
||||
@Input()
|
||||
copyrightText: string = '\u00A9 2016 Alfresco Software, Inc. All Rights Reserved.';
|
||||
|
||||
/* Possible valid values are ECM, BPM or ALL. By default, this component
|
||||
/** Possible valid values are ECM, BPM or ALL. By default, this component
|
||||
* will log in only to ECM. If you want to log in in both systems then use ALL.
|
||||
*/
|
||||
@Input()
|
||||
providers: string;
|
||||
|
||||
/* Custom validation rules for the login form */
|
||||
/** Custom validation rules for the login form. */
|
||||
@Input()
|
||||
fieldsValidation: any;
|
||||
|
||||
/* Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
|
||||
/** Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
|
||||
@Input()
|
||||
disableCsrf: boolean;
|
||||
|
||||
/* Route to redirect to on successful login. */
|
||||
/** Route to redirect to on successful login. */
|
||||
@Input()
|
||||
successRoute: string = null;
|
||||
|
||||
/* Emitted when the login is successful */
|
||||
/** Emitted when the login is successful. */
|
||||
@Output()
|
||||
success = new EventEmitter<LoginSuccessEvent>();
|
||||
|
||||
/* Emitted when the login fails */
|
||||
/** Emitted when the login fails. */
|
||||
@Output()
|
||||
error = new EventEmitter<LoginErrorEvent>();
|
||||
|
||||
/* Emitted when the login form is submitted */
|
||||
/** Emitted when the login form is submitted. */
|
||||
@Output()
|
||||
executeSubmit = new EventEmitter<LoginSubmitEvent>();
|
||||
|
||||
|
||||
@ -50,18 +50,23 @@ export class InfinitePaginationComponent implements OnInit, OnDestroy {
|
||||
hasMoreItems: false
|
||||
};
|
||||
|
||||
/** Pagination object. */
|
||||
@Input()
|
||||
pagination: Pagination;
|
||||
|
||||
/** Component that provides custom pagination support. */
|
||||
@Input()
|
||||
target: PaginatedComponent;
|
||||
|
||||
/** Number of items that are added with each "load more" event. */
|
||||
@Input()
|
||||
pageSize: number = InfinitePaginationComponent.DEFAULT_PAGE_SIZE;
|
||||
|
||||
/** Is a new page loading? */
|
||||
@Input('loading')
|
||||
isLoading: boolean = false;
|
||||
|
||||
/** Emitted when the "Load More" button is clicked. */
|
||||
@Output()
|
||||
loadMore: EventEmitter<Pagination> = new EventEmitter<Pagination>();
|
||||
|
||||
|
||||
@ -56,27 +56,35 @@ export class PaginationComponent implements OnInit, OnDestroy {
|
||||
CHANGE_PAGE_NUMBER: 'CHANGE_PAGE_NUMBER'
|
||||
};
|
||||
|
||||
/** Component that provides custom pagination support. */
|
||||
@Input()
|
||||
target: PaginatedComponent;
|
||||
|
||||
/** An array of page sizes. */
|
||||
@Input()
|
||||
supportedPageSizes: number[] = [5, 25, 50, 100];
|
||||
|
||||
/** Pagination object. */
|
||||
@Input()
|
||||
pagination: Pagination;
|
||||
|
||||
/** Emitted when paginaton changes in any way. */
|
||||
@Output()
|
||||
change: EventEmitter<PaginationQueryParams> = new EventEmitter<PaginationQueryParams>();
|
||||
|
||||
/** Emitted when the page number changes. */
|
||||
@Output()
|
||||
changePageNumber: EventEmitter<Pagination> = new EventEmitter<Pagination>();
|
||||
|
||||
/** Emitted when the page size changes. */
|
||||
@Output()
|
||||
changePageSize: EventEmitter<Pagination> = new EventEmitter<Pagination>();
|
||||
|
||||
/** Emitted when the next page is requested. */
|
||||
@Output()
|
||||
nextPage: EventEmitter<Pagination> = new EventEmitter<Pagination>();
|
||||
|
||||
/** Emitted when the previous page is requested. */
|
||||
@Output()
|
||||
prevPage: EventEmitter<Pagination> = new EventEmitter<Pagination>();
|
||||
|
||||
|
||||
@ -42,9 +42,11 @@ export class HostSettingsComponent {
|
||||
urlFormControlEcm = new FormControl('', [Validators.required, Validators.pattern(this.HOST_REGEX)]);
|
||||
urlFormControlBpm = new FormControl('', [Validators.required, Validators.pattern(this.HOST_REGEX)]);
|
||||
|
||||
/** Determines which configurations are shown. Possible valid values are "ECM", "BPM" or "ALL". */
|
||||
@Input()
|
||||
providers: string = 'ALL';
|
||||
|
||||
/** Emitted when the URL is invalid. */
|
||||
@Output()
|
||||
error = new EventEmitter<string>();
|
||||
|
||||
|
||||
@ -30,18 +30,31 @@ export class ProcessAttachmentListComponent implements OnChanges, AfterContentIn
|
||||
@ContentChild(EmptyListComponent)
|
||||
emptyTemplate: EmptyListComponent;
|
||||
|
||||
/** (**required**) The ID of the process instance to display. */
|
||||
@Input()
|
||||
processInstanceId: string;
|
||||
|
||||
/** Disable/Enable read-only mode for attachment list. */
|
||||
@Input()
|
||||
disabled: boolean = false;
|
||||
|
||||
/** Emitted when the attachment is double-clicked or the
|
||||
* view option is selected from the context menu by the user from
|
||||
* within the component. Returns a Blob representing the object
|
||||
* that was clicked.
|
||||
*/
|
||||
@Output()
|
||||
attachmentClick = new EventEmitter();
|
||||
|
||||
/** Emitted when the attachment list has fetched all the attachments.
|
||||
* Returns a list of attachments.
|
||||
*/
|
||||
@Output()
|
||||
success = new EventEmitter();
|
||||
|
||||
/** Emitted when the attachment list is not able to fetch the attachments
|
||||
* (eg, following a network error).
|
||||
*/
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
@ -27,12 +27,15 @@ import { Observer } from 'rxjs/Observer';
|
||||
})
|
||||
export class ProcessCommentsComponent implements OnChanges {
|
||||
|
||||
/** (**required**) The numeric ID of the process instance to display comments for. */
|
||||
@Input()
|
||||
processInstanceId: string;
|
||||
|
||||
/** Should the comments be read-only? */
|
||||
@Input()
|
||||
readOnly: boolean = true;
|
||||
|
||||
/** Emitted when an error occurs. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
@ -33,15 +33,19 @@ export class PeopleListComponent implements AfterViewInit, AfterContentInit {
|
||||
@ViewChild(DataTableComponent)
|
||||
peopleDataTable: DataTableComponent;
|
||||
|
||||
/** The array of user data used to populate the people list. */
|
||||
@Input()
|
||||
users: UserProcessModel[];
|
||||
|
||||
/** Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. */
|
||||
@Input()
|
||||
actions: boolean = false;
|
||||
|
||||
/** Emitted when the user clicks a row in the people list. */
|
||||
@Output()
|
||||
clickRow: EventEmitter<UserProcessModel> = new EventEmitter<UserProcessModel>();
|
||||
|
||||
/** Emitted when the user clicks in the 'Three Dots' drop down menu for a row. */
|
||||
@Output()
|
||||
clickAction: EventEmitter<UserEventModel> = new EventEmitter<UserEventModel>();
|
||||
|
||||
|
||||
@ -30,12 +30,15 @@ import { PeopleSearchComponent } from '../people-search/people-search.component'
|
||||
})
|
||||
export class PeopleComponent implements OnInit, AfterViewInit {
|
||||
|
||||
/** The array of User objects to display. */
|
||||
@Input()
|
||||
people: UserProcessModel[] = [];
|
||||
|
||||
/** The numeric ID of the task. */
|
||||
@Input()
|
||||
taskId: string = '';
|
||||
|
||||
/** Should the data be read-only? */
|
||||
@Input()
|
||||
readOnly: boolean = false;
|
||||
|
||||
|
||||
@ -30,24 +30,33 @@ import { ProcessFilterService } from './../services/process-filter.service';
|
||||
})
|
||||
export class ProcessFiltersComponent implements OnInit, OnChanges {
|
||||
|
||||
/** The parameters to filter the task filter. If there is no match then the default one
|
||||
* (ie, the first filter in the list) is selected.
|
||||
*/
|
||||
@Input()
|
||||
filterParam: FilterProcessRepresentationModel;
|
||||
|
||||
/** Emitted when the user selects a filter from the list. */
|
||||
@Output()
|
||||
filterClick: EventEmitter<ProcessInstanceFilterRepresentation> = new EventEmitter<ProcessInstanceFilterRepresentation>();
|
||||
|
||||
/** Emitted when the list of filters has been successfully loaded from the server. */
|
||||
@Output()
|
||||
success: EventEmitter<ProcessInstanceFilterRepresentation[]> = new EventEmitter<ProcessInstanceFilterRepresentation[]>();
|
||||
|
||||
/** Emitted when an error occurs. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
/** Display filters available to the current user for the application with the specified ID. */
|
||||
@Input()
|
||||
appId: number;
|
||||
|
||||
/** Display filters available to the current user for the application with the specified name. */
|
||||
@Input()
|
||||
appName: string;
|
||||
|
||||
/** Toggle to show or hide the filter's icon. */
|
||||
@Input()
|
||||
showIcon: boolean = true;
|
||||
|
||||
|
||||
@ -32,6 +32,7 @@ import { ProcessInstanceTasksComponent } from './process-instance-tasks.componen
|
||||
})
|
||||
export class ProcessInstanceDetailsComponent implements OnChanges {
|
||||
|
||||
/** (required) The numeric ID of the process instance to display. */
|
||||
@Input()
|
||||
processInstanceId: string;
|
||||
|
||||
@ -41,23 +42,29 @@ export class ProcessInstanceDetailsComponent implements OnChanges {
|
||||
@ViewChild(ProcessInstanceTasksComponent)
|
||||
tasksList: ProcessInstanceTasksComponent;
|
||||
|
||||
/** Toggles whether to show or hide the title. */
|
||||
@Input()
|
||||
showTitle: boolean = true;
|
||||
|
||||
/** Toggles whether to show or hide the refresh button. */
|
||||
@Input()
|
||||
showRefreshButton: boolean = true;
|
||||
|
||||
/** Emitted when the current process is cancelled by the user from within the component. */
|
||||
@Output()
|
||||
processCancelled: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
/** Emitted when an error occurs. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
/** Emitted when a task is clicked. */
|
||||
@Output()
|
||||
taskClick: EventEmitter<TaskDetailsEvent> = new EventEmitter<TaskDetailsEvent>();
|
||||
|
||||
processInstanceDetails: ProcessInstance;
|
||||
|
||||
/** Emitted when the "show diagram" button is clicked. */
|
||||
@Output()
|
||||
showProcessDiagram: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
@ -26,6 +26,7 @@ import { ProcessInstance } from '../models/process-instance.model';
|
||||
})
|
||||
export class ProcessInstanceHeaderComponent implements OnChanges {
|
||||
|
||||
/** (**required**) Full details of the process instance to display information about. */
|
||||
@Input()
|
||||
processInstance: ProcessInstance;
|
||||
|
||||
|
||||
@ -32,12 +32,17 @@ import { ProcessService } from './../services/process.service';
|
||||
})
|
||||
export class ProcessInstanceTasksComponent implements OnInit, OnChanges {
|
||||
|
||||
/** (**required**) The ID of the process instance to display tasks for. */
|
||||
@Input()
|
||||
processInstanceDetails: ProcessInstance;
|
||||
|
||||
/** Toggles whether to show a refresh button next to the list of tasks to allow
|
||||
* it to be updated from the server.
|
||||
*/
|
||||
@Input()
|
||||
showRefreshButton: boolean = true;
|
||||
|
||||
/** Emitted when an error occurs. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
@ -59,6 +64,7 @@ export class ProcessInstanceTasksComponent implements OnInit, OnChanges {
|
||||
@ViewChild('taskdetails')
|
||||
taskdetails: any;
|
||||
|
||||
/** Emitted when a task is clicked. */
|
||||
@Output()
|
||||
taskClick: EventEmitter<TaskDetailsEvent> = new EventEmitter<TaskDetailsEvent>();
|
||||
|
||||
|
||||
@ -33,35 +33,47 @@ export class ProcessInstanceListComponent implements OnChanges, AfterContentInit
|
||||
|
||||
@ContentChild(DataColumnListComponent) columnList: DataColumnListComponent;
|
||||
|
||||
/** The id of the app. */
|
||||
@Input()
|
||||
appId: number;
|
||||
|
||||
/** The processDefinitionKey of the process. */
|
||||
@Input()
|
||||
processDefinitionKey: string;
|
||||
|
||||
/** Defines the state of the processes. Possible values are `running`, `completed` and `all` */
|
||||
@Input()
|
||||
state: string;
|
||||
|
||||
/** Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`,
|
||||
* `ended-desc`, `ended-asc`.
|
||||
*/
|
||||
@Input()
|
||||
sort: string;
|
||||
|
||||
/** The name of the list. */
|
||||
@Input()
|
||||
name: string;
|
||||
|
||||
/** The presetColumn of the custom schema to fetch. */
|
||||
@Input()
|
||||
presetColumn: string;
|
||||
|
||||
requestNode: ProcessFilterParamRepresentationModel;
|
||||
|
||||
/** Data source to define the datatable. */
|
||||
@Input()
|
||||
data: DataTableAdapter;
|
||||
|
||||
/** Emitted when a row in the process list is clicked. */
|
||||
@Output()
|
||||
rowClick: EventEmitter<string> = new EventEmitter<string>();
|
||||
|
||||
/** Emitted when the list of process instances has been loaded successfully from the server. */
|
||||
@Output()
|
||||
success: EventEmitter<ProcessInstance[]> = new EventEmitter<ProcessInstance[]>();
|
||||
|
||||
/** Emitted when an error occurs while loading the list of process instances from the server. */
|
||||
@Output()
|
||||
error: EventEmitter<any> = new EventEmitter<any>();
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user