API: Legend

Requires

• module:d3

Methods

---

module:Legend(_selection, _data)

This function creates the graph using the selection as container

Parameters:

Name	Type	Description
_selection	D3Selection	A d3 selection that represents the container(s) where the chart(s) will be rendered
_data	object	The data to attach and generate the chart

Source:

• legend.js

---

<static> clearHighlight()

Clears the highlighted line entry

Source:

• legend.js

---

<static> colorSchema(_x)

Gets or Sets the colorSchema of the chart

Parameters:

Name	Type	Description
_x	array	Color scheme array to get/set

Source:

• legend.js

Returns:

Current colorSchema or Donut Chart module to chain calls

Type

number | module

---

<static> height(_x)

Gets or Sets the height of the legend chart

Parameters:

Name	Type	Description
_x	number	Desired width for the chart

Source:

• legend.js

Returns:

Current height or Legend module to chain calls

Type

height | module

---

<static> highlight(entryId)

Highlights a line entry by fading the rest of lines

Parameters:

Name	Type	Description
entryId	number	ID of the entry line

Source:

• legend.js

---

<static> inline(_x)

Gets or Sets the inline mode on the legend

Parameters:

Name	Type	Description
_x	boolean	Desired inline mode for the graph

Source:

• legend.js

Returns:

Current inline mode or Legend module to chain calls

Type

inline | module

---

<static> margin(_x)

Gets or Sets the margin of the legend chart

Parameters:

Name	Type	Description
_x	object	Margin object to get/set

Source:

• legend.js

Returns:

Current margin or Legend module to chain calls

Type

margin | module

---

<static> width(_x)

Gets or Sets the width of the legend chart

Parameters:

Name	Type	Description
_x	number	Desired width for the graph

Source:

• legend.js

Returns:

Current width or Legend module to chain calls

Type

width | module