kchart

KDChartAxisParams Class Reference

#include <KDChartAxisParams.h>

Inherits QObject.

List of all members.


Detailed Description

access the chart axis parameters.

To be used in combination with the axis access methods in class KDChartParams.

See also:
KDChartParams.h

KDChartParams.cpp

Bundles all parameters of one axis including the type except the actual data displayed. Serializing an object of this type plus the data displayed is enough to be able to recreate the chart later.

Definition at line 132 of file KDChartAxisParams.h.


Public Types

enum  AxisType { AxisTypeUnknown, AxisTypeEAST, AxisTypeNORTH, AxisUP }
enum  AxisPos {
  AxisPosSTART = 0, AxisPosBottom = 0, AxisPosSagittal = 0, AxisPosSaggital = 0,
  AxisPosLeft = 1, AxisPosCircular = 1, AxisPosLowerRightEdge = 2, AxisPosTop = 3,
  AxisPosRight = 4, AxisPosLowerLeftEdge = 5, AxisPosAdditionalsSTART = 6, AxisPosBottom2 = 6,
  AxisPosLeft2 = 7, AxisPosLowerRightEdge2 = 8, AxisPosTop2 = 9, AxisPosRight2 = 10,
  AxisPosLowerLeftEdge2 = 11, AxisPosEND = 11
}
enum  AxisAreaMode { AxisAreaModeFixedSize, AxisAreaModeAutoSize, AxisAreaModeMinMaxSize }
enum  AxisCalcMode { AxisCalcLinear, AxisCalcLogarithmic }
enum  LabelsFromDataRow { LabelsFromDataRowYes, LabelsFromDataRowNo, LabelsFromDataRowGuess }
enum  ValueScale {
  ValueScaleNumerical = 0, ValueScaleSecond = 20, ValueScaleMinute = 30, ValueScaleHour = 40,
  ValueScaleDay = 50, ValueScaleWeek = 60, ValueScaleMonth = 70, ValueScaleQuarter = 80,
  ValueScaleYear = 90
}

Public Slots

void setAxisType (AxisType axisType)
AxisType axisType () const
static QString axisTypeToString (AxisType type)
static AxisType stringToAxisType (const QString &type)
static AxisPos basicAxisPos (uint pos)
void setAxisVisible (bool axisVisible)
bool axisVisible () const
void setAxisAreaMode (AxisAreaMode axisAreaMode)
AxisAreaMode axisAreaMode () const
static QString axisAreaModeToString (AxisAreaMode mode)
static AxisAreaMode stringToAxisAreaMode (const QString &type)
void setAxisAreaMin (int axisAreaMin)
int axisAreaMin () const
void setAxisUseAvailableSpace (int axisUseAvailableSpaceFrom, int axisUseAvailableSpaceTo)
int axisUseAvailableSpaceFrom () const
int axisUseAvailableSpaceTo () const
void setAxisAreaMax (int axisAreaMax)
int axisAreaMax () const
void setAxisArea (AxisAreaMode axisAreaMode, int axisAreaMin, int axisAreaMax)
void setAxisCalcMode (AxisCalcMode axisCalcMode)
AxisCalcMode axisCalcMode () const
static QString axisCalcModeToString (AxisCalcMode mode)
static AxisCalcMode stringToAxisCalcMode (const QString &type)
void setIsometricReferenceAxis (uint isoRefAxis)
uint isometricReferenceAxis () const
void setAxisTrueAreaSize (int axisTrueAreaSize)
int axisTrueAreaSize () const
void setAxisTrueAreaRect (const QRect &axisTrueAreaRect)
QRect axisTrueAreaRect () const
void setAxisLineVisible (bool axisLineVisible)
bool axisLineVisible () const
void setAxisLineWidth (int axisLineWidth)
int axisLineWidth () const
void setAxisTrueLineWidth (int axisTrueLineWidth)
int axisTrueLineWidth () const
void setAxisLineColor (QColor axisLineColor)
QColor axisLineColor () const
void setAxisShowFractionalValuesDelimiters (bool axisShowFractValDelim)
bool axisShowFractionalValuesDelimiters () const
void setAxisShowGrid (bool axisShowGrid)
bool axisShowGrid () const
void setAxisGridStyle (PenStyle axisGridStyle)
PenStyle axisGridStyle () const
void setAxisGridColor (QColor axisGridColor)
QColor axisGridColor () const
void setAxisGridLineWidth (int axisGridLineWidth)
int axisGridLineWidth () const
void setAxisShowSubDelimiters (bool axisShowSubDelimiters)
bool axisShowSubDelimiters () const
void setAxisGridSubStyle (PenStyle axisGridSubStyle)
PenStyle axisGridSubStyle () const
void setAxisGridSubColor (QColor axisGridSubColor)
QColor axisGridSubColor () const
void setAxisGridSubLineWidth (int axisGridSubLineWidth)
int axisGridSubLineWidth () const
void setAxisZeroLineColor (QColor axisZeroLineColor)
QColor axisZeroLineColor () const
void setAxisLabelsVisible (bool axisLabelsVisible)
bool axisLabelsVisible () const
void setAxisLabelsTouchEdges (bool axisLabelsTouchEdges)
bool axisLabelsTouchEdges () const
void setAxisLabelsFont (QFont axisLabelsFont, bool useFontSize)
QFont axisLabelsFont () const
void setAxisLabelsFontUseRelSize (bool axisLabelsFontUseRelSize)
bool axisLabelsFontUseRelSize () const
void setAxisLabelsFontRelSize (int axisLabelsFontRelSize)
int axisLabelsFontRelSize () const
void setAxisLabelsFontMinSize (int axisLabelsFontMinSize)
int axisLabelsFontMinSize () const
void setAxisLabelsDontShrinkFont (bool labelsDontShrinkFont)
bool axisLabelsDontShrinkFont () const
void setAxisLabelsDontAutoRotate (bool labelsDontAutoRotate)
bool axisLabelsDontAutoRotate () const
void setAxisLabelsRotation (int rotation)
int axisLabelsRotation () const
void setAxisLabelsColor (QColor axisLabelsColor)
QColor axisLabelsColor () const
void setAxisLabelsCalc (int divPow10=0, int digitsBehindComma=KDCHART_AXIS_LABELS_AUTO_DIGITS)
int axisLabelsDivPow10 () const
int axisLabelsDigitsBehindComma () const
void setAxisLabelsRadix (const QString &decimalPoint, const QString &thousandsPoint)
QString axisLabelsDecimalPoint () const
QString axisLabelsThousandsPoint () const
void setAxisLabelsNotation (KDChartEnums::NumberNotation notation)
KDChartEnums::NumberNotation axisLabelsNotation () const
void setAxisLabelsFormat (const QString &prefix="", const QString &postfix="", const int &totalLen=0, const QChar &padFill= ' ', const bool &blockAlign=true)
QString axisLabelsPrefix () const
QString axisLabelsPostfix () const
int axisLabelsTotalLen () const
QChar axisLabelsPadFill () const
bool axisLabelsBlockAlign () const
static QString labelsFromDataRowToString (LabelsFromDataRow mode)
static LabelsFromDataRow stringToLabelsFromDataRow (const QString &type)
void setAxisValues (bool axisSteadyValueCalc=true, const QVariant &axisValueStart=KDCHART_AXIS_LABELS_AUTO_LIMIT, const QVariant &axisValueEnd=KDCHART_AXIS_LABELS_AUTO_LIMIT, double axisValueDelta=KDCHART_AXIS_LABELS_AUTO_DELTA, int axisDigitsBehindComma=KDCHART_AXIS_LABELS_AUTO_DIGITS, int axisMaxEmptyInnerSpan=KDCHART_DONT_CHANGE_EMPTY_INNER_SPAN_NOW, LabelsFromDataRow takeLabelsFromDataRow=LabelsFromDataRowNo, int labelTextsDataRow=0, QStringList *axisLabelStringList=0, QStringList *axisShortLabelsStringList=0, int axisValueLeaveOut=KDCHART_AXIS_LABELS_AUTO_LEAVEOUT, ValueScale axisValueDeltaScale=ValueScaleNumerical)
void setAxisValueStartIsExact (bool isExactValue=true)
bool axisValueStartIsExact () const
void setAxisValueStart (const QVariant &axisValueStart)
QVariant axisValueStart () const
void setAxisValueEnd (const QVariant &axisValueEnd)
QVariant axisValueEnd () const
void setAxisValueDelta (const double axisValueDelta, ValueScale scale=ValueScaleNumerical)
double axisValueDelta () const
ValueScale axisValueDeltaScale () const
void setAxisValueLeaveOut (const int leaveOut)
int axisValueLeaveOut () const
void setAxisValuesDecreasing (bool valuesDecreasing=true)
bool axisValuesDecreasing () const
void setTrueAxisDeltaPixels (double nDeltaPixels)
double trueAxisDeltaPixels () const
void setTrueAxisLowHighDelta (double nLow, double nHigh, double nDelta)
double trueAxisLow () const
double trueAxisHigh () const
double trueAxisDelta () const
void setTrueAxisDtLowHighDeltaScale (QDateTime dtLow, QDateTime dtHigh, ValueScale dtDeltaScale)
void setTrueAxisDtLow (QDateTime dtLow)
void setTrueAxisDtHigh (QDateTime dtHigh)
void setTrueAxisDtScale (ValueScale scale)
QDateTime trueAxisDtLow () const
QDateTime trueAxisDtHigh () const
ValueScale trueAxisDtDeltaScale () const
void setAxisZeroLineStart (double x, double y)
double axisZeroLineStartX () const
double axisZeroLineStartY () const
void setAxisDtLowPos (double x, double y)
double axisDtLowPosX () const
double axisDtLowPosY () const
void setAxisDtHighPos (double x, double y)
double axisDtHighPosX () const
double axisDtHighPosY () const
void setAxisDigitsBehindComma (const int digits)
int axisDigitsBehindComma () const
void setAxisLabelsDateTimeFormat (const QString &format)
QString axisLabelsDateTimeFormat () const
void setAxisMaxEmptyInnerSpan (const int maxEmpty)
int axisMaxEmptyInnerSpan () const
void setLabelTextsFormDataRow (int row, LabelsFromDataRow mode)
LabelsFromDataRow axisLabelTextsFormDataRow () const
int labelTextsDataRow () const
void setAxisLabelStringLists (QStringList *axisLabelStringList, QStringList *axisShortLabelStringList, const QString &valueStart=QString::null, const QString &valueEnd=QString::null)
QStringList axisLabelStringList () const
uint axisLabelStringCount () const
QStringList axisShortLabelsStringList () const
uint axisShortLabelsStringCount () const
const QStringList * axisLabelTexts () const
void setAxisLabelTexts (const QStringList *axisLabelTexts)
void setAxisLabelTextsDirty (bool axisLabelTextsDirty)
bool axisLabelTextsDirty () const
void setAxisFirstLabelText (const QString &axisFirstLabelText=QString())
void setAxisLastLabelText (const QString &axisLastLabelText=QString())
QString axisFirstLabelText () const
QString axisLastLabelText () const
bool hasAxisFirstLabelText () const
bool hasAxisLastLabelText () const
void setAxisSteadyValueCalc (bool axisSteadyValueCalc)
bool axisSteadyValueCalc () const

Signals

void changed ()

Public Member Functions

 KDChartAxisParams ()
virtual ~KDChartAxisParams ()
KDChartAxisParamsoperator= (const KDChartAxisParams &R)

Static Public Member Functions

static void deepCopy (KDChartAxisParams &D, const KDChartAxisParams &R)

Friends

class KDChartParams
QTextStream & operator<< (QTextStream &s, const KDChartParams &p)
QTextStream & operator>> (QTextStream &s, KDChartParams &p)

Constructor & Destructor Documentation

KDChartAxisParams::KDChartAxisParams (  ) 

enum KDChartAxisParams::Axistype { AxisTypeUnknown, AxisTypeEAST, AxisTypeNORTH, AxisUP };

The axis type - the kind of the axis (x-, y- or z-axis).

  • AxisTypeEAST axis of abscisses, the so-called X-axis. In world coordinates this is the EAST axis as used on topographical maps. This axis normally is assigned to the 1st dimension of the represented data, to change this use KDChartAxesPainter::setAxisAssignment().
  • AxisTypeNORTH axis of ordinates, the so-called Y-axis. when are represented by the chart. In world coordinates this is the NORTH axis as used on topographical maps for 2-dimensional data, or the NORTH axis as used on bird's-eys views of buildings etc for 3-dimensional data, resp.. This axis normally is assigned to the 2nd dimension of the represented data.
  • AxisTypeUP axis of the 3rd dimension, the so-called Z-axis. In world coordinates this is the UP axis as used on bird's-eys views of buildings etc. This axis normally is assigned to the 3rd dimension of the represented data.
The following picture shows the default positions of the different axes:

  +-----------+
  /|           |
  n  +------------+                / |           |
  .  |            |               /  |           |
  NORTH, y .  |   2-dim.   |              /   |           |
  .  |            |             /    +-----------+
  .  |   chart    |            /    /           /  n
  .  |            |        n  +    /  3-dim.   /  .
  .  |            |        .  |   /           /  .  NORTH, y
  .  |            |  UP, z .  |  /  chart    /  .
  .  |            |        .  | /           /  .
  .  |            |        .  |/           /  .
  0  +------------+        0  +-----------+  .
  0
  0............n           0...........n
  EAST, x                  EAST, x
  

Note:
Normally you will not have to specify the AxisType since it will be set automatically in KDChartAxesPainter::setDefaultAxesTypes() called by c'tor of class KDChartAxesPainter
See also:
setAxisType, axisType, KDChartAxesPainter::setAxisAssignment() Constructor. Define default values:
  • do not show this axis at all,
  • use circa 100 per thousand of the printable area size for drawing this axis,
  • calc mode linear,
  • line is visible,
  • line width: 3 per mille of the printable area size
  • line color: black,
  • labels are visible,
  • labels font: helvetica
  • labels font size: 20 / 1000 of the printable area size
  • labels color: black,
  • this axis will be used for an ordinate
  • label value limits will be calculated automatically,

Definition at line 133 of file KDChartAxisParams.cpp.

KDChartAxisParams::~KDChartAxisParams (  )  [virtual]

Destructor.

Only defined to have it virtual.

Definition at line 224 of file KDChartAxisParams.cpp.


Member Function Documentation

void KDChartAxisParams::setAxisType ( AxisType  axisType  )  [slot]

Specifies the axis type.

The default is unknown (AxisTypeUnknown).

Note:
Normally you will not have to specify the AxisType since it will be set automatically in KDChartAxesPainter::setDefaultAxesTypes() called by c'tor of class KDChartAxesPainter
Parameters:
axisType the axis type to use
See also:
axisType, AxisType

Definition at line 240 of file KDChartAxisParams.cpp.

AxisType KDChartAxisParams::axisType (  )  const [inline, slot]

Returns:
the axis type configured in this params object.
See also:
setAxisType, AxisType

Definition at line 156 of file KDChartAxisParams.h.

QString KDChartAxisParams::axisTypeToString ( AxisType  type  )  [static, slot]

Converts the specified axis type enum to a string representation.

Parameters:
type the axis type enum to convert
Returns:
the string representation of the axis type enum

Definition at line 2877 of file KDChartAxisParams.cpp.

KDChartAxisParams::AxisType KDChartAxisParams::stringToAxisType ( const QString &  type  )  [static, slot]

Converts the specified string to an axis type enum value.

Parameters:
string the string to convert
Returns:
the axis type enum value

Definition at line 2899 of file KDChartAxisParams.cpp.

KDChartAxisParams::AxisPos KDChartAxisParams::basicAxisPos ( uint  pos  )  [static, slot]

enum KDChartAxisParams::AxisPos { AxisPosSTART = 0,

AxisPosBottom = 0, AxisPosSagittal = 0, // <-- for POLAR charts AxisPosLeft = 1, AxisPosCircular = 1, // <-- for POLAR charts AxisPosLowerRightEdge = 2,

AxisPosTop = 3, AxisPosRight = 4, AxisPosLowerLeftEdge = 5,

diese Markierung muss jeweils mitgepflegt werden, wenn AxisPos erweitert werden sollte. AxisPosAdditionalsSTART = 6,

AxisPosBottom2 = 6, AxisPosLeft2 = 7, AxisPosLowerRightEdge2 = 8,

AxisPosTop2 = 9, AxisPosRight2 = 10, AxisPosLowerLeftEdge2 = 11,

auch diese Markierung muss jeweils mitgepflegt werden, wenn AxisPos erweitert werden sollte. AxisPosEND = 11 };

Since the chart area is defined by subtracting the space consumed by the axes from the printable area there are two options that are mutually exclusive.

  • Define the chart by precisely specifying (in absolute or in relative numbers) how much space may be used by each axis. and/or define start and end values for the axes' labels.

-> This produces results that are comparable to each other since the chart will have an exactly fixed size and its position on the paper will remain the same even if the labels of its axes become wider or more narrow. Also the graphical representation of the date will be comparable since all your charts will use the same scale if you wish this.

  • Let the program calculate the chart layout based upon the kind of and width of the labels to be drawn at the axes. Also the program can calculate the labels for you and find the boundary values for start and end of the scale automatically. -> This will produce good looking results without you having to fiddle around with the settings. Unfortunately these charts will not allways be comparable to each other if the axes' labels change since both the size of the area reserved for the chart and the scaling of the scales will vary if the data values do so.

With KDChart both ways are possible, see hints given with setAxisAreaMode(), setAxisAreaMin() and setAxisAreaMax().

To optimize your results you might want to use setAxisLineWidth() and setAxisLabelsFontPointSize(): negative values will specify it in per thousand of the printable area size - producing a result looking fine even if the chart is printed at very large dimensions.

See also:
setAxisAreaMode, setAxisAreaMin, setAxisAreaMax

setAxisLineWidth(), setAxisLabelsFontPointSize()

setAxisLabelsLimitsAuto(), setAxisLabelsLimitsLow()

setAxisLabelsLimitsHeigh() The axis position. Use AxisPosBottom for X-axis and AxisPosLeft for traditional Y-axis. When showing 3-dimensional charts you may use AxisPosLowerRightEdge to have an Y-axis on the lower right side going into the 'depth' of the picture and a z-axis going 'upwards' at the left edge. The other, optional values (AxisPosRight, AxisPosTop and AxisPosLowerLeftEdge, resp.) could be used to show a second axis on the other side of the picture - useful in case you want to show two data sets in one chart, like two curves showing data sets sharing the same abscissa axis but having differently scaled ordinates. The additional values (AxisPosBottom2, AxisPosTop2 ..) may be used to specify composed charts having two ordinates at the same side of the drawing and the like...

These AxisPos values are used to specify which axis' settings are to be modified or retrieved, resp.

Note:
Use special values AxisPossagittal and AxisPosCircular to set delimiter/label/grid parameters for polar charts.
See also:
setAxisAreaMode, axisAreaMode, setAxisCalcMode, axisCalcMode

KDChartParams::setAxisParams, KDChartParams::axisParams The basic axis type.

Parameters:
pos the axis type to be analyzed
Returns:
the basic axis type (Bottom, Left, Top or Right)

Definition at line 358 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisVisible ( bool  axisVisible  )  [slot]

Specifies if the axis will be drawn.

The default is false.

Parameters:
axisVisible set true to make visible the respective axis.
See also:
axisVisible, AxisVisible

Definition at line 405 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisVisible (  )  const [slot]

Returns weither the axis will be drawn or not.

Returns:
if the axis is visible or not.
See also:
setAxisVisible, AxisVisible

Definition at line 417 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisAreaMode ( AxisAreaMode  axisAreaMode  )  [slot]

enum AxisAreaMode { AxisAreaModeFixedSize, AxisAreaModeAutoSize, AxisAreaModeMinMaxSize };

The axis size, determines how to calculate the size of area used by the axis - i.e. the width of left axis area (or the right one, resp.) or the height of the top axis area (or the bottom one, resp.).

  • AxisAreaModeFixedSize (default) value will be taken from AxisAreaMinSize() or AxisAreaMaxSize() - whichever returns the smaller value
  • AxisAreaModeAutoSize (default) will be calculated automatically based on the size of the labels to be drawn
  • AxisAreaModeMinMaxSize will be calculated automatically but bearing user defined limits in mind (this is not implemented yet)
See also:
setAxisAreaMode, axisAreaMode, AxisAreaMode

setAxisAreaMin, setAxisAreaMax, setAxisArea Specifies the axis size mode. The default is auto size (AxisAreaModeAutoSize).

Parameters:
axisAreaMode the way how to find out the size of the area where the axis shall be drawn.
See also:
axisAreaMode, AxisAreaMode

setAxisAreaMin, setAxisAreaMax, setAxisArea

Definition at line 453 of file KDChartAxisParams.cpp.

KDChartAxisParams::AxisAreaMode KDChartAxisParams::axisAreaMode (  )  const [slot]

Returns the axis size mode configured in this params object.

Returns:
the axis size mode configured in this params object.
See also:
setAxisAreaMode, AxisAreaMode, setAxisAreaMin, setAxisAreaMax

setAxisArea

Definition at line 468 of file KDChartAxisParams.cpp.

QString KDChartAxisParams::axisAreaModeToString ( AxisAreaMode  mode  )  [static, slot]

Converts the specified axis area mode enum to a string representation.

Parameters:
mode the axis area mode enum to convert
Returns:
the string representation of the mode enum

Definition at line 479 of file KDChartAxisParams.cpp.

KDChartAxisParams::AxisAreaMode KDChartAxisParams::stringToAxisAreaMode ( const QString &  type  )  [static, slot]

Converts the specified string to an axis area mode enum value.

Parameters:
string the string to convert
Returns:
the axis area mode enum value

Definition at line 499 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisAreaMin ( int  axisAreaMin  )  [slot]

Specifies the axis area minimum width (or height, resp.

).

Parameters:
axisAreaMin the axis area minimum width (or height, resp.) If value is negative, the absolute value is per thousand of the size of the printable area to be used. This will make the axis look the same even if scaled to very different size.
Note: It AxisAreaModeFixedSize is set the smaller value of axisAreaMax and axisAreaMin is used for the area size.

See also:
axisAreaMin, axisAreaMax, setAxisAreaMode, setAxisAreaMax

setAxisArea

Definition at line 525 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisAreaMin (  )  const [inline, slot]

Returns the axis area minimum width (or height, resp.

).

Returns:
the axis area minimum width (or height, resp.).
See also:
setAxisAreaMin, setAxisAreaMax, setAxisArea

Definition at line 210 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisUseAvailableSpace ( int  axisUseAvailableSpaceFrom,
int  axisUseAvailableSpaceTo 
) [slot]

Specifies how the axis will make use of the available space.

Use this function to specify how large the area of the axis will be and where it will be positioned.

