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

Class: TeePage

Source Location: /TeePage.php

Class Overview

TeeBase
   |
   --TeePage

Page class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 15]
Page class

Description: Chart paging characteristics




Tags:

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


[ Top ]


Class Variables

$changeEvent =

[line 21]



Tags:

access:  protected

Type:   mixed


[ Top ]

$listenerList =

[line 39]

A list of event listeners for this component.



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor TeePage [line 44]

TeePage TeePage( $c)

The class constructor.



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method getCount [line 60]

number getCount( )

Gets the number of pages, according to MaxPointsPerPage property.
TChart.Page.MaxPointsPerPage must be greater than zero to activate auto paging. TChart.Page.Current determines the current visible page.



Tags:

return:  of Chart pages
access:  public


[ Top ]

method getCurrent [line 80]

current getCurrent( )

The current page number.



Run-time only. TChart.Page.Current determines the current visible points of Series in a Chart with MaxPointsPerPage greater than zero. When TChart.Page.MaxPointsPerPage is greater than zero, TeeChart internally divides all Series points in "pages". Each page is assigned a different initial and ending X coordinates. TChart.Page.NumPages returns the total number of pages. It equals the total number of Series points divided by MaxPointsPerPage. TChart.Page.Previous and TChart.Page.Next decrement or increment Current respectively.




Tags:

return:  page number
access:  public


[ Top ]

method getMaxPointsPerPage [line 101]

maximum getMaxPointsPerPage( )

The number of points displayed per page.
Default value: 0



Tags:

return:  number of points
access:  public


[ Top ]

method getScaleLastPage [line 139]

boolean getScaleLastPage( )

Determines how the last Chart page will be displayed.
It only has effect when TChart.MaxPointsPerPage is greater than zero.

When true, the last Chart page will have the same horizontal scaling as the other pages. When false, the last Chart page scaling will be adjusted based on the number of visible points on that last page.
Default value: true




Tags:

access:  public


[ Top ]

method next [line 162]

void next( )

Moves to next page ( Current + 1 )


When MaxPointsPerPage is greater than Zero, TeeChart automatically divides point values in Pages. Calling Next is the same as Page = Page + 1. The NumPages chart property returns the total number of pages.




Tags:

access:  public


[ Top ]

method previous [line 176]

void previous( )

Moves to previous page ( Current - 1 )


When MaxPointsPerPage is greater than Zero, TeeChart automatically divides point values in Pages. Calling Previous is the same as Page = Page - 1 (Go back a page). The Count property returns the total number of pages.




Tags:

access:  public


[ Top ]

method readResolve [line 49]

void readResolve( )



Tags:

access:  protected


[ Top ]

method setCurrent [line 89]

void setCurrent( value $value)

Sets the current page number.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setMaxPointsPerPage [line 125]

void setMaxPointsPerPage( value $value)

Sets the number of points displayed per page.
MaxPointsPerPage controls "TeeChart AutoPaging".

Setting it to a number greater than zero makes TeeChart internally divide Series points in Pages. You can then navigate across Chart pages by using Chart.Page and Chart.NumPages. For each Page, TeeChart will automatically calculate and display the corresponding Series points. The last page can have fewer points than other pages. You can use the Chart.ScaleLastPage to control if last page will be "stretched" or not.
Default value: 0

<p>Example:


 myChart.getPage().setMaxPointsPerPage(6);
 
</p>




Tags:

see:  getMaxPointsPerPage
access:  public


Parameters:

value   $value   int

[ Top ]

method setScaleLastPage [line 150]

void setScaleLastPage( value $value)

Determines how the last Chart page will be displayed.
Default value: true



Tags:

see:  getScaleLastPage
access:  public


Parameters:

value   $value   boolean

[ Top ]

method __get [line 24]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 31]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


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