arlas-web-components / Exports / MapglLegendComponent

Class: MapglLegendComponent

Implements

• OnInit
• AfterViewInit
• OnChanges

Table of contents

Constructors

• constructor

Properties

• PROPERTY_SELECTOR_SOURCE
• circleRadiusLegend
• collection
• colorLegend
• colorPalette
• colorService
• detail
• downloadSourceEmitter
• enabled
• layer
• legendUpdater
• lineDasharray
• lineWidthLegend
• radiusLegend
• strokeColorLegend
• strokeColorPalette
• translate
• visibilityStatus
• visibilityUpdater
• visibleMode
• widthLegend
• zoom

Methods

• downloadLayerSource
• ngAfterViewInit
• ngOnChanges
• ngOnDestroy
• ngOnInit
• showDetail
• buildColorLegend
• filterLegend

Constructors

constructor

• new MapglLegendComponent(translate, colorService)

Parameters

Name	Type
translate	TranslateService
colorService	ArlasColorService

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:117

Properties

PROPERTY_SELECTOR_SOURCE

• PROPERTY_SELECTOR_SOURCE: typeof PROPERTY_SELECTOR_SOURCE = PROPERTY_SELECTOR_SOURCE

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:106

---

circleRadiusLegend

• circleRadiusLegend: MapglLegendItemComponent

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:97

---

collection

• collection: string

Input

: Angular

Description

Collection of the layer

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:60

---

colorLegend

• colorLegend: Legend = {}

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:99

---

colorPalette

• colorPalette: string = ''

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:112

---

colorService

• colorService: ArlasColorService

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:119

---

detail

• detail: boolean = false

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:104

---

downloadSourceEmitter

• downloadSourceEmitter: Subject<{ downloadType: string ; layer: Layer }>

Output

: Angular

Description

Notifies the parent component that the user wants to download the layer

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:94

---

enabled

• enabled: boolean

Input

: Angular

Description

Whether the layer is enabled or disabled.

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:70

---

layer

• layer: Layer

Input

: Angular

Description

Layer object

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:55

---

legendUpdater

• legendUpdater: Subject<Map<string, Map<string, LegendData>>>

Input

: Angular

Description

Subject of [collection, [field, legendData]] map. The map subscribes to it to keep the legend updated with the data displayed on the map.

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:76

---

lineDasharray

• lineDasharray: number[]

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:100

---

lineWidthLegend

• lineWidthLegend: MapglLegendItemComponent

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:96

---

radiusLegend

• radiusLegend: Legend = {}

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:103

---

strokeColorLegend

• strokeColorLegend: Legend = {}

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:101

---

strokeColorPalette

• strokeColorPalette: string = ''

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:113

---

translate

• translate: TranslateService

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:118

---

visibilityStatus

• visibilityStatus: Subject<boolean>

Output

: Angular

Description

Notifies the parent component that this layer is visible or not

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:88

---

visibilityUpdater

• visibilityUpdater: Subject<Map<string, boolean>>

Input

: Angular

Description

Subject of [field, boolean] map. The map subscribes to it to keep the legend updated with the visibility of the layer.

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:82

---

visibleMode

• visibleMode: boolean = false

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:105

---

widthLegend

• widthLegend: Legend = {}

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:102

---

zoom

• zoom: number

Input

: Angular

Description

Current zoom level of the map

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:65

Methods

downloadLayerSource

▸ downloadLayerSource(layer, downloadType): void

Parameters

Name	Type
layer	Layer
downloadType	string

Returns

void

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:186

---

ngAfterViewInit

▸ ngAfterViewInit(): void

Returns

void

Implementation of

AfterViewInit.ngAfterViewInit

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:167

---

ngOnChanges

▸ ngOnChanges(changes): void

Parameters

Name	Type
changes	SimpleChanges

Returns

void

Implementation of

OnChanges.ngOnChanges

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:173

---

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:181

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:121

---

showDetail

▸ showDetail(event): void

Parameters

Name	Type
event	Event

Returns

void

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:194

---

buildColorLegend

▸ Static buildColorLegend(colorExpression, visibleMode, legendData, filter?, translate?): [Legend, string]

Parameters

Name	Type
colorExpression	string | StyleFunction | Expression
visibleMode	boolean
legendData	Map<string, LegendData>
filter?	any[]
translate?	TranslateService

Returns

[Legend, string]

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:303

---

filterLegend

▸ Static filterLegend(colorLegendValues, filter, field): void

Parameters

Name	Type
colorLegendValues	Map<string, string | number>
filter	any[]
field	string

Returns

void

Defined in

projects/arlas-components/src/lib/components/mapgl-legend/mapgl-legend.component.ts:274