Class: Arrow
Source Location: /styles/Arrow.php
TeeBase
|
--Series
|
--BaseLine
|
--CustomPoint
|
--Points
|
--Arrow
<p>Title: Arrow class</p>
Author(s):
Version:
Copyright:
- (c) 1995-2008 by Steema Software SL. All Rights Reserved. <info@steema.com>
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Methods
constructor Arrow [line 31]
Arrow Arrow(
[
$c = null])
|
|
Tags:
Parameters:
method AddArrow [line 237]
int AddArrow(
x0
$x0, y0
$y0, x1
$x1, y1
$y1, text
$text, color
$color)
|
|
Returns the position of the Arrow in the list. Positions start at zero.
Each arrow is made of 2 points: (X0,Y0) The starting arrow point. (X1,Y1) The arrow head end point. Label (overload option) Color (overload option)
Tags:
Parameters:
method addSampleValues [line 243]
method clicked [line 257]
Tags:
Overrides CustomPoint::clicked() (Returns the ValueIndex of the "clicked" point in the Series.)
Parameters:
method drawValue [line 321]
void drawValue(
valueIndex
$valueIndex)
|
|
Called internally. Draws the "ValueIndex" point of the Series.
Tags:
Overrides CustomPoint::drawValue() (Called internally. Draws the "ValueIndex" point of the Series.)
Parameters:
method getArrowHeight [line 50]
Determines the vertical arrow head size in pixels. It sets the distance from the base of the arrow head to the arrow tip in pixels. It can be used together with ArrowWidth to determine the overall size of the arrow head.
Tags:
method getArrowWidth [line 70]
Determines the horizontal arrow head size in pixels. Default value: 4
Tags:
method getDescription [line 343]
method getEndXValues [line 129]
The X1 values for Arrows. Each Arrow has (X0,Y0) and (X1,Y1) coordinates.
Tags:
method getEndYValues [line 148]
The Y1 values for Arrows. Each Arrow has (X0,Y0) and (X1,Y1) coordinates.
Tags:
method getMaxXValue [line 277]
The Maximum Value of the Series X Values List.
Tags:
Overrides CustomPoint::getMaxXValue() (Returns the Maximum Value of the Series X Values List.)
method getMaxYValue [line 294]
The Maximum Value of the Series Y Values List.
Tags:
Overrides CustomPoint::getMaxYValue() (Returns the Maximum Value of the Series Y Values List.)
method getMinXValue [line 286]
The Minimum Value of the Series X Values List.
Tags:
Overrides CustomPoint::getMinXValue() (Returns the Minimum Value of the Series X Values List.)
method getMinYValue [line 303]
The Minimum Value of the Series Y Values List.
Tags:
Overrides CustomPoint::getMinYValue() (Returns the Minimum Value of the Series Y Values List.)
method getStartXValues [line 91]
The X0 values for Arrows. Each Arrow has (X0,Y0) and (X1,Y1) coordinates. StartXValues.DateTime property default value is true.
Tags:
method getStartYValues [line 110]
The Y0 values for Arrows. Each Arrow has (X0,Y0) and (X1,Y1) coordinates.
Tags:
method setArrowHeight [line 60]
void setArrowHeight(
value
$value)
|
|
Sets the vertical arrow head size in pixels.
Tags:
Parameters:
method setArrowWidth [line 80]
void setArrowWidth(
value
$value)
|
|
Sets the horizontal arrow head size in pixels. Default value: 4
Tags:
Parameters:
method setEndXValues [line 138]
void setEndXValues(
value
$value)
|
|
Sets X1 values for Arrows.
Tags:
Parameters:
method setEndYValues [line 157]
void setEndYValues(
value
$value)
|
|
Sets Y1 values for Arrows.
Tags:
Parameters:
method setStartXValues [line 100]
void setStartXValues(
value
$value)
|
|
Sets X0 values for Arrows.
Tags:
Parameters:
method setStartYValues [line 119]
void setStartYValues(
value
$value)
|
|
Sets Y0 values for Arrows.
Tags:
Parameters:
method _add [line 175]
int _add(
x0
$x0, y0
$y0, x1
$x1, y1
$y1)
|
|
Adds an Arrow with start and end coordinates. Returns the position of the Arrow in the list. Positions start at zero.
Each arrow is made of 2 points: (X0,Y0) The starting arrow point. (X1,Y1) The arrow head end point.
Tags:
Parameters:
method __add [line 196]
int __add(
x0
$x0, y0
$y0, x1
$x1, y1
$y1, text
$text)
|
|
Adds an Arrow with start and end coordinates and label. Returns the position of the Arrow in the list. Positions start at zero.
Each arrow is made of 2 points: (X0,Y0) The starting arrow point. (X1,Y1) The arrow head end point. Label (overload option)
Tags:
Parameters:
method ___add [line 216]
int ___add(
x0
$x0, y0
$y0, x1
$x1, y1
$y1, color
$color)
|
|
Returns the position of the Arrow in the list. Positions start at zero.
Each arrow is made of 2 points: (X0,Y0) The starting arrow point. (X1,Y1) The arrow head end point. Color (overload option)
Tags:
Parameters:
|
|