LegendSettings

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.

Sources

This information about LegendSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

LegendSettings does not extend any other symbol.

LegendSettings is not extended by any other symbol.

Properties

#align

Type stringDefault

Alignment of legend entries. Possible values are: "left", "right" and "center".

#equalWidths

Type booleanDefault false

Specifies if each legend entry should take the same space as the longest legend entry.

#horizontalGap

Type numberDefault

Horizontal space between legend item and left/right border.

#labelText

Type stringDefault

The text which will be displayed in the legend. Tag title will be replaced with the title of the graph.

#marginBottom

Type numberDefault 0

Space below the last row of the legend, in pixels.

#marginTop

Type numberDefault 0

Space above the first row of the legend, in pixels.

#markerBorderAlpha

Type numberDefault

Opacity of marker border.

#markerBorderColor

Type stringDefault

Marker border color.

#markerBorderThickness

Type numberDefault

Thickness of the legend border.

#markerDisabledColor

Type stringDefault

The color of the disabled marker (when the graph is hidden).

#markerLabelGap

Type numberDefault

Space between legend marker and legend text, in pixels.

#markerSize

Type numberDefault

Size of the legend marker (key).

#markerType

Type stringDefault

Shape of the legend marker (key). Possible values are: "square", "circle", "line", "dashedLine", "triangleUp", "triangleDown", "bubble", "none".

#reversedOrder

Type booleanDefault

Specifies whether legend entries should be placed in reversed order.

#rollOverColor

Type stringDefault

Legend item text color on roll-over.

#rollOverGraphAlpha

Type numberDefault

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 booleanDefault

Whether showing/hiding of graphs by clicking on the legend marker is enabled or not.

#switchColor

Type stringDefault

Legend switch color.

#switchType

Type stringDefault

Legend switch type (in case the legend is switchable). Possible values are: "x" and "v".

#textClickEnabled

Type booleanDefault false

Specifies whether the legend text is clickable or not. Clicking on legend text can show/hide value balloons if they are enabled.

#useMarkerColorForLabels

Type booleanDefault

Specifies if legend labels should be use same color as corresponding markers.

#valueTextComparing

Type stringDefault

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 stringDefault

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 numberDefault

Width of the value text. Increase this value if your values do not fit in the allocated space.

#verticalGap

Type numberDefault

Vertical space between legend items, in pixels.

Methods

LegendSettings does not have any methods.

Events

LegendSettings does not have any events.