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

Class: AxisLabels

Source Location: /axis/AxisLabels.php

Class Overview

TeeBase
   |
   --TeeShape
      |
      --TextShape
         |
         --AxisLabels

AxisLabels class


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: TextShape

TextShape::TextShape()
The class constructor.
TextShape::assign()
Assign all properties from a TextShape to another.
TextShape::drawRectRotated()
Draws the Shape rectangle rotated by Angle degrees.
TextShape::getFont()
Determines the font attributes used to output ShapeSeries.<!-- -->Text Strings.
TextShape::getLines()
Accesses the array of Text lines.
TextShape::getLinesLength()
TextShape::getShadowSize()
Obsolete.&nbsp;Please use Shadow.<!-- -->Size.
TextShape::getShapeStyle()
Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle
TextShape::getText()
Displays customized strings inside Shapes.
You can use Font and Aligment to control Text display.

Note: You would maybe need to change Shape Font size to a different value when creating metafiles or when zooming Charts.
TextShape::getTextFormat()
Determines if Text is drawn as Normal or HTML styles.
TextShape::paint()
Paints the TextShape object on the Chart Canvas.
TextShape::readResolve()
TextShape::setChart()
TextShape::setDrawText()
TextShape::setLines()
Accesses the array of Text lines.
TextShape::setShadowSize()
Obsolete.&nbsp;Please use Shadow.<!-- -->Size.
TextShape::setShapeStyle()
Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle
TextShape::setText()
Displays customized strings inside Shapes.
TextShape::setTextFormat()
TextShape::_paint()
Paints the TextShape object on the Chart Canvas.
TextShape::__destruct()
TextShape::__get()
TextShape::__set()

Class: TeeShape

TeeShape::__construct()
The class constructor.
TeeShape::assign()
Assign all properties from a shape to another.
TeeShape::getBevel()
Sets the bevel characteristics of the Shape.
TeeShape::getBevelInner()
Obsolete.&ndsp;Please use Bevel.<!-- -->Inner.
TeeShape::getBevelOuter()
Obsolete.&nbsp;Please use Bevel.<!-- -->Outer
TeeShape::getBevelWidth()
Obsolete.&nbsp;Please use Bevel.<!-- -->Width
TeeShape::getBorderRound()
Rounds the Borders of the Chart Shapes.
TeeShape::getBottom()
Shape rectangle bottom co-ordinate.
TeeShape::getBrush()
Defines the kind of brush used to fill shape background.
TeeShape::getColor()
Defines the shape Color.
TeeShape::getGradient()
Calls the Gradient characteristics for the shape.
TeeShape::getHeight()
TeeShape::getImage()
Rendered Image for Shape background.
Default value: null
TeeShape::getImageBevel()
Sets the bevel characteristics of the Shape.
TeeShape::getImageMode()
ImageMode for rendered Shape background Image.
Default value: ImageMode::$Stretch
TeeShape::getImageTransparent()
Sets the shape image to transparent.
TeeShape::getLeft()
Shape rectangle left co-ordinate.
TeeShape::getPen()
Specifies the pen used to draw the shape.
TeeShape::getRight()
Shape rectangle right co-ordinate.
TeeShape::getShadow()
Defines the shape's Shadow characteristics.
TeeShape::getShapeBorders()
Defines the Shape Borders.
TeeShape::getShapeBounds()
Defines the boundaries of the Shape.
TeeShape::getTop()
Shape rectangle top co-ordinate.
TeeShape::getTransparency()
The Transparency level from 0 to 100% of shape.
TeeShape::getTransparent()
Enables/disables transparency of shape.
See transparency, which sets percentage transparency when Transparent is true.
TeeShape::getVisible()
Shows or hides the Shape.
TeeShape::getWidth()
TeeShape::paint()
TeeShape::setBevel()
Internal use - serialization
TeeShape::setBevelInner()
Defines the inner bevel type of the TChart Panel border.
TeeShape::setBevelOuter()
Defines the outer bevel type of the TChart Panel border.
TeeShape::setBevelWidth()
Obsolete.&nbsp;Please use Bevel.<!-- -->Width
TeeShape::setBorderRound()
Rounds the Borders of the Chart Shapes.
TeeShape::setBottom()
Shape rectangle bottom co-ordinate.
TeeShape::setBrush()
Internal use - serialization
TeeShape::setChart()
Chart associated with this object.
TeeShape::setColor()
TeeShape::setDefaultVisible()
TeeShape::setHeight()
TeeShape::setImage()
Sets Rendered Image for Shape background.
Default value: null
TeeShape::setImageMode()
Sets the ImageMode for rendered Shape background Image.
Default value: ImageMode.Stretch
TeeShape::setImageTransparent()
TeeShape::setLeft()
Shape rectangle left co-ordinate.
TeeShape::setPen()
Internal use - serialization
TeeShape::setRight()
Shape rectangle right co-ordinate.
TeeShape::setShapeBounds()
Defines the boundaries of the Shape.
TeeShape::setTop()
Shape rectangle top co-ordinate.
TeeShape::setTransparency()
Sets Transparency level from 0 to 100% of shape.
Default value: 0
TeeShape::setTransparent()
Enables/disables transparency of shape.
TeeShape::setVisible()
Shows or hides the Shape.
TeeShape::setWidth()
TeeShape::_setColor()
Defines the shape Color.
TeeShape::__destruct()
TeeShape::__get()
TeeShape::__set()

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 25]
AxisLabels class

Description: Axis Label characteristics




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

$axis =

[line 48]



Tags:

access:  public

Type:   mixed


[ Top ]

$axisvaluesformat =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bExponent =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bOnAxis =  true

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iAngle = 0

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iSeparation =  10

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iStyle =

[line 46]



Tags:

access:  public

Type:   mixed


[ Top ]

$labelText =  ''

[line 513]

returns the corresponding text representation of the Value parameter.

It uses the Axis formatting specifiers.




Tags:

access:  public

Type:   mixed


[ Top ]

$position =

[line 47]



Tags:

access:  public

Type:   mixed


[ Top ]

$sDatetimeformat =  ""

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]

$valuesDecimal = 2

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor AxisLabels [line 72]

AxisLabels AxisLabels( a $a)

Accesses the Label characteristics of Axis Labels.



Tags:

access:  public


Parameters:

a   $a   Axis

[ Top ]

destructor __destruct [line 90]

void __destruct( )



Tags:

access:  public


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

[ Top ]

method getAlign [line 425]

AxisLabelAlign getAlign( )

The position of Labels on an Axis.


The default position of an AxisLabel will depend on the Axis with which it is associated. A Bottom Axis will place Labels below the Axis by default. A Top Axis will place the Labels above the Axis.
Default value: Default position
Opposite: Labels positioned on the opposite side to the default position.




Tags:

access:  public


[ Top ]

method getAlternate [line 589]

boolean getAlternate( )

Gets the axis labels to be drawn in two rows or columns.



Tags:

access:  public


[ Top ]

method getAngle [line 166]

int getAngle( )

Defines the rotation degree applied to each Axis Label. Valid angle in degrees are 0, 90, 180, 270 and 360.
Please note that some printers and video drivers fail when drawing rotated fonts or calculating the rotated font dimensions.

Metafile Charts containing rotated fonts sometimes place text at sligthly different coordinates.

Default value: 0




Tags:

access:  public


[ Top ]

method getCustomSize [line 233]

int getCustomSize( )

Changes the spacing occupied by the axis labels between the Ticks and the Title.
Default value: 0



Tags:

access:  public


[ Top ]

method getDateTimeFormat [line 306]

String getDateTimeFormat( )

Standard DateTime formatting string specifier used to draw the axis labels.
Default value: ""



Tags:

access:  public


[ Top ]

method getExactDateTime [line 139]

boolean getExactDateTime( )

Determines whether Axis.Increment calculates Axis Labels in exact DateTime steps.
This is very useful when Axis.Increment is a DateTimeStep constant value.


When ExactDateTime is false (the default value), the OneMonth increment equals 30 days, and axis do not calculate how many days a month has.
The Series XValues or YValues properties should have DateTime = true. ( XValues for horizontal Axis and YValues for vertical Axis).

Default value: false




Tags:

access:  public


[ Top ]

method getExponent [line 400]

boolean getExponent( )

Enables/disables the display of Axis Labels in exponent format with super-script fonts.
Default value: false



Tags:

access:  public


[ Top ]

method getFrac_digits [line 580]

void getFrac_digits( )



Tags:

access:  public


[ Top ]

method getItems [line 447]

AxisLabelsItems getItems( )

Contains the custom labels.



Tags:

access:  public


[ Top ]

method getMultiLine [line 357]

boolean getMultiLine( )

Automatically breaks DateTime Labels on occurence of a space " ".

Use '\n' in other label types to break a line or use SplitInLines in the OnGetAxisLabel event.
Default value: false




Tags:

access:  public


[ Top ]

method getOnAxis [line 189]

boolean getOnAxis( )

Determines whether the Labels at Axis Minimum and Maximum positions will be shown or not.


Default value: true




Tags:

access:  public


[ Top ]

method getRoundFirstLabel [line 284]

boolean getRoundFirstLabel( )

Controls if Axis labels will be automatically "rounded" to the nearest

magnitude. Run-time only. This applies both to DateTime and non-DateTime axis values. When false, Axis labels will start at Maximum Axis value.
Default value: true




Tags:

