| Package | com.amcharts.stock |
| Class | public class LegendSettings |
| Inheritance | LegendSettings  flash.events.EventDispatcher |
If a property has no default value and it is not defined, default styles and properties of StockLegend will be used.
You can set legend-specific properties and styles directly on StockLegend only if a property doesn't have default value. Note, property set here is of a higher priority.
| Property | Defined by | ||
|---|---|---|---|
| align : String
Alignment of legend entries.
| LegendSettings | ||
| horizontalGap : Number
Horizontal space between legend items, in pixels.
| LegendSettings | ||
| labelText : String
The text which will be displayed in the legend.
| LegendSettings | ||
| marginBottom : Number
Space below the last row of the legend, in pixels.
| LegendSettings | ||
| marginTop : Number
Space above the first row of the legend, in pixels.
| LegendSettings | ||
| markerBorderColor : Number
Marker border color.
| LegendSettings | ||
| markerBorderThickness : Number
Thickness of the legend border.
| LegendSettings | ||
| markerDisabledColor : Number
The color of the disabled marker (when the graph is hidden).
| LegendSettings | ||
| markerLabelGap : Number
Space between legend marker and legend text, in pixels.
| LegendSettings | ||
| markerSize : Number
Size of the legend marker (key).
| LegendSettings | ||
| markerType : String
Shape of the legend marker (key).
| LegendSettings | ||
| negativeValueColor : Number
Color of negative values.
| LegendSettings | ||
| numberFormatter : NumberFormatter
An instance of mx.formatters.NumberFormatter.
| LegendSettings | ||
| percentFormatter : NumberFormatter
An instance of mx.formatters.NumberFormatter.
| LegendSettings | ||
| positiveValueColor : Number
Color of positive values.
| LegendSettings | ||
| reversedOrder : Number
Specifies whether legend entries should be placed in reversed order.
| LegendSettings | ||
| rollOverColor : Number
Legend item text color on roll-over.
| LegendSettings | ||
| 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.
| LegendSettings | ||
| switchable : Boolean
Whether showing/hiding of graphs by clicking on the legend marker is enabled or not.
| LegendSettings | ||
| switchColor : Number
Legend switch color.
| LegendSettings | ||
| switchType : String
Legend switch type (in case the legend is switchable).
| LegendSettings | ||
| textClickEnabled : Boolean
Specifies whether the legend text is clickable or not.
| LegendSettings | ||
| useKeyColorForLabels : Boolean
Specifies if legend labels should be use same color as corresponding keys.
| LegendSettings | ||
| usePositiveNegativeOnPercentsOnly : Boolean
Specifies if positiveValueColor and negativeValueColor should only be applied for percent values.
| LegendSettings | ||
| valueAlign : String
Alignment of the value text.
| LegendSettings | ||
| 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.
| LegendSettings | ||
| valueTextRegular : String
The text which will be displayed in the value portion of the legend.
| LegendSettings | ||
| valueWidth : Number
Width of the value text.
| LegendSettings | ||
| verticalGap : Number
Vertical space between legend items, in pixels.
| LegendSettings | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| LegendSettings | ||
| align | property |
align:String [read-write]Alignment of legend entries.
Implementation public function get align():String
public function set align(value:String):void
| horizontalGap | property |
horizontalGap:Number [read-write]Horizontal space between legend items, in pixels.
Implementation public function get horizontalGap():Number
public function set horizontalGap(value:Number):void
| labelText | property |
labelText:String [read-write]The text which will be displayed in the legend. Tag [[title]] will be replaced with the title of the graph.
Implementation public function get labelText():String
public function set labelText(value:String):void
| marginBottom | property |
marginBottom:Number [read-write]Space below the last row of the legend, in pixels.
The default value is 0.
public function get marginBottom():Number
public function set marginBottom(value:Number):void
| marginTop | property |
marginTop:Number [read-write]Space above the first row of the legend, in pixels.
The default value is 0.
public function get marginTop():Number
public function set marginTop(value:Number):void
| markerBorderColor | property |
markerBorderColor:Number [read-write]Marker border color.
Implementation public function get markerBorderColor():Number
public function set markerBorderColor(value:Number):void
| markerBorderThickness | property |
markerBorderThickness:Number [read-write]Thickness of the legend border.
Implementation public function get markerBorderThickness():Number
public function set markerBorderThickness(value:Number):void
| markerDisabledColor | property |
markerDisabledColor:Number [read-write]The color of the disabled marker (when the graph is hidden).
Implementation public function get markerDisabledColor():Number
public function set markerDisabledColor(value:Number):void
| markerLabelGap | property |
markerLabelGap:Number [read-write]Space between legend marker and legend text, in pixels.
Implementation public function get markerLabelGap():Number
public function set markerLabelGap(value:Number):void
| markerSize | property |
markerSize:Number [read-write]Size of the legend marker (key).
Implementation public function get markerSize():Number
public function set markerSize(value:Number):void
| markerType | property |
markerType:String [read-write]Shape of the legend marker (key).
Implementation public function get markerType():String
public function set markerType(value:String):void
| negativeValueColor | property |
negativeValueColor:Number [read-write]Color of negative values.
The default value is 0xCC0000.
public function get negativeValueColor():Number
public function set negativeValueColor(value:Number):void
| numberFormatter | property |
numberFormatter:NumberFormatter [read-write]An instance of mx.formatters.NumberFormatter. The control use this class to format the numbers.
Implementation public function get numberFormatter():NumberFormatter
public function set numberFormatter(value:NumberFormatter):void
| percentFormatter | property |
percentFormatter:NumberFormatter [read-write]An instance of mx.formatters.NumberFormatter. The control use this class to format the percent numbers.
Implementation public function get percentFormatter():NumberFormatter
public function set percentFormatter(value:NumberFormatter):void
| positiveValueColor | property |
positiveValueColor:Number [read-write]Color of positive values.
The default value is 0x00CC00.
public function get positiveValueColor():Number
public function set positiveValueColor(value:Number):void
| reversedOrder | property |
reversedOrder:Number [read-write]Specifies whether legend entries should be placed in reversed order.
Implementation public function get reversedOrder():Number
public function set reversedOrder(value:Number):void
| rollOverColor | property |
rollOverColor:Number [read-write]Legend item text color on roll-over.
Implementation public function get rollOverColor():Number
public function set rollOverColor(value:Number):void
| rollOverGraphAlpha | property |
rollOverGraphAlpha:Number [read-write]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.
Implementation public function get rollOverGraphAlpha():Number
public function set rollOverGraphAlpha(value:Number):void
| switchable | property |
switchable:Boolean [read-write]Whether showing/hiding of graphs by clicking on the legend marker is enabled or not.
Implementation public function get switchable():Boolean
public function set switchable(value:Boolean):void
| switchColor | property |
switchColor:Number [read-write]Legend switch color.
Implementation public function get switchColor():Number
public function set switchColor(value:Number):void
| switchType | property |
switchType:String [read-write]Legend switch type (in case the legend is switchable).
Implementation public function get switchType():String
public function set switchType(value:String):void
| textClickEnabled | property |
textClickEnabled:Boolean [read-write]Specifies whether the legend text is clickable or not. Clicking on legend text can show/hide value balloons if they are enabled.
Implementation public function get textClickEnabled():Boolean
public function set textClickEnabled(value:Boolean):void
| useKeyColorForLabels | property |
useKeyColorForLabels:Boolean [read-write]Specifies if legend labels should be use same color as corresponding keys.
Implementation public function get useKeyColorForLabels():Boolean
public function set useKeyColorForLabels(value:Boolean):void
| usePositiveNegativeOnPercentsOnly | property |
usePositiveNegativeOnPercentsOnly:Boolean [read-write]Specifies if positiveValueColor and negativeValueColor should only be applied for percent values.
The default value is true.
public function get usePositiveNegativeOnPercentsOnly():Boolean
public function set usePositiveNegativeOnPercentsOnly(value:Boolean):void
| valueAlign | property |
valueAlign:String [read-write]Alignment of the value text.
Implementation public function get valueAlign():String
public function set valueAlign(value:String):void
| 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]].
Implementation public function get valueTextRegular():String
public function set valueTextRegular(value:String):void
| valueWidth | property |
valueWidth:Number [read-write]Width of the value text. Increase this value if your values do not fit in the allocated space.
Implementation public function get valueWidth():Number
public function set valueWidth(value:Number):void
| verticalGap | property |
verticalGap:Number [read-write]Vertical space between legend items, in pixels.
Implementation public function get verticalGap():Number
public function set verticalGap(value:Number):void
| LegendSettings | () | constructor |
public function LegendSettings()Constructor.