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

Class: Zoom

Source Location: /Zoom.php

Class Overview

TeeBase
   |
   --ZoomScroll
      |
      --Zoom

<p>Title: Zoom class</p>


Author(s):

  • Steema Software SL.

Version:

  • 1.0

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods

Class: ZoomScroll

ZoomScroll::ZoomScroll()
Creates a new ZoomScroll class that is asociated to chart parameter.
ZoomScroll::activate()
Initializes a Zoom or Scroll operation starting at Point p coordinates.
ZoomScroll::activateXY()
Internal use. Starts a Zoom or Scroll from the co-ordinates x and y.
ZoomScroll::check()
Makes sure x0 and y0 coordinates are lower than x1 and y1 respectively.
ZoomScroll::getActive()
Returns the active state of Chart Zoom and Scroll.
In other words, during the act of zooming or scrolling returns true.
Default value: false
ZoomScroll::setActive()
Sets the active state of Chart Zoom and Scroll.
Default value: false
ZoomScroll::__destruct()

Class: TeeBase

TeeBase::__construct()
TeeBase::getChart()
Chart associated with this object.
TeeBase::invalidate()
Use invalidate when the entire canvas needs to be repainted.
TeeBase::setBooleanProperty()
TeeBase::setChart()
Chart associated with this object.
TeeBase::setColorProperty()
TeeBase::setDoubleProperty()
TeeBase::setIntegerProperty()
TeeBase::setStringProperty()
TeeBase::_setColorProperty()
TeeBase::__destruct()
TeeBase::__get()
TeeBase::__set()

Class Details

[line 24]
<p>Title: Zoom class</p>

Description: Used at tChart1.Zoom property, determines mouse zoom attributes.




Tags:

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


[ Top ]


Class Variables

$animatedFactor =  3.0

[line 39]

Controls the animated zoom "speed" (inertia)



Tags:

access:  public

Type:   mixed


[ Top ]

$pen =

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$zoomed =

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Zoom [line 46]

Zoom Zoom( c $c)

Creates a new Zoom instance.



Tags:

access:  public


Parameters:

c   $c   IBaseChart

[ Top ]

destructor __destruct [line 50]

void __destruct( )



Tags:

access:  public


Overrides ZoomScroll::__destruct() (parent method not documented)

[ Top ]

method calcZoomPoints [line 234]

void calcZoomPoints( )



Tags:

access:  protected


[ Top ]

method draw [line 242]

void draw( )

Displays rectangle while dragging Chart for zoom operation.



Tags:

access:  public


[ Top ]

method getAnimated [line 71]

boolean getAnimated( )

Animates Zoom in sequenced steps when true.
Default value: false



Tags:

access:  public


[ Top ]

method getAnimatedSteps [line 128]

int getAnimatedSteps( )

Determines the number of steps of the animated zooming sequence.


Large number of steps can delay zooming. The Animated property should be true.
Default value: 8




Tags:

access:  public


[ Top ]

method getBrush [line 91]

ChartBrush getBrush( )

Brush used to fill mousedragged zoom area.



Tags:

access:  public


[ Top ]

method getDirection [line 106]

ZoomDirections getDirection( )

The direction of the zoom on a selected area.



Example. Horizontal will zoom only on a horizontal plane although the mouse is dragged across a vertical and horizontal plane.
Default value: Both




Tags:

access:  public


[ Top ]

method getKeyMask [line 150]

int getKeyMask( )

The keyboard button as an extra condition to initiate the zoom.
Default value: None



Tags:

access:  public


[ Top ]

method getMinPixels [line 170]

int getMinPixels( )

The minimum number of pixels to actuate zoom action.
Default value: 16



Tags:

access:  public


[ Top ]

method getMouseButton [line 192]

int getMouseButton( )

The mousebutton to use for the zoom action.


Note that Scroll action uses the right (Right) mousebutton as default.
Default value: Left




Tags:

access:  public


[ Top ]

method getPen [line 211]

ChartPen getPen( )

Pen used to draw surrounding rectangle of zoom area.



Tags:

access:  public


[ Top ]

method getZoomed [line 316]

boolean getZoomed( )

Determines if Chart axis scales fit all Chart points or not.


Run-time only.
It is set to true when users's apply zoom or scroll to the Chart using the mouse at run-time.
The Zoom.Undo method sets the Zoomed property to false and resets the axis scales to fit all Series points.
The default value is true, meaning no zoom or scroll has been applied to the chart after it has been displayed for first time.

Default value: false




Tags:

access:  public


[ Top ]

method setAnimated [line 82]

void setAnimated( value $value)

Animates Zoom in sequenced steps when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setAnimatedSteps [line 140]

void setAnimatedSteps( value $value)

Sets the number of steps of the animated zooming sequence.


Large number of steps can delay zooming. The Animated property should be true.
Default value: 8




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setChart [line 285]

void setChart( c $c)

Overrides base SetChart method to adjust pen and brush chart properties.



Tags:

access:  public


Overrides TeeBase::setChart() (Chart associated with this object.)

Parameters:

c   $c   IBaseChart

[ Top ]

method setDirection [line 116]

void setDirection( value $value)

Sets the direction of the zoom on a selected area.

Default value: Both



Tags:

access:  public


Parameters:

value   $value   ZoomDirections

[ Top ]

method setKeyMask [line 160]

void setKeyMask( value $value)

Sets a keyboard button as an extra condition to initiate the zoom.
Default value: None



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setMinPixels [line 180]

void setMinPixels( value $value)

Sets minimum number of pixels to actuate zoom action.
Default value: 16



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setMouseButton [line 202]

void setMouseButton( value $value)

Sets the mousebutton to use for the zoom action.
Default value: Left



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setZoomed [line 326]

void setZoomed( value $value)

Set the Chart axis scales to fit all Chart points when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method undo [line 298]

void undo( )

Rescales the Chart Axis to their Maximum and Minimum values.



Tags:

access:  public


[ Top ]

method zoomPercent [line 351]

void zoomPercent( percentZoom $percentZoom)

Applies the specified PercentZoom Zoom In/Out to the current Axis

scales.
When PercentZoom is greater than 100%, Zoom Out is performed.
When PercentZoom is lower than 100%, Zoom In is performed.
The Animated property controls if Zoom is done directly in only o ne step or by multiple zooms thus giving an animation effect.




Tags:

access:  public


Parameters:

percentZoom   $percentZoom   double

[ Top ]

method zoomRect [line 226]

void zoomRect( r $r)

Zooms the Chart rectangle. Units pixels.



Tags:

access:  public


Parameters:

r   $r   Rectangle

[ Top ]


Documentation generated on Mon, 19 Aug 2013 13:43:34 +0200 by phpDocumentor 1.4.3