TeeChartPHP
[ class tree: TeeChartPHP ] [ index: TeeChartPHP ] [ all elements ]

Class: ValueList

Source Location: /styles/ValueList.php

Class Overview

TeeBase
   |
   --ValueList

ValueList class


Author(s):

Version:

  • 1.0

Copyright:

  • (c) 1995-2008 by Steema Software SL. All Rights Reserved. <info@steema.com>

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 16]
ValueList class

Description: Array to hold Series data point values




Tags:

author:  
version:  1.0
copyright:  (c) 1995-2008 by Steema Software SL. All Rights Reserved. <info@steema.com>
link:  http://www.steema.com


[ Top ]


Class Variables

$capacity =

[line 21]



Tags:

access:  public

Type:   mixed


[ Top ]

$count = 0

[line 20]



Tags:

access:  public

Type:   mixed


[ Top ]

$dateTime = false

[line 22]



Tags:

access:  public

Type:   mixed


[ Top ]

$defaultCapacity = 0

[line 18]



Tags:

access:  public

Type:   mixed


[ Top ]

$maximum =

[line 23]



Tags:

access:  public

Type:   mixed


[ Top ]

$minimum =

[line 24]



Tags:

access:  public

Type:   mixed


[ Top ]

$name =

[line 36]



Tags:

access:  protected

Type:   mixed


[ Top ]

$series =

[line 30]



Tags:

access:  public

Type:   mixed


[ Top ]

$statsOk =

[line 27]



Tags:

access:  public

Type:   mixed


[ Top ]

$tempValue =

[line 28]



Tags:

access:  public

Type:   mixed


[ Top ]

$total =

[line 25]



Tags:

access:  public

Type:   mixed


[ Top ]

$totalABS =

[line 26]



Tags:

access:  public

Type:   mixed


[ Top ]

$value =

[line 19]



Tags:

access:  public

Type:   mixed


[ Top ]

$valueSource =  ""

[line 29]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor ValueList [line 53]

ValueList ValueList( $s, $name, [ $initialCapacity = -1])



Tags:

access:  public


Parameters:

   $s  
   $name  
   $initialCapacity  

[ Top ]

method addChartValue [line 498]

void addChartValue( $value)



Parameters:

   $value  

[ Top ]

method asDateTime [line 473]

void asDateTime( $index)



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method assign [line 313]

