You are browsing a class reference for deprecated Version 2 of the JavaScript Charts.
Documentation for other versions: amCharts 4 (current) or amCharts 3.
Common settings of legends. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of StockLegend class will be used.
| Property | Type | Default | Description |
|---|---|---|---|
| align | String | Alignment of legend entries. Possible values are: "left", "right" and "center". | |
| equalWidths | Boolean | false | Specifies if each legend entry should take the same space as the longest legend entry. |
| horizontalGap | Number | Horizontal space between legend item and left/right border. | |
| labelText | String | The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph. | |
| marginBottom | Number | 0 | Space below the last row of the legend, in pixels. |
| marginTop | Number | 0 | Space above the first row of the legend, in pixels. |
| markerBorderAlpha | Number | Opacity of marker border. | |
| markerBorderColor | String | Marker border color. | |
| markerBorderThickness | Number | Thickness of the legend border. | |
| markerDisabledColor | String | The color of the disabled marker (when the graph is hidden). | |
| markerLabelGap | Number | Space between legend marker and legend text, in pixels. | |
| markerSize | Number | Size of the legend marker (key). | |
| markerType | String | Shape of the legend marker (key). Possible values are: "square", "circle", "line", "dashedLine", "triangleUp", "triangleDown", "bubble", "none". | |
| reversedOrder | Boolean | Specifies whether legend entries should be placed in reversed order. | |
| rollOverColor | String | Legend item text color on roll-over. | |
| rollOverGraphAlpha | Number | 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 property specifies the opacity of the graphs. | |
| switchable | Boolean | Whether showing/hiding of graphs by clicking on the legend marker is enabled or not. | |
| switchColor | String | Legend switch color. | |
| switchType | String | Legend switch type (in case the legend is switchable). Possible values are: "x" and "v". | |
| textClickEnabled | Boolean | false | Specifies whether the legend text is clickable or not. Clicking on legend text can show/hide value balloons if they are enabled. |
| useMarkerColorForLabels | Boolean | Specifies if legend labels should be use same color as corresponding markers. | |
| valueTextComparing | String | The text which will be displayed in the value portion of the legend when graph is comparable and at least one dataSet is selected for comparing. You can use tags like [[value]], [[open]], [[high]], [[low]], [[close]], [[percents]], [[description]]. | |
| valueTextRegular | String | 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 | Width of the value text. Increase this value if your values do not fit in the allocated space. | |
| verticalGap | Number | Vertical space between legend items, in pixels. |