The css class applied to each legend entry
The css class applied to each legend row
The css class applied to each legend symbol
Adds a given CSS class to the Component.
The CSS class to add.
Attaches the Component as a child of a given d3 Selection.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
background selection for the Component
for the component in pixel space, where the topLeft represents the component's minimum x and y values and the bottomRight represents the component's maximum x and y values.
Gets the current comparator for the Legend's entries.
Sets a new comparator for the Legend's entries. The comparator is used to set the display order of the entries.
Computes and sets the size, position, and alignment of the Component from the specified values. If no parameters are supplied and the Component is a root node, they are inferred from the size of the Component's element.
Gets a Selection containing a
Will return undefined if the Component has not been anchored.
content selection for the Component
Detaches a Component from the DOM. The Component can be reused.
This should only be used if you plan on reusing the calling Component. Otherwise, use destroy().
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
Checks if the Component has a given CSS class.
The CSS class to check for.
Gets the height of the Component in pixels.
Gets the maximum number of entries per row.
Sets the maximum number of entries perrow.
Removes a callback that would be called on anchoring the Component to the DOM. The callback is identified by reference equality.
Removes a callback to be called when the Component is detach()-ed. The callback is identified by reference equality.
Adds a callback to be called on anchoring the Component to the DOM. If the Component is already anchored, the callback is called immediately.
Adds a callback to be called when the Component is detach()-ed.
Sets a callback that gets called when the component resizes. The size change is not guaranteed to be reflected by the DOM at the time the callback is fired.
Gets the origin of the Component relative to its parent.
Gets the origin of the Component relative to the root
Gets the parent ComponentContainer for this Component.
Sets the parent ComponentContainer for this Component. An error will be thrown if the parent does not contain this Component. Adding a Component to a ComponentContainer should be done using the appropriate method on the ComponentContainer.
Causes the Component to re-layout and render.
This function should be called when a CSS change has occured that could influence the layout of the Component, such as changing the font size.
Removes a given CSS class from the Component.
The CSS class to remove.
Queues the Component for rendering.
Renders the Component to a given
A selector-string for the
Gets the function determining the symbols of the Legend.
Sets the function determining the symbols of the Legend.
Gets the opacity of the symbols of the Legend.
Sets the opacity of the symbols of the Legend.
Gets the width of the Component in pixels.
Gets the x alignment of the Component.
Sets the x alignment of the Component.
The x alignment of the Component ("left"/"center"/"right").
Gets the y alignment of the Component.
Sets the y alignment of the Component.
The y alignment of the Component ("top"/"center"/"bottom").
Generated using TypeDoc
The Legend consists of a series of entries, each with a color and label taken from the Color Scale.