You are browsing a class reference for deprecated Version 2 of the JavaScript Charts.
Documentation for other versions: amCharts 4 (current) or amCharts 3.
AmLegend is the class that displays legend of the chart. Legend to the chart should be added using chart.addLegend(legend) method. For example:
var chart = new AmCharts.AmSerialChart(); var legend = new AmCharts.AmLegend(); chart.addLegend(legend);In case legend is used with AmMap, you should provide data to the legend:
legend.data = [{title:"first", color:"#CC0000"}, {title:"second", color:"#00CC00"}]| Property | Type | Default | Description |
|---|---|---|---|
| align | String | left | Alignment of legend entries. Possible values are: "left", "center", "right". |
| autoMargins | Boolean | true | Used if chart is Serial or XY. In case true, margins of the legend are adjusted and made equal to chart's margins. |
| backgroundAlpha | Number | 0 | Opacity of legend's background. Value range is 0 - 1 |
| backgroundColor | String | #FFFFFF | Background color. You should set backgroundAlpha to >0 vallue in order background to be visible. |
| borderAlpha | Number | 0 | Opacity of chart's border. Value range is 0 - 1. |
| borderColor | String | #000000 | Color of legend's border. You should set borderAlpha >0 in order border to be visible. |
| bottom | Number | In case legend position is set to "absolute", you can set distance from bottom of the chart, in pixels. | |
| color | Hex string | Text color. Will use chart's color if not set. | |
| data | Array | This can be used by AmMap only. You can pass array of objects with title, color, markerType values, for example: [{title: "One", color: "#3366CC"},{title: "Two", color: "#FFCC33"}] | |
| equalWidths | Boolean | true | Specifies if each of legend entry should be equal to the most wide entry. Won't look good if legend has more than one line. |
| fontSize | Number | Font size. Will use chart's font size if not set. | |
| horizontalGap | Number | 0 | Horizontal space between legend item and left/right border. |
| labelText | String | [[title]] | The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph. |
| left | Number | In case legend position is set to "absolute", you can set distance from left side of the chart, in pixels. | |
| marginBottom | Number | 0 | Bottom margin. |
| marginLeft | Number | 20 | Left margin. This property will be ignored if chart is Serial or XY and autoMargins property of the legend is true (default). |
| marginRight | Number | 20 | Right margin. This property will be ignored if chart is Serial or XY and autoMargins property of the legend is true (default). |
| marginTop | Number | 0 | Top margin. |
| markerBorderAlpha | Number | 1 | Marker border opacity. |
| markerBorderColor | Hex string | Marker border color. If not set, will use the same color as marker. | |
| markerBorderThickness | Number | 1 | Thickness of the legend border. The default value (0) means the line will be a "hairline" (1 px). In case marker type is line, this style will be used for line thickness. |
| markerDisabledColor | Hex string | #AAB3B3 | The color of the disabled marker (when the graph is hidden). |
| markerLabelGap | Number | 5 | Space between legend marker and legend text, in pixels. |
| markerSize | Number | 16 | Size of the legend marker (key). |
| markerType | String | square | Shape of the legend marker (key). Possible values are: "square", "circle", "line", "dashedLine", "triangleUp", "triangleDown", "bubble", "none". |
| maxColumns | Number | Maximum number of columns in the legend. If Legend's position is set to "right" or "left", maxColumns is automatically set to 1. | |
| position | String | bottom | Position of a legend. Possible values are: "bottom", "top", "left", "right" and "absolute". In case "absolute", you should set left and top properties too. (this setting is ignored in Stock charts). In case legend is used with AmMap, position is set to "absolute" automatically. |
| reversedOrder | Boolean | false | Specifies whether legend entries should be placed in reversed order. |
| right | Number | In case legend position is set to "absolute", you can set distance from right side of the chart, in pixels. | |
| rollOverColor | String | #CC0000 | Legend item text color on roll-over. |
| rollOverGraphAlpha | Number | 1 | When you roll-over the legend entry, all other graphs can reduce their opacity, so that the graph you rolled-over would be distinguished. This style specifies the opacity of the graphs. |
| showEntries | Boolean | true | You can use this property to turn all the legend entries off. |
| spacing | Number | 10 | Horizontal space between legend items, in pixels. |
| switchable | Boolean | true | Whether showing/hiding of graphs by clicking on the legend marker is enabled or not. In case legend is used with AmMap, this is set to false automatically. |
| switchColor | Hex string | #FFFFFF | Legend switch color. |
| switchType | String | x | Legend switch type (in case the legend is switchable). Possible values are "x" and "v". |
| textClickEnabled | Boolean | false | If true, clicking on the text will show/hide balloon of the graph. Otherwise it will show/hide graph/slice, if switchable is set to true. |
| top | Number | In case legend position is set to "absolute", you can set distance from top of the chart, in pixels. | |
| useMarkerColorForLabels | Boolean | false | Labels will use marker color if you set this to true. |
| useMarkerColorForValues | Boolean | false | Specifies if legend values should be use same color as corresponding markers. |
| valueAlign | String | right | Alignment of the value text. Possible values are "left" and "right". |
| valueText | String | [[value]] | The text which will be displayed in the value portion of the legend. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents]], [[description]]. |
| valueWidth | Number | 80 | Width of the value text. |
| verticalGap | Number | 10 | Vertical space between legend items also between legend border and first and last legend row. |
| Name | Parameters | Returns | Description |
|---|---|---|---|
| addListener(type, handler) | type - string like 'clickLabel' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens | Adds event listener to the object. | |
| removeListener(legend, type, handler) | Removes event listener from the legend object. |
| Name | Event object | Description |
|---|---|---|
| clickLabel | {type:"clickLabel", dataItem:Object, chart:AmChart} | Dispatched when legend label is clicked. |
| clickMarker | {type:"clickMarker", dataItem:Object, chart:AmChart} | Dispatched when legend marker is clicked. |
| hideItem | {type:"hideItem", dataItem:Object, chart:AmChart} | Dispatched when user clicks on a legend item marker and hides corresponding object. |
| rollOutItem | {type:"rollOutItem", dataItem:Object, chart:AmChart} | Dispatched when user rolls-out of the legend item label (or whole item, if switchable is set to false). |
| rollOverItem | {type:"rollOverItem", dataItem:Object, chart:AmChart} | Dispatched when user rolls-over the legend item label (or whole item, if switchable is set to false). |
| rollOverMarker | {type:"rollOverMarker", dataItem:Object, chart:AmChart} | Dispatched when user rolls-over the legend item marker. |
| showItem | {type:"showItem", dataItem:Object, chart:AmChart} | Dispatched when user clicks on a legend item marker and shows corresponding object. |