dc.js Class: legend (original) (raw)
dc. legend
new legend()
Source:
Returns:
Type
Example
chart.legend(dc.legend().x(400).y(10).itemHeight(13).gap(5))
Methods
autoItemWidth( [autoItemWidth])
Turn automatic width for legend items on or off. If true, itemWidth is ignored. This setting takes into account the gap.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| autoItemWidth | Boolean | false |
Source:
Returns:
Type
Boolean|dc.legend
gap( [gap])
Set or get gap between legend items.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| gap | Number | 5 |
Source:
Returns:
Type
Number|dc.legend
highlightSelected( [highlightSelected])
This can be optionally used to enable highlighting legends for the selections/filters for the chart.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
| highlightSelected | String |
Source:
Returns:
Type
String|dc.legend
horizontal( [horizontal])
Position legend horizontally instead of vertically.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| horizontal | Boolean | false |
Source:
Returns:
Type
Boolean|dc.legend
itemHeight( [itemHeight])
Set or get legend item height.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| itemHeight | Number | 12 |
Source:
Returns:
Type
Number|dc.legend
itemWidth( [itemWidth])
Legend item width for horizontal legend.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| itemWidth | Number | 70 |
Source:
Returns:
Type
Number|dc.legend
legendText( [legendText])
Set or get the legend text function. The legend widget uses this function to render the legend text for each item. If no function is specified the legend widget will display the names associated with each group.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
| legendText | function |
Source:
Returns:
Type
function|dc.legend
Example
// default legendText legend.legendText(dc.pluck('name'))
// create numbered legend items chart.legend(dc.legend().legendText(function(d, i) { return i + '. ' + d.name; }))
// create legend displaying group counts chart.legend(dc.legend().legendText(function(d) { return d.name + ': ' d.data; }))
legendWidth( [legendWidth])
Maximum width for horizontal legend.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| legendWidth | Number | 500 |
Source:
Returns:
Type
Number|dc.legend
maxItems( [maxItems])
Maximum number of legend items to display
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
| maxItems | Number |
Source:
Returns:
Type
x( [x])
Set or get x coordinate for legend widget.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| x | Number | 0 |
Source:
Returns:
Type
Number|dc.legend
y( [y])
Set or get y coordinate for legend widget.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
| y | Number | 0 |
Source:
Returns:
Type
Number|dc.legend