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

Class: DepthAxis

Source Location: /axis/DepthAxis.php

Class Overview

TeeBase
   |
   --Axis
      |
      --DepthAxis

DepthAxis class


Author(s):

Version:

  • 1.0

Copyright:

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

Methods


Inherited Variables

Inherited Methods

Class: Axis

Axis::Axis()
The class constructor.
Axis::adjustMaxMin()
Calculates Maximum and Minimum $values based on Max and Min $values of the dependent Series.
AdjustMaxMin is automatically called if Axis.Automatic is true.
Axis::adjustMaxMinRect()
Called internally to recalculate the max and min $values using the
Axis::applyPosition()
Axis::calcLabelStyle()
Returns the most logical Axis Label style.
Axis::calcMinMax()
Returns the minimum and maximum $values of the associated Series.
Axis::calcPosPoint()
Returns the corresponding $value of a Screen position.
Axis::calcPosValue()
Returns the corresponding $value of a Screen position in pixels.
Axis::calcRect()
Used internally by Chart when creating Axes
Axis::calcSizeValue()
Returns the amount in pixels that corresponds to a portion of the axis of size "$value" in axis scales.
Axis::calcXPosValue()
Description Calculates the Horizontal coordinate in pixels of $value parameter You can use CalcXPos$value when requiring pixel positions from which to plot Drawing output.
Axis::calcXYIncrement()
Returns the calculated Axis Label increment.
Axis::calcYPosvalue()
Calculates the Vertical coordinate in pixels of $value parameter.
Axis::calcZPos()
Axis::clicked()
Returns if X and Y coordinates are close to the Axis position.
Axis::dateTimeDefaultFormat()
Returns either a Time or Date format depending if the astep parameter is lower than one day (time) or greater (date).
Axis::dateTimeIncrement()
Is a set of constants used to specify a date time increment.
Axis::draw()
Displays an Axis at the specified screen positions with the current axis scales.
Normally you do not need to call the Draw method directly.
Axis::drawAxisLabel()
Draws Axis Label (String) in font f at specified X,Y co-ordinate at Angle.
Axis::drawTitle()
TeeChart internal use. Outputs the title during the chart painting procedure.
Axis::findDateTimeStep()
Used internally to return Axis Datetime step.
Axis::getAutomatic()
Calculates Max and Min of axis scale based on associated Series.
Axis::getAutomaticMaximum()
Controls if Axis will adjust the Maximum $value automatically based on the maximum $value of its associated Series.
Default $value: true
Axis::getAutomaticMinimum()
Controls minimum $value automatically based on the minimum $value of its associated Series.
Default $value: true
Axis::getAxisPen()
Determines the kind of pen used to draw the major Axis lines.
These are the lines which go from Axis Minimum to Axis Maximum screen positions.
Axis::getCalcIncrement()
Returns the calculated Axis Label increment and serves as a useable
Axis::getCustomLabels()
Returns the custom labels
Axis::getDepthAxisAlign()
Axis::getEndPosition()
Axis End Position on its own Axis expressed as a percentage (0-100%).
Axis::getGrid()
Determines the kind of pen used to draw the Grid lines at every Axis
Axis::getGridCentered()
Obsolete.&nbsp;Please use Axis.<!-- -->Grid.<!-- -->Centered property
Axis::getHorizontal()
Determines the Custom axis to be drawn horizontally.
Axis::getIncrement()
Determines the minimum step between axis labels.
Axis::getInverted()
Swaps the Axis Minimum and Maximum scales.
Axis::getLabels()
Accesses the Label characteristics of Axis Labels.
Axis::getLabelsOnAxis()
Obsolete.&nbsp;Please use Labels.<!-- -->OnAxis instead.
Axis::getLogarithmic()
Scales the Axis Logarithmically when true.
Axis::getLogarithmicBase()
The base for the Logarithmic scale when Axis Logarithmic = true.
Axis::getMaximum()
The highest $value an Axis will use to scale their dependent Series
Axis::getMaximumOffset()
Amount of pixels that will be left as a margin at axis maximum
Axis::getMaxXValue()
Returns the calculated Maximum Horizontal $value for the specified AAxis.
Axis::getMaxYValue()
Returns the calculated Maximum Vertical $value for the specified AAxis.
Axis::getMinAxisIncrement()
Advanced use. Smallest Axis calculation increment.
Default $value: 1e-12
Axis::getMinimum()
The lowest $value an Axis will use to scale their dependent Series
Axis::getMinimumOffset()
The number of pixels that will be left as a margin at axis minimum
Axis::getMinorGrid()
Characteristics of the Grid coincidental to Minor Ticks.
The Minor Grid.Visible is false as default.
Axis::getMinorTickCount()
The number of Axis minor ticks between major ticks.
Axis::getMinorTicks()
Determines the Pen used to draw the Axis Minor ticks.
Minor ticks will only be displayed if MinorTicks.Visible is true.
Axis::getMinXValue()
Returns the calculated Minimum Horizontal $value for the specified AAxis.
Axis::getMinYValue()
Returns the calculted Minimum Vertical $value for the specified AAxis.
Axis::getOtherSide()
Positions the Axis labels to the Otherside of the axis.
For instance, moves labels on a vertical Axis to the right of the Axis. This is useful when adding a Custom Axis, to place the labelling to the Right for a right vertical Axis, or to the Top for a Top Axis.
Axis::getPosAxis()
Obsolete.&nbsp;Please use Position instead.
Axis::getPosition()
Determines the screen co-ordinate where axis is drawn.
Axis::getPositionUnits()
Defines axis Position units (pixels or percentage).
Axis::getRange()
Axis::getRectangleEdge()
Axis::getRelativePosition()
Determines the Axis position as percentage 0-100% of the Chart.
  1. being Top for a horizontal Axis and Left for a vertical Axis.
