Class: Legend

Legend(parent)

An SVG object used to display contextual information about a panel. Panel layouts determine basic features of a legend - its position in the panel, orientation, title, etc. Layouts of child data layers of the panel determine the actual content of the legend.

Constructor

new Legend(parent)

Parameters:
Name Type Description
parent Panel
Source:

Members

background_rect :d3.selection

Type:
  • d3.selection
Source:

elements :Array.<d3.selection>

Type:
  • Array.<d3.selection>
Source:

(protected) elements_group :d3.selection|null

SVG selector for the group containing all elements in the legend

Type:
  • d3.selection | null
Source:

(protected) hidden :Boolean

TODO: Not sure if this property is used; the external-facing methods are setting layout.hidden instead. Tentatively mark deprecated.

Type:
  • Boolean
Deprecated:
  • Yes
Source:

id :String

Type:
  • String
Source:

layout :Object

Type:
  • Object
Source:

parent :Panel

Type:
Source:

selector :d3.selection

Type:
  • d3.selection
Source:

Methods

hide()

Hide the legend (triggers a re-render)

Source:

position() → {Legend|null}

Place the legend in position relative to the panel, as specified in the layout configuration

Source:
Returns:

TODO: should this always be chainable?

Type
Legend | null

render()

Render the legend in the parent panel

Source:

show()

Show the legend (triggers a re-render)

Source: