static method findDateTimeStep [line 1884]
static int findDateTimeStep(
step$value
$stepValue)
|
|
Used internally to return Axis Datetime step.
Tags:
Parameters:
constructor Axis [line 106]
Axis Axis(
[
$horiz = false], [
$isOtherSide = false], [
$chart = null])
|
|
The class constructor.
Tags:
Parameters:
method adjustMaxMin [line 298]
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 260]
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 1854]
void applyPosition(
$apos,
$r)
|
|
Parameters:
method calcLabelStyle [line 2458]
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 1067]
void calcMinMax(
tmp
$tmp)
|
|
Returns the minimum and maximum $values of the associated Series.
Tags:
Parameters:
method calcPosPoint [line 1332]
double calcPosPoint(
$value, $value
$Screen)
|
|
Returns the corresponding $value of a Screen position.
Tags:
Parameters:
method calcPosValue [line 1218]
Position calcPosValue(
$value
$value)
|
|
Returns the corresponding $value of a Screen position in pixels.
Tags:
Parameters:
method calcRect [line 1808]
Rectangle calcRect(
r
$r, inflateChartRectangle
$inflateChartRectangle)
|
|
Used internally by Chart when creating Axes
Tags:
Parameters:
method calcSizeValue [line 1306]
$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 1230]
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 1676]
double calcXYIncrement(
$maxLabelSize, maxLabelSize
$The)
|
|
Returns the calculated Axis Label increment.
Tags:
Parameters:
method calcYPosvalue [line 1258]
$Vertical calcYPosvalue(
$value
$value)
|
|
Calculates the Vertical coordinate in pixels of $value parameter.
Tags:
Parameters:
method calcZPos [line 1293]
method clicked [line 1414]
boolean clicked(
x
$x, y
$y)
|
|
Returns if X and Y coordinates are close to the Axis position.
Tags:
Parameters:
method dateTimeDefaultFormat [line 1493]
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 2388]
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 2478]
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 1984]
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 2308]
void drawTitle(
x
$x, y
$y)
|
|
TeeChart internal use. Outputs the title during the chart painting procedure.
Tags:
Parameters:
method getAutomatic [line 160]
Calculates Max and Min of axis scale based on associated Series.
Tags:
method getAutomaticMaximum [line 328]
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 351]
boolean getAutomaticMinimum(
)
|
|
Controls minimum $value automatically based on the minimum $value of its associated Series.
Default $value: true
Tags:
method getAxisPen [line 374]
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 1701]
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 151]
Returns the custom labels
Tags:
method getDepthAxisAlign [line 2285]
void getDepthAxisAlign(
)
|
|
Tags:
method getEndPosition [line 986]
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 387]
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 897]
boolean getGridCentered(
)
|
|
Obsolete. Please use Axis.<!-- -->Grid.<!-- -->Centered property
Tags:
method getHorizontal [line 183]
Determines the Custom axis to be drawn horizontally.
Tags:
method getIncrement [line 445]
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 474]
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 142]
Accesses the Label characteristics of Axis Labels.
Tags:
method getLabelsOnAxis [line 399]
boolean getLabelsOnAxis(
)
|
|
Obsolete. Please use Labels.<!-- -->OnAxis instead.
Tags:
method getLogarithmic [line 502]
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 1005]
double getLogarithmicBase(
)
|
|
The base for the Logarithmic scale when Axis Logarithmic = true.
Tags:
method getMaximum [line 577]
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 550]
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 1431]
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 1448]
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 601]
double getMinAxisIncrement(
)
|
|
Advanced use. Smallest Axis calculation increment.
Default $value: 1e-12
Tags:
method getMinimum [line 627]
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 650]
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 1024]
Characteristics of the Grid coincidental to Minor Ticks.
The Minor Grid.Visible is false as default.
Tags:
method getMinorTickCount [line 674]
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 694]
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 1465]
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 1482]
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 208]
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 711]
Obsolete. Please use Position instead.
Tags:
method getPosition [line 724]
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 938]
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 133]
method getRectangleEdge [line 1742]
void getRectangleEdge(
$r)
|
|
Parameters:
method getRelativePosition [line 916]
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 1174]
method getSizeTickAxis [line 1727]
method getStartPosition [line 963]
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 737]
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 763]
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 789]
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 804]
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 824]
Obsolete. Please use Axis.<!-- -->Title.<!-- -->CustomSize
Tags:
method getVisible [line 844]
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 877]
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 2359]
void incDecDateTime(
$increment,
$value,
$anIncrement,
$tmpWhichDatetime)
|
|
Tags:
Parameters:
method internalCalcPositions [line 2499]
void internalCalcPositions(
)
|
|
Tags:
method internalCalcRange [line 224]
void internalCalcRange(
)
|
|
Internal use.
Tags:
method internalSetInverted [line 99]
void internalSetInverted(
$value)
|
|
Tags:
Parameters:
method isCustom [line 287]
Returns true if Axis is a Custom Axis
Tags:
method isDateTime [line 421]
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 1111]
Returns the maximum width in pixels of all Axis Labels.
Tags:
method readResolve [line 120]
method scroll [line 2566]
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 168]
void setAutomatic(
boolean
$value)
|
|
Description Max and Min of axis scale based on associated Series.
Tags:
Parameters:
method setAutomaticMaximum [line 339]
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 362]
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 2620]
method setEndPosition [line 996]
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 906]
void setGridCentered(
$value
$value)
|
|
Obsolete. Please use Axis.<!-- -->Grid.<!-- -->Centered property
Tags:
Parameters:
method setHorizontal [line 192]
void setHorizontal(
$value
$value)
|
|
Sets a custom axis to be drawn horizontally.
Tags:
Parameters:
method setIncrement [line 454]
void setIncrement(
$value
$value)
|
|
Sets the minimum step between axis labels.
Tags:
Parameters:
method setInverted [line 484]
void setInverted(
$value
$value)
|
|
Swaps the Axis Minimum and Maximum scales when true.
Default $value: false
Tags:
Parameters:
method setLabelsOnAxis [line 408]
void setLabelsOnAxis(
$value
$value)
|
|
Obsolete. Please use Labels.<!-- -->OnAxis instead.
Tags:
Parameters:
method setLogarithmic [line 513]
void setLogarithmic(
$value
$value)
|
|
Scales the Axis Logarithmically when true.
Default $value: false
Tags:
Parameters:
method setLogarithmicBase [line 1014]
void setLogarithmicBase(
$value
$value)
|
|
Sets the base for the Logarithmic scale when Axis Logarithmic = true.
Tags:
Parameters:
method setMaximum [line 587]
void setMaximum(
$value
$value)
|
|
Sets the highest $value an Axis will use to scale their dependent Series posvalues.
Tags:
Parameters:
method setMaximumOffset [line 561]
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 611]
void setMinAxisIncrement(
$value
$value)
|
|
Advanced use. Determines the smallest Axis calculation increment.
Default $value: 1e-12
Tags:
Parameters:
method setMinimum [line 637]
void setMinimum(
$value
$value)
|
|
Sets the lowest $value an Axis will use to scale their dependent Series possvalues.
Tags:
Parameters:
method setMinimumOffset [line 661]
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 2602]
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 2591]
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 684]
void setMinorTickCount(
$value
$value)
|
|
Determines the number of Axis minor ticks between major ticks.
Default $value: 3
Tags:
Parameters:
method setMinorTicks [line 703]
void setMinorTicks(
$value)
|
|
Tags:
Parameters:
method setOtherSide [line 217]
void setOtherSide(
$value
$value)
|
|
Sets the Axis labels to the Otherside of the axis.
Tags:
Parameters:
method setPositionUnits [line 948]
void setPositionUnits(
$value
$value)
|
|
Determines the axis Position units (pixels or percentage).
Default $value: Percent
Tags:
Parameters:
method setRelativePosition [line 925]
void setRelativePosition(
$value
$value)
|
|
Determines the Axis position as percentage 0-100% of the Chart.
Tags:
Parameters:
method setStartPosition [line 974]
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 748]
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 773]
method setTitle [line 815]
method setTitleSize [line 833]
void setTitleSize(
$value
$value)
|
|
Obsolete. Please use Axis.<!-- -->Title.<!-- -->CustomSize
Tags:
Parameters:
method setVisible [line 854]
void setVisible(
$value
$value)
|
|
Shows the Axis lines, ticks, grids, labels and title when true.
Default $value: true
Tags:
Parameters:
method setZPosition [line 887]
void setZPosition(
$value
$value)
|
|
Sets the Z axis position along chart Depth as a percentage of the total depth.
Tags:
Parameters:
method shouldSerializeHorizontal [line 174]
void shouldSerializeHorizontal(
)
|
|
Tags:
method shouldSerializeMaximum [line 531]
void shouldSerializeMaximum(
)
|
|
Tags:
method shouldSerializeMinimum [line 591]
void shouldSerializeMinimum(
)
|
|
Tags:
method shouldSerializeOtherSide [line 196]
void shouldSerializeOtherSide(
)
|
|
Tags:
method shouldSerializeZPosition [line 858]
void shouldSerializeZPosition(
)
|
|
Tags:
method titleOrName [line 1034]
method _draw [line 2463]
void _draw(
$g,
$calcPosAxis)
|
|
Tags:
Parameters:
method _drawAxisLabel [line 1969]
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 2523]
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 85]
method __set [line 92]
void __set(
$property,
$value)
|
|
Overrides
TeeBase::__set() (parent method not documented)
Parameters:
method ___draw [line 2541]
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 2651]
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 2677]
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: