com.amcharts.stock.StockLegend

Public Properties

	Property		Defined by
		adjustWidth : Boolean If adjustWidth is true, the legend will srink so that it would take only space needed for all the entries.	AmLegend
		dataProvider : AmChart Data provider of the legend is the chart object.	AmLegend
		labelText : String The text which will be displayed in the legend.	AmLegend
		numberFormatter : NumberFormatter An instance of mx.formatters.NumberFormatter.	AmLegend
		percentFormatter : NumberFormatter An instance of mx.formatters.NumberFormatter.	AmLegend
		textClickEnabled : Boolean Specifies whether the legend text is clickable or not.	AmLegend
		useMarkerColorForLabels : Boolean Specifies if legend labels should be use same color as corresponding markers.	AmLegend
		usePositiveNegativeOnPercentsOnly : Boolean If positiveValueColor and negativeValueColor styles are defined, legend value changes it's color depending on the value.	AmLegend
		valueFunction : Function You can set custom function which will format your value text using this property	AmLegend
		valueText : String The text which will be displayed in the value portion of the legend.	AmLegend
		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.	StockLegend
		valueTextRegular : String The text which will be displayed in the value portion of the legend.	StockLegend

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		StockLegend()	StockLegend
		setActualSize(w:Number, h:Number):void	AmLegend

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
clickLabel	Dispatched when user clicks on a legend item label.	AmLegend
clickMarker	Dispatched when user clicks on a legend item marker (and the switchable is set to "false").	AmLegend
hideItem	Dispatched when user clicks on a legend item marker and hides corresponding object.	AmLegend
rollOutItem	Dispatched when user rolls-out of the legend item label (or whole item, if switchable is set to false).	AmLegend
rollOutMarker	Dispatched when user rolls-out of the legend item marker.	AmLegend
rollOverItem	Dispatched when user rolls-over the legend item label (or whole item, if switchable is set to false).	AmLegend
rollOverMarker	Dispatched when user rolls-over the legend item marker.	AmLegend
showItem	Dispatched when user clicks on a legend item marker and shows corresponding object.	AmLegend

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined by
align	Type: String CSS Inheritance: no Alignment of legend entries.	AmLegend
backgroundAlpha	Type: Number CSS Inheritance: no Background opacity.	AmLegend
backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color.	AmLegend
borderAlpha	Type: Number CSS Inheritance: no Border opacity.	AmLegend
borderColor	Type: uint Format: Color CSS Inheritance: no Border color.	AmLegend
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label.	AmLegend
disabledColor	Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled.	AmLegend
fontAntiAliasType	Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields.	AmLegend
fontFamily	Type: String CSS Inheritance: yes Name of the font to use.	AmLegend
fontGridFitType	Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls.	AmLegend
fontSharpness	Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls.	AmLegend
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels.	AmLegend
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font.	AmLegend
fontThickness	Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls.	AmLegend
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface.	AmLegend
horizontalGap	Type: Number CSS Inheritance: no Horizontal space between legend items, in pixels.	AmLegend
kerning	Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`).	AmLegend
letterSpacing	Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character.	AmLegend
marginBottom	Type: Number CSS Inheritance: no Space below the last row of the legend, in pixels.	AmLegend
marginLeft	Type: Number CSS Inheritance: no Space on the left from the first column of the legend.	AmLegend
marginRight	Type: Number CSS Inheritance: no Space on the right from the last column of the legend.	AmLegend
marginTop	Type: Number CSS Inheritance: no Space above the first row of the legend, in pixels.	AmLegend
markerBorderColor	Type: uint Format: Color CSS Inheritance: no Marker border color.	AmLegend
markerBorderThickness	Type: Number CSS Inheritance: no Thickness of the legend border.	AmLegend
markerDisabledColor	Type: uint Format: Color CSS Inheritance: no The color of the disabled marker (when the graph is hidden).	AmLegend
markerLabelGap	Type: Number CSS Inheritance: no Space between legend marker and legend text, in pixels.	AmLegend
markerSize	Type: Number CSS Inheritance: no Size of the legend marker (key).	AmLegend
markerType	Type: String CSS Inheritance: no Shape of the legend marker (key).	AmLegend
maxColumns	Type: Number CSS Inheritance: no Maximum number of columns in the legend.	AmLegend
negativeValueColor	Type: uint Format: Color CSS Inheritance: no Value text color if value is negative.	AmLegend
positiveValueColor	Type: uint Format: Color CSS Inheritance: no Value text color if value is positive.	AmLegend
reversedOrder	Type: Boolean CSS Inheritance: no Specifies whether legend entries should be placed in reversed order.	AmLegend
rollOverColor	Type: uint Format: Color CSS Inheritance: yes Legend item text color on roll-over.	AmLegend
rollOverGraphAlpha	Type: Number CSS Inheritance: no When you roll-over the legend entry, all other graphs can reduce their opacity, so that the graph you rolled-over would be distinguished.	AmLegend
switchable	Type: Boolean CSS Inheritance: no Whether showing/hiding of graphs by clicking on the legend marker is enabled or not.	AmLegend
switchColor	Type: uint Format: Color CSS Inheritance: no legend switch color.	AmLegend
switchType	Type: String CSS Inheritance: no legend switch type (in case the legend is switchable).	AmLegend
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container.	AmLegend
textDecoration	Type: String CSS Inheritance: yes Determines whether the text is underlined.	AmLegend
textIndent	Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels.	AmLegend
valueAlign	Type: String CSS Inheritance: no Alignment of the value text.	AmLegend
valueWidth	Type: Number CSS Inheritance: no Width of the value text.	AmLegend
verticalGap	Type: Number CSS Inheritance: no Vertical space between legend items, in pixels.	AmLegend

Property detail

valueTextComparing

property

valueTextComparing:String [read-write]

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

Implementation
public function get valueTextComparing():String
public function set valueTextComparing(value:String):void

valueTextRegular

property

valueTextRegular:String [read-write]

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

The default value is [[percents]]%.

Implementation
public function get valueTextRegular():String
public function set valueTextRegular(value:String):void

Constructor detail

StockLegend

()

constructor

public function StockLegend()

amStock Flex component documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class StockLegend	Properties \| Methods \| Events \| Styles

Package	com.amcharts.stock
Class	public class StockLegend
Inheritance	StockLegend AmLegend mx.core.UIComponent