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

Class: SeriesMarks

Source Location: /styles/SeriesMarks.php

Class Overview

TeeBase
   |
   --TeeShape
      |
      --TextShape
         |
         --SeriesMarks

SeriesMarks class


Author(s):

  • Steema Software SL.

Version:

  • 1.0

Copyright:

  • 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]
SeriesMarks class

Description: Series Marks characteristics




Tags:

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


[ Top ]


Class Variables

$bClip = false

[line 36]



Tags:

access:  protected

Type:   mixed


[ Top ]

$checkMarkArrowColor =  true

[line 32]

When True, Marks arrow pen color is changed if the point has the same color.



Tags:

access:  public

Type:   mixed


[ Top ]

$iSeries =

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]

$markerStyle =  2

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pPositions =

[line 35]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor SeriesMarks [line 66]

SeriesMarks SeriesMarks( $s)

The class constructor.



Tags:

access:  public


Parameters:

   $s  

[ Top ]

destructor __destruct [line 93]

void __destruct( )



Tags:

access:  public


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

[ Top ]

method allSeriesVisible [line 567]

void allSeriesVisible( )



Tags:

access:  public


[ Top ]

method antiOverlap [line 795]

void antiOverlap( $first, $valueIndex, $aPos)



Tags:

access:  public


Parameters:

   $first  
   $valueIndex  
   $aPos  

[ Top ]

method applyArrowLength [line 586]

void applyArrowLength( $aPos)



Tags:

access:  public


Parameters:

   $aPos  

[ Top ]

method clear [line 260]

void clear( )

Removes all mark positions and mark items.



Tags:

access:  public


[ Top ]

method clicked [line 287]

int clicked( x $x, y $y)

Determines which Mark contains the XY pixel point parameters.



Tags:

return:  the Mark index containing the XY point.
access:  public


Parameters:

x   $x   int
y   $y   int

[ Top ]

method convertTo2D [line 734]

void convertTo2D( $aPos, $p)



Tags:

access:  protected


Parameters:

   $aPos  
   $p  

[ Top ]

method getAngle [line 462]

double getAngle( )

The angle from 0 to 360 to rotate Marks.
Default value: 0



Tags:

access:  public


[ Top ]

method getArrow [line 353]

ChartPen getArrow( )

The Pen used to draw a line connecting Marks to Series points.


Each Series class handles Marks in a different manner, thus the Arrow coordinates are specific to each Series type.
By default, Arrow pen is defined to be a White solid pen of 1 pixel width.




Tags:

access:  public


[ Top ]

method getArrowLength [line 368]

int getArrowLength( )

The length in pixels for the line connecting the Mark to Series point.


Default value: 16




Tags:

access:  public


[ Top ]

method getBackColor [line 319]

Color getBackColor( )

Obsolete.&nbsp;Use the Color method instead.



Tags:

access:  public


[ Top ]

method getCallout [line 125]

MarksCallout getCallout( )

Marks Callout characteristics.
Determines how to draw a line connecting a series mark to its series point.



Tags:

access:  public


[ Top ]

method getClip [line 393]

boolean getClip( )

Restricts Marks to Chart axes space, when true.


When true, Marks will be drawn only within inner chart boundaries, keeping Axis Labels, Titles, Legend, etc almost untouched.
Default value: false




Tags:

access:  public


[ Top ]

method getDrawEvery [line 440]

int getDrawEvery( )

The number of Marks to skip.
Default is 1, all Marks are displayed.

Setting it to two will draw every other Mark, to three every third etc.
Default value: 1




Tags:

access:  public


[ Top ]

method getFrame [line 339]

ChartPen getFrame( )

Obsolete.&nbsp;Use the Pen method instead.



Tags:

access:  public


[ Top ]

method getItems [line 137]

MarksItems getItems( )

Returns a collection of mark items.
Each mark item has its own formatting (color, font, shadow, etc).
By default Items are empty, so the default marks formatting is used.



Tags:

access:  public


[ Top ]

method getLines [line 168]

String[] getLines( )

Contains the list of lines drawn on the chart by the user at run-time.



Tags:

access:  public


Overrides TextShape::getLines() (Accesses the array of Text lines.
)

[ Top ]

method getMultiLine [line 415]

boolean getMultiLine( )

Characters in Mark texts are split into multiple lines, when true.
Default value: false



Tags:

access:  public


[ Top ]

method getPositions [line 158]

MarkPositions getPositions( )

Accesses Custom position characteristics for Series Marks.


TeeChart for Net has a number of algorithmns that were designed to stop TeeChart SeriesMark overlap. However, if you aren't happy with the automatically generated mark positions, you can always move marks around with code.

(Remember that you could also use the DragMarks Tool to reposition marks on your Chart.)




Tags:

access:  public


[ Top ]

method getSeries [line 181]

ISeries getSeries( )

Series is a read-only runtime method.
It returns the Series component that owns the TSeriesMarks subcomponent.


All Series types own a Marks subcomponent of the TSeriesMarks class.




Tags:

access:  public


[ Top ]

method getStyle [line 197]

MarksStyle getStyle( )

Each different Style value makes Marks output a different text.

Several options are available, but you can also use the TChart Series.OnGetMarkText event and override the default Series Marks text.
Default value: MarksStyle.Label




Tags:

access:  public


[ Top ]

method getSymbol [line 218]

void getSymbol( )



Tags:

access:  public


[ Top ]

method getTextAlign [line 498]

void getTextAlign( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method getZPosition [line 483]

int getZPosition( )

The Position in pixels on the Z axis.



Tags:

access:  public


[ Top ]

method internalDraw [line 839]

void internalDraw( $index, $aColor, $st, $aPos)



Tags:

access:  public


Parameters:

   $index  
   $aColor  
   $st  
   $aPos  

[ Top ]

method markItem [line 826]

void markItem( $valueIndex)



Tags:

access:  public


Parameters:

   $valueIndex  

[ Top ]

method percentString [line 604]

String percentString( valueIndex $valueIndex, addTotal $addTotal)

Returns the String showing a "percent" value for a given point.
For example: "25%"
The optional "AddTotal" parameter, when true, returns: "25% of 1234".



Tags:

access:  public


Parameters:

valueIndex   $valueIndex   int
addTotal   $addTotal   boolean

[ Top ]

method readResolve [line 112]

void readResolve( )



Tags:

access:  protected


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

[ Top ]

method resetPositions [line 244]

void resetPositions( )

Tells chart to repaint using automatically positioned marks.
Turns all Marks positions Custom to false.



Tags:

access:  public


[ Top ]

method setAngle [line 473]

void setAngle( value $value)

Sets angle from 0 to 360 to rotate Marks.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setArrowLength [line 380]

void setArrowLength( value $value)

Stes the length in pixels of the line connecting the Mark to Series point.
Default value: 16



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setBackColor [line 329]

void setBackColor( value $value)

Obsolete.&nbsp;Use the Color method instead.



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setChart [line 231]

void setChart( $value)



Tags:

access:  public


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

Parameters:

   $value  

[ Top ]

method setClip [line 404]

void setClip( value $value)

Restricts Marks to Chart axes space, when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDrawEvery [line 451]

void setDrawEvery( value $value)

Sets the number of Marks to skip.
Default value: 1



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setItems [line 142]

void setItems( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setMultiLine [line 426]

void setMultiLine( value $value)

Characters in Mark texts are split into multiple lines, when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStyle [line 209]

void setStyle( value $value)

Defines how Series Marks are constructed.
Default value: MarksStyle.Label



Tags:

access:  public


Parameters:

value   $value   MarksStyle

[ Top ]

method setTextAlign [line 503]

void setTextAlign( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setZPosition [line 493]

void setZPosition( value $value)

Sets Position in pixels on the Z axis.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method shouldDrawSymbol [line 916]

void shouldDrawSymbol( )



[ Top ]

method textWidth [line 703]

int textWidth( valueIndex $valueIndex)

Returns the length in pixels for the ValueIndex th mark text String.
It checks if the Mark has multiple lines of text.



Tags:

access:  public


Parameters:

valueIndex   $valueIndex   int

[ Top ]

method _clicked [line 275]

int _clicked( p $p)

Determines which Mark contains the p point parameters.



Tags:

access:  public


Parameters:

p   $p   Point

[ Top ]

method __get [line 49]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 56]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


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