Interface LegendRenderable

An interface for classes that represent a legend object.

export
interface: LegendRenderable

Hierarchy

LegendRenderable

Implemented by

Index

Properties

$el
key

Methods

Properties

$el

$el: any

The DOM element for the legend.

memberof: LegendRenderable

key

key: string

Key associated with the legend.

memberof: LegendRenderable

Methods

getSize

getSize(): Size

- Defined in src/maps/types/legend.interface.ts:57
Returns the size of the legend content.

memberof

LegendRenderable

Returns Size

hide

hide(): void

- Defined in src/maps/types/legend.interface.ts:41
Hides the legend DOM element.

memberof

LegendRenderable

Returns void

reset

reset(): void

- Defined in src/maps/types/legend.interface.ts:72
Resets the legend.

memberof

LegendRenderable

Returns void

setMetric

setMetric(metric: boolean): void

- Defined in src/maps/types/legend.interface.ts:65
Sets whether to display data values in Metric units.

memberof

LegendRenderable

Parameters
- metric: boolean
Returns void

setSize

setSize(size: Size): void

- Defined in src/maps/types/legend.interface.ts:49
Sets the size of the legend.

memberof

LegendRenderable

Parameters
- size: Size
Returns void

show

show(): void

- Defined in src/maps/types/legend.interface.ts:34
Shows the legend DOM element.

memberof

LegendRenderable

Returns void

update

update(opts?: any, force?: boolean): void

- Defined in src/maps/types/legend.interface.ts:80
Forces the legend to update if needed.

memberof

LegendRenderable

Parameters
- Optional opts: any
- Optional force: boolean
Returns void

Generated using TypeDoc