Class Legend

HTML legend for use with the Brain Viewer.

Index

Constructors

Methods

Constructors

constructor

new Legend(elem: HTMLElement, settings?: Partial<LegendSettings>): Legend
Create a new legend. Call update(...) to initialize or update the DOM after.
Parameters
- elem: HTMLElement
  DOM element to attach legend to.
- Optionalsettings: Partial<LegendSettings>
Returns Legend
- Defined in src/colormaps/legend.ts:77

Methods

dispose

dispose(): void
Remove legend from DOM.

Returns void
- Defined in src/colormaps/legend.ts:170

update

update(settings: Partial<LegendSettings>): void
Update legend with new settings.
Parameters
- settings: Partial<LegendSettings>
  Legend settings.
Returns void
- Defined in src/colormaps/legend.ts:195