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

Class: TChart

Source Location: /TChart.php

Class Overview




Implements interfaces:

Variables

Methods



Class Details

[line 24]


[ Top ]


Class Variables

static $controlName = 'TChart'

[line 39]



Tags:

access:  public

Type:   mixed


[ Top ]

$eventHandlers =

[line 37]



Tags:

access:  public

Type:   mixed


[ Top ]

$eventSource =

[line 36]



Tags:

access:  public

Type:   mixed


[ Top ]

$height =

[line 35]



Tags:

access:  public

Type:   mixed


[ Top ]

$listeners =

[line 30]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mousePosition =

[line 32]



Tags:

access:  public

Type:   mixed


[ Top ]

$scrollable =

[line 29]



Tags:

access:  protected

Type:   mixed


[ Top ]

$tmpImg =

[line 33]



Tags:

access:  public

Type:   mixed


[ Top ]

$width =

[line 34]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor TChart [line 105]

TChart TChart( [ $width = 300], [ $height = 200], [ $handlers = null])

The class constructor.



Parameters:

   $width  
   $height  
   $handlers  

[ Top ]

destructor __destruct [line 131]

void __destruct( )



Tags:

access:  public


[ Top ]

method addMyEventListener [line 895]

void addMyEventListener( IEventListener $listener)



Parameters:

IEventListener   $listener  

[ Top ]

method addSeries [line 302]

Series addSeries( Series $s)

Adds a new Series.



Tags:

access:  public


Parameters:

Series   $s  

[ Top ]

method checkBackground [line 499]

void checkBackground( $sender, $e)



Tags:

access:  public



Implementation of:
IChart::checkBackground()

Parameters:

   $sender  
   $e  

[ Top ]

method checkGraphics [line 954]

void checkGraphics( )



Tags:

access:  public



Implementation of:
IChart::checkGraphics()
[ Top ]

method createToolTip [line 597]

void createToolTip( )



Tags:

access:  public


[ Top ]

method dispose [line 159]

void dispose( disposing $disposing)

Cleans up any resources being used.



Tags:

access:  protected


Parameters:

disposing   $disposing   boolean

[ Top ]

method doAfterDraw [line 477]

void doAfterDraw( )



Tags:

access:  public



Implementation of:
IChart::doAfterDraw()
[ Top ]

method doAfterDrawSeries [line 464]

void doAfterDrawSeries( )



Tags:

access:  public



Implementation of:
IChart::doAfterDrawSeries()
[ Top ]

method doAllowScroll [line 492]

void doAllowScroll( $a, $delta, $result)



Tags:

access:  public



Implementation of:
IChart::doAllowScroll()

Parameters:

   $a  
   $delta  
   $result  

[ Top ]

method doBaseInvalidate [line 579]

void doBaseInvalidate( )



Tags:

access:  public


[ Top ]

method doBeforeDraw [line 482]

void doBeforeDraw( )



Tags:

access:  public



Implementation of:
IChart::doBeforeDraw()
[ Top ]

method doBeforeDrawAxes [line 456]

void doBeforeDrawAxes( )



Tags:

access:  public



Implementation of:
IChart::doBeforeDrawAxes()
[ Top ]

method doBeforeDrawSeries [line 469]

void doBeforeDrawSeries( )



Tags:

access:  public



Implementation of:
IChart::doBeforeDrawSeries()
[ Top ]

method doClickSeries [line 487]

void doClickSeries( $sender, $s, $valueIndex, $e)



Tags:

access:  public


Parameters:

   $sender  
   $s  
   $valueIndex  
   $e  

[ Top ]

method doDrawImage [line 423]

void doDrawImage( $g)



Tags:

access:  public



Implementation of:
IChart::doDrawImage()

Parameters:

   $g  

[ Top ]

method doInvalidate [line 899]

void doInvalidate( )



Tags:

access:  public



Implementation of:
IChart::doInvalidate()
[ Top ]

method doZoomed [line 979]

void doZoomed( $sender)



Tags:

access:  public


Parameters:

   $sender  

[ Top ]

method exchangeSeries [line 382]

void exchangeSeries( int $series1, int $series2)

Obsolete.&nbsp;Use TChart.<!-- -->Series.<!-- -->Exchange() instead.



Tags:

deprecated:  
access:  public


Parameters:

int   $series1  
int   $series2  

[ Top ]

method fireChartPaint [line 42]

void fireChartPaint( )



Tags:

access:  protected


[ Top ]

method getApplyZOrder [line 227]

boolean getApplyZOrder( )

Obsolete.&nbsp;Please use getSeries.getApplyZOrder() instead.



Tags:

deprecated:  
access:  public


[ Top ]

method getAspect [line 775]

Aspect getAspect( )

Accesses view characteristics of the Chart.
3D view parameters.



Tags:

access:  public


[ Top ]

method getAutoRepaint [line 321]

boolean getAutoRepaint( )

Enables/Disables repainting of Chart when points are added.


Use AutoRepaint false to disable Chart repainting whilst, for example, adding a large number of points to a Chart Series. This avoidss repainting of the Chart whilst the points are added.
AutoRepaint may be re-enabled, followed by a manual Repaint command when all points are added.
Default value: true




Tags:

access:  public


[ Top ]

method getAxes [line 852]

Axes getAxes( )

Collection of predefined and custom axis objects.



Tags:

access:  public


[ Top ]

method getBackColor [line 251]

Color getBackColor( )

The color the Chart rectangle is filled with.


The chart rectangle is the screen area between axes.
Setting BackColor to Color.EMPTY does not fill the rectangle.
Assigning Color->_empty to tChart->getBackColor() makes TeeChart NOT fill the Chart back area, so Gradient fills and Background Bitmaps can be shown.




Tags:

access:  public


[ Top ]

method getBackground [line 269]

void getBackground( )



Tags:

access:  public


[ Top ]

method getBackgroundImage [line 416]

Image getBackgroundImage( )

Returns background image of TChart



Tags:

access:  public


[ Top ]

method getBuildNumber [line 975]

void getBuildNumber( )



Tags:

access:  public


[ Top ]

method getCanvas [line 785]

IGraphics3D getCanvas( )

Obsolete.&nbsp;Please use getGraphics3D function.



Tags:

deprecated:  
access:  public


[ Top ]

method getChart [line 607]

Chart getChart( )

Defines the Chart to display.



Tags:

access:  public


[ Top ]

method getClipPoints [line 207]

boolean getClipPoints( )

Obsolete.&nbsp;Please use Aspect->ClipPoints instead.



Tags:

deprecated:  
access:  public


[ Top ]

method getControl [line 575]

void getControl( )



Tags:

access:  public



Implementation of:
IChart::getControl()
[ Top ]

method getCursor [line 508]

void getCursor( )



Tags:

access:  public


[ Top ]

method getExport [line 861]

Exports getExport( )

Accesses Chart export attributess.



Tags:

access:  public


[ Top ]

method getFont [line 716]

Font getFont( )

Determines the Font characteristics.



Tags:

access:  public


[ Top ]

method getFooter [line 728]

Footer getFooter( )

Defines Text shown at the bottom of the Chart.
Use Text to enter the desired Footer lines, set Visible to True and change the Font, Frame and Brush methods.
Use Alignment to control text output position.



Tags:

access:  public


[ Top ]

method getFrame [line 391]

ChartPen getFrame( )

Use TChart.<!-- -->getWalls()<!-- -->getPen() instead.



Tags:

access:  public


[ Top ]

method getGetCursorPos [line 292]

TeePoint getGetCursorPos( )

Obsolete. Please use mousePosition field instead.



Tags:

deprecated:  
access:  public


[ Top ]

method getGraphics3D [line 971]

GraphicsGD getGraphics3D( )

Used to access TeeChart Draw attributes.



Tags:

access:  public


[ Top ]

method getHeader [line 695]

Header getHeader( )

Defines the Text and formatting properties to be drawn at the top of

the Chart.
Use Text to enter the desired Header lines, set Visible to True and change the Font, Frame and Brush methods.
Use Alignment to control text output position.




Tags:

access:  public


[ Top ]

method getImage [line 337]

void getImage( )



Tags:

access:  public


[ Top ]

method getImport [line 870]

Imports getImport( )

Accesses Chart import attributes.



Tags:

access:  public


[ Top ]

method getLegend [line 681]

Legend getLegend( )

Legend characteristics.


The Legend property determines the text and drawing attributes of Chart's textual representation of Series and Series values.
The Legend class draws a rectangle and for each Series in a Chart (or for each point in a Series) outputs a text representation of that Series (or that point).
You can use the Legend.LegendStyle and Legend.TextStyle properties to control the text used to draw the legend.
The Legend can be positioned at Left, Right, Top and Bottom chart sides using the Legend.Alignment property.
Use the Legend.Visible property to show / hide the Legend.
The Inverted property makes Legend to draw text starting from bottom.
The Frame, Font and Color properties allow you to change Legend appearance.
The Legend.ColorWidth property determines the percent width of each item's "colored" mark.
The Legend.FirstValue property controls which Series (or Series point) will be used to draw first Legend item.




Tags:

access:  public


[ Top ]

method getMetafiling [line 196]

boolean getMetafiling( )

True when the Chart is internally drawing into a Metafile image.



Tags:

access:  public


[ Top ]

method getPage [line 655]

Page getPage( )

Accesses multiple page characteristics of the Chart.



Tags:

access:  public


[ Top ]

method getPanel [line 637]

TeePanel getPanel( )

Background visible attributes.
Provides access, via the Panel Interface, to all Chart Panel properties.



Tags:

access:  public


[ Top ]

method getPanning [line 753]

Scroll getPanning( )

Accesses Panning characteristics.



Scrolling speed depends on:
The number of Series and Series Points.
The Chart Width and Height.
The computer processor and Video card processor speed.
The Video resolution and number of colors.
The Windows version and the Video driver.
The speed when dragging the mouse !




Tags:

access:  public


[ Top ]

method getPreferredSize [line 168]

void getPreferredSize( )

Returns a Dimension object of prefered size.



Tags:

access:  public


[ Top ]

method getPrinter [line 646]

Printer getPrinter( )

Printing related attributes.



Tags:

access:  public


[ Top ]

method getPrinting [line 177]

boolean getPrinting( )

Determines which Chart is being printed.



Tags:

access:  public


[ Top ]

method getSeries [line 822]

SeriesCollection getSeries( [int $index = -1])

Collection of Series contained in this Chart.



TeeChart Series are the data display method type, e.g. Line Series, Bar Series, Pie Series etc. You can mix different Series types in a Chart according to your requirements, thus your design is not limited to just one 'Chart type' defined by TeeChart. The concept of Chart type being virtually obsolete in terms of the number of permutations of Charts (Series type mix) you may create.

For more information please see "Tutorial 6 - Working with Series".




Tags:

return:  or Series depending if parameter has been passed
access:  public


Parameters:

int   $index  

[ Top ]

method getSeriesCount [line 400]

int getSeriesCount( )

Returns the number of Series in Chart.



Tags:

access:  public


[ Top ]

method getSubFooter [line 765]

Footer getSubFooter( )

Defines Text shown directly above Footer.
Use Text to enter the desired SubFooter lines, set Visible to True and change the Font, Frame and Brush methods.
Use Alignment to control text output position.



Tags:

access:  public


[ Top ]

method getSubHeader [line 707]

Header getSubHeader( )

