Name

chart — a simple chart

Synopsis

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

Description

[Warning] Warning
This component is of Beta quality and is subject to change.
chart is the base class representing a chart. In general, this class is not instantiated directly. A chart contains at least one dataseries element at least one axis element The chart needs to look at its dataseries children and pass the relevant dataseries to each axis. Relevent dataseries for the chart must have columns for each of the axes that the chart cares about.

Superclass Chain

node (LzNode) » view (LzView) » basecomponent » chart

Known Subclasses

Known Direct Subclasses: piechart, rectangularchart

Details

Properties (19)

bottomMargin
<attribute name="bottomMargin" type="number" value="10" />
public var bottomMargin : Number;
The blank space bordering the bottom of the chart area.
databorderEnabled
<attribute name="databorderEnabled" type="boolean" value="true" />
public var databorderEnabled : Boolean;
datalabelColumn
<attribute name="datalabelColumn" type="string" value="" />
public var datalabelColumn : String;
data column name of the data label
datalabelEnabled
<attribute name="datalabelEnabled" type="boolean" value="false" />
public var datalabelEnabled : Boolean;
enable data label
dataPointsEnabled
<attribute name="dataPointsEnabled" type="boolean" value="false" />
public var dataPointsEnabled : Boolean;
enable data point(data marker)
datatipColumn
<attribute name="datatipColumn" type="string" value="" />
public var datatipColumn : String;
data column name of the tooltip
datatipEnabled
<attribute name="datatipEnabled" type="boolean" value="false" />
public var datatipEnabled : Boolean;
enable tooltip for data
defaultRightMargin
<attribute name="defaultRightMargin" type="number" value="10" />
public var defaultRightMargin : Number;
The default blank space bordering the right side of the chart area.
defaultstyle
<attribute name="defaultstyle" type="expression" value="${defaultchartstyle}" />
public var defaultstyle : Object;
The default style to be applied to the chart.
horizontalGap
<attribute name="horizontalGap" type="number" value="5" />
public var horizontalGap : Number;
The horizontal blank space between components.
initdone
<attribute name="initdone" type="boolean" value="false" />
public var initdone : Boolean;
subview have
leftMargin
<attribute name="leftMargin" type="number" value="10" />
public var leftMargin : Number;
The blank space bordering the left side of the chart area.
rightMargin
<attribute name="rightMargin" type="number" value="10" />
public var rightMargin : Number;
The blank space bordering the right side of the chart area.
topMargin
<attribute name="topMargin" type="number" value="10" />
public var topMargin : Number;
The blank space bordering the top of the chart area.
valuelinesenabled
<attribute name="valuelinesenabled" type="boolean" value="true" />
public var valuelinesenabled : Boolean;
enable value lines
valuepointsenabled
<attribute name="valuepointsenabled" type="boolean" value="true" />
public var valuepointsenabled : Boolean;
enable value points
valueregionsenabled
<attribute name="valueregionsenabled" type="boolean" value="true" />
public var valueregionsenabled : Boolean;
enable value region
verticalGap
<attribute name="verticalGap" type="number" value="5" />
public var verticalGap : Number;
The vertical blank space between components.
zoomEnabled
<attribute name="zoomEnabled" type="boolean" value="false" />
public var zoomEnabled : Boolean;
enable zoom

Methods (6)

adjustPlotAreaToLayout()
<method name="adjustPlotAreaToLayout" />
public function adjustPlotAreaToLayout();
Adjust the plot area to the dimensions of the chart and other components
getDataSeries()
<method name="getDataSeries" />
public function getDataSeries();
get the dataseries
getNodeOfClass()
<method name="getNodeOfClass" args="className" />
public function getNodeOfClass(className : string);
return a subnode with the class name
getNodesOfClass()
<method name="getNodesOfClass" args="className" />
public function getNodesOfClass(className : string);
return an array of subnodes with the class name
render()
<method name="render" />
public function render();
Method that renders the chart. This method is overridden by class rectangularchart. The class piechart uses it as is.
renderPlotArea()
<method name="renderPlotArea" />
public function renderPlotArea();

LZX Synopsis

<class name="chart" extends=" basecomponent ">
  <attribute name=" bottomMargin " type="number" value="10" />
  <attribute name=" databorderEnabled " type="boolean" value="true" />
  <attribute name=" datalabelColumn " type="string" value="" />
  <attribute name=" datalabelEnabled " type="boolean" value="false" />
  <attribute name=" dataPointsEnabled " type="boolean" value="false" />
  <attribute name=" datatipColumn " type="string" value="" />
  <attribute name=" datatipEnabled " type="boolean" value="false" />
  <attribute name=" defaultRightMargin " type="number" value="10" />
  <attribute name=" defaultstyle " type="expression" value="${defaultchartstyle}" />
  <attribute name=" horizontalGap " type="number" value="5" />
  <attribute name=" initdone " type="boolean" value="false" />
  <attribute name=" leftMargin " type="number" value="10" />
  <attribute name=" rightMargin " type="number" value="10" />
  <attribute name=" topMargin " type="number" value="10" />
  <attribute name=" valuelinesenabled " type="boolean" value="true" />
  <attribute name=" valuepointsenabled " type="boolean" value="true" />
  <attribute name=" valueregionsenabled " type="boolean" value="true" />
  <attribute name=" verticalGap " type="number" value="5" />
  <attribute name=" zoomEnabled " type="boolean" value="false" />
  <method name=" adjustPlotAreaToLayout " />
  <method name=" getDataSeries " />
  <method name=" getNodeOfClass " args="className" />
  <method name=" getNodesOfClass " args="className" />
  <method name=" render " />
  <method name=" renderPlotArea " />
</class>

JavaScript Synopsis

public chart extends  basecomponent  {
  public var bottomMargin  : Number;
  public var databorderEnabled  : Boolean;
  public var datalabelColumn  : String;
  public var datalabelEnabled  : Boolean;
  public var dataPointsEnabled  : Boolean;
  public var datatipColumn  : String;
  public var datatipEnabled  : Boolean;
  public var defaultRightMargin  : Number;
  public var defaultstyle  : Object;
  public var horizontalGap  : Number;
  public var initdone  : Boolean;
  public var leftMargin  : Number;
  public var rightMargin  : Number;
  public var topMargin  : Number;
  public var valuelinesenabled  : Boolean;
  public var valuepointsenabled  : Boolean;
  public var valueregionsenabled  : Boolean;
  public var verticalGap  : Number;
  public var zoomEnabled  : Boolean;
  prototype public function adjustPlotAreaToLayout ();
  prototype public function getDataSeries ();
  prototype public function getNodeOfClass (className : string);
  prototype public function getNodesOfClass (className : string);
  prototype public function render ();
  prototype public function renderPlotArea ();
}