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

Class: CustomBar

Source Location: /styles/CustomBar.php

Class Overview

TeeBase
   |
   --Series
      |
      --CustomBar

CustomBar 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


Child classes:

Bar
Bar Class
HorizBar
HorizBar Class

Inherited Variables

Inherited Methods

Class: Series

Series::Series()
Series::add()
Adds a new point with specified value.
Series::addArray()
Adds the array of double values.
Series::addChartValue()
Series::added()
Series::addNull()
Obsolete.&nbsp;Please use add() method without parameters instead.
Series::addNullXY()
Obsolete.&nbsp;Please use add(x,y,Color.<!-- -->Transparent) method instead.
Series::addSampleValues()
Series::addSeriesMouseListener()
Series::addSeriesPaintListener()
Series::addText()
Adds a new null point with specified text.
Series::addValues()
Series::addXY()
Adds a new point with specified x and y values.
Series::addXYColor()
Adds a new point with specified x and y values and color.
Series::addXYText()
Adds a new point with specified x,y values and text.
Series::addXYTextColor()
Adds a new point with specified x,y values, text and color.
Series::addYColor()
Adds a new point with specified value and color.
Series::addYText()
Adds a new point with specified value and text.
Series::addYTextColor()
Adds a new point with specified value, text and color.
Series::assign()
Copies all properties from one Series component to another.
Series::assignDispose()
Series::assignValues()
Adds all Values from Source seriesto the current Series.
Series::associatedToAxis()
Series::beginUpdate()
Recalculates the function just one time, when finished adding points.
Series::calcFirstLastVisibleIndex()
Series::calcHorizMargins()
Returns the number of pixels for horizontal margins
Series::calcPosValue()
Returns "Value" parameter coordinate position in pixels.
Series::calcVerticalMargins()
Returns the number of pixels for vertical margins
Series::calcXPos()
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.
Series::calcXPosValue()
The pixel Screen Horizontal coordinate of the specified Value.
Series::calcXSizeValue()
Returns the size in pixels corresponding to value parameter in horizontal axis scales.
This coordinate is calculated using the Series associated Horizontal Axis.
Series::calcYPos()
The pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcYPosValue()
The pixel Screen Vertical coordinate of the specified Value.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcYSizeValue()
Returns the size in pixels corresponding to value parameter in vertical axis scales.
This coordinate is calculated using the Series associated Vertical Axis.
Series::calcZOrder()
Series::canAddRandomPoints()
Series::changeType()
Replaces ASeries object with a new Series object of another class.
Series::checkDataSource()
Refreshes all Series point values, either from database Tables or Series points.
Series::checkMouse()
Adds the array of integer values.
Series::checkOrder()
Reorders points according to Order property of X,Y,etc value lists.
Refreshes sort order of Series points if Order type of XValues or YValues is not loNone.
Series::checkOtherSeries()
Series::clear()
Removes all points, texts and Colors from the Series.
Dependent Series are notified. If no new points are appended to the Series, nothing will be painted.
Series::clearLists()
Series::clicked()
Returns the ValueIndex of the "clicked" point in the Series.
Clicked means the X and Y coordinates are in the point screen region bounds. If no point is "touched", Clicked returns -1
Series::cloneS()
Series::cloneSeries()
Returns a new Series, copy of this original.
It returns the SeriesIndex of the new Series.
Series::convertArray()
Adds all points in source Series.
Series::createNewSeries()
Creates a new Series object and sets the Name, Chart, Sub-Style and Function methods.
This is an internal method, you should seldomly use it in your applications.
Series::createSubGallery()
Series::dataSourceArray()
Series::delete()
Removes the index th point.
X values remain unchanged.
The Chart will be automatically redrawn.
Dependent Series will be recalculated.
Series::dispose()
Series::doAfterDrawValues()
Series::doBeforeDrawChart()
Series::doBeforeDrawValues()
Series::doClick()
Series::doClickPointer()
Series::doDoubleClick()
Series::draw()
Series::drawLegend()
Series::drawLegendShape()
Series::drawMark()
Series::drawMarks()
Series::drawSeries()
Draws the series to the Chart Canvas.
Series::drawSeriesForward()
Series::drawValue()
Called internally. Draws the "ValueIndex" point of the Series.
Series::drawValuesForward()
Returns whether Series draws its points in ascending/descending order.
Series::endUpdate()
Recalculates the function just one time, when finished adding points.
Series::fillSampleValues()
Adds the specified NumValues random points.
Series::fireSeriesMouseEvent()
Series::fireSeriesPaint()
Series::galleryChanged3D()
Series::getActive()
Shows or hides this series.
Series::getAllowSinglePoint()
Series::getBitmapEditor()
Returns the URL of the associated bitmap icon for a given Series class.
This icon is used at ChartListBox and Series Editor dialog.
Series::getColor()
Default color for all points.
Series::getColorEach()
Draws points with different preset Colors.
Series::getColorMember()
The the Datasource Color Field.
Default value: ""
Series::getColors()
Accesses the stored Color Array, if created, for the Series.
When attaching new series to any Chart, setting TChart Series.SerieColor to Color.EMPTY will make TeeChart assign a different color to each Series.
Series::getCount()
Returns the number of points in the Series.
Series::getCountLegendItems()
Series::getCursor()
Cursor displayed when mouse is over a series point.
Each Series determines the intersection of points with mouse coordinates each time the mouse moves. There are many different Cursors available.
Series::getCustomHorizAxis()
Specifies the custom horizontal axis for the series.
Series::getCustomVertAxis()
Specifies the custom vertical axis for the series.
Default value: null
Series::getDataSource()
Object to load data from.
Default value: null
Series::getDepth()
The Depth of the series points or interconnecting lines.
Default value: -1
Series::getDescription()
Gets descriptive text.
Series::getEndZ()
For internal use.
Series::getFields()
Series::getFirstVisible()
Returns the index of the Series' first visible point.
Series::getFunction()
Function object to calculate values.
Default value: null
Series::getHasZValues()
Series::getHorizAxis()
Series::getHorizontalAxis()
Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom
Series::getLabelMember()
The the Datasource Label Field.
Default value: ""
Series::getLabels()
Accesses a list of series point labels.
Series::getLastVisible()
Returns the index of the Series' last visible point.
Series::getLegendString()
Returns the formatted String corresponding to the LegendIndex point.
Series::getMandatory()
Series::getMarks()
Defines how to draw a mark near to each Series point.
Series::getMarkText()
Returns the String corresponding to the Series Mark text for a given ValueIndex point.
The Mark text depends on the Marks.Style method.
Series::getMarkValue()
Returns corresponding Point value suitable for displaying at Series Marks.
Series::getMaxXValue()
The Maximum Value of the Series X Values List.
Series::getMaxYValue()
The Maximum Value of the Series Y Values List.
Series::getMaxZValue()
The Maximum Z Value. For non-3D series, this is the Z order.
Series::getMiddleZ()
For internal use.
Series::getMinXValue()
The Minimum Value of the Series X Values List.
Series::getMinYValue()
The Minimum Value of the Series Y Values List.
Series::getMinZValue()
The Minimum Z Value. For non-3D series, this is the Z order.
Series::getNotMandatory()
Series::getNumGallerySeries()
For internal use.
Series::getNumSampleValues()
Series::getOriginValue()
Series::getPercentFormat()
The Format to display point values as percentage.
Series::getPoint()
Point characteristics.
Series::getSeriesColor()
Obsolete.&nbsp;Use the Series.Color method instead.
Series::getShowInLegend()
Displays this Series Title in Legend.
It is only meaningful when LegendStyle is Series or LastValues.
Default value: true
Series::getStartZ()
For internal use.
Series::getTitle()
Series description to show in Legend and dialogs.
Series::getUseAxis()
Series::getValueColor()
The colour of the index point.
Series::getValueFormat()
Determines the Format to display point values.
It specifies the desired formatting string to be applied to Axis Labels.
Series::getValueList()
Series::getValueListNum()
Adds the collection of objects that implement the IList interface.
Series::getValueMarkText()
Returns the String representation of a Index point used to draw the Mark.
Series::getValuesLists()
Returns the steema.teechart.styles.ValuesLists object of the series.
Series::getVertAxis()
Series::getVerticalAxis()
Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left
Series::getVisible()
Returns if this series is Visible.
Series::getXValues()
Values defining horizontal point positions.
Series::getYMandatory()
Returns whether or not this Series has Y values as mandatory.
Series::getYValueList()
Returns the value list that the AListName parameter has.
Series::getYValues()
Values defining vertical point positions.

