Class Legend

HTML legend for use with the Brain Viewer.

Hierarchy

  • Legend

Constructors

constructor

Properties

backgroundColor color elem height marginBottom marginLeft marginRight marginTop tickSize title width

Methods

applySettings dispose init update

Constructors

constructor

  • Create a new legend. Call update(...) to initialize or update the DOM after.

    Parameters

    • elem: HTMLElement

      DOM element to attach legend to.

    • Optional settings: Partial<LegendSettings>

    Returns Legend

Properties

Private backgroundColor

backgroundColor: string = "#00000088"

Private color

color: ScaleSequential<string, never> = ...

Private elem

elem: HTMLElement

Private height

height: number = ...

Private marginBottom

marginBottom: number = ...

Private marginLeft

marginLeft: number = 0

Private marginRight

marginRight: number = 0

Private marginTop

marginTop: number = 18

Private tickSize

tickSize: number = 16

Private title

title: string = "Intensity"

Private width

width: number = 320

Methods

Private applySettings

  • Apply settings to legend.

    Parameters

    • settings: Partial<LegendSettings>

      Legend settings.

    Returns void

dispose

Private init

update

  • Update legend with new settings.

    Parameters

    • settings: Partial<LegendSettings>

      Legend settings.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc