arlas-wui-toolkit / Exports / ArlasExportCsvService

Class: ArlasExportCsvService

Table of contents

Constructors

• constructor

Methods

• compute
• export
• exportResultlist
• fetchHistogramData$
• fetchResultlistData$

Constructors

constructor

• new ArlasExportCsvService(collaborativesearchService, configService, settingsService, translate, arlasCollectionService)

Parameters

Name	Type
collaborativesearchService	ArlasCollaborativesearchService
configService	ArlasConfigService
settingsService	ArlasSettingsService
translate	TranslateService
arlasCollectionService	ArlasCollectionService

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:38

Methods

compute

▸ compute(contributor, contributorType?): Observable<AggregationResponse>

Parameters

Name	Type
contributor	Contributor
contributorType?	string

Returns

Observable<AggregationResponse>

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:67

---

export

▸ export(contributor, stayAtFirstLevel, contributorType?): Observable<Blob>

Parameters

Name	Type
contributor	Contributor
stayAtFirstLevel	boolean
contributorType?	string

Returns

Observable<Blob>

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:42

---

exportResultlist

▸ exportResultlist(contributor, hits): void

Exports hits as CSV file. The columns of the CSV are retrieved from contributor.getAllFields() method.

Parameters

Name	Type	Description
contributor	ResultListContributor	Resultlist contributor
hits	Hits	arlas Hits to be exported as CSV

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:147

---

fetchHistogramData$

▸ fetchHistogramData$(contributor): Observable<AggregationResponse>

Parameters

Name	Type
contributor	any

Returns

Observable<AggregationResponse>

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:93

---

fetchResultlistData$

▸ fetchResultlistData$(contributor, filter?): Observable<Hits>

Fetches the resulist data by taking into account the current sort/geosort, columns and details of the resultlist. The number of elements fetched is configured at the applicative level with resultlist.export_size in settings.yaml .

Parameters

Name	Type	Description
contributor	ResultListContributor	Resultlist contributor
filter?	Filter	an optional filter to add to the collaboration filters if needed

Returns

Observable<Hits>

an Observable (rxjs) of arlas Hits.

Defined in

projects/arlas-toolkit/src/lib/services/export-csv/export-csv.service.ts:136