access:  public


[ Top ]

method getSeparation [line 212]

int getSeparation( )

Specifies the minimum distance between Axis Labels as a percentage.

Setting it to "0" zero makes Axis skip calculating overlapping labels. (No clipping is performed). Labels visibility depends also on Labels.Font size, Labels.Angle and Axis.Increment properties.
Default value: 10




Tags:

access:  public


[ Top ]

method getStyle [line 259]

AxisLabelStyle getStyle( )

The style of the labels. Setting Axis.Label.Style to talAuto will

force the Axis to guess what labels will be drawn. For each Active associated Series, if the Series have XLabels then the Label.Style will be talText. If no Series have XLabels, then Label.Style will be talValue. If no Active Series are associated with the Axis, then Label.Style will be talNone.
Default value: AxisLabelStyle.Auto




Tags:

access:  public


[ Top ]

method getValueFormat [line 332]

formatting getValueFormat( )

Specifies the desired formatting string to be applied to Axis Labels.

It has effect when Axis associated Series have their XValues.DateTime or YValues.DateTime property set to false.
For DateTime Axis labels use the AxisLabels.DateTimeFormat property.
ValueFormat is a standard formatting string specifier. Chart Axis uses it to draw the axis labels. Chart Series uses it to draw the Marks.
Default value: '#,##0.###'




Tags:

return:  String to be applied to Axis Labels.
access:  public


[ Top ]

method labelHeight [line 497]

int labelHeight( value $value)

returns the Axis Label height of the Value parameter. It uses the Axis formatting specifiers, the Axis Labels Font and the Labels rotation and style.



Tags:

return:  Axis Label height in pixels
access:  public


Parameters:

value   $value   double Axis value

[ Top ]

method labelValue [line 515]

void labelValue( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method labelWidth [line 478]

int labelWidth( value $value)

returns the Axis Label width of the Value parameter. It uses the Axis formatting specifiers, the Axis Labels Font and the Labels rotation and style.



Tags:

return:  Axis Label width in pixels
access:  public


Parameters:

value   $value   double Axis value

[ Top ]

method readResolve [line 112]

void readResolve( )



Tags:

access:  protected


Overrides TextShape::readResolve() (parent method not documented)

[ Top ]

method setAlign [line 435]

void setAlign( value $value)

Sets the position of Labels on an Axis.
Default value: Default position



Tags:

access:  public


Parameters:

value   $value   AxisLabelAlign

[ Top ]

method setAlternate [line 598]

boolean setAlternate( $value)

Gets the axis labels to be drawn in two rows or columns.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setAngle [line 176]

void setAngle( value $value)

Defines the rotation degree applied to each Axis Label.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setCustomSize [line 244]

void setCustomSize( value $value)

Changes the spacing occupied by the axis labels between the Ticks and the Title.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setDateTimeFormat [line 317]

void setDateTimeFormat( value $value)

Standard DateTime formatting string specifier used to draw the axis labels.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setExactDateTime [line 150]

void setExactDateTime( value $value)

Determines whether Axis.Increment calculates Axis Labels in exact DateTime steps.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setExponent [line 411]

void setExponent( value $value)

Enables/disables the display of Axis Labels in exponent format with super-script fonts.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setFrac_digits [line 576]

void setFrac_digits( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setMultiLine [line 367]

void setMultiLine( value $value)

Automatically breaks DateTime Labels on occurence of a space " ".
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setOnAxis [line 199]

void setOnAxis( value $value)

Shows the Labels at Axis Minimum and Maximum positions when true.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setRoundFirstLabel [line 295]

void setRoundFirstLabel( value $value)

Axis labels will be automatically "rounded" to the nearest magnitude when true.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setSeparation [line 222]

void setSeparation( value $value)

Specifies the minimum distance between Axis Labels as a percentage.
Default value: 10



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setStyle [line 269]

void setStyle( value $value)

Sets the style of the labels.
Default value: AxisLabelStyle.Auto



Tags:

access:  public


Parameters:

value   $value   AxisLabelStyle

[ Top ]

method setValueFormat [line 342]

void setValueFormat( value $value)

Specifies the desired formatting string to be applied to Axis Labels.
Default value: '#,##0.###'



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method shouldSerializeTransparent [line 121]

void shouldSerializeTransparent( )



Tags:

access:  protected


[ Top ]

method splitInLines [line 380]

String splitInLines( s $s, separator $separator)

Sets Separator String to invoke 'new line' in String St. Replaces input string St with separator to be used to break lines at each occurrence of the separator.



Tags:

access:  public


Parameters:

s   $s   Input String
separator   $separator   String to be used for new line

[ Top ]

method __get [line 53]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 60]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Mon, 19 Aug 2013 13:41:53 +0200 by phpDocumentor 1.4.3