Note:
This function is to be used for (vertical) ordinate axes only, available space usage specified for abscissa axes will be ignored.
example: setAxisUseAvailableSpace( 0, -499 ) will make the axis occupy the first half of the available space, so there could be a second axis (for chart #2 having the same x-axis as chart #1) using the remaining part of the available space, this one would be specified by setAxisUseAvailableSpace( -500, -1000 ).

See also the examples given with KDChartParams::setAdditionalChartType().

Parameters:
axisUseAvailableSpaceFrom the beginning offset of the space to be covered by this axis. Set this to 0 to have your axis start at the very beginning of the avaliable space - this is the default setting. Use negative values to specify an offset in per mil of the available space, or use positive values to specify it in pixels.
axisUseAvailableSpaceTo the ending offset of the space to be covered by this axis. Set this to -1000 (== 1000 per mille) to let the axis end at the very end of the available space, this is the default setting. to a smaller negative value to specify the percantage Use negative values to specify an offset in per mil of the available space, or use positive values to specify it in pixels.
See also:
axisUseAvailableSpaceFrom, axisUseAvailableSpaceTo

Definition at line 578 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisUseAvailableSpaceFrom (  )  const [inline, slot]

Returns the beginning offset of the space used by this axis in comparison to the available space that could be used by this axis.

See also:
setAxisUseAvailableSpace, axisUseAvailableSpaceTo

Definition at line 213 of file KDChartAxisParams.h.

int KDChartAxisParams::axisUseAvailableSpaceTo (  )  const [inline, slot]

Returns the ending offset of the space used by this axis in comparison to the available space that could be used by this axis.

See also:
setAxisUseAvailableSpace, axisUseAvailableSpaceFrom

Definition at line 214 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisAreaMax ( int  axisAreaMax  )  [slot]

Specifies the axis area maximum width (or height, resp.

).

Parameters:
axisAreaMax the axis area maximum width (or height, resp.) If value is negative, the absolute value is per thousand of the size of the printable area to be used. This will make the axis look the same even if scaled to very different size.
Note: If AxisAreaModeFixedSize is set the smaller value of axisAreaMax and axisAreaMin is used for the area size.

See also:
axisAreaMax, axisAreaMin, setAxisAreaMode, setAxisAreaMin

setAxisArea

Definition at line 621 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisAreaMax (  )  const [inline, slot]

Returns the axis area maximum width (or height, resp.

).

Returns:
the axis area maximum width (or height, resp.).
See also:
setAxisAreaMax, setAxisAreaMin, setAxisArea

Definition at line 216 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisArea ( AxisAreaMode  axisAreaMode,
int  axisAreaMin,
int  axisAreaMax 
) [slot]

Specifies the axis area size mode and the minimum and maximum width (or height, resp.

) of the area. This method is here for convenience, see setAxisAreaMode, setAreaMin and setAreaMax for details.

Note: Is AxisAreaModeFixedSize is set the smaller value of axisAreaMax and axisAreaMin is used for the area size.

Parameters:
axisAreaMode the way how to find out the size of the area where the axis shall be drawn.
axisAreaMin the axis area minimum width (or height, resp.)
axisAreaMax the axis area maximum width (or height, resp.)
See also:
setAxisAreaMode, setAxisAreaMin, setAxisAreaMax

Definition at line 650 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisCalcMode ( AxisCalcMode  axisCalcMode  )  [slot]

enum AxisCalcMode { AxisCalcLinear, AxisCalcLogarithmic }; The axis calculation mode.

See also:
setAxisCalcMode, axisCalcMode, AxisCalcMode Specifies the axis calculation mode. The default is linear calculation (AxisCalcLinear).
Note:
Specifying an AxisCalcLogarithmic calculation mode also results in the axis's label parameters being adjusted, in detail these settings will become valid:
  • steady-value-calculation mode is activated
  • automatic limit calculation will be set for the begin and the end of the axis
  • logarithmical step width will be calculated automatically: 0.001, 0.01, 0.1, 1, 10, ..
  • number of Digits shown behind the comma will be calculated automatically.
This is done by implicitely calling setAxisValues(), so you don't need to explicitely call that function, actually the following is what happens inside:

  if( AxisCalcLogarithmic == axisCalcMode )
  setAxisValues( true,
                 KDCHART_AXIS_LABELS_AUTO_LIMIT,
                 KDCHART_AXIS_LABELS_AUTO_LIMIT,
                 1.0,
                 KDCHART_AXIS_LABELS_AUTO_DIGITS );
  

You may override these setting by making an extra setAxisValues() call AFTER calling setAxisCalcMode( AxisCalcLogarithmic ).

Parameters:
axisCalcMode the axis calculation mode to be used.
See also:
axisCalcMode, AxisCalcMode

setAxisSteadyValueCalc

Definition at line 700 of file KDChartAxisParams.cpp.

AxisCalcMode KDChartAxisParams::axisCalcMode (  )  const [inline, slot]

Returns the axis calculation mode configured in this params object.

Returns:
the axis calculation mode configured in this params object.
See also:
setAxisCalcMode, AxisCalcMode

Definition at line 226 of file KDChartAxisParams.h.

QString KDChartAxisParams::axisCalcModeToString ( AxisCalcMode  mode  )  [static, slot]

Converts the specified axis calc mode enum to a string representation.

Parameters:
mode the axis calc mode enum to convert
Returns:
the string representation of the mode enum

Definition at line 726 of file KDChartAxisParams.cpp.

KDChartAxisParams::AxisCalcMode KDChartAxisParams::stringToAxisCalcMode ( const QString &  type  )  [static, slot]

Converts the specified string to an axis calc mode enum value.

Parameters:
string the string to convert
Returns:
the axis calc mode enum value

Definition at line 744 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setIsometricReferenceAxis ( uint  isoRefAxis  )  [slot]

Specifies another axis which this axis shall be isometric with.

Parameters:
isoRefAxis axis which this axis shall be isometric with.
Normally all axes' step widths are calculated independently from each other. By specifying a reference axis for one axis you make KDChart use the same scale for both axes.

For example to have the left axis using the same scale as the right axis you could invoke this:

  KDChartAxisParams pa(
  _p->axisParams( KDChartAxisParams::AxisPosLeft ) );
  pa.setIsometricReferenceAxis( KDChartAxisParams::AxisPosBottom );
  _p->setAxisParams( KDChartAxisParams::AxisPosLeft, pa );
  

These commands are equivalent to the following ones:

  KDChartAxisParams pa(
  _p->axisParams( KDChartAxisParams::AxisPosBottom ) );
  pa.setIsometricReferenceAxis( KDChartAxisParams::AxisPosLeft );
  _p->setAxisParams( KDChartAxisParams::AxisPosBottom, pa );
  

In any case both axes will use the same scale so - unless you are using more axes than these two ones - the resulting chart will be true to scale.

Note:
Use special value KDCHART_ALL_AXES if your chart has got more than two axes and all of them shall use the same scale, specifying this for one of the axes is enough, there is no need to set it several times.
Use special value KDCHART_NO_AXIS to undo any previous setting that was specified for this axis, this has to be called for any axis that was modified by previous calls.

See also:
isometricReferenceAxis

Definition at line 795 of file KDChartAxisParams.cpp.

uint KDChartAxisParams::isometricReferenceAxis (  )  const [inline, slot]

Returns which axis this axis shall be isometric with, this will be either the axis position - see KDChartAxisParams::AxisPos - or one of the special values KDCHART_ALL_AXES and KDCHART_NO_AXIS.

Returns:
which axis this axis shall be isometric with.
See also:
setIsometricReferenceAxis

Definition at line 230 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisTrueAreaSize ( int  axisTrueAreaSize  )  [inline, slot]

Specifies the true axis area width (or height, resp.

).

Parameters:
axisAreaMax the true axis area width (or height, resp.) as it was calculated and drawn. This is allways an absolute value.
Note:
Do not call this function unless you are knowing exactly what you are doing. setAxisTrueAreaSize is normally reserved for internal usage by methods calculating the area size based upon axisAreaMin and axisAreaMax. Thus the signal changed() is not sended here.
See also:
axisAreaMax, axisAreaMin, setAxisAreaMode, setAxisAreaMin

setAxisArea

Definition at line 231 of file KDChartAxisParams.h.

int KDChartAxisParams::axisTrueAreaSize (  )  const [inline, slot]

Returns the true axis area width (or height, resp.

) as calculated and drawn.

Returns:
the true axis area width (or height, resp.).
See also:
setAxisAreaMax, setAxisAreaMin, setAxisArea

Definition at line 232 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisTrueAreaRect ( const QRect &  axisTrueAreaRect  )  [inline, slot]

Specifies the true axis area rectangle.

Parameters:
axisAreaMax the true axis area rectangle as it was calculated and drawn.
Note:
Do not call this function unless you are knowing exactly what you are doing. setAxisTrueAreaRect is normally reserved for internal usage by methods calculating the area size based upon axisAreaMin and axisAreaMax. Thus the signal changed() is not sended here.
See also:
axisAreaMax, axisAreaMin, setAxisAreaMode, setAxisAreaMin

setAxisArea

Definition at line 233 of file KDChartAxisParams.h.

QRect KDChartAxisParams::axisTrueAreaRect (  )  const [inline, slot]

Returns the true axis area rectangle as calculated and drawn.

Returns:
the true axis area rectangle
See also:
setAxisAreaMax, setAxisAreaMin, setAxisArea

Definition at line 234 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLineVisible ( bool  axisLineVisible  )  [slot]

Specifies whether the axis line should be drawn.

Parameters:
axisLineVisible if true the line of this axis will be drawn.
See also:
axisLineVisible

Definition at line 916 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisLineVisible (  )  const [inline, slot]

Returns whether the axis line should be drawn.

Returns:
whether the axis line should be drawn.
See also:
setAxisLineVisible

Definition at line 236 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLineWidth ( int  axisLineWidth  )  [slot]

Specifies the axis line width.

Parameters:
axisLineWidth the axis line width. If value is negative, the absolute value is per thousand of the printable area size to be used. This will make the axis look the same even if scaled to very different size.
See also:
axisLineWidth

Definition at line 941 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisLineWidth (  )  const [inline, slot]

Returns the axis line width.

Returns:
the axis line width.
See also:
setAxisLineWidth

Definition at line 238 of file KDChartAxisParams.h.

void s KDChartAxisParams::setAxisTrueLineWidth ( int  axisTrueLineWidth  )  [inline, slot]

Specifies the actual axis line width, as calculated and drawn.

You may not use this internal function.

Parameters:
axisTrueLineWidth the actual axis line width, as calculated and drawn.
See also:
axisTrueLineWidth

Definition at line 239 of file KDChartAxisParams.h.

int KDChartAxisParams::axisTrueLineWidth (  )  const [inline, slot]

Returns the axis true line width, as calculated and drawn.

Returns:
the axis true line width, as calculated and drawn.
See also:
setAxisTrueLineWidth

Definition at line 240 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLineColor ( QColor  axisLineColor  )  [slot]

Specifies the axis line colour.

Parameters:
axisLineColor the axis line colour.
See also:
axisLineColor

Definition at line 984 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisLineColor (  )  const [inline, slot]

Returns the axis line colour.

Returns:
the axis line colour.
See also:
setAxisLineColor

Definition at line 242 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisShowFractionalValuesDelimiters ( bool  axisShowFracValDelim  )  [slot]

Specifies whether the delimiters should be drawn at the position for the fractional values.

Note:
This can be useful if you want to force only painting non fractional values on the axis and do not want the delimiters and grid lines to be drawn at the position where some fractional values (auto calculation) were meant to be displayed. It will have no effect in case fractional values labels are painted. In order to force painting only non fractional values you need to call setAxisBehindDigitsComma(0).
Parameters:
axisShowFracValDelim if false delimiters and grid line will not be drawn on this axis at the positon where fractional values were meant to be drawn.
See also:
setAxisDigitBehindComma

Definition at line 895 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisShowGrid ( bool  axisShowGrid  )  [slot]

Specifies whether a grid should be drawn at the chart data area.

By default the grid will be drawn based on the left ordinate axis and on the bottom abscissa axis.

The grid will show a solid line for each delimiter. (or a line with a pattern defined by setAxisGridStyle, resp.)

Note:
If true and axisShowSubDelimiters is also true the grid will show a thin dotted line for each sub-delimiter. (or a line with a pattern defined by setAxisGridSubStyle, resp.)
Parameters:
axisShowGrid if true a grid will be drawn on the chart data area.
See also:
axisShowGrid, setAxisGridStyle, setAxisGridSubStyle

Definition at line 1014 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisShowGrid (  )  const [inline, slot]

Returns whether a grid should be drawn at the chart data area.

Returns:
whether a grid should be drawn at the chart data area.
See also:
setAxisShowGrid, setAxisShowSubDelimiters

Definition at line 247 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridStyle ( PenStyle  axisGridStyle  )  [slot]

Specifies the axis grid line pattern.

Parameters:
axisGridStyle the axis grid line pattern.
See also:
axisGridStyle, setAxisShowGrid

Definition at line 1154 of file KDChartAxisParams.cpp.

PenStyle KDChartAxisParams::axisGridStyle (  )  const [inline, slot]

Returns the axis grid line pattern.

Returns:
the axis grid line pattern.
See also:
setAxisGridStyle, setAxisShowGrid

Definition at line 249 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridColor ( QColor  axisGridColor  )  [slot]

Specifies the axis grid colour.

To reset the color to the built-in default value please call setAxisGridColor( KDCHART_DEFAULT_AXIS_GRID_COLOR )

Parameters:
axisGridColor the axis grid color.
See also:
axisGridColor, setAxisShowGrid

Definition at line 1039 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisGridColor (  )  const [inline, slot]

Returns the axis grid color.

Returns:
the axis grid color.
See also:
setAxisGridColor, setAxisShowGrid

Definition at line 251 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridLineWidth ( int  axisGridLineWidth  )  [slot]

Specifies the width of the axis grid lines.

Note:
Normally you would not call this function since grid lines in most cases look best in their default line width: the same width as the axis line they belong to. However when combining multiple datasets or multiple charts sharing the same abscissa axes but having their ordinates differently scaled you might want to reduce the line width of the respective grid lines and use different grid colours to show two grids at the same time. In such cases it might also be a good idea to deactivate setAxisShowSubDelimiters thus avoiding the dotted sub-grid lines or to set their style to Qt::NoPen to get sub-delimiters on the axis but no sub-grid lines.
You may use setAxisGridLineWidth( KDCHART_AXIS_GRID_AUTO_LINEWIDTH ) to reset the value to its default: being automatically adjusted to the width of the axis line.

Parameters:
axisGridLineWidth the width of the axis grid lines. If value is negative, the absolute value is per thousand of the printable area size to be used. This will make the grid look the same even if scaled to very different size.
See also:
axisGridLineWidth, setAxisGridColor, setAxisGridStyle

setAxisShowGrid, setAxisShowSubDelimiters

Definition at line 1106 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisGridLineWidth (  )  const [inline, slot]

Returns the width of the axis grid lines.

(see explanation given with setAxisGridLineWidth )

Returns:
the width of the axis grid lines.
See also:
setAxisGridLineWidth, setAxisShowGrid

Definition at line 253 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisShowSubDelimiters ( bool  axisShowSubDelimiters  )  [slot]

Specifies whether the axis sub-delimiters should be drawn.

Note:
If true and axisShowGrid is also true the grid on the chart data area will show a thin dotted line for each sub-delimiter (or a line with a pattern defined by setAxisGridSubStyle, resp.)
Parameters:
axisShowSubDelimiters if true sub-delimiters will be drawn at this axis.
See also:
axisShowSubDelimiters, setAxisShowGrid, setAxisGridSubStyle

Definition at line 876 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisShowSubDelimiters (  )  const [inline, slot]

Returns whether the axis sub-delimiters will be drawn.

Returns:
whether the axis sub-delimiters will be drawn.
See also:
setAxisShowSubDelimiters

Definition at line 256 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridSubStyle ( PenStyle  axisGridSubStyle  )  [slot]

Specifies the axis grid line pattern for the thin lines showing the sub-delimiter values.

Parameters:
axisGridStyle the axis grid line pattern for the thin lines showing the sub-delimiter values.
See also:
axisGridSubStyle, setAxisGridStyle, axisGridStyle

setAxisShowGrid

Definition at line 1178 of file KDChartAxisParams.cpp.

PenStyle KDChartAxisParams::axisGridSubStyle (  )  const [inline, slot]

Returns the axis grid line pattern for the thin lines showing the sub-delimiter values.

Returns:
the axis grid line pattern for the thin lines showing the sub-delimiter values.
See also:
setAxisGridSubStyle

setAxisGridStyle, axisGridStyle, setAxisShowGrid

Definition at line 258 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridSubColor ( QColor  axisGridSubColor  )  [slot]

Specifies the colour to be used for the thin lines between the normal axis grid lines.

To reset the color to the built-in default value please call setAxisGridSubColor( KDCHART_DEFAULT_AXIS_GRID_COLOR )

Parameters:
axisGridSubColor the axis grid sub color.
See also:
axisGridSubColor, setAxisGridColor, setAxisShowGrid, setAxisShowSubDelimiters

Definition at line 1064 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisGridSubColor (  )  const [inline, slot]

Returns the axis grid sub color.

Returns:
the axis grid sub color.
See also:
setAxisGridSubColor

Definition at line 260 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisGridSubLineWidth ( int  axisGridSubLineWidth  )  [slot]

Specifies the width of the thin lines between the normal axis grid lines.

You may use setAxisGridSubLineWidth( KDCHART_AXIS_GRID_AUTO_LINEWIDTH ) to reset the value to its default: being automatically adjusted to the width of the axis line.

Parameters:
axisGridSubLineWidth the axis grid sub line width.
See also:
axisGridSubLineWidth, setAxisGridLineWidth, setAxisShowGrid, setAxisShowSubDelimiters

Definition at line 1132 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisGridSubLineWidth (  )  const [inline, slot]

Returns the axis grid sub line width.

Returns:
the axis grid sub line width.
See also:
setAxisGridSubLineWidth

Definition at line 262 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisZeroLineColor ( QColor  axisZeroLineColor  )  [slot]

Specifies the colour of the zero-line that is drawn if zero is not at the lower edge of the chart.

Parameters:
axisZeroLineColor the zero-line colour.
See also:
axisZeroLineColor

Definition at line 1203 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisZeroLineColor (  )  const [inline, slot]

Returns the colour used for the zero-value line that is drawn if zero is not at the lower edge of the chart.

Returns:
the zero-line colour.
See also:
setAxisZeroLineColor

Definition at line 265 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsVisible ( bool  axisLabelsVisible  )  [slot]

Specifies whether the axis labels should be drawn.

Parameters:
axisLabelsVisible if true the labels of this axis will be drawn.
See also:
axisLabelsVisible

Definition at line 1226 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisLabelsVisible (  )  const [inline, slot]

Returns whether the axis labels should be drawn.

Returns:
whether the axis labels should be drawn.
See also:
setAxisLabelsVisible

Definition at line 268 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsTouchEdges ( bool  axisLabelsTouchEdges  )  [slot]

Specifies whether the axis labels start and end at the edges of the charts instead being positioned in the middle of the first data point (or the last one, resp.

)

Parameters:
axisLabelsTouchEdges if the axis labels start and end at the edges of the charts instead being positioned in the middle of the first data point (or the last one, resp.)
See also:
axisLabelsTouchEdges

Definition at line 1266 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisLabelsTouchEdges (  )  const [inline, slot]

Returns whether the axis labels start and end at the edges of the charts instead being positioned in the middle of the first data point (or the last one, resp.

)

Returns:
whether the axis labels start and end at the edges of the charts instead being positioned in the middle of the first data point (or the last one, resp.)
See also:
setAxisLabelsTouchEdges

Definition at line 270 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsFont ( QFont  axisLabelsFont,
bool  useFontSize 
) [slot]

Specifies the axis labels font.

Note:
The font size will be ignored if useFontSize is false, in this case the font size will be calculated dynamically using the value stored by you calling setAxisLabelsFontRelSize().
Parameters:
axisLabelsFont the font to be used for the axis' labels.
useFontSize set ti true if the fixed font size of the axisLabelsFont is to be used, otherwise the font size will be calculated dynamically.
See also:
setAxisLabelsFontRelSize, setAxisLabelsFontUseRelSize

axisLabelsFont, axisLabelsFontRelSize

Definition at line 1299 of file KDChartAxisParams.cpp.

QFont KDChartAxisParams::axisLabelsFont (  )  const [inline, slot]

Returns the axis labels font.

Returns:
the axis labels font.
See also:
setAxisLabelsFont, setAxisLabelsFontRelSize

axisLabelsFontRelSize

Definition at line 272 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsFontUseRelSize ( bool  axisLabelsFontUseRelSize  )  [slot]

Specifies whether axis labels shall be drawn using relative font size.

Parameters:
axisLabelsFontUseRelSize whether axis labels shall be drawn using relative font size. If true the absolute value of the value set by setAxisLabelsFontRelSize is per thousand of of the printable area size to be used. This will make the axis look the same even if scaled to very different size.
See also:
setAxisLabelsFontRelSize, setAxisLabelsFont

Definition at line 1328 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisLabelsFontUseRelSize (  )  const [inline, slot]

Returns whether the fix axis font size is used.

Returns:
whether the fix axis labels font size is used.
See also:
setAxisLabelsFontRelSize, setAxisLabelsFont

Definition at line 274 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsFontRelSize ( int  axisLabelsFontRelSize  )  [slot]

Specifies the axis labels relative font size.

Parameters:
axisLabelsFontRelSize the relative axis font size. If this value unequals zero the absolute value is per thousand of the printable area width size to be used. This will make the axis look the same even if scaled to very different size.
See also:
setAxisLabelsFontUseRelSize, setAxisLabelsFont

Definition at line 1354 of file KDChartAxisParams.cpp.

int KDChartAxisParams::axisLabelsFontRelSize (  )  const [inline, slot]

Returns the axis labels relative font size.

Returns:
the axis labels relative font size.
See also:
setAxisLabelsFontRelSize, setAxisLabelsFontUseRelSize

Definition at line 276 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsFontMinSize ( int  axisLabelsFontMinSize  )  [inline, slot]

Specifies the minimal font size to be used for displaying the axis labels.

Use this to specify the minimal font size to be used for axis labels, in case KD Chart is calculating the axis labels fonts dynamically. Default value is 10 points.

See also:
setAxisLabelsFont, setAxisLabelsFontUseRelSize, setAxisLabelsFontRelSize

Definition at line 277 of file KDChartAxisParams.h.

bool KDChartAxisParams::axisLabelsDontShrinkFont (  )  const [inline, slot]

Specifies whether the axis labels' font size may be shrinked to avoid overwriting neighboring areas.

See also:
axisLabelsDontShrinkFont

setAxisLabelsDontAutoRotate, setAxisLabelsRotation

setAxisLabelsFontUseRelSize, setAxisLabelsFont

Definition at line 280 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsDontAutoRotate ( bool  labelsDontAutoRotate  )  [inline, slot]

Specifies whether the axis labels may be rotated to avoid overwriting neighboring areas.

See also:
axisLabelsDontAutoRotate

setAxisLabelsDontShrinkFont, setAxisLabelsRotation

setAxisLabelsFontUseRelSize, setAxisLabelsFont

Definition at line 281 of file KDChartAxisParams.h.

bool KDChartAxisParams::axisLabelsDontAutoRotate (  )  const [inline, slot]

Returns whether the axis labels may not be rotated to avoid overwriting neighboring areas.

Returns:
whether the axis labels may not be rotated to avoid overwriting neighboring areas.
See also:
setAxisLabelsDontAutoRotate

axisLabelsDontShrinkFont, setAxisLabelsRotation

setAxisLabelsFontRelSize, setAxisLabelsFont

Definition at line 282 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsRotation ( int  rotation  )  [inline, slot]

Specifies by how many degrees the axis labels shall be rotated.

Parameters:
rotation The rotation of the labels - value must be either zero or between 360 and 270. 360 degrees means don't rotate.
Note:
This setting specifies the minimum rotation of the labels. Rotation may be increased to fit labels into available space unless you explicitely called the setAxisLabelsDontAutoRotate() function.
See also:
axisLabelsDontAutoRotate

setAxisLabelsDontShrinkFont, setAxisLabelsRotation

setAxisLabelsFontUseRelSize, setAxisLabelsFont

Definition at line 283 of file KDChartAxisParams.h.

int KDChartAxisParams::axisLabelsRotation (  )  const [inline, slot]

Returns by how many degrees the axis labels will be rotated.

See also:
setAxisLabelsDontAutoRotate

axisLabelsDontShrinkFont, setAxisLabelsRotation

setAxisLabelsFontRelSize, setAxisLabelsFont

Definition at line 284 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsColor ( QColor  axisLabelsColor  )  [slot]

Specifies the axis labels colour.

Parameters:
axisLabelsColor the axis labels colour.
See also:
axisLabelsColor

Definition at line 1437 of file KDChartAxisParams.cpp.

QColor KDChartAxisParams::axisLabelsColor (  )  const [inline, slot]

Returns the axis labels colour.

Returns:
the axis labels colour.
See also:
setAxisLabelsColor

Definition at line 286 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsCalc ( int  divPow10 = 0,
int  digitsBehindComma = KDCHART_AXIS_LABELS_AUTO_DIGITS 
) [slot]

Specifies the calculations to be applied to the axis labels.

Parameters:
divPow10 The power of 10 which the data value is to be divided by. A value of 2 means divide by 100, a value of -3 means multiply by 1000, and 0 (by definition) would result in multiplying by 1.
digitsBehindComma The number of digits to show behind the comma, to have this calculated automatically just use the default value KDCHART_DATA_VALUE_AUTO_DIGITS.
See also:
setAxisLabelsFormat

setAxisLabelsNotation

axisLabelsDivPow10, axisLabelsDigitsBehindComma

Definition at line 1464 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisLabelsRadix ( const QString &  decimalPoint,
const QString &  thousandsPoint 
) [slot]

Specifies the way how the axis label strings will be formatted.

Will be ignored for non-numerical axis labels.

Parameters:
decimalPoint The 'radix character' (or text, resp.) to be inserted into the string (default is '.').
thousandsPoint The character (or text, resp.) to be used as delimiter between the hundred digit and the thousand digit and between the 100.000 and the 1.000.000 digit (default is ',').
See also:
setAxisLabelsFormat, setAxisLabelsCalc

setAxisLabelsNotation

axisLabelsDecimalPoint, axisLabelsThousandsPoint

Definition at line 1485 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisLabelsNotation ( KDChartEnums::NumberNotation  notation  )  [slot]

Specifies the way how the number part of the axis label strings will be formatted.

Will be ignored for non-numerical axis labels.

Parameters:
notation The way of notation to be used for the number part.
Note:
If you need exponential notation with a common magnitude, just use setAxisLabelsCalc to declare the divisor, and then add a KDChartCustomBox to the end of your axis's area, informing the user about the magnitude to be added to each of the values, e.g. by saying "x 1e3".
See also:
KDChartEnums::NumberNotation, setAxisLabelsCalc, setAxisLabelsRadix, setAxisLabelsFormat

Definition at line 1506 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisLabelsFormat ( const QString &  prefix = "",
const QString &  postfix = "",
const int &  totalLen = 0,
const QChar &  padFill = ' ',
const bool &  blockAlign = true 
) [slot]

Specifies the way how the axis label strings will be formatted.

Will be ignored for non-numerical axis labels.

Parameters:
prefix The character (or text, resp.) to be prepended before the string after inserting the decimalPoint and the thousandsPoint.
postfix The character (or text, resp.) to be appended to the string after adding decimalPoint, thousandsPoint, prefix.
totalLen The forced size of the string after adding decimalPoint, thousandsPoint, prefix, postfix. If this parameter is set to zero (default) no padding will be performed. If the string has more characters than the (non-zero) value of totalLen, the respective number of characters will be cut off at the right side.
padFill The padding character to be prepended before the string (or inserted into the string, resp.) when increasing its length until the totalLen is reached.
blockAlign If set to true (default) the padFill character(s) will be inserted between the number and the prefix, if set to false they will be prepended before the prefix.
See also:
setAxisLabelsRadix, setAxisLabelsCalc

setAxisLabelsNotation

axisLabelsPrefix, axisLabelsPostfix, axisLabelsTotalLen

axisLabelsPadFill, axisLabelsBlockAlign

Definition at line 1535 of file KDChartAxisParams.cpp.

QString KDChartAxisParams::labelsFromDataRowToString ( LabelsFromDataRow  mode  )  [static, slot]

enum LabelsFromDataRow { LabelsFromDataRowYes, LabelsFromDataRowNo, LabelsFromDataRowGuess };

Are the axis labels stored in a data row? If LabelsFromDataRowGuess we assume yes only if all the entries of that data row contain strings - no numbers.

  • LabelsFromDataRowYes = label texts are to be taken from data row
  • LabelsFromDataRowNo = do not take label texts from data row
  • LabelsFromDataRowGuess = take label texts from data row if all entries in that row are strings (no numerical values!)
See also:
setAxisValues, setAxisValueStart, setAxisValueEnd, setAxisValueDelta

setLabelTextsFormDataRow

axisLabelTextsFormDataRow Converts the specified labels from data row enum to a string representation.

Parameters:
mode the enum to convert
Returns:
the string representation of the mode enum

Definition at line 1577 of file KDChartAxisParams.cpp.

KDChartAxisParams::LabelsFromDataRow KDChartAxisParams::stringToLabelsFromDataRow ( const QString &  type  )  [static, slot]

Converts the specified string to a data row enum value.

Parameters:
string the string to convert
Returns:
the data row mode enum value

Definition at line 1597 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisValues ( bool  axisSteadyValueCalc = true,
const QVariant &  axisValueStart = KDCHART_AXIS_LABELS_AUTO_LIMIT,
const QVariant &  axisValueEnd = KDCHART_AXIS_LABELS_AUTO_LIMIT,
double  axisValueDelta = KDCHART_AXIS_LABELS_AUTO_DELTA,
int  axisDigitsBehindComma = KDCHART_AXIS_LABELS_AUTO_DIGITS,
int  axisMaxEmptyInnerSpan = KDCHART_DONT_CHANGE_EMPTY_INNER_SPAN_NOW,
LabelsFromDataRow  takeLabelsFromDataRow = LabelsFromDataRowNo,
int  labelTextsDataRow = 0,
QStringList *  axisLabelStringList = 0,
QStringList *  axisShortLabelsStringList = 0,
int  axisValueLeaveOut = KDCHART_AXIS_LABELS_AUTO_LEAVEOUT,
ValueScale  axisValueDeltaScale = ValueScaleNumerical 
) [slot]

enum ValueScale { ValueScaleNumerical = 0, ( have gaps here to allow specifying of additional scaling steps in between ) ValueScaleSecond = 20, ValueScaleMinute = 30, ValueScaleHour = 40, ValueScaleDay = 50, ValueScaleWeek = 60, ValueScaleMonth = 70, ValueScaleQuarter = 80, ValueScaleYear = 90 };

Are axis labels scaled mumerically or fixing a time period? If ValueScaleNumerical axis labels are just numbers like "item 1", "item 2"...

  • ValueScaleSecond = seconds
  • ValueScaleMinute = minutes ..
  • ValueScaleYear = years
See also:
setAxisValues, setAxisValueStart, setAxisValueEnd, setAxisValueDelta

setLabelTextsFormDataRow

axisLabelTextsFormDataRowNote: The following text is to become part of the setAxisValues() doku you see below. It shall be added once the automatic string support has been added!

Currently the following strings are supported by the automatical numbering feature. (These strings are implemented for your convenience, you may specify any other set of label texts by passing a QStringList pointer to axisLabelStringList.)

  • Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
  • January, February, March, May, June, July, August, September, October, November, December
  • Spring, Summer, Autumn, Winter
...

To specify the start value and the way the label values are calculated you may

  • either pass one of the above strings as start value
    In this case the label texts will be taken from the respective list restarting at the beginnig whenever the end is reached.
    In case you specify a non-zero integer value for axisValueDelta the width and direction of steps will be performed accordingly:
    A value of 1.0 (specifying a step-length of 1 ) will cause every entry to be taken.
    A 4.0 would take the start entry, skip 3 entries, take the 4th entry and so forth...
    By using negative numbers you can specify backward stepping.
    (Of course all non-integer values will be ignored here.) General axis texts setup routine.
    Specifies how the axis limits shall be calculated and specifies the lower and the upper limit, the step-width and the list of strings (if such is to be used).
Note:
Start and end values are KDChartData so you may either specify numerical data or pass a string.
However if passing a string make sure to also specify a valid QStringList* for axisLabelStringList. In that case it could be wise to also also specify a second QStringList* for axisShortLabelsStringsList to be used in case the axes area is not wide enough to display the label texts in their full length.

To specify the start value and the way the label values are calculated you may

  • either pass a string as start value
    In this case the label texts will be taken from the string list passed to the function via axisLabelStringList starting with the string you specified as start value and restarting at the beginnig whenever the end is reached. In case the start value is not contained in the axisLabelStringList list it will be ignored and labelling will be done as if you had specified KDCHART_AXIS_LABELS_AUTO_LIMIT as start value (see below).
    In case you specify a non-zero integer value for axisValueDelta the width and direction of steps will be performed accordingly:
    A value of 1.0 (specifying a step-length of 1 ) will cause every entry of the list to be taken.
    A 4.0 would take the start entry, skip 3 entries, take the 4th entry and so forth...
    By using negative numbers you can specify backward stepping.
    (Of course all non-integer values will be ignored here.)
  • or pass KDCHART_AXIS_LABELS_AUTO_LIMIT as start value
    In this case the first label text
    either will be calculated based upon the lowest value of the associated datasets row number labelTextsDataRow if axisLabelsFromDataRow is set to true,
    or the first entry of the texts list will be taken if axisLabelStringList is set properly,
    otherwise it will be set to "1".
  • or pass a numerical value as start value
    In this case the first label text will be set to that value.
    In either case (KDCHART_AXIS_LABELS_AUTO_LIMIT or numerical value) the axisValueDelta may be used to specify the value to be added to obtain the next values:
    A value of 1.0 will cause 1.0 to be added to the current value to make the next value.
    A -0.25 would cause 0.25 to be subtracted from the current value.
    (Negative or non-integer numbers are allowed here.)

Examples:

setAxisValues();
This would specify a default ordinate-axis obtaining its values from the attached dataset. Looks nice but it is difficult to compare it to another chart representing slightly different min/max values since it neither starts at zero nor ends at an allways same value.

setAxisValues( true, KDChartData( 0.0 ) );
This would specify a half-automatical ordinate-axis obtaining its values from the attached dataset. Looks nice and can be slightly easier compared to another chart since it allways starts at zero, causing negative values to be ignored completely.

setAxisValues( true, KDChartData( -2.0 ),
        KDChartData(  7.5 ),
        0.5, 1 );
This would specify an ordinate-axis obtaining its values from the attached dataset. Since both the start value and the end value are specified the range of the dataset values are ignored completely. It will show one digit behind the comma. The resulting chart can be perfectly compared to another chart since it allways starts and ends at the very same level - no matter what the dataset values are about actually.

setAxisValues( false, KDChartData( 0.0 ),
        KDChartData( 3.5),
        0.25, 2 );
This would specify a default abscissa-axis starting with value 0.0 and adding 0.25 to get the next value, will count until 3.5. It will show two digits behind the comma.

setAxisValues( false,
        KDChartData( 1964.0 ), KDCHART_AXIS_LABELS_AUTO_LIMIT, 1, 0 );
This would specify a default abscissa-axis starting with value 1964 and adding 1 to get the next value. It will show no digits behind the comma.

KDChartParams p;
KDChartAxisParams pa( p.axisParams( KDChartAxisParams::AxisPosBottom ) );

QStringList abscissaNames;
abscissaNames << "Sunday" << "Monday" << "Tuesday" << "Wednesday"
<< "Thursday" << "Friday" << "Saturday";

QStringList abscissaShortNames;
abscissaShortNames << "Sun" << "Mon" << "Tue" << "Wed"
<< "Thu" << "Fri" << "Sat";

pa.setAxisValues( false,
        KDChartData( "Monday" ),
        KDCHART_AXIS_LABELS_AUTO_LIMIT,
        KDCHART_AXIS_LABELS_AUTO_DELTA,
        KDCHART_AXIS_LABELS_AUTO_DIGITS,
        KDChartAxisParams::LabelsFromDataRowNo,
        0,
        &abscissaNames,
        &abscissaShortNames );
p.setAxisParams( KDChartAxisParams::AxisPosBottom, pa );
This would specify a default abscissa-axis starting with 'Monday' and counting the days of the week as far as neccessary to represent all the entries in the associated dataset. Note this LabelsFromDataRowNo indicating that the texts are not to be taken from a data row and note &abscissaNames indicating the QStringList where to take the texts from instead. (In case the axis area is not wide enough to display the strings in their full length their counterparts stored in abscissaShortNames will be displayed instead.) Note also: The strings in those two QStringList are not copied into the KDChartAxisParams nor into the KDChartParams so please make sure the Lists are alive and valid till the end of the param objects. Otherwise you will not be able to display the texts.

Parameters:
axisSteadyValueCalc specifies whether label values shall be calculataed based upon the associated dataset values (normally this is true for ordinate axes) or based upon some string list (as you might expect it for abscissa labels).
axisValueStart specifies first label value to be written.
axisValueEnd specifies the last label value to be written.
axisValueDelta specifies the length of the steps to be taken from one label text to the next one.
axisDigitsBehindComma specifies how many digits are to be shown behind the axis label texts comma.
axisMaxEmptyInnerSpan specifies the percentage of the y-axis range that may to contain NO data entries, if - and only if - axisValueStart (or axisValueEnd, resp.) is set to KDCHART_AXIS_LABELS_AUTO_LIMIT. To prevent setAxisValues from changing the current setting you may specify KDCHART_DONT_CHANGE_EMPTY_INNER_SPAN_NOW here, to deactivate taking into account the inner span entirely just use KDCHART_AXIS_IGNORE_EMPTY_INNER_SPAN.
takeLabelsFromDataRow specifies whether the labels texts shall be taken from a special row (reserved for this in each dataset) or not.
axisLabelStringList points to a QStringList containing the label texts to be used.
axisShortLabelsStringList points to a QStringList containing the label texts to be used in case their full-size counterparts cannot be shown due to limited axis area size.
axisValueLeaveOut is used for horizontal (top or bottom) axes only; it specifies whether some of the axis labels are to be skipped if there is not enough room for drawing them all without overlapping - this parameter may be set to KDCHART_AXIS_LABELS_AUTO_LEAVEOUT or to zero or to another positive value.
axisValueDeltaScale is used to specify the scaling mode of axisValueDelta - either just ValueScaleNumbers of a special time scale indicator.
See also:
setAxisValueStart, setAxisValueEnd, setAxisValueDelta, setAxisValuesDecreasing

axisValueStart axisValueEnd, axisValueDelta, ValueScale

LabelsFromDataRow, axisLabelTextsFormDataRow, axisLabelTexts

axisSteadyValueCalc, setAxisValueLeaveOut

Definition at line 1853 of file KDChartAxisParams.cpp.

KDChartData KDChartAxisParams::axisValueStart (  )  const [inline, slot]

Returns the lower limit for the axis labels: the start value.

Returns:
the lower limit for the axis labels: the start value.
See also:
setAxisValues, setAxisValueStart, setAxisValueStartIsExact

setAxisValueEnd, setAxisValueDelta

axisValueEnd, axisValueDelta

axisLabelsFromDataRow, axisLabelTexts

axisLabelStringList, axisShortLabelsStringList

Definition at line 349 of file KDChartAxisParams.h.

KDChartData KDChartAxisParams::axisValueEnd (  )  const [inline, slot]

Returns the upper limit for the axis labels: the end value.

Returns:
the upper limit for the axis labels: the end value.
See also:
setAxisValues, setAxisValueStart, setAxisValueStartIsExact

setAxisValueEnd, setAxisValueDelta

axisValueStart, axisValueDelta

axisLabelsFromDataRow, axisLabelTexts

axisLabelStringList, axisShortLabelsStringList

Definition at line 351 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisValueDelta ( const double  axisValueDelta,
ValueScale  scale = ValueScaleNumerical 
) [slot]

Specifies the DELTA value for the axis labels: the distance between two labels.

Parameters:
axisValueDelta the DELTA value for the axis labels: the distance between two labels.
scale the scaling of the DELTA value
See also:
ValueScale

setAxisValues

setAxisValueStart, setAxisValueStartIsExact

setAxisValueEnd, setAxisValueDelta

axisValueStart, axisValueEnd, axisValueDelta

axisLabelsFromDataRow, axisLabelTexts

axisLabelStringList, axisShortLabelsStringList

Definition at line 2005 of file KDChartAxisParams.cpp.

double KDChartAxisParams::axisValueDelta (  )  const [inline, slot]

Returns the DELTA value for the axis labels: the distance between two labels.

Returns:
the DELTA value for the axis labels: the distance between two labels.
See also:
setAxisValueDelta

Definition at line 354 of file KDChartAxisParams.h.

ValueScale KDChartAxisParams::axisValueDeltaScale (  )  const [inline, slot]

Returns the DELTA value scaling mode for the axis labels.

See also:
setAxisValueDelta

Definition at line 355 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisValueLeaveOut ( const int  leaveOut  )  [inline, slot]

Specifies how many axis labels are to be skipped if there is not enough space for displaying all of them.

This is usefull in case you have lots of entries in one dataset.

See also:
setAxisValues

Definition at line 356 of file KDChartAxisParams.h.

int KDChartAxisParams::axisValueLeaveOut (  )  const [inline, slot]

Returns how many axis labels are to be skipped if there is not enough space for displaying all of them.

See also:
setAxisValueLeaveOut

Definition at line 357 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisValuesDecreasing ( bool  valuesDecreasing = true  )  [inline, slot]

Specifies whether axis values should be printed in reverted order: starting with the highest label and decreasing until the lowest label is reached.

Note:
This feature is supported for LINE charts only.
See also:
setAxisValues

Definition at line 358 of file KDChartAxisParams.h.

bool KDChartAxisParams::axisValuesDecreasing (  )  const [inline, slot]

Returns whether axis values should be printed in reverted order: starting with the highest label and decreasing until the lowest label is reached.

Note:
This feature is supported for LINE charts only.
See also:
setAxisValuesDecreasing

Definition at line 362 of file KDChartAxisParams.h.

void KDChartAxisParams::setTrueAxisDeltaPixels ( double  nDeltaPixels  )  [inline, slot]

Specifies the true axis pixel distance between two label delimiters.

Parameters:
nDeltaPixels the true value as it was calculated.
Note:
Do not call this function unless you are knowing exactly what you are doing. setTrueAxisDeltaPixels is normally reserved for internal usage by methods calculating the axis label texts. Thus the signal changed() is not sended here.
See also:
trueAxisDeltaPixels, trueAxisLow, trueAxisHigh, trueAxisDelta

setAxisArea

Definition at line 363 of file KDChartAxisParams.h.

double KDChartAxisParams::trueAxisDeltaPixels (  )  const [inline, slot]

Returns the true delimiter delta pixel value of the axis labels as is was calculated and set by setTrueAxisDeltaPixels.

Returns:
the true delimiter delta pixel value of the axis labels
See also:
setAxisValues

trueAxisLow, trueAxisHigh, trueAxisDelta

Definition at line 364 of file KDChartAxisParams.h.

void KDChartAxisParams::setTrueAxisLowHighDelta ( double  nLow,
double  nHigh,
double  nDelta 
) [slot]

Specifies the true axis lower and upper limit values of the axis and the exact Delta value between the axis delimiters.

Parameters:
nLow/nHigh/nDelta the true values as they were calculated.
Note:
Do not call this function unless you are knowing exactly what you are doing. setAxisTrueAreaSize is normally reserved for internal usage by methods calculating the axis label texts. Thus the signal changed() is not sended here.
See also:
trueAxisLow, trueAxisHigh, trueAxisDelta, trueAxisDeltaPixels

setAxisArea

Definition at line 2109 of file KDChartAxisParams.cpp.

double KDChartAxisParams::trueAxisLow (  )  const [inline, slot]

Returns the true start value of the ordinate axis labels as is was calculated and set by setTrueAxisLowHighDelta.

Returns:
the true lower limit of the axis labels
See also:
setAxisValues

trueAxisHigh, trueAxisDelta, trueAxisDeltaPixels

Definition at line 366 of file KDChartAxisParams.h.

double KDChartAxisParams::trueAxisHigh (  )  const [inline, slot]

Returns the true end value of the ordinate axis labels as is was calculated and set by setTrueAxisLowHighDelta.

Returns:
the true upper limit of the axis labels
See also:
setAxisValues

trueAxisLow, trueAxisDelta, trueAxisDeltaPixels

Definition at line 367 of file KDChartAxisParams.h.

double KDChartAxisParams::trueAxisDelta (  )  const [inline, slot]

Returns the true delta value of the ordinate axis labels as is was calculated and set by setTrueAxisLowHighDelta.

Returns:
the true delta value of the axis labels
See also:
setAxisValues

trueAxisLow, trueAxisHigh, trueAxisDeltaPixels

Definition at line 368 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisZeroLineStart ( double  x,
double  y 
) [slot]

Specifies the not-rounded screen positions where drawing of this axis zero line started.

You may not call this internal function - it is reserved for internal usage of methodes needing to know the zero-line offsets

Parameters:
Pt the not-rounded screen positions where drawing of this axis zero line started.
See also:
axisZeroLineStartX, axisZeroLineStartY

Definition at line 2201 of file KDChartAxisParams.cpp.

double KDChartAxisParams::axisZeroLineStartX (  )  const [inline, slot]

Returns the not-rounded x-position where drawing of this axis zero line started.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded x-position where drawing of this axis zero line started.
See also:
setAxisZeroLineStart, axisZeroLineStartY

Definition at line 378 of file KDChartAxisParams.h.

double KDChartAxisParams::axisZeroLineStartY (  )  const [inline, slot]

Returns the not-rounded y-position where drawing of this axis zero line started.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded y-position where drawing of this axis zero line started.
See also:
setAxisZeroLineStart, axisZeroLineStartX

Definition at line 379 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisDtLowPos ( double  x,
double  y 
) [slot]

Specifies the not-rounded screen positions where drawing of this axis low date/time value could be done.

You may not call this internal function - it is reserved for internal usage of methodes needing to know the zero-line offsets

Parameters:
Pt the not-rounded screen positions where drawing of this axis low date/time value could be done.
See also:
axisDtLowPosX, axisDtLowPosY

Definition at line 2243 of file KDChartAxisParams.cpp.

double void KDChartAxisParams::axisDtLowPosX (  )  const [inline, slot]

Returns the not-rounded x-position where drawing of this axis low date/time value could be done.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded x-position where drawing of this axis low date/time value could be done.
See also:
setAxisDtLowPos, axisDtLowPosY

Definition at line 381 of file KDChartAxisParams.h.

double KDChartAxisParams::axisDtLowPosY (  )  const [inline, slot]

Returns the not-rounded y-position where drawing of this axis low date/time value could be done.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded y-position where drawing of this axis low date/time value could be done.
See also:
setAxisDtLowPos, axisDtLowPosX

Definition at line 382 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisDtHighPos ( double  x,
double  y 
) [slot]

Specifies the not-rounded screen positions where drawing of this axis high date/time value could be done.

You may not call this internal function - it is reserved for internal usage of methodes needing to know the zero-line offsets

Parameters:
Pt the not-rounded screen positions where drawing of this axis high date/time value could be done.
See also:
axisDtHighPosX, axisDtHighPosY

Definition at line 2286 of file KDChartAxisParams.cpp.

double KDChartAxisParams::axisDtHighPosX (  )  const [inline, slot]

Returns the not-rounded x-position where drawing of this axis high date/time value could be done.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded x-position where drawing of this axis high date/time value could be done.
See also:
setAxisDtHighPos, axisDtHighPosY

Definition at line 384 of file KDChartAxisParams.h.

double KDChartAxisParams::axisDtHighPosY (  )  const [inline, slot]

Returns the not-rounded y-position where drawing of this axis high date/time value could be done.

This function needed when painting the data of isometric axes (bars, lines, dots...).

Returns:
the unrounded y-position where drawing of this axis high date/time value could be done.
See also:
setAxisDtHighPos, axisDtHighPosX

Definition at line 385 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisDigitsBehindComma ( const int  digits  )  [inline, slot]

Specifies the number of digits to be printed behind the comma on the axis labels.

Parameters:
digits the number of digits to be printed behind the comma on the axis labels.
See also:
axisDigitsBehindComma

Definition at line 386 of file KDChartAxisParams.h.

int KDChartAxisParams::axisDigitsBehindComma (  )  const [inline, slot]

Returns the number of digits to be printed behind the comma on the axis labels.

Returns:
the number of digits to be printed behind the comma on the axis labels.
See also:
setAxisValues

axisValueStart

axisLabelsFromDataRow, axisLabelTexts

axisLabelStringList, axisShortLabelsStringList

setAxisLabelStringLists

Definition at line 387 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelsDateTimeFormat ( const QString &  format  )  [inline, slot]

Specifies the format to be used for displaying abscissa axis QDateTime item labels.

Note:
This feature is only available when using Qt 3.0 or newer, previous versions use a non changable format.
To calculate the format automatically (based on the time span to be displayed) use the special value KDCHART_AXIS_LABELS_AUTO_DATETIME_FORMAT - this is the default setting.

See Qt documentation on the format to be used here:

$QTDIR/doc/html/qdatetime.htmltoString-2

Note:
Insert a '
' character if you want to print the labels in two rows, e.g. "h:mm:ss\nd.MM.yyyy" would do that.
See also:
axisLabelsDateTimeFormat

Definition at line 388 of file KDChartAxisParams.h.

QString KDChartAxisParams::axisLabelsDateTimeFormat (  )  const [inline, slot]

Returns the format to be used for displaying abscissa axis QDateTime item labels.

See also:
setAxisLabelsDateTimeFormat

Definition at line 389 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisMaxEmptyInnerSpan ( const int  maxEmpty  )  [inline, slot]

Specifies the percentage of the y-axis range that may to contain NO data entries, if - and only if - axisValueStart (or axisValueEnd, resp.

) is set to KDCHART_AXIS_LABELS_AUTO_LIMIT.

Parameters:
maxEmpty the percentage of the y-axis range that may to contain NO data entries, if - and only if - axisValueStart (or axisValueEnd, resp.) is set to KDCHART_AXIS_LABELS_AUTO_LIMIT.
See also:
axisMaxEmptyInnerSpan

Definition at line 390 of file KDChartAxisParams.h.

int KDChartAxisParams::axisMaxEmptyInnerSpan (  )  const [inline, slot]

Returns the percentage of the y-axis range that may to contain NO data entries, if - and only if - axisValueStart (or axisValueEnd, resp.

) is set to KDCHART_AXIS_LABELS_AUTO_LIMIT.

Note:
If more space is empty the zero-line will not be included info the chart but the lowest (or highest, resp.) entry of the axis will be shifted accordingly.
See also:
setAxisValues

Definition at line 391 of file KDChartAxisParams.h.

void void KDChartAxisParams::setLabelTextsFormDataRow ( int  row,
LabelsFromDataRow  mode 
) [slot]

Specifies whether the axis labels are stored in a data row.

Returns whether the axis labels will be taken from the associated dataset.

If LabelsFromDataRowGuess we assume yes only if all the entries of that data row contain strings - no numbers.

Note:
Calling this function results in overwriting the information that you might have set by previous calls of that function. Only one data row can be specified as containing label texts. To specify a data row that contains (or might contain) axis label texts just call this function with LabelsFromDataRowYes (or LabelsFromDataRowGuess, resp.) specifying this row but do not call the function n times with the LabelsFromDataRowNo parameter to 'deactivate' the other rows. The LabelsFromDataRowNo should be used to specify that none of the data rows is containing the axis label texts (this is the default setting).
Parameters:
row the data row number that contains (or might contain, resp.) the labels
mode the state of our information concerning that row (see: LabelsFromDataRow)
See also:
LabelsFromDataRow, axisLabelTextsFormDataRow, setAxisValues
Returns:
whether the axis limits will be taken from the associated dataset.
See also:
setAxisValues

axisValueStart, axisValueEnd

axisLabelsFromDataRow, axisLabelTexts

Definition at line 2417 of file KDChartAxisParams.cpp.

int KDChartAxisParams::labelTextsDataRow (  )  const [inline, slot]

Returns the number of the data row that contains (or might contain, resp.

) the texts to be taken for the axis labels.
Use axisLabelTextsFormDataRow to make sure the texts are to be taken from that row.
Use axisLabelStringList to get a QStringList* of texts from which the texts to be drawn will be taken.

Use axisShortLabelsStringList to get a QStringList* of texts from which the texts to be drawn will be taken in case the axis area size is too small to display their full-size counterparts stored in axisLabelStringList.

Use axisLabelTexts to get a QStringList* containing the label texts that are actually drawn at the axis.

Returns:
the number of the data row that contains (or might contain, resp.) the texts to be taken for the axis labels.
See also:
setAxisValues

axisValueStart, axisValueEnd

axisLabelsFromDataRow, axisLabelTexts

axisLabelStringList, axisShortLabelsStringList

Definition at line 394 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelStringLists ( QStringList *  axisLabelStringList,
QStringList *  axisShortLabelStringList,
const QString &  valueStart = QString::null,
const QString &  valueEnd = QString::null 
) [slot]

Specifies a QStringList which the axis label texts are to be taken from, the second parameter (if not zero) specifies an alternative list of strings that are to be displayed in case the axis area size is too small for showing the full-length names.

Note:
Normally axis labeling starts with the list's first string and end with its last string, but by specifying a start and an end value as additional parameters you can make KDChart repeat the strings between these two values only, as shown here:
  QStringList abscissaNames;
  abscissaNames << "Sunday" << "Monday" << "Tuesday" << "Wednesday"
  << "Thursday" << "Friday" << "Saturday";
  QStringList abscissaShortNames;
  abscissaShortNames << "Sun" << "Mon" << "Tue" << "Wed"
  << "Thu" << "Fri" << "Sat";

  KDChartAxisParams pa( _p->axisParams(
  KDChartAxisParams::AxisPosBottom ) );

  setAxisLabelStringParams( &abscissaNames,
  &abscissaShortNames,
  "Monday",
  "Friday")

  _p->setAxisParams( KDChartAxisParams::AxisPosBottom, pa );
  

Parameters:
QStringList* axisLabelStringList points to the list of labels to be displayed
QStringList* axisShortLabelStringList points to an alternative list of short names to be displayed if the long labels take too much place
QString valueStart ( default null ) the label to begin with
QString valueEnd ( default null ) the label to end with
See also:
KDChartParams::setAxisLabelStringParams

axisLabelStringList, axisShortLabelsStringList

setAxisValues, setLabelTextsFormDataRow

axisLabelTexts

Definition at line 2505 of file KDChartAxisParams.cpp.

QStringList KDChartAxisParams::axisLabelStringList (  )  const [inline, slot]

Returns a QStringList containing the label texts to be used.

Calling axisShortLabelsStringList() instead will return another QStringList containing the label texts to be displayed in case the axis area size is too small to show the full-size names.

Note:
This is the list of texts you specified by setAxisValues or by setAxisLabelStringLists. The texts actually drawn at the axis are not neccessarily the same as the ones in this list since (regarding Start and/or End and/or Delta value) they might be only a subset of this list. Whenever label texts are calculated automatically the resulting labels are also stored in a second list that you may access via axisLabelTexts().
Returns:
a QStringList containing the label texts to be used.
See also:
axisShortLabelsStringList

setAxisLabelStringLists

setAxisValues

axisValueStart, axisValueEnd, axisLabelTexts

axisLabelsFromDataRow, setLabelTextsFormDataRow

Definition at line 399 of file KDChartAxisParams.h.

uint KDChartAxisParams::axisLabelStringCount (  )  const [inline, slot]

Returns the number of strings stored as label texts, the texts can be retrieved by calling axisLabelStringList().

See also:
axisShortLabelsStringCount

axisLabelStringList, axisShortLabelsStringList

Definition at line 400 of file KDChartAxisParams.h.

QStringList KDChartAxisParams::axisShortLabelsStringList (  )  const [inline, slot]

Returns a QStringList containing the label texts to be used in case the axis area size is too small to show the full-size label texts.

Calling axisLabelStringList() instead will return another QStringList containing their full-size counterparts.

Note:
This is the list of texts you specified by setAxisValues or by setAxisShortLabelsStringList. The texts actually drawn at the axis are not neccessarily the same as the ones in this list since (regarding Start and/or End and/or Delta value) they might be only a subset of this list. Whenever label texts are calculated automatically the resulting labels are also stored in a second list that you may access via axisLabelTexts().
Returns:
a QStringList containing the label texts to be used in case the axis area size is too small to show the full-size label texts.
See also:
axisLabelStringList

setAxisLabelStringLists

setAxisValues

axisValueStart, axisValueEnd, axisLabelTexts

axisLabelsFromDataRow, setLabelTextsFormDataRow

Definition at line 401 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisLabelTexts ( const QStringList *  axisLabelTexts  )  [slot]

Specifies the label texts that are actually drawn at the axis labels.

Note:
Do not call this function unless you know what you are doing. It is used internally whenever the texts to be drawn have been re-calculated or the charts parameters have changed. For specifying another list of strings to be used as label texts you might rather want to call setAxisLabelStringLists() or setLabelTextsFormDataRow() depending from whether your texts are stored in a QStringList or in a data row.
Parameters:
axisLabelTexts specifies the texts that are actually drawn at the axis labels are unknown.
See also:
setAxisLabelStringLists, setLabelTextsFormDataRow, setAxisValues

setAxisFirstLabelText, setAxisLastLabelText

Definition at line 2648 of file KDChartAxisParams.cpp.

bool KDChartAxisParams::axisLabelTextsDirty (  )  const [inline, slot]

Returns whether the label texts that are actually drawn at the axis labels are unknown.

If false, they could successfully be retrieved by axisLabelTexts().

Returns:
whether the texts that are actually drawn at the axis labels are unknown.
See also:
setAxisLabelStringLists, setLabelTextsFormDataRow, setAxisValues

Definition at line 406 of file KDChartAxisParams.h.

void KDChartAxisParams::setAxisFirstLabelText ( const QString &  axisFirstLabelText = QString()  )  [slot]

Sets a special text that is to be displayed _instead_of_ the first axis label IF the parameter is not a NULL string.

Note:
This function does not affect axis label and axis range calculation but it replaces the first label after all calculation is done. This may be used in case you want to replace the first label by some special text string, e.g. you might want to display the text "origo" instead of the start value.
To remove a first label string that was set by a previous call of this function just call it again, with no parameter.

Parameters:
axisFirstLabelText specifies the text that is actually drawn as the first label: a NULL string ( as produced by QString() ) will be ignored, to suppress the first label please specify an EMPTY but NOT NULL string by passing "" as parameter.
See also:
setAxisLastLabelText

setAxisLabelStringLists, setLabelTextsFormDataRow, setAxisValues

Definition at line 2712 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisLastLabelText ( const QString &  axisLastLabelText = QString()  )  [slot]

Sets a special text that is to be displayed _instead_of_ the last axis label IF the parameter is not a NULL string.

Note:
This function does not affect axis label and axis range calculation but it replaces the last label after all calculation is done. This may be used in case you want to replace the last label by some special text string, e.g. you might want to display the text "maximum" instead of the end value.
To remove a last label string that was set by a previous call of this function just call it again, with no parameter.

Parameters:
axisFirstLabelText specifies the text that is actually drawn as the last label: a NULL string ( as produced by QString() ) will be ignored, to suppress the first label please specify an EMPTY but NOT NULL string by passing "" as parameter.
See also:
setAxisFirstLabelText

setAxisLabelStringLists, setLabelTextsFormDataRow, setAxisValues

Definition at line 2739 of file KDChartAxisParams.cpp.

void KDChartAxisParams::setAxisSteadyValueCalc ( bool  axisSteadyValueCalc  )  [inline, slot]

Specifies whether label values shall be calculated based upon the associated dataset values (normally this is true for ordinate axes) or based upon some string list (as you might expect it for abscissa labels).

See also:
setAxisValues

Definition at line 413 of file KDChartAxisParams.h.

bool KDChartAxisParams::axisSteadyValueCalc (  )  const [inline, slot]

Returns whether label values shall be calculataed based upon the associated dataset values (normally this is true for ordinate axes) or based upon some string list (as you might expect it for abscissa labels).

See also:
setAxisValues

Definition at line 414 of file KDChartAxisParams.h.

KDChartAxisParams & KDChartAxisParams::operator= ( const KDChartAxisParams R  ) 

Assignment operator: By calling the copy method, see also the copy constructor.

Definition at line 2777 of file KDChartAxisParams.cpp.

void KDChartAxisParams::changed (  )  [signal]

Signals: This signal is emitted when any of the chart axis parameters have changed.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys