Type class
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.
Inheritance
LegendSettings does not extend any other symbol.
LegendSettings is not extended by any other symbol.
Properties
align # |
Type Alignment of legend entries. Possible values are: "left", "right" and "center". |
---|---|
equalWidths # |
Type Default Specifies if each legend entry should take the same space as the longest legend entry. |
horizontalGap # |
Type Horizontal space between legend item and left/right border. |
labelText # |
Type The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph. |
marginBottom # |
Type Default Space below the last row of the legend, in pixels. |
marginTop # |
Type Default Space above the first row of the legend, in pixels. |
markerBorderAlpha # |
Type Opacity of marker border. |
markerBorderColor # |
Type Marker border color. |
markerBorderThickness # |
Type Thickness of the legend border. |
markerDisabledColor # |
Type The color of the disabled marker (when the graph is hidden). |
markerLabelGap # |
Type Space between legend marker and legend text, in pixels. |
markerSize # |
Type Size of the legend marker (key). |
markerType # |
Type Shape of the legend marker (key). Possible values are: square, circle, diamond, triangleUp, triangleDown, triangleLeft, triangleDown, bubble, none |
position # |
Type Position of legend in panels. Possible values are: "bottom" and "top". |
reversedOrder # |
Type Specifies whether legend entries should be placed in reversed order. |
rollOverColor # |
Type Legend item text color on roll-over. |
rollOverGraphAlpha # |
Type 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 # |
Type Whether showing/hiding of graphs by clicking on the legend marker is enabled or not. |
switchColor # |
Type Legend switch color. |
switchType # |
Type Legend switch type (in case the legend is switchable). Possible values are: "x" and "v". |
textClickEnabled # |
Type Default Specifies whether the legend text is clickable or not. Clicking on legend text can show/hide value balloons if they are enabled. |
useMarkerColorForLabels # |
Type Specifies if legend labels should be use same color as corresponding markers. |
valueTextComparing # |
Type 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 # |
Type 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 # |
Type Width of the value text. Increase this value if your values do not fit in the allocated space. |
verticalGap # |
Type Vertical space between legend items, in pixels. |
Methods
LegendSettings does not have any methods.
Events
LegendSettings does not have any events.
Adapters
LegendSettings does not have any adapters.