mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)
* [ADF-2847] Added class members heading to content services docs * [ADF-2847] Updated all prop/method tables in content services
This commit is contained in:
committed by
Eugenio Romano
parent
616036f9e7
commit
2c0e7aa035
@@ -11,21 +11,27 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
|
||||
### Methods
|
||||
|
||||
- `addFilterQuery(query: string): void`
|
||||
Adds a filter query to the search.
|
||||
- `query` - Query text
|
||||
- `removeFilterQuery(query: string): void`
|
||||
Removes a previously added filter query from the search.
|
||||
- `query` - Query text
|
||||
- `getFacetQuery(label: string): FacetQuery`
|
||||
Gets a facet query.
|
||||
- `label` - Identifier of the target query
|
||||
- `update(): void`
|
||||
Rebuilds the query and triggers the `updated` event.
|
||||
- `async execute()`
|
||||
Executes the query.
|
||||
- `buildQuery(): QueryBody`
|
||||
Builds the query.
|
||||
- `addFilterQuery(query: string = null)`<br/>
|
||||
|
||||
- `query: string = null` -
|
||||
- `buildQuery(): QueryBody`<br/>
|
||||
|
||||
- **Returns** `QueryBody` -
|
||||
|
||||
- `execute(): Promise<void>`<br/>
|
||||
|
||||
- **Returns** `Promise<void>` -
|
||||
|
||||
- `getFacetQuery(label: string = null): FacetQuery`<br/>
|
||||
|
||||
- `label: string = null` -
|
||||
- **Returns** `FacetQuery` -
|
||||
|
||||
- `removeFilterQuery(query: string = null)`<br/>
|
||||
|
||||
- `query: string = null` -
|
||||
|
||||
- `update()`<br/>
|
||||
|
||||
## Details
|
||||
|
||||
@@ -34,13 +40,13 @@ You can reuse it with multiple component implementations.
|
||||
|
||||
You can use custom widgets to populate and edit the following parts of the resulting query:
|
||||
|
||||
- categories
|
||||
- query fragments that form query expression
|
||||
- include fields
|
||||
- scope settings
|
||||
- filter queries
|
||||
- facet fields
|
||||
- range queries
|
||||
- categories
|
||||
- query fragments that form query expression
|
||||
- include fields
|
||||
- scope settings
|
||||
- filter queries
|
||||
- facet fields
|
||||
- range queries
|
||||
|
||||
```ts
|
||||
constructor(queryBuilder: SearchQueryBuilderService) {
|
||||
@@ -54,4 +60,4 @@ constructor(queryBuilder: SearchQueryBuilderService) {
|
||||
});
|
||||
|
||||
}
|
||||
```
|
||||
```
|
||||
|
Reference in New Issue
Block a user