void assign( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method clear [line 197]

void clear( )

Removes all values in the list.

Warning: You should not call this "clear" method directly. Call the series "clear" method instead.




Tags:

access:  public


[ Top ]

method exchange [line 555]

void exchange( $index1, $index2)



Tags:

access:  public


Parameters:

   $index1  
   $index2  

[ Top ]

method fillSequence [line 548]

void fillSequence( )

Renumbers all values in a ValueList class starting at zero.
Warning: Calling fillSequence removes any previous value in a ValueList.
Use fillSequence when deleting points at runtime.



Tags:

see:  sort
access:  public


[ Top ]

method getCount [line 464]

void getCount( )



Tags:

access:  public


[ Top ]

method getDataMember [line 76]

String getDataMember( )

Field to use as source for this value list.
Default value: ""



Tags:

access:  public


[ Top ]

method getDateTime [line 113]

boolean getDateTime( )

Allows values to be expressed either as numbers or as Date+Time

values.

Each Series value list has a boolean property called DateTime. The boolean DateTime method tells TeeChart what type the numbers are. The horizontal (x axis) and vertical (y axis) value defaults are number format (DateTime False). DateTime can be changed both at design-time and run-time, forcing the Chart to repaint. It used whenever a value must be converted to text, for example, to draw it as the chart axis labels. Axis labels will be drawn in DateTime or numeric format accordingly to the setting of the DateTime method.

You can also set the Chart Series ValueFormat and the Chart Axis DateTimeFormat formatting strings, to control how the values will be displayed.
Default value: false




Tags:

access:  public


[ Top ]

method getFirst [line 277]

double getFirst( )

Returns the First point value.



Tags:

access:  public


[ Top ]

method getLast [line 299]

double getLast( )

Returns the Last point value.
This is the same value as the Count - 1 index value:



Tags:

access:  public


[ Top ]

method getMaximum [line 369]

double getMaximum( )

The highest of all values in the list.


As new points are being added to Series, the IValueList object calculates the Maximum, Minimum and TotalABS properties.
This applies to all Series lists of values, such as XValues, YValues, etc.




Tags:

access:  public


[ Top ]

method getMaxValue [line 382]

double getMaxValue( )

Obsolete.&nbsp;Please use Maximum method instead.



Tags:

access:  public


[ Top ]

method getMinimum [line 401]

double getMinimum( )

The lowest of all values in the list.




Tags:

see:  getMaximum
access:  public


[ Top ]

method getMinValue [line 391]

double getMinValue( )

Obsolete.&nbsp;Please use Minimum instead.



Tags:

access:  public


[ Top ]

method getName [line 188]

String getName( )

Returns the name of this ValueList.

The "Name" property is used as the "dataMember" of other series when they are linked through functions.




Tags:

access:  public


[ Top ]

method getOrder [line 141]

ValueListOrder getOrder( )

Determines if points are automatically sorted or left at original

position.
Runtime only.
This Order is used by default by the Series XValues to draw lines from Left to Right. Setting the XValues.Order property to loNone will respect the points order at point creation. This can be used to draw polygons.
Default value: None




Tags:

access:  public


[ Top ]

method getRange [line 352]

double getRange( )



Tags:

access:  public


[ Top ]

method getTotal [line 418]

double getTotal( )

The sum of all IValueList values.


When adding, deleting or modifying point values using the right methods, Total is automatically incremented and decremented.
Total is used by some Functions to improve speed when performing calculations against point values, where having already calculated the sum of point values is necessary.




Tags:

access:  public


[ Top ]

method getTotalABS [line 435]

double getTotalABS( )

The sum of all absolute values in the list.


Run-time and read only.
The values are first converted to their absolute value.
Pie series, for example, uses this property to calculate the percent each Pie slice represents.




Tags:

see:  getMaximum
access:  public


[ Top ]

method getValue [line 444]

void getValue( $index)



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method getValues [line 454]

void getValues( )



Tags:

access:  public


[ Top ]

method indexOf [line 210]

int indexOf( value $value)

Returns the corresponding point index which has the specified Value.
You can use it for example to obtain X co-ordinates based on Y values, or vice-versa.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method insertChartValue [line 281]

void insertChartValue( $valueIndex, $value)



Parameters:

   $valueIndex  
   $value  

[ Top ]

method locate [line 309]

int locate( value $value)

Obsolete.&nbsp;Please use IndexOf method instead.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method removeAt [line 227]

void removeAt( $index)



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method removeRange [line 219]

void removeRange( $index, $count)



Tags:

access:  public


Parameters:

   $index  
   $count  

[ Top ]

method setCount [line 469]

void setCount( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDataMember [line 86]

void setDataMember( value $value)

Field to use as source for this value list.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setDateTime [line 124]

void setDateTime( value $value)

Allows values to be expressed either as numbers or as Date+Time values.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setName [line 177]

void setName( name $name)

Returns the name of this ValueList.

The Name property can be used to link series when using functions. You can link one series ValueList to another series list, by using the setDataMember method.

For example:

mySeries.setDataSource( myCandle ); mySeries.getYValues().setDataMember(myCandle.getHighValues().getName());




Tags:

access:  public


Parameters:

name   $name   String

[ Top ]

method setOrder [line 152]

void setOrder( value $value)

Determines if points are automatically sorted or left at original position.
Runtime only.
Default value: None



Tags:

access:  public


Parameters:

value   $value   ValueListOrder

[ Top ]

method setValue [line 448]

void setValue( $index, $value)



Tags:

access:  public


Parameters:

   $index  
   $value  

[ Top ]

method setValues [line 459]

void setValues( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method sort [line 247]

void sort( )

Re-orders Series points, interchanging their position in the Series

Values lists.
By default, Series are set to sort points in ascending order using their X coordinates. This is accomplished with this code:

[C#]
tChart1.getSeries(0).getXValues().setOrder( loAscending )
tChart1.getSeries(0).getYValues().setOrder( loNone )

By default, Series draw points using the point ValueIndex, except in some non common situations like having the horizontal axis inverted.
Important Note: Re-Ordering Series points do NOT change point X coordinates. Series points which have no X coordinates are assigned a unique incremental number to determine the point horizontal positions. Automatic Point indexes start at zero. You will need to change every point X coordinate when sorting Series points with automatic X values.




Tags:

access:  public


[ Top ]

method trim [line 259]

void trim( )



Tags:

access:  public


[ Top ]

method __get [line 39]

void __get( $property)



Overrides TeeBase::__get() (parent method not documented)

Parameters:

   $property  

[ Top ]

method __set [line 46]

void __set( $property, $value)



Overrides TeeBase::__set() (parent method not documented)

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:09:08 +0200 by phpDocumentor 1.4.1