Defines Text shown directly below Header.
Use the Text method to enter the desired SubHeader lines, set Visible to True and change the Font, Frame and Brush methods.
Use the Alignment method to control text output position.



Tags:

access:  public


[ Top ]

method getText [line 616]

String getText( )

The text for the Footer, Header, SubFooter and SubHeader.



Tags:

access:  public


[ Top ]

method getTools [line 834]

ToolsCollection getTools( )

Collection of Tool components contained in this Chart.



Tags:

access:  public


[ Top ]

method getWalls [line 843]

Walls getWalls( )

Accesses left, bottom and back wall characteristics of the Chart.



Tags:

access:  public


[ Top ]

method getZoom [line 737]

Zoom getZoom( )

Accesses the Zoom characteristics of the Chart.



Tags:

access:  public


[ Top ]

method mouseDragged [line 273]

void mouseDragged( $e)



Tags:

access:  public


Parameters:

   $e  

[ Top ]

method mouseMoved [line 281]

void mouseMoved( MouseEvent $e)

Captures current mouse position every time the mouse is moved.



Tags:

access:  public


Parameters:

MouseEvent   $e  

[ Top ]

method onMyEvent [line 52]

void onMyEvent( ChartEvent $event)




Implementation of:
IEventListener::onMyEvent()

Parameters:

ChartEvent   $event  

[ Top ]

method paint [line 431]

void paint( $g, $rectangle)



Tags:

access:  public


Parameters:

   $g  
   $rectangle  

[ Top ]

method paintComponent [line 903]

void paintComponent( $g, [ $rec = null])



Tags:

access:  protected


Parameters:

   $g  
   $rec  

[ Top ]

method pointToScreen [line 582]

void pointToScreen( $p)



Tags:

access:  public



Implementation of:
IChart::pointToScreen()

Parameters:

   $p  

[ Top ]

method refreshControl [line 593]

void refreshControl( )



Tags:

access:  public



Implementation of:
IChart::refreshControl()
[ Top ]

method RegisterEventHandler [line 136]

void RegisterEventHandler( $handler)



Tags:

access:  public


Parameters:

   $handler  

[ Top ]

method removeAllSeries [line 370]

void removeAllSeries( )

Removes all Series.



Tags:

access:  public


[ Top ]

method removeScrollable [line 408]

void removeScrollable( )



Tags:

access:  public


[ Top ]

method render [line 928]

void render( [string $fileName = null])

Render the chart image



Tags:

access:  public


Parameters:

string   $fileName   Name of the file to render the image to (optional)

[ Top ]

method serialize [line 59]

void serialize( $chart_s, $prefix)

Serializes the TChart and Chart objects



Tags:

access:  public


Parameters:

   $chart_s  
   $prefix  

[ Top ]

method setApplyZOrder [line 238]

void setApplyZOrder( boolean $value)

Obsolete.&nbsp;Please use getSeries().setApplyZOrder() instead.



Tags:

deprecated:  
access:  public


Parameters:

boolean   $value  

[ Top ]

method setAutoRepaint [line 332]

void setAutoRepaint( boolean $value)

Enables/Disables repainting of Chart when points are added.
Default value: true



Tags:

see:  getAutoRepaint
access:  public


Parameters:

boolean   $value  

[ Top ]

method setAxes [line 523]

void setAxes( $axes)



Tags:

access:  public


Parameters:

   $axes  

[ Top ]

method setBackColor [line 260]

void setBackColor( Color $value)

Sets the color the Chart rectangle is filled with.




Tags:

access:  public


Parameters:

Color   $value  

[ Top ]

method setBackground [line 265]

