constructor Legend [line 98]
The class constructor.
Tags:
Parameters:
destructor __destruct [line 117]
method addAnimation [line 1518]
void addAnimation(
$animation)
|
|
Parameters:
method calcItemHeight [line 824]
method clicked [line 782]
Returns the index of the clicked Legend Point.
Tags:
Parameters:
method doMouseDown [line 734]
method drawTitle [line 840]
method formattedLegend [line 1539]
String formattedLegend(
seriesOrValueIndex
$seriesOrValueIndex)
|
|
Returns the text string corresponding to a Legend position.
The Legend position depends on Legend.LegendStyle. If LegendStyle is lsSeries, then the text string will be the SeriesOrValueIndexth Active Series Title.
If LegendStyle is lsValues, then the text string will be the formatted SeriesOrValueIndexth value of the first Active Series in the Chart.
If LegendStyle is lsAuto and only one Active Series exists in the Chart, then the LegendStyle is considered to be lsValues.
If there is more than one Active Series then LegendStyle will be lsSeries.
Values are formatted accordingly to LegendTextStyle.
Tags:
Parameters:
method formattedValue [line 1581]
String formattedValue(
aSeries
$aSeries, valueIndex
$valueIndex)
|
|
Returns the corresponding Legend text for the Series ValueIndex point.
Legend.LegendTextStyle is used to properly format the point values and labels.
Tags:
Parameters:
method getAlignment [line 427]
Defines the Legend position.
Legend can be currently placed at Top, Left, Right and Bottom side of Chart.
Left and Right Legend alignments define a vertical Legend with currently one single column of items.
Top and Bottom Legend alignments define an horizontal Legend with currently one single row of items.
The Legend itself automatically reduces the number of displayed legend items based on the available charting space.
The Legend.ResizeChart property controls if Legend dimensions should be used to reduce Chart points space.
The Legend.GetLegendRect event provides a mechanism to supply the desired Rectangle Legend dimensions and placement.
The Legend.GetLegendPos event can be used to specify fixed Legend items X Y coordinates.
The Legend.HorizMargin and VertMargin properties control distance between Legend and Left and Right margins.
The Legend.TopLeftPos property can be used in Left Legend alignments to control vertical distance between Legend and Top Chart Margin.
These techniques allow almost complete Legend control.
Default value: Right
Tags:
method getAnimations [line 1513]
method getCheckBoxes [line 265]
Enables/Disables the display of Legend check boxes.
Default value: false
Tags:
method getColorWidth [line 972]
method getColumnWidth [line 446]
void getColumnWidth(
$column)
|
|
Tags:
Parameters:
method getColumnWidthAuto [line 468]
boolean getColumnWidthAuto(
)
|
|
Automatically calculates best fit of legend columns.
When set to true, columnWidths control the legend width
Default value: true
Tags:
method getCurrentPage [line 295]
boolean getCurrentPage(
)
|
|
Determines whether or not the Legend shows only the current page items when the Chart is divided into pages.
Default value: true
Tags:
method getDividingLines [line 340]
Specifies the Pen attributes used to draw lines separating Legend items.
Lines are drawn horizontally for Left or Right aligned Legend and vertically for Top or Bottom Legend alignments.
Tags:
method getFirstValue [line 496]
Defines which is the first Legend item displayed.
Legend can display all active Series names or all points of a single Series. FirstValue should be set accordingly, taking care not to overflow the number of active Series or the number of Series points. You can use FirstValue to show a specific subset of Series or points in Legend. It should be greater or equal to zero, and lower than the number of active Series or Series points. See Legend.LegendStyle for a description of the different Legend styles.
Default value: 0
Tags:
method getFontSeriesColor [line 318]
boolean getFontSeriesColor(
)
|
|
The legend text font color to that of the Series color.
Default value: false
Tags:
method getHorizMargin [line 612]
Speficies the number of screen pixels between Legend and Chart
rectangles.
By default it is 0, meaning Legend will calculate a predefined margin based on total Legend width. It is only used when Legend position is Left or Right aligned otherwise use VertMargin.
Default value: 0
Tags:
method getInverted [line 386]
Draws the Legend items in opposite direction when true.
Legend strings are displayed starting at top for Left and Right Aligment and starting at left for Top and Bottom Legend orientations. You can use Legend.FirstValue to determine the ValueIndex for the first Legend text item.
Default value: false
Tags:
method getLastValue [line 201]
Returns the index of the first displayed value at legend.
The index can be a series value index or a series index depending on legend style.
Tags:
method getLegendStyle [line 704]
Defines which items will be displayed in the Chart Legend.
Series style shows the Series.Title of all active Series in a Chart.
Whenever a Series Title is empty, Series Name is used.
Values style shows a text representation of all points of the first active Series in a Chart.
LastValues style shows the last point value and the Series.Title of all active Series in a Chart. It is useful for real-time charting, where new points are being added at the end of each Series.
Auto style (the default) means LegendStyle will be Series when there's more than one Active Series, and Values when there's only one Series in a Chart.
Legend.TextStyle determines how the Series point values are formatted.
Default value: auto
Tags:
method getLines [line 556]
method getMaxNumRows [line 541]
The Maximum number of Legend Rows displayed for a horizontal Legend (Chart Top or Bottom).
Default value: 10
Tags:
method getResizeChart [line 661]
boolean getResizeChart(
)
|
|
Automatically resizes Chart rectangle to prevent overlap with Legend.
When set to true, Legend.HorizMargin and Legend.VertMargin control the amount of pixels by which the Chart rectangle will be reduced.
Default value: true
Tags:
method getSeries [line 245]
Determines which series is used as data for the Legend entries.
By default, the Legend chooses the first Active Series with ShowInLegend:=true. It only applies to Legend style "Values".
Tags:
method getSymbol [line 362]
Controls the width and position of the color rectangle associated with each Legend's item.
Tags:
method getText [line 569]
Adds text to the Legend.
Tags:
Overrides
TextShape::getText() (Displays customized strings inside Shapes.
You can use Font and Aligment to control Text display.
Note: You would maybe need to change Shape Font size to a different value when creating metafiles or when zooming Charts.)
method getTextAlign [line 205]
method getTextStyle [line 190]
Determines how Legend text items will be formatted.
Plain shows the point Label only.
LeftValue shows the point Value and the point Label.
RightValue shows the point Label and the point Value.
LeftPercent shows the percent the point represents and the point Label.
RightPercent shows the point Label and the percent the points represent.
XValue shows the point's X value. It applies only to Series with X (horizontal) values.
Values are pre-formatted using the Series ValueFormat property.
Percents are pre-formatted using the Series PercentFormat property.
Default value: LeftValue
Tags:
method getTitle [line 727]
Sets the Title text and its characteristics at the top of the legend
Tags:
method getTopLeftPos [line 520]
Specifies the Legend's top position in percent of total chart height.
It's used when Legend.Alignment is Left or Right only. For Top or Bottom Legend alignments, you can use the Chart's MarginTop and MarginBottom.
Default value: 10
Tags:
method getVertical [line 902]
Is read only and returns true only if the legend is left or right aligned.
Tags:
method getVertMargin [line 638]
The vertical margin in pixels between Legend and Chart
rectangle.
Legend.ResizeChart must be true and Legend.Alignment must be Top or Bottom. When 0, the corresponding Chart margin method is used to determine the amount of pixels for margins (Chart.MarginTop for Top Legend.alignment and Chart.MarginBottom for Bottom Legend.Alignment).
Default value: 0
Tags:
method getVertSpacing [line 588]
The vertical spacing between Legend items (pixels).
Default value: 0
Tags:
method hasCheckBoxes [line 892]
Returns true when the legend displays checkboxes and it is showing series names.
Tags:
method paint [line 1388]
void paint(
[
$gd = null], [
$rect = null])
|
|
Tags:
Overrides
TextShape::paint() (Paints the TextShape object on the Chart Canvas.)
Parameters:
method readResolve [line 164]
method resizeChartRect [line 1329]
Returns the chart rectangle minus the space occupied by the Legend.
Tags:
Parameters:
method setAlignment [line 439]
void setAlignment(
value
$value)
|
|
Defines the Legend position.
Default value: Right
Tags:
Parameters:
method setChart [line 269]
method setCheckBoxes [line 283]
void setCheckBoxes(
value
$value)
|
|
Displays the Legend check boxes when true.
Default value: false
Tags:
Parameters:
method setColorWidth [line 976]
void setColorWidth(
$value)
|
|
Tags:
Parameters:
method setColumnWidth [line 454]
void setColumnWidth(
$column,
$value)
|
|
Tags:
Parameters:
method setColumnWidthAuto [line 479]
void setColumnWidthAuto(
value
$value)
|
|
Automatically calculates best fit of legend columns.
When set to true, columnWidths control the legend width
Default value: true
Tags:
Parameters:
method setCurrentPage [line 308]
void setCurrentPage(
value
$value)
|
|
When true, the Legend shows only the current page items when the Chart is divided into pages.
Default value: true
Tags:
Parameters:
method setDividingLines [line 351]
void setDividingLines(
$value)
|
|
Internal use - serialization
Tags:
Parameters:
method setFirstValue [line 507]
void setFirstValue(
value
$value)
|
|
Determines which is the first Legend item displayed.
Default value: 0
Tags:
Parameters:
method setFontSeriesColor [line 328]
void setFontSeriesColor(
value
$value)
|
|
Sets the legend text font color to that of the Series color.
Default value: false
Tags:
Parameters:
method setHorizMargin [line 623]
void setHorizMargin(
value
$value)
|
|
Speficies the number of screen pixels between Legend and Chart rectangles.
Default value: 0
Tags:
Parameters:
method setInverted [line 397]
void setInverted(
value
$value)
|
|
Draws the Legend items in opposite direction when true.
Default value: false
Tags:
Parameters:
method setLegendStyle [line 716]
void setLegendStyle(
value
$value)
|
|
Defines which items will be displayed in the Chart Legend.
Default value: Auto
Tags:
Parameters:
method setLines [line 560]
method setMaxNumRows [line 552]
void setMaxNumRows(
value
$value)
|
|
Sets the Maximum number of Legend Rows displayed for a horizontal Legend (Chart Top or Bottom).
Default value: 10
Tags:
Parameters:
method setResizeChart [line 673]
void setResizeChart(
value
$value)
|
|
Automatically resizes Chart rectangle to prevent overlap with Legend.
When set to true, Legend.HorizMargin and Legend.VertMargin control the amount of pixels by which the Chart rectangle will be reduced.
Default value: true
Tags:
Parameters:
method setSeries [line 254]
void setSeries(
value
$value)
|
|
Determines which series is used as data for the Legend entries.
Tags:
Parameters:
method setSymbol [line 372]
method setText [line 578]
void setText(
value
$value)
|
|
Adds text to the Legend.
Tags:
Overrides
TextShape::setText() (Displays customized strings inside Shapes.
)
Parameters:
method setTextAlign [line 223]
void setTextAlign(
$value)
|
|
Tags:
Parameters:
method setTextStyle [line 216]
void setTextStyle(
value
$value)
|
|
Specifies how Legend text items will be formatted.
Default value: LeftValue
Tags:
Parameters:
method setTopLeftPos [line 530]
void setTopLeftPos(
value
$value)
|
|
Specifies the Legend's top position in percent of total chart height.
Default value: 10
Tags:
Parameters:
method setVertMargin [line 649]
void setVertMargin(
value
$value)
|
|
Determines the vertical margin in pixels between Legend and Chart rectangle.
Default value: 0
Tags:
Parameters:
method setVertSpacing [line 598]
void setVertSpacing(
value
$value)
|
|
Determines the vertical spacing between Legend items (pixels).
Default value: 0
Tags:
Parameters:
method _clicked [line 771]
Returns the index of the clicked Legend Point.
Tags:
Parameters:
method __get [line 81]
method __set [line 88]