WARNING:
You CAN NOT Delete, Clear or Add values DIRECTLY. You need to call the Series equivalent methods to do this.
Series::getZOrder()
Determines where on the depth axis the Series is drawn.

Series::hasDataSource()
Series::hasListenersOf()
Series::hasNoMandatoryValues()
Series::isNull()
Returns true if the index th point in the Series is "null" or "empty".
Series::isValidSeriesSource()
Series::isValidSourceOf()
Validates Series datasource.
Series::legendItemColor()
Series::legendToValueIndex()
Series::maxMarkWidth()
Returns the length in pixels of the longest Mark text.
Series::moreSameZOrder()
Returns true if there are more series that share the same Z order.
For example Stacked Bars.
Series::mouseEvent()
Series::newFromType()
Creates a new series from the Class type of an existing series object.
Series::numSampleValues()
Series::onDisposing()
Series::paintLegend()
Draws the Series "Legend" on the specified rectangle and Graphics.
Series::prepareForGallery()
Series::prepareLegendCanvas()
Series::randomBounds()
Removes count number of points starting at index.
When RemoveGap parameter is true, it calls ValueList FillSequence.
The Chart will be automatically redrawn.
Dependent Series will be recalculated.
Series::readResolve()
Series::recalcGetAxis()
Series::refreshSeries()
Recalculates all dependent Series points again.
Series::removeMarkTextResolver()
Series::removeSeriesMouseListener()
Series::removeSeriesPaintListener()
Series::repaint()
Forces the Chart to Repaint.
You don't normally call Repaint directly. It can be used within derived TChartSeries components when changing their properties internally .
Series::sameClass()
Returns True when the tmpSeries parameter is of the same class.
Series::setActive()
Shows or hides this series.
Series::setChart()
Series::setColor()
Default color for all points.
Default value: Color.Empty
Series::setColorEach()
Series::setColorMember()
Sets the Datasource Color Field.
Default value: ""
Series::setColors()
Accesses the stored Color Array, if created, for the Series.
Default value: null
Series::setCursor()
Cursor displayed when mouse is over a series point.
Default value: default
Series::setCustomHorizAxis()
Specifies the custom horizontal axis for the series.
Default value: null
Series::setCustomHorizAxisValue()
Specifies the custom horizontal axis for the series.
Default value: null
Series::setCustomVertAxis()
Specifies the custom vertical axis for the series.
Default value: null
Series::setCustomVertAxisValue()
Specifies the custom vertical axis for the series.
Default value: null
Series::setDataSource()
Object to load data from.
Default value: null
Series::setDepth()
Sets the Depth of the series points or interconnecting lines.
Default value: -1
Series::setEndZ()
Series::setFunction()
Series::setHorizontal()
Series::setHorizontalAxis()
Stes the Horizontal axis associated to this Series.
Default value: HorizontalAxis.Bottom
Series::setLabelMember()
Sets the Datasource Label Field.
Default value: ""
Series::setLabels()
Accesses a list of series point labels.
Series::setMarks()
Series::setMarkTextResolver()
Series::setMiddleZ()
Series::setNull()
Sets the specified series point to a null (transparent) point.
Series::setPercentFormat()
Sets the Format to display point values as percentage.
Default value: Language::getString("DefPercentFormat")
Series::setSeriesColor()
Obsolete.&nbsp;Use the Series.Color method instead.
Series::setShowInLegend()
Displays this Series Title in Legend.
Default value: true
Series::setStartZ()
Series::setSubGallery()
Creates and prepares the index'th Series style to show at sub-gallery dialog.
Series::setTitle()
Series description to show in Legend and dialogs.
Default value: ""
Series::setValueFormat()
Determines the Format to display point values.
Default value: Language::getString("DefValueFormat")
Series::setValueList()
Series::setVerticalAxis()
Determines Vertical axis associated to this Series.
Default value: VerticalAxis.Left
Series::setVisible()
An alias to Active property.
Shows or Hides the component.
Series::setXValues()
Series::setYValues()
Series::setZOrder()
Determines where on the depth axis the Series is drawn.

Default value: AutoZOrder
Series::setZPositions()
Series::swap()
Series::swapValueIndex()
Exchanges one point with another. Also the point color and point label.
Series::titleOrName()
Obsolete.&nbsp;Please use ToString() method instead.
Series::toString()
Overridden ToString() method.
Series::valuesListAdd()
Series::xScreenToValue()
Returns the corresponding X value of a Screen position between Axis limits.
The Screen position must be between Axis limits.
Series::yScreenToValue()
Returns the corresponding Y value of a Screen position between Axis limits.
The resulting Value is based on the Series.GetVertAxis.
Series::__destruct()
Series::__get()
Series::__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]
CustomBar Class

Description: Custom Bar Series




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

$barSizePercent =  70

[line 44]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bDark3D =  true

[line 46]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bUseOrigin =  true

[line 48]



Tags:

access:  protected

Type:   mixed


[ Top ]

$conePercent =

[line 45]



Tags:

access:  protected

Type:   mixed


[ Top ]

$customBarSize =

[line 52]



Tags:

access:  protected

Type:   mixed


[ Top ]

$dOrigin =

[line 49]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iBarBounds =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iBarSize =

[line 51]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iMultiBar =

[line 47]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iNumBars =

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iOrderPos =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]

$iPreviousCount =

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$normalBarColor =

[line 53]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pPen =

[line 50]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor CustomBar [line 72]

CustomBar CustomBar( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

destructor __destruct [line 86]

void __destruct( )



Tags:

access:  public


Overridden in child classes as:

Bar3D::__destruct()

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

[ Top ]

method applyBarOffset [line 977]

void applyBarOffset( $position)



Tags:

access:  protected


Parameters:

   $position  

[ Top ]

method barMargin [line 750]

int barMargin( )

Returns side margin amount in pixels.



Tags:

access:  public


[ Top ]

method barRectangle [line 655]

void barRectangle( barColor $barColor, r $r)

For internal use.


Displays a Bar or HorizBar point using the parameter coordinates and the BarColor parameter.
It is internally called for each point in the Series.
The BarStyle property determines the type of graphical representation of every point (ie: Rectangle, Ellipse, Pyramid, etc).




Tags:

access:  public


Parameters:

barColor   $barColor   Color
r   $r   Rectangle

[ Top ]

method calcMarkLength [line 985]

void calcMarkLength( $valueIndex)



Tags:

access:  protected


Parameters:

   $valueIndex  

[ Top ]

method calcZOrder [line 863]

void calcZOrder( )



Tags:

access:  public


Overrides Series::calcZOrder() (parent method not documented)

[ Top ]

method doBarGradient [line 697]

void doBarGradient( $valueIndex, $rect)



Tags:

access:  protected


Parameters:

   $valueIndex  
   $rect  

[ Top ]

method doBeforeDrawChart [line 904]

void doBeforeDrawChart( )



Tags:

access:  public


Overrides Series::doBeforeDrawChart() (parent method not documented)

[ Top ]

method doGetBarStyle [line 591]

void doGetBarStyle( $valueIndex)



Tags:

access:  protected


Parameters:

   $valueIndex  

[ Top ]

method doGradient3D [line 631]

void doGradient3D( $valueIndex, $p0, $p1)



Tags:

access:  protected


Parameters:

   $valueIndex  
   $p0  
   $p1  

[ Top ]

method drawLegendShape [line 970]

void drawLegendShape( $g, $valueIndex, $rect)



Tags:

access:  protected


Overrides Series::drawLegendShape() (parent method not documented)

Parameters:

   $g  
   $valueIndex  
   $rect  

[ Top ]

method getAutoMarkPosition [line 391]

boolean getAutoMarkPosition( )

Repositions Marks on BarSeries to prevent overlapping.


Marks are displaced to the top of the Bars to minimize the overlapping effect of Marks with long text or big font sizes.
When false, no checking is performed and all Marks are drawn at their Mark.ArrowLength distance to the top of the Bar.
Default value: false




Tags:

access:  public


[ Top ]

method getBarBounds [line 555]

Rectangle getBarBounds( )

Coordinates of current Bar point being displayed.


Run-time and read-only.
This function returns an internal variable, that is calculated only when the Bar Series DrawValue method is called.
You should only use BarBounds in custom-derived series, after calling the "inherited DrawValue" method.




Tags:

access:  public


[ Top ]

method getBarBoundsMidX [line 559]

void getBarBoundsMidX( )



Tags:

access:  protected


[ Top ]

method getBarStyle [line 455]

BarStyle getBarStyle( )

Defines the Bar shape used to draw Bars.
Default value: BarStyle.Rectangle



Tags:

access:  public


[ Top ]

method getBrush [line 486]

ChartBrush getBrush( )

Defines the Brush used to fill Bars.
When BarBrush.Style is different than bsSolid, the Series.Color color is the background bar color.



Tags:

access:  public


[ Top ]

method getConePercent [line 411]

int getConePercent( )

The apex size as percentage of the base.
Default value: 0



Tags:

access:  public


[ Top ]

method getCustomBarWidth [line 706]

void getCustomBarWidth( )



Tags:

access:  public


[ Top ]

method getDark3D [line 243]

boolean getDark3D( )

Darkens sides of bars to enhance 3D effect.
This has effect only when Chart.Aspect.View3D is true.

High color video modes (greater than 256 colors) will show dark colors much better than 256 or 16 color modes.
Default value: true




Tags:

access:  public


[ Top ]

method getDepthPercent [line 215]

int getDepthPercent( )

Determines the percent amount of bar size in "z" depth direction.

Default value: 100%




Tags:

access:  public


[ Top ]

method getGradient [line 146]

Gradient getGradient( )

Defines the color Gradient used to fill the Bars.


These can be filled with these three colors: StartColor, MidColor, EndColor. You can control the drawing output by setting the Direction method.
Use the Visible property to show / hide filling.

<p>Example:


  $barSeries = new Bar(myChart->getChart());
  $barSeries->getMarks()->setVisible(true);
  $barSeries->fillSampleValues(6);
  $barSeries->setColor(new Color(255,0,0));
  $barSeries->setBarStyle(BarStyle::$RECTGRADIENT);
  $barSeries->getGradient()->setDirection(GradientDirection::$VERTICAL);
  $barSeries->getGradient()->setStartColor(Color.GREEN);
  $barSeries->getGradient()->setUseMiddle(false);
  $barSeries->getGradient()->setMiddleColor(Color.YELLOW);
 
</p>




Tags:

access:  public


[ Top ]

method getGradientRelative [line 156]

boolean getGradientRelative( )

Calculates Colors based on highest bar when Gradient is Visible.
Default value: false



Tags:

access:  public


[ Top ]

method getMultiBar [line 512]

MultiBars getMultiBar( )

Determines how multiple BarSeries will be displayed in the same

Chart.
If you have more than one Bar series in the same Chart, then you can choose if they will be drawn side-by-side, back-to-front or Stacked.
Side-by-side means the Bar width will be divided by the number of Bar Series.
Default value: MultiBars.Side




Tags:

access:  public


[ Top ]

method getOffsetPercent [line 434]

int getOffsetPercent( )

The Bar displacement as percentage of Bar size.
Displacement is horizontal for Bar series and vertical for HorizBar series. It can be used to create "overlayed" Bar charts.

You can specify positive or negative values.
Default value: 0




Tags:

access:  public


[ Top ]

method getOrigin [line 367]

double getOrigin( )

The common bottom value used for all Bar points.
UseOrigin must be true (the default) to use the Origin property.
Bars with a value bigger than Origin are drawn in one direction and Bars with a lower value are drawn in the opposite direction.

This applies both to Bar series and HorizBar series classes.
Default value: 0




Tags:

access:  public


[ Top ]

method getPen [line 537]

ChartPen getPen( )

Pen used to draw the Bar rectangles.
You can set BarPen.Visible = false to hide these lines.



Tags:

access:  public


[ Top ]

method getSideMargins [line 297]

boolean getSideMargins( )

Margin between Chart rectangle and Bars.
Default value: true



Tags:

access:  public


[ Top ]

method getStackGroup [line 177]

int getStackGroup( )

Allows stacking independent Series within the same Chart, in series groups.
Default value: 0



Tags:

access:  public


[ Top ]

method getUseOrigin [line 343]

boolean getUseOrigin( )

Bars to be bottom aligned at the Origin method value.


When false, the minimum of all Bar values is used as the Bar origins value.
When true, the Origin property is used as the start point for Bars.
Default value: true




Tags:

access:  public


[ Top ]

method getYOrigin [line 321]

double getYOrigin( )

Obsolete.&nbsp;Please use CustomBar.<!-- -->Origin instead.



Tags:

access:  public


[ Top ]

method internalApplyBarMargin [line 761]

void internalApplyBarMargin( $margins)



Tags:

access:  protected


Parameters:

   $margins  

[ Top ]

method internalCalcMarkLength [line 599]

void internalCalcMarkLength( $valueIndex)



Tags:

access:  protected


Overridden in child classes as:

Bar::internalCalcMarkLength()
HorizBar::internalCalcMarkLength()

Parameters:

   $valueIndex  

[ Top ]

method internalClicked [line 999]

void internalClicked( $valueIndex, $point)



Tags:

access:  protected


Overridden in child classes as:

Bar::internalClicked()
HorizBar::internalClicked()

Parameters:

   $valueIndex  
   $point  

[ Top ]

method internalGetOriginPos [line 768]

void internalGetOriginPos( $valueIndex, $defaultOrigin)



Tags:

access:  protected


Parameters:

   $valueIndex  
   $defaultOrigin  

[ Top ]

method maxMandatoryValue [line 787]

void maxMandatoryValue( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method minMandatoryValue [line 840]

void minMandatoryValue( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method numSampleValues [line 1036]

int numSampleValues( x 0, y 1)

Returns the ValueIndex of the "clicked" point in the Series.
Clicked means the X and Y coordinates are in the point screen region bounds. If no point is "touched", Clicked returns -1



Tags:

access:  protected


Overrides Series::numSampleValues() (parent method not documented)

Parameters:

x   0   int
y   1   int

[ Top ]

method pointOrigin [line 824]

double pointOrigin( valueIndex $valueIndex, sumAll $sumAll)

For Internal Use.


The PointOrigin function returns the summed values of more than one Series point.
It's only used by Series types with Stacked or Stacked 100% styles such as BarSeries, HorizBar series and Area series.




Tags:

access:  public


Overridden in child classes as:

Bar3D::pointOrigin()
Returns the corresponding screen pixels coordinate of the leftmost horizontal bar edge.

Parameters:

valueIndex   $valueIndex   int
sumAll   $sumAll   boolean

[ Top ]

method prepareForGallery [line 257]

void prepareForGallery( $isEnabled)



Tags:

access:  public


Overrides Series::prepareForGallery() (parent method not documented)

Parameters:

   $isEnabled  

[ Top ]

method removeBarStyleResolver [line 121]

void removeBarStyleResolver( )



Tags:

access:  public


[ Top ]

method setAutoMarkPosition [line 401]

void setAutoMarkPosition( value $value)

Repositions Marks on BarSeries to prevent overlapping.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setBarSizePercent [line 263]

void setBarSizePercent( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method setBarStyle [line 466]

void setBarStyle( value $value)

Defines the Bar shape used to draw Bars.
Default value: BarStyle.Rectangle



Tags:

access:  public


Parameters:

value   $value   BarStyle

[ Top ]

method setBarStyleResolver [line 117]

void setBarStyleResolver( $resolver)



Tags:

access:  public


Parameters:

   $resolver  

[ Top ]

method setChart [line 490]

void setChart( $c)



Tags:

access:  public


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

Parameters:

   $c  

[ Top ]

method setConePercent [line 421]

void setConePercent( value $value)

Sets the apex size as a percentage of the base.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setCustomBarWidth [line 710]

void setCustomBarWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDark3D [line 253]

void setDark3D( value $value)

Darkens sides of bars to enhance 3D effect.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDepthPercent [line 230]

void setDepthPercent( value $value)

Determines the percent amount of bar size in "z" depth direction.

Default value: 100%

<p>Example:


 series.setDepthPercent(50) ; // % of 3D depth
 
</p>




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setGradientRelative [line 166]

void setGradientRelative( value $value)

Calculates Colors based on highest bar when Gradient is Visible.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setMultiBar [line 523]

void setMultiBar( value $value)

Determines how multiple BarSeries will be displayed in the same Chart.
Default value: MultiBars.Side



Tags:

access:  public


Parameters:

value   $value   MultiBars

[ Top ]

method setOffsetPercent [line 444]

void setOffsetPercent( value $value)

Sets the Bar displacement as percentage of Bar size.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setOrigin [line 377]

void setOrigin( value $value)

Sets the common bottom value used for all Bar points.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setPenBrushBar [line 1049]

void setPenBrushBar( $barColor)



Tags:

access:  protected


Parameters:

   $barColor  

[ Top ]

method setSideMargins [line 307]

void setSideMargins( value $value)

Sets a margin between Chart rectangle and Bars.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStackGroup [line 194]

void setStackGroup( value $value)

Allows stacking independent Series within the same Chart, in series groups.
Default value: 0


Example:


 bar1Series.setStackGroup(0);
 bar2Series.setStackGroup(1);
 




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setUseOrigin [line 353]

void setUseOrigin( value $value)

Allows Bars to be bottom aligned at the Origin method value.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setYOrigin [line 330]

void setYOrigin( value $value)

Obsolete.&nbsp;Please use CustomBar.<!-- -->Origin instead.



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setZPositions [line 198]

void setZPositions( )



Tags:

access:  public


Overrides Series::setZPositions() (parent method not documented)

[ Top ]

method shouldSerializeYOrigin [line 312]

void shouldSerializeYOrigin( )



Tags:

access:  protected


[ Top ]

method subGalleryStack [line 1060]

void subGalleryStack( )



Tags:

access:  protected


Overridden in child classes as:

Bar3D::subGalleryStack()

[ Top ]

method _barRectangle [line 673]

void _barRectangle( barColor $barColor, aLeft $aLeft, aTop $aTop, aRight $aRight, aBottom $aBottom)

For internal use.


Displays a Bar or HorizBar point using the parameter coordinates and the BarColor parameter.
It is internally called for each point in the Series.
The BarStyle property determines the type of graphical representation of every point (ie: Rectangle, Ellipse, Pyramid, etc).




Tags:

access:  public


Parameters:

barColor   $barColor   Color
aLeft   $aLeft   int
aTop   $aTop   int
aRight   $aRight   int
aBottom   $aBottom   int

[ Top ]

method __get [line 58]

void __get( $property)



Overridden in child classes as:

Bar::__get()
HorizBar::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 65]

void __set( $property, $value)



Overridden in child classes as:

Bar::__set()
HorizBar::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Mon, 19 Aug 2013 13:42:15 +0200 by phpDocumentor 1.4.3