Important version information!

You are browsing a class reference for Version 2 of the JavaScript Charts. If you are using Version 3 (current), please click here.

LegendSettings

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.

Properties

PropertyTypeDefaultDescription
alignString Alignment of legend entries. Possible values are: "left", "right" and "center".
equalWidthsBooleanfalseSpecifies if each legend entry should take the same space as the longest legend entry.
horizontalGapNumber Horizontal space between legend item and left/right border.
labelTextString The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph.
marginBottomNumber0Space below the last row of the legend, in pixels.
marginTopNumber0Space above the first row of the legend, in pixels.
markerBorderAlphaNumber Opacity of marker border.
markerBorderColorString Marker border color.
markerBorderThicknessNumber Thickness of the legend border.
markerDisabledColorString The color of the disabled marker (when the graph is hidden).
markerLabelGapNumber Space between legend marker and legend text, in pixels.
markerSizeNumber Size of the legend marker (key).
markerTypeString Shape of the legend marker (key). Possible values are: "square", "circle", "line", "dashedLine", "triangleUp", "triangleDown", "bubble", "none".
reversedOrderBoolean Specifies whether legend entries should be placed in reversed order.
rollOverColorString Legend item text color on roll-over.
rollOverGraphAlphaNumber 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.
switchableBoolean Whether showing/hiding of graphs by clicking on the legend marker is enabled or not.
switchColorString Legend switch color.
switchTypeString Legend switch type (in case the legend is switchable). Possible values are: "x" and "v".
textClickEnabledBooleanfalseSpecifies whether the legend text is clickable or not. Clicking on legend text can show/hide value balloons if they are enabled.
useMarkerColorForLabelsBoolean Specifies if legend labels should be use same color as corresponding markers.
valueTextComparingString 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]].
valueTextRegularString 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]].
valueWidthNumber Width of the value text. Increase this value if your values do not fit in the allocated space.
verticalGapNumber Vertical space between legend items, in pixels.

Methods

LegendSettings class does not have any methods.

Events

LegendSettings class does not have any events.