<CHART> : Chart component

Java class : leon.info.LyChartInfo

ROLE

This element defines parameters to draw a chart to display data graphically. This meta-model part can be built either manually or by filling the three parameter windows of _chart action.

ATTRIBUTES

<!ATTLIST CHART
	  id ID #REQUIRED
	  name CDATA #IMPLIED
	  classInfoId CDATA #IMPLIED
	  xField CDATA #IMPLIED
	  groupField CDATA #IMPLIED
	  typeVarY ( TEXT | NUMBER | DATE) "TEXT"
	  typeVarX ( TEXT | NUMBER | DATE) "TEXT"
	  graphType ( STACK_BAR | BAR | PIE | SCATTER_PLOT | PLOT | STACK_AREA) "STACK_BAR"
	  xVal ( REAL | INTERVAL) "REAL"
	  yVal ( REAL | SUM_REAL | COUNT_INTERVAL | COUNT_REAL) "REAL"
	  xIntsBegin CDATA #IMPLIED
	  xIntsLength CDATA #IMPLIED
	  xIntsUnit CDATA #IMPLIED
	  yIntsBegin CDATA #IMPLIED
	  yIntsLength CDATA #IMPLIED
	  yIntsUnit CDATA #IMPLIED
	  pieBy ( true | false) "false"
	  title CDATA #IMPLIED
	  xTitle CDATA #IMPLIED
	  yTitle CDATA #IMPLIED
	  xAxisMin CDATA #IMPLIED
	  xAxisMax CDATA #IMPLIED
	  xAxisWidth CDATA #IMPLIED
	  yAxisMin CDATA #IMPLIED
	  yAxisMax CDATA #IMPLIED
	  yAxisWidth CDATA #IMPLIED
	  xVerticalLabels ( true | false) "false"
	  xGrid ( true | false) "true"
	  yGrid ( true | false) "true"
	  d3Effect ( true | false) "true"
	  showLegend ( true | false) "true"
	  showTips ( true | false) "false"
	  ratios ( true | false) "false">
Attribute Mand. Description Default
id yes Identifier of chart element.  
name no Name chosen when saving the chart.  
classInfoId no Identifier of the LyClassInfo corresponding to the chart. This attribute is filled when saving the chart and it is read when loading it. It is not required because it is useless for charts defined in meta-models, and not in XML files (because there is a classInfo parameter in _chart and _graphicalChart actions).  
xField no Identifier of the field in function of which the chart will be drawn.  
groupField no Identifier of the field used to group results on a given xField.  
typeVarY no Permits to define Y type of variables in a large sense: text, numeric, date. If more than one variable are studied, they have to belong to the same type. NUMBER: numeric values. TEXT: strings. DATE: dates. The default type is TEXT. TEXT
typeVarX no Permits to define X type of variable in a large sense: text, numeric, date. NUMBER: numeric values.TEXT: strings.DATE: dates. The default type is TEXT. TEXT
graphType no Chart Type chosen to display data. Chart Type supported are these ones : PIE  SCATTER_PLOT : unconnected points. PLOT : points connected by lines. STACK_AREA : connected points, filled below the points. Places each Y-series on top of the last to show the area relationships between each series and the total. BAR : bars in clusters. STACK_BAR : Stacking bars. The default selected type is STACK_BAR. STACK_BAR
xVal no Choice if the values of the selected X variable have to be: REAL: Let unchanged INTERVAL : Grouped by intervals (if numeric or date) The default selection is REAL. REAL
yVal no Choice if the values of the selected X variable have to be: REAL: Let unchanged SUM_REAL : Summed (if numeric) COUNT_INTERVAL : Counted after being grouped by intervals (if numeric or date) COUNT_REAL : Counted for each Y value The default selection is REAL. REAL
xIntsBegin no Bound of any X interval.  
xIntsLength no Length of X intervals.  
xIntsUnit no Time unit for X intervals, if its type is date (YEARS, MONTHS, DAYS, HOURS, MINS, SECS).  
yIntsBegin no Bound of any interval of the studied variables.  
yIntsLength no Length of studied variables' intervals.  
yIntsUnit no Time unit for studied variables' intervals, if their type is date (YEARS, MONTHS, DAYS, HOURS, MINS, SECS).  
pieBy no Indicate if pies have to correspond to the variables to analyse or to the « function of » variables. By default there is one pie by variable to analyse. false
title no Permits to define the title (string) which will be showed in the chart window.  
xTitle no Permits to define a title (string) which will be showed on the horizontal axis.  
yTitle no Permits to define a title (string) which will be showed on the vertical axis.  
xAxisMin no Minimum value on the horizontal axis.  
xAxisMax no Maximum value on the horizontal axis.  
xAxisWidth no Horizontal Axis Increment  
yAxisMin no Minimum value on the vertical axis.  
yAxisMax no Maximum value on the vertical axis.  
yAxisWidth no Vertical Axis Increment  
xVerticalLabels no Permits to write horizontal axis labels vertically. It is used when labels are longs (only when the type of chart is not PIE). false
xGrid no Permits to draw vertical lines corresponding to horizontal axis gradation (only when the type of chart is not PIE). true
yGrid no Permits to draw horizontal lines corresponding to vertical axis gradation (only when the type of chart is not PIE). true
d3Effect no Permits to draw the chart with a 3D effect (only when the type of chart is PIE, BAR or STACK_BAR). true
showLegend no Permits to draw the legend true
showTips no If this attribute is set to true, all the tips of the points are visible. Else they are visible only when the mouse is over the points, if the viewer supports it (for example it doesn't work in web) false
ratios no Permits to calculate percentiles. By default they aren't calculated. false

ELEMENTS

<!ELEMENT CHART 
	  (YFIELD+,
	   PREFERENCE?)>
Element Mand. Mult. Description
YFIELD yes yes Attributes that are studied in the chart.
PREFERENCE no no Preference used to organize objects before when creating the chart.

SAMPLE

<CHART id="_chartId" graphType="STACK_BAR" xField="liv_date"
		typeVarX="DATE" typeVarY="NUMBER" yVal="COUNT_INTERVAL" 
		xVal="INTERVAL" yIntsBegin="4" yIntsLength="30"  
		xIntsBegin="01/01/2001 14:00:00" xIntsLength="10" xIntsUnit="2"
	xVerticalLabels='true'>
	<YFIELD value='liv_price_min'/>
	<YFIELD value='liv_price_max'/>
</CHART>