@myrmidon/chiron-document-list v1.0.2

Chiron Document List

This library was generated with Angular CLI version 13.0.0.

Component: ChironDocumentList (chiron-document-list).

API

Input properties:

• corpusIdPrefix: the optional fixed corpus ID prefix to use when filtering documents. When set, this is constantly used as the corpus ID prefix filter when loading documents in this list.
• profileIdPrefix: the optional fixed profile ID prefix to use when filtering profiles. This applies to the profile selection bar.
• hideProfileBar: true to hide the profile selection bar.
• hideCorpusEditor: true to hide the the corpus editor used to add/remove the current selection to/from a corpus.
• customActions: an optional set of custom document actions. These are shown with additional buttons for each document in the list. When the user clicks a custom action button, the customAction event fires. The property is an array of CustomDocumentListAction objects, having these properties:
  • id (string)
  • iconId (string)
  • tip (string, optional)
  • disabled: an optional function receiving document (of type Document) and returning a boolean.

Events:

• documentEdit: emitted when user requests to edit a document (argument=document ID).
• documentAdd: emitted when user requests to add a new document.
• documentAnalyze: emitted when user requests to analyze a document (argument=DocumentAnalysisRequest).
• customAction: emitted when user requests a custom action on a document (argument=CustomDocumentActionRequest).
• profilesEdit: emitted when user requests to edit profiles.