void setBackground( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setCanvas [line 795]

void setCanvas( IGraphics3D $value)

Obsolete.&nbsp;Please use setGraphics3D method.



Tags:

deprecated:  
access:  public


Parameters:

IGraphics3D   $value  

[ Top ]

method setChart [line 516]

void setChart( value $value)



Tags:

access:  public



Implementation of:
IChart::setChart()

Parameters:

value   $value   Chart

[ Top ]

method setClipPoints [line 216]

void setClipPoints( boolean $value)

Obsolete. Please use Aspect->ClipPoints instead.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setCursor [line 588]

void setCursor( $c)



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method setFont [line 531]

void setFont( $font)



Tags:

access:  public


Parameters:

   $font  

[ Top ]

method setFooter [line 527]

void setFooter( $footer)



Tags:

access:  public


Parameters:

   $footer  

[ Top ]

method setGraphics3D [line 805]

void setGraphics3D( IGraphics3D $value)

Used to access TeeChart Draw attributes.



Tags:

access:  public


Parameters:

IGraphics3D   $value  

[ Top ]

method setHeader [line 535]

void setHeader( $header)



Tags:

access:  public


Parameters:

   $header  

[ Top ]

method setHeight [line 341]

void setHeight( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setLegend [line 539]

void setLegend( $legend)



Tags:

access:  public


Parameters:

   $legend  

[ Top ]

method setPage [line 571]

void setPage( $page)



Tags:

access:  public


Parameters:

   $page  

[ Top ]

method setPanel [line 567]

void setPanel( $panel)



Tags:

access:  public


Parameters:

   $panel  

[ Top ]

method setPanning [line 563]

void setPanning( $panning)



Tags:

access:  public


Parameters:

   $panning  

[ Top ]

method setPrinter [line 559]

void setPrinter( $printer)



Tags:

access:  public


Parameters:

   $printer  

[ Top ]

method setPrinting [line 186]

void setPrinting( boolean $value)

Determines which Chart is being printed.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setScrollable [line 404]

void setScrollable( $scrollable)



Tags:

access:  public


Parameters:

   $scrollable  

[ Top ]

method setSeries [line 874]

void setSeries( $series)



Tags:

access:  public


Parameters:

   $series  

[ Top ]

method setSubFooter [line 543]

void setSubFooter( $subFooter)



Tags:

access:  public


Parameters:

   $subFooter  

[ Top ]

method setSubHeader [line 547]

void setSubHeader( $subHeader)



Tags:

access:  public


Parameters:

   $subHeader  

[ Top ]

method setText [line 625]

void setText( String $value)

Sets the text for the Footer, Header, SubFooter and SubHeader.



Tags:

access:  public


Parameters:

String   $value  

[ Top ]

method setTools [line 890]

void setTools( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setToolTip [line 886]

void setToolTip( $tool, $text)



Tags:

access:  public



Implementation of:
IChart::setToolTip()

Parameters:

   $tool  
   $text  

[ Top ]

method setWalls [line 551]

void setWalls( $walls)



Tags:

access:  public


Parameters:

   $walls  

[ Top ]

method setWidth [line 354]

void setWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setZoom [line 555]

void setZoom( $zoom)



Tags:

access:  public


Parameters:

   $zoom  

[ Top ]

method TriggerEvent [line 149]

void TriggerEvent( $eventName, $args)



Tags:

access:  public


Parameters:

   $eventName  
   $args  

[ Top ]

method unserialize [line 71]

void unserialize( $chart_s, $prefix)

Unserializes the TChart and Chart objects



Tags:

access:  public


Parameters:

   $chart_s  
   $prefix  

[ Top ]

method _paint [line 451]

void _paint( $g, $width, $height)



Tags:

access:  public


Parameters:

   $g  
   $width  
   $height  

[ Top ]

method _setSeries [line 878]

void _setSeries( $index, $value)



Tags:

access:  public


Parameters:

   $index  
   $value  

[ Top ]

method __get [line 88]

void __get( $property)



Parameters:

   $property  

[ Top ]

method __set [line 95]

void __set( $property, $value)



Parameters:

   $property  
   $value  

[ Top ]


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