arlas-wui-toolkit / Exports / FiltersComponent

Class: FiltersComponent

Implements

• OnInit
• OnChanges

Table of contents

Constructors

• constructor

Properties

• NUMBER_FORMAT_CHAR
• ZoomToDataStrategy
• availableSpace
• backgroundColorFilter
• clickOnFilter
• collaborationByCollection
• collaborations
• collaborationsMap
• collectionToDescription
• colorFilter
• contributors
• contributorsIcons
• countAll
• extraCountAll
• ignoredContributors
• isExtraOpen
• showExtraCollections
• showZoomToData
• spacing
• zoomEvent
• zoomToStrategy

Methods

• changeCollaborationState
• getAllContributorsIcons
• ngOnChanges
• ngOnDestroy
• ngOnInit
• removeAllFilters
• removeCollaboration
• toggleExtraCounts
• zoomToData

Constructors

constructor

• new FiltersComponent(collaborativeSearchService, arlasStartupService, configService, arlasColorService, cdr, collectionService)

Parameters

Name	Type
collaborativeSearchService	ArlasCollaborativesearchService
arlasStartupService	ArlasStartupService
configService	ArlasConfigService
arlasColorService	ArlasColorService
cdr	ChangeDetectorRef
collectionService	ArlasCollectionService

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:189

Properties

NUMBER_FORMAT_CHAR

• Readonly NUMBER_FORMAT_CHAR: "NUMBER_FORMAT_CHAR"

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:176

---

ZoomToDataStrategy

• ZoomToDataStrategy: typeof ZoomToDataStrategy = ZoomToDataStrategy

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:180

---

availableSpace

• availableSpace: number

Input

: Angular

Description

Specifies which space in pixels is available to display the collection counts, in order to hide the one that would overflow. If not set, this behavior is not put in place.

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:136

---

backgroundColorFilter

• backgroundColorFilter: string = '#FFF'

Input

: Angular

Description

Background color of the filters chips

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:111

---

clickOnFilter

• clickOnFilter: Subject<string>

Output

: Angular

Description

This output emit contributor id on click on filter chip

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:161

---

collaborationByCollection

• collaborationByCollection: { collaborationId: string ; collection: string }[] = []

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:173

---

collaborations

• collaborations: Set<string>

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:170

---

collaborationsMap

• collaborationsMap: Map<string, Collaboration>

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:177

---

collectionToDescription

• collectionToDescription: Map<string, CollectionReferenceParameters>

Input

: Angular

Description

Map of collectionName, collection params. This input allows us to verify if the collection has a centroid path and therefore propose or not the 'Zoom to Data' button

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:129

---

colorFilter

• colorFilter: string = '#000'

Input

: Angular

Description

Color of the filters icon

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:116

---

contributors

• contributors: Map<string, Contributor>

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:171

---

contributorsIcons

• contributorsIcons: Map<string, string>

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:172

---

countAll

• countAll: CollectionCount[]

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:174

---

extraCountAll

• extraCountAll: CollectionCount[]

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:175

---

ignoredContributors

• ignoredContributors: string[]

Input

: Angular

Description

Contributors identifier array which will be ignored from the filter summary

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:122

---

isExtraOpen

• isExtraOpen: boolean = false

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:178

---

showExtraCollections

• showExtraCollections: boolean = false

Description

Whether to exceptionally display the extra collections for space computations

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:185

---

showZoomToData

• showZoomToData: boolean = true

Input

: Angular

Description

Whether the zoom to data icon is displayed or not

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:149

---

spacing

• spacing: number = 5

Input

: Angular

Description

Spacing used between collection count elements. Used to compute how much space is available for the counts.

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:143

---

zoomEvent

• zoomEvent: Subject<string>

Output

: Angular

Description

This output emits the order of zooming on the extent of the given collection name

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:167

---

zoomToStrategy

• zoomToStrategy: ZoomToDataStrategy

Input

: Angular

Description

Type of zoom to data

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:155

Methods

changeCollaborationState

▸ changeCollaborationState(contributorId): void

Parameters

Name	Type
contributorId	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:221

---

getAllContributorsIcons

▸ getAllContributorsIcons(): any

Returns

any

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:236

---

ngOnChanges

▸ ngOnChanges(changes): void

Parameters

Name	Type
changes	SimpleChanges

Returns

void

Implementation of

OnChanges.ngOnChanges

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:205

---

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:211

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:201

---

removeAllFilters

▸ removeAllFilters(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:231

---

removeCollaboration

▸ removeCollaboration(contributorId): void

Parameters

Name	Type
contributorId	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:216

---

toggleExtraCounts

▸ toggleExtraCounts(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:245

---

zoomToData

▸ zoomToData(collection): void

Parameters

Name	Type
collection	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/filters/filters.component.ts:241