static method findDateTimeStep [line 1954]
static int findDateTimeStep(
step$value
$stepValue)
|
|
Used internally to return Axis Datetime step.
Tags:
Parameters:
constructor Axis [line 176]
Axis Axis(
[
$horiz = false], [
$isOtherSide = false], [
$chart = null])
|
|
The class constructor.
Tags:
Parameters:
destructor __destruct [line 107]
method adjustMaxMin [line 368]
Calculates Maximum and Minimum $values based on Max and Min $values of the dependent Series.
AdjustMaxMin is automatically called if Axis.Automatic is true.
The Chart Zoom.Undo method calls AdjustMaxMin for Left, Right,Top and Bottom axis.
Tags:
method adjustMaxMinRect [line 330]
void adjustMaxMinRect(
rect
$rect)
|
|
Called internally to recalculate the max and min $values using the
Rect parameter positions.
The Rect parameter determines in pixels the margins to apply to ChartRect. The Axis recalculates the appropiate maximum and minimum $values using the Rect parameter positions.
Tags:
Parameters:
method applyPosition [line 1924]
void applyPosition(
$apos,
$r)
|
|
Parameters:
method calcLabelStyle [line 2522]
Returns the most logical Axis Label style.
It calculates the "best candidate" label style based on how many Active Series are in the Chart and if the Series has po$labels. The LabelStyle property must be set to talAuto for this function to work.
If LabelStyle is not talAuto, the LabelStyle property $value is returned.
Tags:
method calcMinMax [line 1137]
void calcMinMax(
tmp
$tmp)
|
|
Returns the minimum and maximum $values of the associated Series.
Tags:
Parameters:
method calcPosPoint [line 1402]
double calcPosPoint(
$value, $value
$Screen)
|
|
Returns the corresponding $value of a Screen position.
Tags:
Parameters:
method calcPosValue [line 1288]
Position calcPosValue(
$value
$value)
|
|
Returns the corresponding $value of a Screen position in pixels.
Tags:
Parameters:
method calcRect [line 1878]
Rectangle calcRect(
r
$r, inflateChartRectangle
$inflateChartRectangle)
|
|
Used internally by Chart when creating Axes
Tags:
Parameters:
method calcSizeValue [line 1376]
$Potrtion calcSizeValue(
$value
$value)
|
|
Returns the amount in pixels that corresponds to a portion of the axis of size "$value" in axis scales.
Tags:
Parameters:
method calcXPosValue [line 1300]
int calcXPosValue(
double
$value)
|
|
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.
Tags:
Parameters:
method calcXYIncrement [line 1746]
double calcXYIncrement(
$maxLabelSize, maxLabelSize
$The)
|
|
Returns the calculated Axis Label increment.
Tags:
Parameters:
method calcYPosvalue [line 1328]
$Vertical calcYPosvalue(
$value
$value)
|
|
Calculates the Vertical coordinate in pixels of $value parameter.
Tags:
Parameters:
method calcZPos [line 1363]
method clicked [line 1484]
boolean clicked(
x
$x, y
$y)
|
|
Returns if X and Y coordinates are close to the Axis position.
Tags:
Parameters:
method dateTimeDefaultFormat [line 1563]
DateFormat dateTimeDefaultFormat(
astep
$astep)
|
|
Returns either a Time or Date format depending if the astep parameter is lower than one day (time) or greater (date).
Tags:
Parameters:
method dateTimeIncrement [line 2452]
double dateTimeIncrement(
isDateTime
$isDateTime, increment
$increment, $value
$value, anIncrement
$anIncrement, tmpWhichDatetime
$tmpWhichDatetime)
|
|
Is a set of constants used to specify a date time increment.
Tags:
Parameters:
method draw [line 2542]
void draw(
calcPosAxis
$calcPosAxis)
|
|
Displays an Axis at the specified screen positions with the current axis scales.
Normally you do not need to call the Draw method directly.
Tags:
Parameters:
method drawAxisLabel [line 2052]
void drawAxisLabel(
f
$f, x
$x, y
$y,
$angle, st
$st, format
$format, angle
$Angle)
|
|
Draws Axis Label (String) in font f at specified X,Y co-ordinate at Angle.
Tags:
Parameters:
method drawTitle [line 2372]
void drawTitle(
x
$x, y
$y)
|
|
TeeChart internal use. Outputs the title during the chart painting procedure.
Tags:
Parameters:
method getAutomatic [line 230]
Calculates Max and Min of axis scale based on associated Series.
Tags:
method getAutomaticMaximum [line 398]
boolean getAutomaticMaximum(
)
|
|
Controls if Axis will adjust the Maximum $value automatically based on the maximum $value of its associated Series.
Default $value: true
Tags:
method getAutomaticMinimum [line 421]
boolean getAutomaticMinimum(
)
|
|
Controls minimum $value automatically based on the minimum $value of its associated Series.
Default $value: true
Tags:
method getAxisPen [line 444]
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.
Tags:
method getCalcIncrement [line 1771]
double getCalcIncrement(
)
|
|
Returns the calculated Axis Label increment and serves as a useable
measure when Labelling is set to manual or automatic increments.
Please note that the related Increment property only returns the increment $value when those increments are manually set via the same property.
Tags:
method getCustomLabels [line 221]
Returns the custom labels
Tags:
method getDepthAxisAlign [line 2349]
void getDepthAxisAlign(
)
|
|
Tags:
method getEndPosition [line 1056]
Axis End Position on its own Axis expressed as a percentage (0-100%).
For a Vertical Axis a $value of 75% would place the beginning of the scale at 75% down from Top.
Default $value: 100%
Tags:
method getGrid [line 457]
Determines the kind of pen used to draw the Grid lines at every Axis
Label position.
These are the lines which go from "cousin Axis" Minimum to "cousin Axis" Maximum screen positions for each Label position.
Use the MinorGrid property to make the Grid from Minor Ticks visible.
Tags:
method getGridCentered [line 967]
boolean getGridCentered(
)
|
|
Obsolete. Please use Axis.<!-- -->Grid.<!-- -->Centered property
Tags:
method getHorizontal [line 253]
Determines the Custom axis to be drawn horizontally.
Tags:
method getIncrement [line 515]
Determines the minimum step between axis labels.
Can use DateTimeStep for date-time axis. It must be a positive number or DateTime $value. TChart will use this $value as the inicial axis label step. If there is not enough space for all labels, TChart will calculate a bigger one. You can use the DateTimeStep constant array for DateTime increments.
Tags:
method getInverted [line 544]
Swaps the Axis Minimum and Maximum scales.
When true, Axis Minimum and Maximum scales will be swapped. Axis labels and Series points will be displayed accordingly. This applies both to vertical and horizontal axis.
Default $value: false
Tags:
method getLabels [line 212]
Accesses the Label characteristics of Axis Labels.
Tags:
method getLabelsOnAxis [line 469]
boolean getLabelsOnAxis(
)
|
|
Obsolete. Please use Labels.<!-- -->OnAxis instead.
Tags:
method getLogarithmic [line 572]
boolean getLogarithmic(
)
|
|
Scales the Axis Logarithmically when true.
Axis Minimum and Maximum $values should be greater than 0, and Axis cannot be of DateTime type.
Default $value: false
Tags:
method getLogarithmicBase [line 1075]
double getLogarithmicBase(
)
|
|
The base for the Logarithmic scale when Axis Logarithmic = true.
Tags:
method getMaximum [line 647]
The highest $value an Axis will use to scale their dependent Series
posvalues.
It can be any number or DateTime $value. It must be greater than the Axis.Minimum $value.
VERY IMPORTANT:
Axis.Automatic property must be FALSE. If Axis.Automatic is true, the Axis will set Maximum and Minimum $values to Maximum and Minimum dependent Series $values.
Tags:
method getMaximumOffset [line 620]
Amount of pixels that will be left as a margin at axis maximum
position.
It is useful when you don't want the series to display points very close to axis boundaries.
Default $value: 0
Example:
myChart.getAxes().getBottom().setMaximumOffset(4);
myChart.getAxes().getBottom().setMinimumOffset(4);
Tags:
method getMaxXValue [line 1501]
Returns the calculated Maximum Horizontal $value for the specified AAxis.
AAxis can be Axis.Top or Axis.Bottom. Calculated means that the return $value will be the Maximum $value of the Maximum Series X $values. Only Series with the HorizontalAxis equal to AAxis will be considered.
Tags:
method getMaxYValue [line 1518]
Returns the calculated Maximum Vertical $value for the specified AAxis.
AAxis can be Axis.Left or Axis.Right. Calculated means that the return $value will be the Maximum $value of the Maximum Series Y $values. Only Series with the VerticalAxis equal to AAxis will be considered.
Tags:
method getMinAxisIncrement [line 671]
double getMinAxisIncrement(
)
|
|
Advanced use. Smallest Axis calculation increment.
Default $value: 1e-12
Tags:
method getMinimum [line 697]
The lowest $value an Axis will use to scale their dependent Series
povalues.
It can be any number or DateTime $value. It must be lower than the Axis.Maximum $value.
VERY IMPORTANT:
Axis.Automatic property must be FALSE. If Axis.Automatic is true, the Axis will set Maximum and Minimum $values to Maximum and Minimum dependent Series $values.
Tags:
method getMinimumOffset [line 720]
The number of pixels that will be left as a margin at axis minimum
position.
It is useful when you don't want the series to display points very close to axis boundaries.
Default $value: 0
Tags:
method getMinorGrid [line 1094]
Characteristics of the Grid coincidental to Minor Ticks.
The Minor Grid.Visible is false as default.
Tags:
method getMinorTickCount [line 744]
The number of Axis minor ticks between major ticks.
Axis minor ticks are the Axis sub-ticks between major ticks. It should be a positive number greater than zero and less than half the number of pixels between major ticks, otherwise Minor ticks will "overlap".
Default $value: 3
Tags:
method getMinorTicks [line 764]
Determines the Pen used to draw the Axis Minor ticks.
Minor ticks will only be displayed if MinorTicks.Visible is true.
Tags:
method getMinXValue [line 1535]
Returns the calculated Minimum Horizontal $value for the specified AAxis.
AAxis can be Axis.Top or Axis.Bottom. Calculated means that the return $value will the Minimum $value of the Minimum Series X $values. Only Series with the HorizontalAxis equal to AAxis will be considered.
Tags:
method getMinYValue [line 1552]
Returns the calculted Minimum Vertical $value for the specified AAxis.
AAxis can be Axis.Left or Axis.Right. Calculated means that the return $value will the Minimum $value of the Minimum Series Y $values. Only Series with the VerticalAxis equal to AAxis will be considered.
Tags:
method getOtherSide [line 278]
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.
Tags:
method getPosAxis [line 781]
Obsolete. Please use Position instead.
Tags:
method getPosition [line 794]
Determines the screen co-ordinate where axis is drawn.
It returns the position of the Axis in pixels relative to the Chart Panel. For horizontal axes the number is a Y position, for vertical axes an X position.
Default $value: 0
Tags:
method getPositionUnits [line 1008]
Defines axis Position units (pixels or percentage).
When PositionUnits is Percent, Position $value is a percentage of total chart size.
When PositionUnits is Pixels, Position is considered in pixels.
Default $value: Percent
Tags:
method getRange [line 203]
method getRectangleEdge [line 1812]
void getRectangleEdge(
$r)
|
|
Parameters:
method getRelativePosition [line 986]
double getRelativePosition(
)
|
|
Determines the Axis position as percentage 0-100% of the Chart.
- being Top for a horizontal Axis and Left for a vertical Axis.
Tags:
method getSizeLabels [line 1244]
method getSizeTickAxis [line 1797]
method getStartPosition [line 1033]
double getStartPosition(
)
|
|
Axis Start position on its own Axis expressed as a percentage.
For a vertical Axis a StartPosition of 75 would place the top of the Axis 75% down the Chart.
Default $value: 0%
Tags:
method getTickOnLabelsOnly [line 807]
boolean getTickOnLabelsOnly(
)
|
|
The Axis Ticks and Axis Grid to be drawn only coincide at Labels.
Otherwise, they will be drawn at all axis increment positions.
When the Axis.Labels.Separation property is greater than 0 (default 10), Axis increases the increment property to afunction Axis Label overlap.
Default $value: true
Tags:
method getTicks [line 833]
Determines the kind of Pen used to draw Axis marks along the Axis line.
Ticks position is calculated based on Axis.Increment, Axis.Labels.Separation and Axis.Label.Style methods.
There are three kind of ticks available: Ticks, MinorTicks and TicksInner.
You can show or hide any of them of have all of them Visible. Ticks.Length defines the length of Axis Ticks in logical pixels.
Tags:
method getTicksInner [line 859]
Determines the kind of Pen used to draw Axis marks along the Axis line.
This does the same as Ticks, but lines are drawn inside Chart boundaries instead. TicksInner position is calculated based on Axis.Increment, Axis.Labels.Separation and Axis.Label.Style.
There are three kind of ticks available: Ticks, MinorTicks and TicksInner.
You can show or hide any of them of have all of them Visible. TickInnerLength defines the length of Axis TicksInner in logical pixels.
Tags:
method getTitle [line 874]
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.
Tags:
method getTitleSize [line 894]
Obsolete. Please use Axis.<!-- -->Title.<!-- -->CustomSize
Tags:
method getVisible [line 914]
Shows or hides the Axis lines, ticks, grids, labels and title.
You can change it both at design and runtime.
Default $value: true
Tags:
method getZPosition [line 947]
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.
In 3D or orthogonal display modes, ZPosition controls where to display the axis line. It useful if you want to move axis to front or to back in 3D view.
Tags:
method incDecDateTime [line 2423]
void incDecDateTime(
$increment,
$value,
$anIncrement,
$tmpWhichDatetime)
|
|
Tags:
Parameters:
method internalCalcPositions [line 2563]
void internalCalcPositions(
)
|
|
Tags:
method internalCalcRange [line 294]
void internalCalcRange(
)
|
|
Internal use.
Tags:
method internalSetInverted [line 169]
void internalSetInverted(
$value)
|
|
Tags:
Parameters:
method isCustom [line 357]
Returns true if Axis is a Custom Axis
Tags:
method isDateTime [line 491]
Returns if the Axis dependent $values are DateTime or not.
Each Chart Axis can consider $values to be normal numbers or DateTime $values. An axis is "DateTime" if at least one Active Series with datetime $values is associated to it.
Default $value: false
Tags:
method maxLabelsWidth [line 1181]
Returns the maximum width in pixels of all Axis Labels.
Tags:
method readResolve [line 190]
method scroll [line 2630]
void scroll(
offset
$offset, checkLimits
$checkLimits)
|
|
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.
Tags:
Parameters:
method setAutomatic [line 238]
void setAutomatic(
boolean
$value)
|
|
Description Max and Min of axis scale based on associated Series.
Tags:
Parameters:
method setAutomaticMaximum [line 409]
void setAutomaticMaximum(
$value
$value)
|
|
The Axis adjusts the Maximum $value automatically based on the maximum $value of its associated Series when true.
Default $value: true
Tags:
Parameters:
method setAutomaticMinimum [line 432]
void setAutomaticMinimum(
$value
$value)
|
|
The Axis adjusts the Minimum $value automatically based on the maximum $value of its associated Series when true.
Default $value: true
Tags:
Parameters:
method setChart [line 2684]
method setEndPosition [line 1066]
void setEndPosition(
$value
$value)
|
|
Sets the Axis End Position on its own Axis expressed as a percentage.
Default $value: 100%
Tags:
Parameters:
method setGridCentered [line 976]
void setGridCentered(
$value
$value)
|
|
Obsolete. Please use Axis.<!-- -->Grid.<!-- -->Centered property
Tags:
Parameters:
method setHorizontal [line 262]
void setHorizontal(
$value
$value)
|
|
Sets a custom axis to be drawn horizontally.
Tags:
Parameters:
method setIncrement [line 524]
void setIncrement(
$value
$value)
|
|
Sets the minimum step between axis labels.
Tags:
Parameters:
method setInverted [line 554]
void setInverted(
$value
$value)
|
|
Swaps the Axis Minimum and Maximum scales when true.
Default $value: false
Tags:
Parameters:
method setLabelsOnAxis [line 478]
void setLabelsOnAxis(
$value
$value)
|
|
Obsolete. Please use Labels.<!-- -->OnAxis instead.
Tags:
Parameters:
method setLogarithmic [line 583]
void setLogarithmic(
$value
$value)
|
|
Scales the Axis Logarithmically when true.
Default $value: false
Tags:
Parameters:
method setLogarithmicBase [line 1084]
void setLogarithmicBase(
$value
$value)
|
|
Sets the base for the Logarithmic scale when Axis Logarithmic = true.
Tags:
Parameters:
method setMaximum [line 657]
void setMaximum(
$value
$value)
|
|
Sets the highest $value an Axis will use to scale their dependent Series posvalues.
Tags:
Parameters:
method setMaximumOffset [line 631]
void setMaximumOffset(
$value
$value)
|
|
Sets the amount of pixels that will be left as a margin at axis maximum position.
Default $value: 0
Tags:
Parameters:
method setMinAxisIncrement [line 681]
void setMinAxisIncrement(
$value
$value)
|
|
Advanced use. Determines the smallest Axis calculation increment.
Default $value: 1e-12
Tags:
Parameters:
method setMinimum [line 707]
void setMinimum(
$value
$value)
|
|
Sets the lowest $value an Axis will use to scale their dependent Series possvalues.
Tags:
Parameters:
method setMinimumOffset [line 731]
void setMinimumOffset(
$value
$value)
|
|
Determines the number of pixels that will be left as a margin at axis minimum position.
Default $value: 0
Tags:
Parameters:
method setMinMax [line 2666]
void setMinMax(
min
$min, max
$max)
|
|
Changes the current Axis Minimum and Maximum scales.
Axis.Automatic must be set to false.
Tags:
Parameters:
method setMinMaxDate [line 2655]
void setMinMaxDate(
minDate
$minDate, maxDate
$maxDate)
|
|
Changes the current Axis Minimum and Maximum scales.
Axis.Automatic must be set to false.
Tags:
Parameters:
method setMinorTickCount [line 754]
void setMinorTickCount(
$value
$value)
|
|
Determines the number of Axis minor ticks between major ticks.
Default $value: 3
Tags:
Parameters:
method setMinorTicks [line 773]
void setMinorTicks(
$value)
|
|
Tags:
Parameters:
method setOtherSide [line 287]
void setOtherSide(
$value
$value)
|
|
Sets the Axis labels to the Otherside of the axis.
Tags:
Parameters:
method setPositionUnits [line 1018]
void setPositionUnits(
$value
$value)
|
|
Determines the axis Position units (pixels or percentage).
Default $value: Percent
Tags:
Parameters:
method setRelativePosition [line 995]
void setRelativePosition(
$value
$value)
|
|
Determines the Axis position as percentage 0-100% of the Chart.
Tags:
Parameters:
method setStartPosition [line 1044]
void setStartPosition(
$value
$value)
|
|
Sets the Axis Start position on its own Axis expressed as a percentage.
Default $value: 0%
Tags:
Parameters:
method setTickOnLabelsOnly [line 818]
void setTickOnLabelsOnly(
$value
$value)
|
|
Sets the Axis Ticks and Axis Grid to be drawn to only coincide at Labels.
Default $value: true
Tags:
Parameters:
method setTicks [line 843]
method setTitle [line 885]
method setTitleSize [line 903]
void setTitleSize(
$value
$value)
|
|
Obsolete. Please use Axis.<!-- -->Title.<!-- -->CustomSize
Tags:
Parameters:
method setVisible [line 924]
void setVisible(
$value
$value)
|
|
Shows the Axis lines, ticks, grids, labels and title when true.
Default $value: true
Tags:
Parameters:
method setZPosition [line 957]
void setZPosition(
$value
$value)
|
|
Sets the Z axis position along chart Depth as a percentage of the total depth.
Tags:
Parameters:
method shouldSerializeHorizontal [line 244]
void shouldSerializeHorizontal(
)
|
|
Tags:
method shouldSerializeMaximum [line 601]
void shouldSerializeMaximum(
)
|
|
Tags:
method shouldSerializeMinimum [line 661]
void shouldSerializeMinimum(
)
|
|
Tags:
method shouldSerializeOtherSide [line 266]
void shouldSerializeOtherSide(
)
|
|
Tags:
method shouldSerializeZPosition [line 928]
void shouldSerializeZPosition(
)
|
|
Tags:
method titleOrName [line 1104]
method _draw [line 2527]
void _draw(
$g,
$calcPosAxis)
|
|
Tags:
Parameters:
method _drawAxisLabel [line 2037]
void _drawAxisLabel(
x
$x, y
$y,
$angle, st
$st, labelItem
$labelItem, angle
$Angle)
|
|
Draws Axis Label (String) at specified X,Y co-ordinate at Angle.
Tags:
Parameters:
method __draw [line 2587]
void __draw(
posLabels
$posLabels, posTitle
$posTitle, posAxis
$posAxis, gridVisible
$gridVisible)
|
|
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Tags:
Parameters:
method __get [line 93]
method __set [line 100]
void __set(
$property,
$value)
|
|
Overrides
TeeBase::__set() (parent method not documented)
Parameters:
method ___draw [line 2605]
void ___draw(
posLabels
$posLabels, posTitle
$posTitle, posAxis
$posAxis, gridVisible
$gridVisible, aStartPos
$aStartPos, aEndPos
$aEndPos)
|
|
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Tags:
Parameters:
method ____draw [line 2715]
void ____draw(
posLabels
$posLabels, posTitle
$posTitle, posAxis
$posAxis, gridVisible
$gridVisible, aMinimum
$aMinimum, aMaximum
$aMaximum, aStartPosition
$aStartPosition, aEndPosition
$aEndPosition)
|
|
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Tags:
Parameters:
method _____draw [line 2741]
void _____draw(
posLabels
$posLabels, posTitle
$posTitle, posAxis
$posAxis, gridVisible
$gridVisible, aMinimum
$aMinimum, aMaximum
$aMaximum, aIncrement
$aIncrement, aStartPos
$aStartPos, aEndPos
$aEndPos)
|
|
Displays an Axis at the specified screen positions with the current axis scales.
Main drawing method. Custom draw methods can be overloads.
Tags:
Parameters: