Class 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.

Index

Properties

Properties

public align: string

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

public equalWidths: boolean

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

public horizontalGap: number

Horizontal space between legend item and left/right border.

public labelText: string

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

public marginBottom: number

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

public marginTop: number

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

public markerBorderAlpha: number

Opacity of marker border.

public markerBorderColor: string

Marker border color.

public markerBorderThickness: number

Thickness of the legend border.

public markerDisabledColor: string

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

public markerLabelGap: number

Space between legend marker and legend text, in pixels.

public markerSize: number

Size of the legend marker (key).

public markerType: string

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

public reversedOrder: boolean

Specifies whether legend entries should be placed in reversed order.

public rollOverColor: string

Legend item text color on roll-over.

public 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.

public switchColor: string

Legend switch color.

public switchType: string

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

public switchable: boolean

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

public textClickEnabled: boolean

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

public useMarkerColorForLabels: boolean

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

public 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.

public 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.

public valueWidth: number

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

public verticalGap: number

Vertical space between legend items, in pixels.