Axis::getSizeLabels()
Axis::getSizeTickAxis()
Axis::getStartPosition()
Axis Start position on its own Axis expressed as a percentage.
Axis::getTickOnLabelsOnly()
The Axis Ticks and Axis Grid to be drawn only coincide at Labels.
Otherwise, they will be drawn at all axis increment positions.
Axis::getTicks()
Determines the kind of Pen used to draw Axis marks along the Axis line.
Axis::getTicksInner()
Determines the kind of Pen used to draw Axis marks along the Axis line.
Axis::getTitle()
An Axis sub-class used to define Title attributes.
Axis Titles are a string of text drawn near Axes. Use Text to specify Axis Title text.
Use Font and Angle to set the format desired.
Axis::getTitleSize()
Obsolete.&nbsp;Please use Axis.<!-- -->Title.<!-- -->CustomSize
Axis::getVisible()
Shows or hides the Axis lines, ticks, grids, labels and title.
You can change it both at design and runtime.
Default $value: true
Axis::getZPosition()
Determines the Z axis position along chart Depth as a percentage of the total depth.
It can even be set to negative $values to place the axis in front of the Chart, or $values greater than 100% to place the axis behind the Chart.
Axis::incDecDateTime()
Axis::internalCalcPositions()
Axis::internalCalcRange()
Internal use.
Axis::internalSetInverted()
Axis::isCustom()
Returns true if Axis is a Custom Axis
Axis::isDateTime()
Returns if the Axis dependent $values are DateTime or not.
Axis::maxLabelsWidth()
Returns the maximum width in pixels of all Axis Labels.
Axis::readResolve()
Axis::scroll()
Scrolls or displaces the Axis Maximum and Minimum $values by the Offset parameter.
If you want to scroll the Axis outside Series limits, CheckLimits must be false.
Axis::setAutomatic()
Description Max and Min of axis scale based on associated Series.
Axis::setAutomaticMaximum()
The Axis adjusts the Maximum $value automatically based on the maximum $value of its associated Series when true.
Default $value: true
Axis::setAutomaticMinimum()
The Axis adjusts the Minimum $value automatically based on the maximum $value of its associated Series when true.
Default $value: true
Axis::setChart()
Axis::setEndPosition()
Sets the Axis End Position on its own Axis expressed as a percentage.
Default $value: 100%
Axis::setGridCentered()
Obsolete.&nbsp;Please use Axis.<!-- -->Grid.<!-- -->Centered property
Axis::setHorizontal()
Sets a custom axis to be drawn horizontally.
Axis::setIncrement()
Sets the minimum step between axis labels.
Axis::setInverted()
Swaps the Axis Minimum and Maximum scales when true.
Default $value: false
Axis::setLabelsOnAxis()
Obsolete.&nbsp;Please use Labels.<!-- -->OnAxis instead.
Axis::setLogarithmic()
Scales the Axis Logarithmically when true.
Default $value: false
Axis::setLogarithmicBase()
Sets the base for the Logarithmic scale when Axis Logarithmic = true.
Axis::setMaximum()
Sets the highest $value an Axis will use to scale their dependent Series posvalues.
Axis::setMaximumOffset()
Sets the amount of pixels that will be left as a margin at axis maximum position.
Default $value: 0
Axis::setMinAxisIncrement()
Advanced use. Determines the smallest Axis calculation increment.
Default $value: 1e-12
Axis::setMinimum()
Sets the lowest $value an Axis will use to scale their dependent Series possvalues.
Axis::setMinimumOffset()
Determines the number of pixels that will be left as a margin at axis minimum position.
Default $value: 0
Axis::setMinMax()
Changes the current Axis Minimum and Maximum scales.
Axis.Automatic must be set to false.
Axis::setMinMaxDate()
Changes the current Axis Minimum and Maximum scales.
Axis.Automatic must be set to false.
Axis::setMinorTickCount()
Determines the number of Axis minor ticks between major ticks.
Default $value: 3
Axis::setMinorTicks()
Axis::setOtherSide()
Sets the Axis labels to the Otherside of the axis.
Axis::setPositionUnits()
Determines the axis Position units (pixels or percentage).
Default $value: Percent
Axis::setRelativePosition()
Determines the Axis position as percentage 0-100% of the Chart.
Axis::setStartPosition()
Sets the Axis Start position on its own Axis expressed as a percentage.
Axis::setTickOnLabelsOnly()
Sets the Axis Ticks and Axis Grid to be drawn to only coincide at Labels.
Default $value: true
Axis::setTicks()
Axis::setTitle()
Axis::setTitleSize()
Obsolete.&nbsp;Please use Axis.<!-- -->Title.<!-- -->CustomSize
Axis::setVisible()
Shows the Axis lines, ticks, grids, labels and title when true.
Default $value: true
Axis::setZPosition()
Sets the Z axis position along chart Depth as a percentage of the total depth.
Axis::shouldSerializeHorizontal()
Axis::shouldSerializeMaximum()
Axis::shouldSerializeMinimum()
Axis::shouldSerializeOtherSide()
Axis::shouldSerializeZPosition()
Axis::titleOrName()
Axis::_draw()
Axis::_drawAxisLabel()
Draws Axis Label (String) at specified X,Y co-ordinate at Angle.
Axis::__draw()
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Axis::__get()
Axis::__set()
Axis::___draw()
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Axis::____draw()
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Axis::_____draw()
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.

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::__get()
TeeBase::__set()

Class Details

[line 16]
DepthAxis class

Description: Z plane Axis characteristics.




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 Methods


constructor DepthAxis [line 21]

DepthAxis DepthAxis( $horiz, $isOtherSide, $c)

The class constructor.



Tags:

access:  public


Parameters:

   $horiz  
   $isOtherSide  
   $c  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:05:03 +0200 by phpDocumentor 1.4.1