Name

legend — a legend for a chart

Synopsis

LZX: legend
JavaScript: legend
Type: Class
Access: public
Topic: Charting And Graphing.Common
Declared in: lps/components/charts/common/legend.lzx

Description

[Warning] Warning
This component is of Beta quality and is subject to change.
simple legend class

Superclass Chain

legend

Known Subclasses

Details

Properties (12)

borderColor
<attribute name="borderColor" type="color" value="0x000000" />
public var borderColor : color;
Allow to set the color line from the legend tag
borderWidth
<attribute name="borderWidth" type="number" value="1" />
public var borderWidth : Number;
Allow to set the line width from the legend tag
chart
<attribute name="chart" type="expression" value="${null}" />
public var chart : Object;
Takes the relationship with the chart
chartClassName
<attribute name="chartClassName" type="string" value="${null}" />
public var chartClassName : String;
direction
<attribute name="direction" type="string" value="vertical" />
public var direction : String;
Indicates how the legend items will be displayed, default: vertical
fillColor
<attribute name="fillColor" type="color" value="0xFFFFFF" />
public var fillColor : color;
Allow to set the fill color from the legend tag
legendborder
<attribute name="legendborder" type="boolean" value="true" />
public var legendborder : Boolean;
Indicates if legend box will have a border, default: true
legendFont
<attribute name="legendFont" type="string" value="serif" />
public var legendFont : String;
Indicates the Font will be used in the legend item text
legendFontcolor
<attribute name="legendFontcolor" type="color" value="0x000000" />
public var legendFontcolor : color;
Indicates the Font color wiil be used in the legend item text, default: black
legendFontsize
<attribute name="legendFontsize" type="size" value="10" />
public var legendFontsize : size;
Indicates the Font size wiil be used in the legend item text, default: 10px
position
<attribute name="position" type="string" value="right" />
public var position : String;
Indicates where the legend box will be positioned, default: right
styleBorder
<attribute name="styleBorder" type="string" value="null" />
public var styleBorder : String;
Indicates the style will be applied tho the border legend box

LZX Synopsis

<class name="legend">
  <attribute name=" borderColor " type="color" value="0x000000" />
  <attribute name=" borderWidth " type="number" value="1" />
  <attribute name=" chart " type="expression" value="${null}" />
  <attribute name=" chartClassName " type="string" value="${null}" />
  <attribute name=" direction " type="string" value="vertical" />
  <attribute name=" fillColor " type="color" value="0xFFFFFF" />
  <attribute name=" legendborder " type="boolean" value="true" />
  <attribute name=" legendFont " type="string" value="serif" />
  <attribute name=" legendFontcolor " type="color" value="0x000000" />
  <attribute name=" legendFontsize " type="size" value="10" />
  <attribute name=" position " type="string" value="right" />
  <attribute name=" styleBorder " type="string" value="null" />
</class>

JavaScript Synopsis

public legend {
  public var borderColor  : color;
  public var borderWidth  : Number;
  public var chart  : Object;
  public var chartClassName  : String;
  public var direction  : String;
  public var fillColor  : color;
  public var legendborder  : Boolean;
  public var legendFont  : String;
  public var legendFontcolor  : color;
  public var legendFontsize  : size;
  public var position  : String;
  public var styleBorder  : String;
}