Class Index | File Index

Classes


Class Legend

Displays a list of chart series data
Defined in: <..\..\src\teechart.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Legend(chart)
Method Summary
Method Attributes Method Name and Description
 
 
 
drawSeries(index, order)
 
 
 
itemText(series, index)
 
 
 
Class Detail
Legend(chart)
Parameters:
{Tee.Chart} chart
The parent chart this legend object belongs to.
Method Detail
{Number} availRows()
Returns:
{Number} Returns the maximum number of vertical rows using the available height.

{Number} calcPadding()
Returns:
{Number} Returns the distance in pixels between legend and chart bounds.

{Boolean} drawSeries(index, order)
Parameters:
index
order
Returns:
{Boolean} Returns if index'th series is visible and has been displayed at legend.

{Boolean} isVertical()
Returns:
{Boolean} Returns if legend orientation is vertical.

{Number} itemsCount()
Returns:
{Number} Returns the number of legend items that should be displayed.

{String} itemText(series, index)
Parameters:
series
index
Returns:
{String} Returns the index'th legend text string.

{Number} largestItemWidth()
Returns:
{Number} Returns the maximum width in pixels of all legend items text.

{Boolean} showValues()
Returns:
{Boolean} Returns if legend shows series titles or a series values.

{Number} totalWidth()
Returns:
{Number} Returns the width in pixels of legend items, including text and symbols if visible.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Feb 29 2012 19:36:56 GMT+0100 (CET)