kchart
KDChartParams Class Reference
#include <KDChartParams.h>
Inherits QObject.
Inherited by KChart::KChartParams.
Detailed Description
Bundles the display parameters of a chart.Bundles all parameters of a chart 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 139 of file KDChartParams.h.
General parameters. | |
These methods set general parameters that apply to several or all chart types. | |
enum | ChartType { NoType, Bar, Line, Area, Pie, HiLo, Ring, Polar, BoxWhisker } |
enum | SourceMode { UnknownMode = 0, DontUse = 1, DataEntry = 2, AxisLabel = 3, LegendText = 4, ExtraLinesAnchor = 5, Last_SourceMode = ExtraLinesAnchor } |
typedef QIntDict < KDChartCustomBox > | CustomBoxDict |
void | setOptimizeOutputForScreen (bool screenOutput) |
bool | optimizeOutputForScreen () const |
void | setGlobalLeading (int left, int top, int right, int bottom) |
void | setGlobalLeadingLeft (int leading) |
void | setGlobalLeadingTop (int leading) |
void | setGlobalLeadingRight (int leading) |
void | setGlobalLeadingBottom (int leading) |
int | globalLeadingLeft () const |
int | globalLeadingTop () const |
int | globalLeadingRight () const |
int | globalLeadingBottom () const |
int | registerProperties (KDChartPropertySet &rSet) |
void | setProperties (int id, KDChartPropertySet &rSet) |
bool | removeProperties (int id) |
bool | properties (int id, KDChartPropertySet &rSet) const |
KDChartPropertySet * | properties (int id) |
bool | calculateProperties (int startId, KDChartPropertySet &rSet) const |
void | setFrame (uint area, const KDFrame &frame, int outerGapX, int outerGapY, int innerGapX, int innerGapY, bool addFrameWidthToLayout=true, bool addFrameHeightToLayout=true) |
void | setSimpleFrame (uint area, int outerGapX=0, int outerGapY=0, int innerGapX=0, int innerGapY=0, bool addFrameWidthToLayout=true, bool addFrameHeightToLayout=true, KDFrame::SimpleFrame simpleFrame=KDFrame::FrameFlat, int lineWidth=1, int midLineWidth=0, QPen pen=QPen(), QBrush background=QBrush(Qt::NoBrush), const QPixmap *backPixmap=0, KDFrame::BackPixmapMode backPixmapMode=KDFrame::PixStretched, int shadowWidth=0, KDFrame::CornerName sunPos=KDFrame::CornerTopLeft) |
bool | removeFrame (uint area) |
bool | moveDataRegionFrame (uint oldDataRow, uint oldDataCol, uint, uint newDataRow, uint newDataCol, uint) |
const KDChartFrameSettings * | frameSettings (uint area, bool &bFound, int *pIterIdx=0) const |
const KDChartFrameSettings * | nextFrameSettings (bool &bFound, int *pIterIdx) const |
uint | insertCustomBox (const KDChartCustomBox &box) |
bool | removeCustomBox (const uint &idx) |
void | removeAllCustomBoxes () |
KDChartCustomBox * | customBoxRef (uint box) |
const KDChartCustomBox * | customBox (uint box) const |
uint | maxCustomBoxIdx () const |
void | setChartType (ChartType chartType) |
ChartType | chartType () const |
void | setAdditionalChartType (ChartType chartType) |
ChartType | additionalChartType () const |
void | setChartSourceMode (SourceMode mode, uint dataset, uint dataset2=KDCHART_NO_DATASET, uint chart=0) |
bool | neverUsedSetChartSourceMode () const |
SourceMode | chartSourceMode (uint dataset, uint dataset2=KDCHART_NO_DATASET, uint *chart=0) const |
bool | findDataset (SourceMode mode, uint &dataset, uint &dataset2, uint chart=0) const |
bool | findDatasets (SourceMode mode1, SourceMode mode2, uint &dataset, uint &dataset2, uint chart=0) const |
uint | maxDatasetSourceMode () const |
void | setDefaultAxesTypes () |
void | activateDefaultAxes () |
void | setNumValues (uint numValues) |
int | numValues () const |
void | calculateShadowColors (QColor color, QColor &shadow1, QColor &shadow2) const |
void | setDataColor (uint dataset, QColor color) |
QColor | dataColor (uint dataset) const |
void | setDataDefaultColors () |
void | setDataRainbowColors () |
void | setDataSubduedColors (bool ordered=false) |
void | setShadowBrightnessFactor (double factor) |
double | shadowBrightnessFactor () const |
Qt::BrushStyle | shadowPattern () const |
void | setOutlineDataColor (QColor color) |
QColor | outlineDataColor () const |
void | setOutlineDataLineWidth (uint width) |
uint | outlineDataLineWidth () const |
void | setOutlineDataLineStyle (PenStyle style) |
PenStyle | outlineDataLineStyle () const |
uint | maxDataColor () const |
void | setThreeDShadowColors (bool shadow) |
bool | threeDShadowColors () const |
static int | roundVal (double d) |
void | setPrintDataValues (bool active, uint chart=KDCHART_ALL_CHARTS, int divPow10=0, int digitsBehindComma=KDCHART_DATA_VALUE_AUTO_DIGITS, QFont *font=0, uint size=UINT_MAX, const QColor *color=KDCHART_DATA_VALUE_AUTO_COLOR, KDChartEnums::PositionFlag negativePosition=KDChartEnums::PosCenter, uint negativeAlign=Qt::AlignCenter, int negativeDeltaX=0, int negativeDeltaY=0, int negativeRotation=0, KDChartEnums::PositionFlag positivePosition=KDChartEnums::PosCenter, uint positiveAlign=Qt::AlignCenter, int positiveDeltaX=0, int positiveDeltaY=0, int positiveRotation=0, KDChartEnums::TextLayoutPolicy policy=KDChartEnums::LayoutPolicyRotate) |
void | setDataValuesCalc (int divPow10=0, int digitsBehindComma=KDCHART_DATA_VALUE_AUTO_DIGITS, uint chart=KDCHART_ALL_CHARTS) |
void | setDataValuesFont (QFont *font, uint size=UINT_MAX, uint chart=KDCHART_ALL_CHARTS) |
void | setDataValuesPlacing (KDChartEnums::PositionFlag position, uint align, int deltaX, int deltaY, int rotation, bool specifyingPositiveValues=true, uint chart=KDCHART_ALL_CHARTS) |
void | setDataValuesColors (const QColor *color=KDCHART_DATA_VALUE_AUTO_COLOR, const QBrush &background=Qt::NoBrush, uint chart=KDCHART_ALL_CHARTS) |
void | setDataValuesPolicy (KDChartEnums::TextLayoutPolicy policy=KDChartEnums::LayoutPolicyRotate, uint chart=KDCHART_ALL_CHARTS) |
void | setDataValuesShowInfinite (bool dataValuesShowInfinite=true, uint chart=KDCHART_ALL_CHARTS) |
void | setPrintDataValuesWithDefaultFontParams (uint chart=KDCHART_ALL_CHARTS, bool callSetPrintDataValues=true) |
void | setAllowOverlappingDataValueTexts (bool allow) |
bool | allowOverlappingDataValueTexts () const |
bool | printDataValuesWithDefaultFontParams (uint chart) const |
bool | printDataValues (uint chart) const |
QFont | dataValuesFont (uint chart) const |
bool | dataValuesUseFontRelSize (uint chart) const |
int | dataValuesFontRelSize (uint chart) const |
QColor | dataValuesColor (uint chart) const |
bool | dataValuesAutoColor (uint chart) const |
KDChartEnums::PositionFlag | dataValuesAnchorPosition (uint chart, bool negative) const |
uint | dataValuesAnchorAlign (uint chart, bool negative) const |
int | dataValuesAnchorDeltaX (uint chart, bool negative) const |
int | dataValuesAnchorDeltaY (uint chart, bool negative) const |
int | dataValuesRotation (uint chart, bool negative) const |
KDChartEnums::TextLayoutPolicy | dataValuesLayoutPolicy (uint chart) const |
void | setPrintDataValuesColor (uint chart=KDCHART_ALL_CHARTS, const QColor *color=KDCHART_DATA_VALUE_AUTO_COLOR) |
void | setPrintDataValuesFontRelSize (uint chart, uint size) |
QColor | dataShadow1Color (uint dataset) const |
QColor | dataShadow2Color (uint dataset) const |
void | changed () |
Bar chart-specific methods. | |
These methods query and set barchart-specific parameters. | |
enum | BarChartSubType { BarNormal, BarStacked, BarPercent, BarMultiRows } |
void | setBarChartSubType (BarChartSubType barChartSubType) |
BarChartSubType | barChartSubType () const |
void | setThreeDBars (bool threeDBars) |
bool | threeDBars () const |
void | setThreeDBarsShadowColors (bool shadow) |
bool | threeDBarsShadowColors () const |
void | setThreeDBarAngle (uint angle) |
uint | threeDBarAngle () const |
double | cosThreeDBarAngle () const |
void | setThreeDBarDepth (double depth) |
double | threeDBarDepth () const |
void | setDatasetGap (int gap) |
int | datasetGap () const |
void | setDatasetGapIsRelative (bool gapIsRelative) |
bool | datasetGapIsRelative () const |
void | setValueBlockGap (int gap) |
int | valueBlockGap () const |
void | setValueBlockGapIsRelative (bool gapIsRelative) |
bool | valueBlockGapIsRelative () const |
void | setBarWidth (int width=KDCHART_AUTO_SIZE) |
int | barWidth () const |
int | numBarsDisplayed () const |
int | numBarsLeft () const |
void | setDrawSolidExcessArrows (bool solidArrows) |
bool | drawSolidExcessArrows () const |
Line and area chart-specific methods. | |
These methods query and set line and area chart-specific parameters. | |
enum | LineChartSubType { LineNormal, LineStacked, LinePercent } |
enum | LineMarkerStyle { LineMarkerCircle = 0, LineMarkerSquare = 1, LineMarkerDiamond = 2, LineMarker1Pixel = 3, LineMarker4Pixels = 4, LineMarkerRing = 5, LineMarkerCross = 6, LineMarkerFastCross = 7 } |
enum | AreaChartSubType { AreaNormal, AreaStacked, AreaPercent } |
enum | AreaLocation { AreaAbove, AreaBelow } |
typedef QMap< uint, LineMarkerStyle > | LineMarkerStyleMap |
void | setLineChartSubType (LineChartSubType lineChartSubType) |
LineChartSubType | lineChartSubType () const |
void | setLineMarker (bool marker) |
bool | lineMarker () const |
void | setLineMarkerStyle (uint dataset, LineMarkerStyle style) |
void | setLineMarkerStyles (LineMarkerStyleMap map) |
LineMarkerStyle | lineMarkerStyle (uint dataset) const |
LineMarkerStyleMap | lineMarkerStyles () const |
uint | maxDatasetLineMarkerStyle () const |
void | setLineMarkerSize (QSize size) |
QSize | lineMarkerSize () const |
void | setLineWidth (int width) |
int | lineWidth () const |
void | setLineColor (QColor color=QColor()) |
QColor | lineColor () const |
PenStyle | lineStyle (uint dataset=KDCHART_GLOBAL_LINE_STYLE) const |
void | setThreeDLines (bool threeD) |
bool | threeDLines () const |
void | setThreeDLineDepth (int depth) |
int | threeDLineDepth () const |
void | setThreeDLineXRotation (int degrees) |
int | threeDLineXRotation () const |
void | setThreeDLineYRotation (int degrees) |
int | threeDLineYRotation () const |
void | setAreaChartSubType (AreaChartSubType areaChartSubType) |
AreaChartSubType | areaChartSubType () const |
void | setAreaLocation (AreaLocation location) |
AreaLocation | areaLocation () const |
Polar chart-specific methods. | |
These methods query and set polar chart-specific parameters. | |
enum | PolarChartSubType { PolarNormal, PolarStacked, PolarPercent } |
enum | PolarMarkerStyle { PolarMarkerCircle = 0, PolarMarkerSquare = 1, PolarMarkerDiamond = 2, PolarMarker1Pixel = 3, PolarMarker4Pixels = 4, PolarMarkerRing = 5, PolarMarkerCross = 6 } |
typedef QMap< uint, PolarMarkerStyle > | PolarMarkerStyleMap |
void | setPolarChartSubType (PolarChartSubType polarChartSubType) |
PolarChartSubType | polarChartSubType () const |
void | setPolarMarker (bool marker) |
bool | polarMarker () const |
void | setPolarMarkerStyle (uint dataset, PolarMarkerStyle style) |
PolarMarkerStyle | polarMarkerStyle (uint dataset) const |
void | setPolarMarkerStyles (PolarMarkerStyleMap map) |
PolarMarkerStyleMap | polarMarkerStyles () const |
uint | maxDatasetPolarMarkerStyle () const |
void | setPolarMarkerSize (QSize size=QSize(-40,-40)) |
QSize | polarMarkerSize () const |
void | setPolarLineWidth (int width=-3) |
int | polarLineWidth () const |
void | setPolarZeroDegreePos (int degrees) |
int | polarZeroDegreePos () const |
void | setPolarRotateCircularLabels (bool rotateCircularLabels) |
bool | polarRotateCircularLabels () const |
void | setPolarDelimsAndLabelsAtPos (KDChartEnums::PositionFlag pos, bool showDelimiters, bool showLabels) |
bool | polarDelimAtPos (KDChartEnums::PositionFlag pos) const |
bool | polarLabelsAtPos (KDChartEnums::PositionFlag pos) const |
Hi-lo chart-specific methods. | |
These methods query and set hi-lo chart-specific parameters. | |
enum | HiLoChartSubType { HiLoNormal, HiLoSimple = HiLoNormal, HiLoClose, HiLoOpenClose } |
void | setHiLoChartSubType (HiLoChartSubType hiLoChartSubType) |
HiLoChartSubType | hiLoChartSubType () const |
void | setHiLoChartPrintLowValues (bool active, QFont *font=0, int size=14, QColor *color=0) |
bool | hiLoChartPrintLowValues () const |
QFont | hiLoChartLowValuesFont () const |
bool | hiLoChartLowValuesUseFontRelSize () const |
int | hiLoChartLowValuesFontRelSize () const |
QColor | hiLoChartLowValuesColor () const |
void | setHiLoChartPrintHighValues (bool active, QFont *font=0, int size=14, QColor *color=0) |
bool | hiLoChartPrintHighValues () const |
QFont | hiLoChartHighValuesFont () const |
bool | hiLoChartHighValuesUseFontRelSize () const |
int | hiLoChartHighValuesFontRelSize () const |
QColor | hiLoChartHighValuesColor () const |
void | setHiLoChartPrintOpenValues (bool active, QFont *font=0, uint size=14, QColor *color=0) |
bool | hiLoChartPrintOpenValues () const |
QFont | hiLoChartOpenValuesFont () const |
bool | hiLoChartOpenValuesUseFontRelSize () const |
int | hiLoChartOpenValuesFontRelSize () const |
QColor | hiLoChartOpenValuesColor () const |
void | setHiLoChartPrintCloseValues (bool active, QFont *font=0, int size=14, QColor *color=0) |
bool | hiLoChartPrintCloseValues () const |
QFont | hiLoChartCloseValuesFont () const |
bool | hiLoChartCloseValuesUseFontRelSize () const |
int | hiLoChartCloseValuesFontRelSize () const |
QColor | hiLoChartCloseValuesColor () const |
void | setHiLoChartPrintFirstValues (bool active, QFont *font=0, uint size=14, QColor *color=0) |
bool | hiLoChartPrintFirstValues () const |
QFont | hiLoChartFirstValuesFont () const |
bool | hiLoChartFirstValuesUseFontRelSize () const |
int | hiLoChartFirstValuesFontRelSize () const |
QColor | hiLoChartFirstValuesColor () const |
void | setHiLoChartPrintLastValues (bool active, QFont *font=0, int size=14, QColor *color=0) |
bool | hiLoChartPrintLastValues () const |
QFont | hiLoChartLastValuesFont () const |
bool | hiLoChartLastValuesUseFontRelSize () const |
int | hiLoChartLastValuesFontRelSize () const |
QColor | hiLoChartLastValuesColor () const |
Box-and-whisker chart-specific methods. | |
These methods query and set box-and-whisker chart-specific parameters. | |
enum | BWChartSubType { BWNormal, BWSimple = BWNormal } |
enum | BWStatVal { BWStatValSTART, UpperOuterFence = BWStatValSTART, UpperInnerFence, Quartile3, Median, Quartile1, LowerInnerFence, LowerOuterFence, MaxValue, MeanValue, MinValue, BWStatValEND = MinValue, BWStatValOffEndValue, BWStatValALL, BWStatValUNKNOWN } |
void | setBWChartSubType (BWChartSubType bWChartSubType) |
BWChartSubType | bWChartSubType () const |
void | setBWChartFences (double upperInner, double lowerInner, double upperOuter, double lowerOuter) |
void | bWChartFences (double &upperInner, double &lowerInner, double &upperOuter, double &lowerOuter) const |
void | setBWChartBrush (const QBrush &bWChartBrush) |
QBrush | bWChartBrush () const |
void | setBWChartOutValMarkerSize (int size) |
int | bWChartOutValMarkerSize () const |
void | setBWChartPrintStatistics (BWStatVal statValue, bool active, QFont *font=0, int size=24, QColor *color=0, QBrush *brush=0) |
bool | bWChartPrintStatistics (BWStatVal statValue) const |
QFont | bWChartStatisticsFont (BWStatVal statValue) const |
bool | bWChartStatisticsUseRelSize (BWStatVal statValue) const |
int | bWChartStatisticsFontRelSize (BWStatVal statValue) const |
QColor | bWChartStatisticsColor (BWStatVal statValue) const |
QBrush | bWChartStatisticsBrush (BWStatVal statValue) const |
Legend methods. | |
These methods query and set legend parameters. | |
enum | LegendPosition { NoLegend, LegendTop, LegendBottom, LegendLeft, LegendRight, LegendTopLeft, LegendTopLeftTop, LegendTopLeftLeft, LegendTopRight, LegendTopRightTop, LegendTopRightRight, LegendBottomLeft, LegendBottomLeftBottom, LegendBottomLeftLeft, LegendBottomRight, LegendBottomRightBottom, LegendBottomRightRight } |
enum | LegendSource { LegendManual, LegendFirstColumn, LegendAutomatic } |
void | setLegendPosition (LegendPosition position) |
LegendPosition | legendPosition () const |
Orientation | legendOrientation () const |
void | setLegendShowLines (bool legendShowLines) |
bool | legendShowLines () const |
void | setLegendSource (LegendSource source) |
LegendSource | legendSource () const |
void | setLegendText (uint dataset, const QString &text) |
QString | legendText (uint dataset) const |
void | setLegendTextColor (const QColor &color) |
QColor | legendTextColor () const |
void | setLegendFont (const QFont &font, bool useFontSize) |
QFont | legendFont () const |
void | setLegendFontUseRelSize (bool legendFontUseRelSize) |
bool | legendFontUseRelSize () const |
void | setLegendFontRelSize (int legendFontRelSize) |
int | legendFontRelSize () const |
void | setLegendTitleText (const QString &text) |
QString | legendTitleText () const |
void | setLegendTitleTextColor (const QColor &color) |
QColor | legendTitleTextColor () const |
void | setLegendTitleFont (const QFont &font, bool useFontSize) |
QFont | legendTitleFont () const |
void | setLegendTitleFontUseRelSize (bool legendTitleFontUseRelSize) |
bool | legendTitleFontUseRelSize () const |
void | setLegendTitleFontRelSize (int legendTitleFontRelSize) |
int | legendTitleFontRelSize () const |
void | setLegendSpacing (uint space) |
uint | legendSpacing () const |
Header and footer methods. | |
These methods query and set header and footer parameters. The names of the Header and Footer sections. You may use up to 9 header and/or up to 9 footer sections.
Usage: Please see example code at
| |
enum | HdFtPos { HdFtPosSTART = 0, HdFtPosHeadersSTART = 0, HdFtPosHeaders0START = 0, HdFtPosHeader0 = 0, HdFtPosHeader0L = 1, HdFtPosHeader0R = 2, HdFtPosHeaders0END = 2, HdFtPosHeaders1START = 3, HdFtPosHeader = 3, HdFtPosHeaderL = 4, HdFtPosHeaderR = 5, HdFtPosHeaders1END = 5, HdFtPosHeaders2START = 6, HdFtPosHeader2 = 6, HdFtPosHeader2L = 7, HdFtPosHeader2R = 8, HdFtPosHeaders2END = 8, HdFtPosHeadersEND = 8, HdFtPosFootersSTART = 9, HdFtPosFooters1START = 9, HdFtPosFooter = 9, HdFtPosFooterL = 10, HdFtPosFooterR = 11, HdFtPosFooters1END = 11, HdFtPosFooters2START = 12, HdFtPosFooter2 = 12, HdFtPosFooter2L = 13, HdFtPosFooter2R = 14, HdFtPosFooters2END = 14, HdFtPosFooters0START = 15, HdFtPosFooter0 = 15, HdFtPosFooter0L = 16, HdFtPosFooter0R = 17, HdFtPosFooters0END = 17, HdFtPosFootersEND = 17, HdFtPosEND = 17 } |
void | setHeaderFooterText (uint pos, const QString &text) |
QString | headerFooterText (uint pos) const |
const QRect & | headerFooterRect (uint pos) const |
void | setHeaderFooterColor (uint pos, const QColor color) |
QColor | headerFooterColor (uint pos) const |
void | setHeaderFooterFont (uint pos, const QFont &font, bool fontUseRelSize, int fontRelSize) |
QFont | headerFooterFont (uint pos) const |
bool | headerFooterFontUseRelSize (uint pos) const |
int | headerFooterFontRelSize (uint pos) const |
void | setHeader1Text (const QString &text) |
QString | header1Text () const |
void | setHeader1Font (const QFont &font) |
QFont | header1Font () const |
void | setHeader2Text (const QString &text) |
QString | header2Text () const |
void | setHeader2Font (const QFont &font) |
QFont | header2Font () const |
void | setFooterText (const QString &text) |
QString | footerText () const |
void | setFooterFont (const QFont &font) |
QFont | footerFont () const |
Public Types | |
typedef QMap< int, double > | ExplodeFactorsMap |
typedef QArray< uint > | AxesArray |
Public Slots | |
void | setDataRegionFrame (uint dataRow, uint dataCol, uint, int innerGapX=0, int innerGapY=0, bool addFrameWidthToLayout=true, bool addFrameHeightToLayout=true, KDFrame::SimpleFrame simpleFrame=KDFrame::FrameFlat, int lineWidth=1, int midLineWidth=0, QPen pen=QPen(), int shadowWidth=0, KDFrame::CornerName sunPos=KDFrame::CornerTopLeft) |
static QString | chartTypeToString (ChartType type) |
static ChartType | stringToChartType (const QString &string) |
static QString | chartSourceModeToString (const SourceMode &mode) |
static SourceMode | stringToChartSourceMode (const QString &string) |
void | setShadowPattern (BrushStyle style) |
int | dataValuesDivPow10 (uint chart) const |
int | dataValuesDigitsBehindComma (uint chart) const |
QBrush | dataValuesBackground (uint chart) const |
bool | dataValuesShowInfinite (uint chart) const |
static QString | markerStyleToString (int style) |
static QString | markerStyleToStringTr (int style) |
static int | stringToMarkerStyle (const QString &string) |
static int | stringToMarkerStyleTr (const QString &string) |
static QString | barChartSubTypeToString (BarChartSubType type) |
static BarChartSubType | stringToBarChartSubType (const QString &string) |
int | userWidth () const |
static LineChartSubType | stringToLineChartSubType (const QString &string) |
static QString | lineChartSubTypeToString (LineChartSubType type) |
static QString | lineMarkerStyleToString (LineMarkerStyle style) |
static QString | lineMarkerStyleToStringTr (LineMarkerStyle style) |
static LineMarkerStyle | stringToLineMarkerStyle (const QString &string) |
static LineMarkerStyle | stringToLineMarkerStyleTr (const QString &string) |
void | setLineStyle (PenStyle style, uint dataset=KDCHART_GLOBAL_LINE_STYLE) |
static QString | areaChartSubTypeToString (AreaChartSubType type) |
static AreaChartSubType | stringToAreaChartSubType (const QString &string) |
static QString | areaLocationToString (AreaLocation type) |
static AreaLocation | stringToAreaLocation (const QString &string) |
static PolarChartSubType | stringToPolarChartSubType (const QString &string) |
static QString | polarChartSubTypeToString (PolarChartSubType type) |
static QString | polarMarkerStyleToString (PolarMarkerStyle style) |
static QString | polarMarkerStyleToStringTr (PolarMarkerStyle style) |
static PolarMarkerStyle | stringToPolarMarkerStyle (const QString &string) |
static PolarMarkerStyle | stringToPolarMarkerStyleTr (const QString &string) |
static QString | hiLoChartSubTypeToString (HiLoChartSubType type) |
static HiLoChartSubType | stringToHiLoChartSubType (const QString &string) |
static QString | bWChartSubTypeToString (BWChartSubType type) |
static BWChartSubType | stringToBWChartSubType (const QString &string) |
static QString | bWChartStatValToString (BWStatVal type) |
static BWStatVal | stringToBWChartStatVal (const QString &string) |
void | setLegendOrientation (Orientation orientation) |
static QString | legendPositionToString (LegendPosition pos) |
static LegendPosition | stringToLegendPosition (const QString &string) |
static QString | legendSourceToString (LegendSource source) |
static LegendSource | stringToLegendSource (const QString &string) |
void | setAxisLabelTextParams (uint n, bool axisSteadyValueCalc=true, QVariant axisValueStart=KDCHART_AXIS_LABELS_AUTO_LIMIT, QVariant axisValueEnd=KDCHART_AXIS_LABELS_AUTO_LIMIT, double axisValueDelta=KDCHART_AXIS_LABELS_AUTO_DELTA, int axisDigitsBehindComma=KDCHART_AXIS_LABELS_AUTO_DIGITS, int axisMaxEmptyInnerSpan=67, KDChartAxisParams::LabelsFromDataRow takeLabelsFromDataRow=KDChartAxisParams::LabelsFromDataRowNo, int labelTextsDataRow=0, QStringList *axisLabelStringList=0, QStringList *axisShortLabelsStringList=0, int axisValueLeaveOut=KDCHART_AXIS_LABELS_AUTO_LEAVEOUT, KDChartAxisParams::ValueScale axisValueDeltaScale=KDChartAxisParams::ValueScaleNumerical) |
bool | findFirstAxisCustomBoxID (uint n, uint &boxID) const |
void | setAxisTitle (uint n, const QString &axisTitle) |
QString | axisTitle (uint n) const |
void | setAxisTitleColor (uint n, QColor axisTitleColor) |
QColor | axisTitleColor (uint n) const |
void | setAxisTitleFont (uint n, QFont axisTitleFont) |
void | setAxisTitleFont (uint n, QFont axisTitleFont, bool useFixedFontSize) |
QFont | axisTitleFont (uint n) const |
void | setAxisTitleFontUseRelSize (uint n, bool useRelSize) |
bool | axisTitleFontUseRelSize (uint n) const |
void | setAxisTitleFontRelSize (uint n, int axisTitleFontRelSize) |
int | axisTitleFontRelSize (uint n) const |
void | __internalStoreHdFtRect (int pos, QRect rect) |
void | loadAxesFormXML (int &curAxisSettings, QDomElement &element) |
bool | loadXML (const QDomDocument &doc) |
void | saveAxesToXML (QDomDocument &doc, QDomElement &docRoot) const |
QDomDocument | saveXML (bool withPI=true) const |
static void | createChartValueNode (QDomDocument &doc, QDomNode &parent, const QString &elementName, const QVariant &valY, const QVariant &valX, const int &propID) |
static void | createColorMapNode (QDomDocument &doc, QDomNode &parent, const QString &elementName, const QMap< uint, QColor > &map) |
static void | createDoubleMapNode (QDomDocument &doc, QDomNode &parent, const QString &elementName, const QMap< int, double > &map) |
static void | createChartFontNode (QDomDocument &doc, QDomNode &parent, const QString &elementName, const QFont &font, bool useRelFont, int relFont, int minFont=-1) |
static bool | readColorMapNode (const QDomElement &element, QMap< uint, QColor > *map) |
static bool | readDoubleMapNode (const QDomElement &element, QMap< int, double > *map) |
static bool | readChartFontNode (const QDomElement &element, QFont &font, bool &useRelFont, int &relFontSize, int *minFontSize=0) |
static bool | readChartValueNode (const QDomElement &element, QVariant &valY, QVariant &valX, int &propID) |
void | setDataArea (const QRect &areaRect) |
void | setLegendArea (const QRect &areaRect) |
Ring and pie chart-specific methods. | |
These methods query and set ring and pie chart-specific parameters. | |
void | setExplode (bool explode) |
bool | explode () const |
void | setExplodeValues (QValueList< int > explodeList) |
QValueList< int > | explodeValues () const |
void | setExplodeFactors (ExplodeFactorsMap factors) |
ExplodeFactorsMap | explodeFactors () const |
void | setExplodeFactor (double factor) |
double | explodeFactor () const |
void | setThreeDPies (bool threeDPies) |
bool | threeDPies () const |
void | setThreeDPieHeight (int pixels) |
int | threeDPieHeight () const |
void | setPieStart (int degrees) |
int | pieStart () const |
void | setRingStart (int degrees) |
int | ringStart () const |
void | setRelativeRingThickness (bool relativeThickness) |
bool | relativeRingThickness () const |
Axis methods. | |
These methods query and set axis parameters. | |
void | setAxisType (uint n, const KDChartAxisParams::AxisType axisType) |
void | setAxisVisible (uint n, const bool axisVisible) |
bool | axisVisible (uint n) const |
void | setAxisShowGrid (uint n, bool axisShowGrid) |
bool | showGrid () const |
void | setAxisDatasets (uint n, uint dataset, uint dataset2=KDCHART_NO_DATASET, uint chart=0) |
bool | axisDatasets (uint n, uint &dataset, uint &dataset2, uint &chart) const |
bool | chartAxes (uint chart, uint &cnt, AxesArray &axes) const |
void | setAxisArea (const uint n, const QRect &areaRect) |
void | setAxisLabelsTouchEdges (uint n, bool axisLabelsTouchEdges) |
void | setAxisLabelsVisible (uint n, bool axisLabelsVisible) |
void | setAxisLabelsFont (uint n, QFont axisLabelsFont, int axisLabelsFontSize=0, QColor axisLabelsColor=Qt::black) |
void | setAxisLabelStringParams (uint n, QStringList *axisLabelStringList, QStringList *axisShortLabelStringList, const QString &valueStart=QString::null, const QString &valueEnd=QString::null) |
void | setAxisParams (uint n, const KDChartAxisParams &axisParams) |
const KDChartAxisParams & | axisParams (uint n) const |
QRect | axisArea (const uint n) const |
QRect | dataArea () const |
QRect | legendArea () const |
Public Member Functions | |
KDChartParams () | |
virtual | ~KDChartParams () |
Protected Member Functions | |
void | setBarsDisplayed (int barsDisplayed) |
void | setBarsLeft (int barsLeft) |
Friends | |
QTextStream & | operator<< (QTextStream &s, const KDChartParams &p) |
QTextStream & | operator>> (QTextStream &s, KDChartParams &p) |
Classes | |
class | KDChartFrameSettings |
Stores the frame settings for one of the chart areas:. More... |
Member Typedef Documentation
The type of the storage structure for line marker styles.
You should normally not need to use this.
Definition at line 1099 of file KDChartParams.h.
The type of the storage structure for polar marker styles.
You should normally not need to use this.
Definition at line 1310 of file KDChartParams.h.
Member Enumeration Documentation
The chart source mode.
Use setChartSourceMode
to specify if and how any data should be taken into account for a given chart.
Definition at line 552 of file KDChartParams.h.
The bar subtype.
Only used when chartType() == Bar
- See also:
- setBarChartSubType, barChartSubType
Definition at line 886 of file KDChartParams.h.
The line subtype.
Only used when chartType == Line
- See also:
- setLineChartSubType, lineChartSubType
Definition at line 1058 of file KDChartParams.h.
The area subtype.
Only used when chartType == Area
- See also:
- setAreaChartSubType, areaChartSubType
Definition at line 1217 of file KDChartParams.h.
Specifies whether the area above the value points or below the value points should be filled.
The default is to fill below the value points.
- See also:
- setAreaLocation(), areaLocation()
Definition at line 1241 of file KDChartParams.h.
The polar subtype.
Only used when chartType == Polar
- See also:
- setPolarChartSubType, polarChartSubType
Definition at line 1263 of file KDChartParams.h.
The HiLo subtype.
Only used when chartType == HiLo
- See also:
- setHiLoChartSubType, hiLoChartSubType
Definition at line 1507 of file KDChartParams.h.
The BoxWhisker subtype.
Only used when chartType == BoxWhisker
- See also:
- setBWChartSubType, bWChartSubType
Definition at line 1736 of file KDChartParams.h.
The different statistical values that can be printed into or asked from a Box and Whisker chart.
Only used when chartType == BoxWhisker
- See also:
- setBWChartSubType, bWChartSubType
Definition at line 1738 of file KDChartParams.h.
The possible positions for a legend.
NoLegend turns legend display off.
- See also:
- setLegendPosition, legendPosition
Definition at line 1844 of file KDChartParams.h.
The possible ways for getting the legend text.
Available are:
- Manual - Uses texts set with setLegendText(); if no text is set for a dataset, the legend text will be empty.
- FirstColumn - Uses values from the first column, no matter what this contains.
- Automatic - Tries first to use values from the first column; if this does not contain any string values, tries to use values set manually with setLegendText(). If there are no values set manually either, resolves to standard texts like Series 1, Series 2, .... This is the default.
- See also:
- setLegendSource, legendSource, setLegendText, legendText
Definition at line 1900 of file KDChartParams.h.
This enum lists the positions that headers and footers can take.
Definition at line 2241 of file KDChartParams.h.
Constructor & Destructor Documentation
KDChartParams::KDChartParams | ( | ) |
KDChartParams::~KDChartParams | ( | ) | [virtual] |
Member Function Documentation
KDChartParams::setOptimizeOutputForScreen | ( | bool | screenOutput | ) | [inline, slot] |
Specify whether drawing should be optimized for (low resolution) screen output or whether other routines should be used to obtain best quality when using a printer.
- Note:
- The default of this flag is TRUE, so make sure to deactivate it before painting your KDChart onto a QPrinter device!
This setting is NOT stored together with the other parameters, it is recommended to set the flag each time when the drawing targed (printer or screen, resp) is changed.
- See also:
- optimizeOutputForScreen
Definition at line 166 of file KDChartParams.h.
bool KDChartParams::optimizeOutputForScreen | ( | ) | const [inline, slot] |
Returns whether drawing is optimized for (low resolution) screen output (this is the default) or whether other routines are used to obtain best quality when using a printer.
- See also:
- setOptimizeOutputForScreen
Definition at line 172 of file KDChartParams.h.
void KDChartParams::setGlobalLeading | ( | int | left, | |
int | top, | |||
int | right, | |||
int | bottom | |||
) | [slot] |
Specifies the distance between the chart and the left border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
globalLeadingLeft, globalLeadingTop, globalLeadingRight, globalLeadingBottom
Definition at line 2296 of file KDChartParams.cpp.
void KDChartParams::setGlobalLeadingLeft | ( | int | leading | ) | [inline, slot] |
Specifies the distance between the chart and the left border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
globalLeadingLeft, globalLeadingTop, globalLeadingRight, globalLeadingBottom
Definition at line 179 of file KDChartParams.h.
void KDChartParams::setGlobalLeadingTop | ( | int | leading | ) | [inline, slot] |
Specifies the distance between the chart and the upper border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingRight, setGlobalLeadingBottom
globalLeadingLeft, globalLeadingTop, globalLeadingRight, globalLeadingBottom
Definition at line 184 of file KDChartParams.h.
void KDChartParams::setGlobalLeadingRight | ( | int | leading | ) | [inline, slot] |
Specifies the distance between the chart and the right border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingBottom
globalLeadingLeft, globalLeadingTop, globalLeadingRight, globalLeadingBottom
Definition at line 189 of file KDChartParams.h.
void KDChartParams::setGlobalLeadingBottom | ( | int | leading | ) | [inline, slot] |
Specifies the distance between the chart and the lower border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingRight
globalLeadingLeft, globalLeadingTop, globalLeadingRight, globalLeadingBottom
Definition at line 194 of file KDChartParams.h.
int KDChartParams::globalLeadingLeft | ( | ) | const [inline, slot] |
Return the distance between the chart and the left border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
Definition at line 199 of file KDChartParams.h.
KDChartParams::globalLeadingTop | ( | ) | const [inline, slot] |
Return the distance between the chart and the upper border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
Definition at line 203 of file KDChartParams.h.
KDChartParams::globalLeadingRight | ( | ) | const [inline, slot] |
Return the distance between the chart and the right border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
Definition at line 207 of file KDChartParams.h.
int KDChartParams::globalLeadingBottom | ( | ) | const [inline, slot] |
Return the distance between the chart and the lower border of the painter area.
If leading
is a negative value it is interpreted as per-mille value of the painter area, the true offset will then be calculated dynamically at drawing time.
- See also:
- setGlobalLeading, setGlobalLeadingLeft, setGlobalLeadingTop, setGlobalLeadingRight, setGlobalLeadingBottom
Definition at line 211 of file KDChartParams.h.
int KDChartParams::registerProperties | ( | KDChartPropertySet & | rSet | ) | [slot] |
Stores a new property set: data are stored by value so you may use your rSet
instance for other purpose later.
..
- Returns:
- The property set's ID to be used for later retrieving the property information by calling the properties() function or for assigning these properties to a data cell - either in the KDChartData constructor or by calling KDChartData::setPropertySet().
- Note:
- The property set's ID may also be retrieved by calling set.id() after calling registerProperties( set )
The predefined (build-in) property ids (like KDCHART_PROPSET_NORMAL_DATA and KDCHART_PROPSET_TRANSPARENT_DATA) must not be registered but should be used without further initialization.
- See also:
- KDCHART_PROPSET_NORMAL_DATA, KDCHART_PROPSET_TRANSPARENT_DATA
Definition at line 491 of file KDChartParams.cpp.
void KDChartParams::setProperties | ( | int | id, | |
KDChartPropertySet & | rSet | |||
) | [slot] |
Overwrites a property set with a new property set.
- Note:
- This function might also be used to initialy store a property set using a specific ID number, but note that another property set having the same number would be replaced by this property set automatically. Therefor in general it is better to use the registerProperties function to initially obtain a unique ID number for your new property set.
- Returns:
- TRUE if the property set had been stored before, or FALSE if the set was now stored initially.
Definition at line 517 of file KDChartParams.cpp.
bool KDChartParams::removeProperties | ( | int | id | ) | [slot] |
Removes a property set from the registry that was registered via registerProperties().
- Note:
- It is not possible to remove the build-in default property set: function calls using KDCHART_PROPSET_NORMAL_DATA as ID will be ignored.
- Returns:
- TRUE if the property set was found and removed, or FALSE if the set was not found or KDCHART_PROPSET_NORMAL_DATA was specified as ID value.
- See also:
- registerProperties, setProperties
Definition at line 538 of file KDChartParams.cpp.
bool KDChartParams::properties | ( | int | id, | |
KDChartPropertySet & | rSet | |||
) | const [slot] |
Retrieves the values specified for a property set that was stored by registerProperties().
Use this function to retrieve the exact specification of a property set.
Don't use this function to retrieve the properties that are valid for a given data cell but use KDChartParams::calculateProperties() instead.
- Note:
- This function does not return a pointer to the property set itself but a copy of the data stored therein. To change a stored property set you may use the setProperties() function.
- Returns:
- TRUE if the property set was found, FALSE if it no property set was registred with this ID.
Definition at line 569 of file KDChartParams.cpp.
KDChartPropertySet * KDChartParams::properties | ( | int | id | ) | [slot] |
Retrieves the internal property set object that created when you called registerProperties().
Use this function to access a property set for modifying it directly.
Don't use this function to retrieve the properties that are valid for a given data cell but use KDChartParams::calculateProperties() instead.
- Note:
- This function does return a pointer to the property set itself, so you can directly modify its contents. However you have to make sure NOT to delete this pointer, since KDChartParams is owning it, so it would try to free the pointer again later, most likely resulting in a program crash. To delete a stored property set you may use the removeProperties() function.
- Returns:
- A pointer to the internally stored property set if the property set was found, Zero if no property set was registred with this ID.
Definition at line 601 of file KDChartParams.cpp.
bool KDChartParams::calculateProperties | ( | int | startId, | |
KDChartPropertySet & | rSet | |||
) | const [slot] |
Retrieves the values that correspond to a property set by reading this set's properties and obtaining other property set's values if necessary (according to ID numbers that might be stored in the property set).
Use this function to retrieve the properties that are valid for a given data cell.
Don't use this function to retrieve the exact specification of a property set but use KDChartParams::properties() instead.
- Returns:
- TRUE if the property set was found, FALSE if it no property set was registred with this ID.
Definition at line 624 of file KDChartParams.cpp.
void KDChartParams::setFrame | ( | uint | area, | |
const KDFrame & | frame, | |||
int | outerGapX, | |||
int | outerGapY, | |||
int | innerGapX, | |||
int | innerGapY, | |||
bool | addFrameWidthToLayout = true , |
|||
bool | addFrameHeightToLayout = true | |||
) | [inline, slot] |
- Deprecated:
- Feature scheduled for future release, at present not implemented.
Definition at line 384 of file KDChartParams.h.
void KDChartParams::setSimpleFrame | ( | uint | area, | |
int | outerGapX = 0 , |
|||
int | outerGapY = 0 , |
|||
int | innerGapX = 0 , |
|||
int | innerGapY = 0 , |
|||
bool | addFrameWidthToLayout = true , |
|||
bool | addFrameHeightToLayout = true , |
|||
KDFrame::SimpleFrame | simpleFrame = KDFrame::FrameFlat , |
|||
int | lineWidth = 1 , |
|||
int | midLineWidth = 0 , |
|||
QPen | pen = QPen() , |
|||
QBrush | background = QBrush( Qt::NoBrush ) , |
|||
const QPixmap * | backPixmap = 0 , |
|||
KDFrame::BackPixmapMode | backPixmapMode = KDFrame::PixStretched , |
|||
int | shadowWidth = 0 , |
|||
KDFrame::CornerName | sunPos = KDFrame::CornerTopLeft | |||
) | [inline, slot] |
Select a pre-defined frame setting to be used for one of the chart areas.
- Parameters:
-
area The area to be surrounded by a frame. outerGap The distance between the frame and the surrounding parts of the chart. innerGap The distance between the frame and the inner area. addFrameWidthToLayout For internal use - must be true
.addFrameHeightToLayout For internal use - must be true
.simpleFrame For internal use - must be KDFrame::FrameFlat
.lineWidth For internal use - must be 1
.midLineWidth For internal use - must be 0
.pen The pen to be used for drawing the four frame border lines. background The brush to be used for painting the frame background. backPixmap The picture to be displayed as background image of the frame. backPixmapMode The way how backPixmap is to be modified to fill the frame, these are possible: KDFrame::PixCentered
Image will not be scaled nor stretched but shown in original size.KDFrame::PixScaled
Image will be scaled until it's height or it's width match the frame's height (or width, resp.) - whichever comes first - but image proportions will be preserved.KDFrame::PixStretched
Image will be stretched to have the same height and the same width as the frame - normally this results in changing the original image proportions.
shadowWidth For internal use - do not set this parameter or set it to 0
.sunPos For internal use - do not set this parameter or set it to KDFrame::CornerTopLeft
.
- See also:
- removeFrame
Definition at line 408 of file KDChartParams.h.
bool KDChartParams::removeFrame | ( | uint | area | ) | [slot] |
Remove the last frame, that was specified for this chart area.
If you have more than one frame attached to the same area, make sure to call this method repeatedly, if you want to remove all of them.
- Note:
- This method can be used to remove frames, that were specified via setFrame (or via setSimpleFrame, resp.), but if can not be used to remove frames, that were specified using setDataRegionFrame.
- See also:
- nextFrameSettings, setSimpleFrame, setFrame
Definition at line 2644 of file KDChartParams.cpp.
bool KDChartParams::moveDataRegionFrame | ( | uint | oldDataRow, | |
uint | oldDataCol, | |||
uint | , | |||
uint | newDataRow, | |||
uint | newDataCol, | |||
uint | ||||
) | [slot] |
Move a frame that was previously specified using setDataRegionFrame to another location: moves the frame from cell[ oldDataRow, oldDataCol ] to cell[ newDataRow, newDataCol ] without changing looking of the frame, or just removes the frame entirely.
- Parameters:
-
oldDataRow The table row of the frame to be removed. oldDataCol The table column of the frame to be removed. oldData3rd The third table coordinate of the old cell (parameter not used, its value will be ignored, set to 0, reserved for future use). newDataRow The table row of the cell to be framed instead, or KDCHART_NO_DATASET if the frame is to be removed without framing another cell then. newDataCol The table column of the cell to be framed instead. newData3rd The third table coordinate of the new cell (parameter not used, its value will be ignored, set to 0, reserved for future use).
- Note:
- Using KDCHART_NO_DATASET for the newDataRow parameter will not result in returning FALSE because it is an allowed action: the frame is just removed then.
- Returns:
- TRUE if the frame could be moved or was removed; FALSE if either there was no frame around the old cell or the target cell does not exist.
Definition at line 2566 of file KDChartParams.cpp.
const KDChartParams::KDChartFrameSettings * KDChartParams::frameSettings | ( | uint | area, | |
bool & | bFound, | |||
int * | pIterIdx = 0 | |||
) | const [slot] |
Return the frame settings of one of the chart areas.
- See also:
- nextFrameSettings, setSimpleFrame, setFrame, removeFrame
Definition at line 2606 of file KDChartParams.cpp.
const KDChartParams::KDChartFrameSettings * KDChartParams::nextFrameSettings | ( | bool & | bFound, | |
int * | pIterIdx | |||
) | const [slot] |
Return the next frame settings specified for the same area type as the frame that was retrieved by previous calls of frameSettings()
or nextFrameSettings()
.
- See also:
- setDataRegionFrame, frameSettings
Definition at line 2657 of file KDChartParams.cpp.
uint KDChartParams::insertCustomBox | ( | const KDChartCustomBox & | box | ) | [slot] |
Add a new custom box to the list of boxes.
To remove this box from the list lateron just call removeCustomBox with the index that was returned by insertCustomBox.
- See also:
- removeCustomBox, removeAllCustomBoxes, customBox, maxCustomBoxIdx
Definition at line 2692 of file KDChartParams.cpp.
bool KDChartParams::removeCustomBox | ( | const uint & | idx | ) | [slot] |
Remove a custom box from the list of boxes.
Please fill in the index parameter with the value that was returned by insertCustomBox.
- Note:
- This method also removes the last frame, that was attached to this box (if any), so the only reason for calling removeFrame() manually would be, that you have specified more than one frame for this box.
- See also:
- removeAllCustomBoxes, insertCustomBox, customBox, maxCustomBoxIdx
Definition at line 2728 of file KDChartParams.cpp.
void KDChartParams::removeAllCustomBoxes | ( | ) | [inline, slot] |
Remove all custom boxes from the list of boxes.
- See also:
- removeCustomBox, insertCustomBox, customBox, maxCustomBoxIdx
Definition at line 519 of file KDChartParams.h.
KDChartCustomBox * KDChartParams::customBoxRef | ( | uint | box | ) | [slot] |
Retrieve a non-const pointer to a custom box from the list.
You may fill in the index parameter with the value that was returned by insertCustomBox, or you may use a numerical value, e.g. when iterating from zero up to maxCustomBoxIdx().
- Note:
- The reference returned by this method may be used to directly modify the properties of the respective box.
- Returns:
- Zero if the custom box has been removed by calling removeCustomBox.
Definition at line 2777 of file KDChartParams.cpp.
const KDChartCustomBox * KDChartParams::customBox | ( | uint | box | ) | const [slot] |
Retrieve a const pointer to a custom box from the list.
You may fill in the index parameter with the value that was returned by insertCustomBox, or you may use a numerical value, e.g. when iterating from zero up to maxCustomBoxIdx().
- Returns:
- Zero if the custom box has been removed by calling removeCustomBox.
Definition at line 2759 of file KDChartParams.cpp.
uint KDChartParams::maxCustomBoxIdx | ( | ) | const [slot] |
Retrieve the biggest custom boxes ID used.
- See also:
- insertCustomBox, removeCustomBox, removeAllCustomBoxes, customBox
Definition at line 2787 of file KDChartParams.cpp.
void KDChartParams::setChartType | ( | ChartType | chartType | ) | [slot] |
Specifies the chart type.
The default is bar charts (Bar).
- Note:
- Allways call this before specifying other axis properties and before calling
setAdditionalChartType()
.
setChartType()
deactivates the right axis and also sets the axisLabelsTouchEdges back to their default for all bottom and top axes.Calling setChartType() results in changing the default data value texts font settings (i.e. the font size, colour, position, but not the QFont itself) if these parameters were not changed by setPrintDataValues(). In order to re-activate this automatical adjustment of font settings even after you have changed them manually you may call setPrintDataValuesWithDefaultFontParams().
- When calling setPrintDataValuesWithDefaultFontParams() before calling setChartType() make sure you set the
callSetPrintDataValues
parameter tofalse
. - When calling setPrintDataValuesWithDefaultFontParams() after calling setChartType() you may set the
callSetPrintDataValues
parameter totrue
or you may call setPrintDataValues() yourself after calling setPrintDataValuesWithDefaultFontParams() to specify additional parameters.
- When calling setPrintDataValuesWithDefaultFontParams() before calling setChartType() make sure you set the
- Parameters:
-
chartType the chart type to use
- See also:
- chartType, ChartType
setAdditionalChartType, additionalChartType,
setBarChartSubType, barChartSubType
setLineChartSubType, lineChartSubType
setPolarChartSubType, polarChartSubType
Definition at line 2847 of file KDChartParams.cpp.
KDChartParams::ChartType KDChartParams::chartType | ( | ) | const [inline, slot] |
Returns the chart type configured in this params object.
- Returns:
- the chart type configured in this params object.
- See also:
- setChartType, ChartType
setAdditionalChartType, additionalChartType,
setBarChartSubType, barChartSubType
setLineChartSubType, lineChartSubType
Definition at line 536 of file KDChartParams.h.
QString KDChartParams::chartTypeToString | ( | ChartType | type | ) | [static, slot] |
Converts the specified chart type enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2556 of file KDChartParams_io.cpp.
KDChartParams::ChartType KDChartParams::stringToChartType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a chart type enum value.
- Parameters:
-
string the string to convert
- Returns:
- the chart type enum value
Definition at line 2589 of file KDChartParams_io.cpp.
void KDChartParams::setAdditionalChartType | ( | ChartType | chartType | ) | [slot] |
Specifies the additional chart type.
The default is no additional chart (NoType). The additional chart will have no grid so either make sure you specify the chart that should have a grid via setChartType()
and the other one as additional chart or specify the grid manually if you need one for the additional chart too.
The additional chart uses the same abscissa axis as the main chart, but cannot change the abscissa settings: the abscissa range and step width is determined according to the main chart's values.
You may combine all different types of cartesian charts (== Bar, Line, HiLo, ..., but not Polar, Pie, ...) so e.g. the following combinations are possible:
setChartType( KDChartParams::Bar ); setAdditionalChartType( KDChartParams::Line );
setChartType( KDChartParams::Line ); setAdditionalChartType( KDChartParams::HiLo );
setChartType( KDChartParams::Bar ); setAdditionalChartType( KDChartParams::Bar ); ...
- Note:
- When defining multiple charts it is mandatory to call
setChartSourceMode()
for specifying the dataset(s) and their respective charts after callingsetAdditionalChartType()
, also it is recommended to callsetAxisDatasets()
for all axes to be used by the different datasets - otherwise the default setting will be used (all datasets except the last one match the left axis, the last dataset matches the right axis), so e.g. your code to have a bar chart for datasets 0..2 (using the left axis) and a line chart for datasets 3..4 (using the right axis) could look like this:
setChartType( KDChartParams::Bar ); setAdditionalChartType( KDChartParams::Line ); setChartSourceMode( KDChartParams::DataEntry, 0,2, 0 ); setChartSourceMode( KDChartParams::DataEntry, 3,4, 1 ); setAxisDatasets( KDChartAxisParams::AxisPosLeft, 0,2, 0 ); setAxisDatasets( KDChartAxisParams::AxisPosRight, 3,4, 1 );
- Note:
- In case you DON'T want to use the right axis but the left axis #2 make sure to reset the dataset assignment that is automatically done for the right axis. Doing this will also clear the visibility flag of the right axis that is automatically set by setAdditionalChartType() implicitely assuming that the additional chart will use the right axis, so there is no need to explicitely call setAxisVisible( false ) for the right axis: specifying KDCHART_NO_DATASET is enough to disable it. e.g. in the example shown above you would replace the last line by these ones:
setAxisDatasets( KDChartAxisParams::AxisPosLeft2, 3,4, 1 ); setAxisDatasets( KDChartAxisParams::AxisPosRight, KDCHART_NO_DATASET );
Often your additional chart will look better when not overlapping with the first chart, specifying different y-positions for the charts is possible by KDChartAxisParams::setAxisUseAvailableSpace()
, e.g. like this:
// specify which amount of the available space // is to be used by the first y-axis: KDChartAxisParams pa( _p->axisParams( KDChartAxisParams::AxisPosLeft ) ); pa.setAxisUseAvailableSpace( 0, -499 ); _p->setAxisParams( KDChartAxisParams::AxisPosLeft, pa ); // specify which amount of the available space // is to be used by the second y-axis: pa = _p->axisParams( KDChartAxisParams::AxisPosLeft2 ); pa.setAxisUseAvailableSpace( -750, -1000 ); _p->setAxisParams( KDChartAxisParams::AxisPosLeft2, pa );
- Parameters:
-
chartType the additional chart type to use
- See also:
- additionalChartType, setChartSourceMode, setAxisDatasets
Definition at line 2990 of file KDChartParams.cpp.
void KDChartParams::ChartType KDChartParams::additionalChartType | ( | ) | const [inline, slot] |
Returns the additional chart type configured in this params object.
- Returns:
- the additional chart type configured in this params object.
- See also:
- setAdditionalChartType, setChartSourceMode, chartSourceMode
Definition at line 546 of file KDChartParams.h.
void KDChartParams::setChartSourceMode | ( | SourceMode | mode, | |
uint | dataset, | |||
uint | dataset2 = KDCHART_NO_DATASET , |
|||
uint | chart = 0 | |||
) | [slot] |
Specifies the chart source mode of one or more datasets.
Use this to specify if and how any data should be taken into account for a given chart. You may call this function multiple times to specify how the different datasets are to be used. Number of datasets is only limited by the data that you actually provide to the chart widget. Usage of this method is mandatory when specifying combinations of more than one chart (e.g. via setAdditionalChartType()
).
- Note:
- If specifying more than one dataset for the very same chart and the same source mode make sure they form a contiguous series.
It is not possible to use dataset 0..3 as DataEntry, dataset 4 as AxisLabel and again dataset 5..6 as DataEntry for the very same chart!
Of course you could specify 0..3 as DataEntry for chart 0 while 5..6 would contain the data entries for chart 1 when specifying a widget showing two charts.
Whenever you use
setChartSourceMode()
make sure not to forget any of the datasets which you want to define: not specifying a dataset would result in it being ignored.So the rule is: either don't call setChartSourceMode() at all or call it for each dataset!
To quickly clear all such settings just might want to call setChartSourceMode( UnknownMode, KDCHART_ALL_DATASETS ); without specifying a dataset number and without specifying a chart number.
However this KDCHART_ALL_DATASETS may only be used to clear SourceMode settings - but not for defining the SourceMode for all datasets - the above mentioned combination with UnknownMode is the only way how to use KDCHART_ALL_DATASETS here!
Examples:
setChartSourceMode( DataEntry, 2 );
setChartSourceMode( DataEntry, 0, 0, 0 ); setChartSourceMode( DataEntry, 3, 3, 1 );
setChartSourceMode( LegendText, 1, 1, 0 ); setChartSourceMode( AxisLabel, 2, 2, 0 ); setChartSourceMode( DataEntry, 3, 6, 0 ); setChartSourceMode( ExtraLinesAnchor, 7, 7, 0 ); setChartSourceMode( LegendText, 8, 8, 1 ); setChartSourceMode( AxisLabel, 9, 9, 1 ); setChartSourceMode( DataEntry, 10, 13, 1 );
- Note:
- If source mode is ExtraLinesAnchor all cells of the respective datset will be ignored when the normal cell representations (e.g. Bars or Lines) are drawn - these cells will only be used as anchor points for any extra lines that are specified with these cell's property sets.
ExtraLinesAnchor
for more than one dataset of the same chart make sure they form a contiguous row together with the DataEntry
dataset(s): e.g you may use datasets 3..8 for DataEntry cells and datasets 9..10 for ExtraLinesAnchor cells. All datasets with mode DataEntry or ExtraLinesAnchor are taken into account for calculation of the axes ranges and delimiters.
- Parameters:
-
mode the way how to use information stored in this dataset. dataset the dataset number to be used (or ignored, resp.). Use KDCHART_ALL_DATASETS
to indicate that information given applies to all of the datasets.dataset2 a second dataset number to be taken into account (or ignored, resp.). Use this one together with the param to specify a range of datasets. chart the chart taking into account this dataset. Use this parameter only if more than one chart is to be displayed. By using KDCHART_ALL_CHARTS here you may specify that the dataset (or the range of datasets, resp.) is to be taken into account for all of the charts displayed.
Definition at line 1440 of file KDChartParams.cpp.
QString KDChartParams::chartSourceModeToString | ( | const SourceMode & | mode | ) | [static, slot] |
Converts the specified chart source mode enum value to a string.
- Parameters:
-
mode the chart source mode enum value to convert
- Returns:
- the string
Definition at line 3263 of file KDChartParams_io.cpp.
KDChartParams::SourceMode KDChartParams::stringToChartSourceMode | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a chart source mode enum value.
- Parameters:
-
string the string to convert
- Returns:
- the chart source mode enum value
Definition at line 3290 of file KDChartParams_io.cpp.
bool KDChartParams::neverUsedSetChartSourceMode | ( | ) | const [inline, slot] |
Retrieves whether setChartSourceMode() was called or not.
Definition at line 571 of file KDChartParams.h.
KDChartParams::SourceMode KDChartParams::chartSourceMode | ( | uint | dataset, | |
uint | dataset2 = KDCHART_NO_DATASET , |
|||
uint * | pChart = 0 | |||
) | const [slot] |
Retrieves usage information of a given dataset or a range of datasets.
- Note:
- If you specify a range of datasets and not all of them share the same SourceMode the return value will be
UnknownMode
whereas in case of the dataset(s) not being used it will beDontUse
. Accordingly if you provide a chart pointer and not all the datasets share the same chart the chart pointer will receive the value KDCHART_UNKNOWN_CHART.
setChartSourceMode()
was not used at all chartSourceMode() will return DataEntry no matter what dataset number is specified.
- Parameters:
-
dataset the dataset number to be looked at. Use KDCHART_ALL_DATASETS
to find out if all of the datasets share the very same SourceMode.dataset2 a second dataset number. Use this one together with the param to look at a range of datasets and find out if all of them share the very same SourceMode. chart If this parameter points to an int the method will provide you with the chart number that this dataset (or this range of datasets, resp.) is taken into account for.
Definition at line 1494 of file KDChartParams.cpp.
bool KDChartParams::findDataset | ( | SourceMode | mode, | |
uint & | dataset, | |||
uint & | dataset2, | |||
uint | chart = 0 | |||
) | const [slot] |
Retrieves the dataset number or a range of datasets being used with a given SourceMode for a given chart or KDCHART_NO_DATASET if no dataset was specified for that mode and that chart.
- Note:
- If
setChartSourceMode()
was not used at all findDataset() will return true and set the dataset to KDCHART_ALL_DATASETS when called for SourceMode DataEntry. All other SourceModes will return false then.
- Returns:
- True if at least one dataset was found.
- Parameters:
-
mode the SourceMode to search for. dataset the dataset number found (or the first dataset number in case a series of datasets was found, resp.) dataset2 the dataset number found (or the last dataset number in case a series of datasets was found, resp.) Hint: You may give the same variable both for dataset and for dataset2, e.g. this makes sense in case you are sure that findDataset will find only one dataset anyway. chart the chart number that the dataset (or this range of datasets, resp.) must have been defined for. If this is missing findDataset assumes you are looking for datasets of the first chart.
- See also:
- findDatasets, SourceMode, setChartSourceMode, chartSourceMode
Definition at line 1570 of file KDChartParams.cpp.
bool KDChartParams::findDatasets | ( | SourceMode | modeA, | |
SourceMode | modeB, | |||
uint & | dataset, | |||
uint & | dataset2, | |||
uint | chart = 0 | |||
) | const [slot] |
Retrieves the dataset number or a range of datasets being used with one of two given SourceModes for a given chart or KDCHART_NO_DATASET if no dataset was specified for that mode and that chart.
If setChartSourceMode()
was not used at all findDataset() will return true and set the dataset to KDCHART_ALL_DATASETS when either modeA
or modeB
is DataEntry. All other SourceModes will return false then.
- Note:
- If the found datasets do not form a contiguous series the return value will be false and the value of
dataset
will be KDCHART_NO_DATASET and a comment will be written to stderr (if KDChart was compiled in debug mode).
- Returns:
- True if at least one dataset was found.
- Parameters:
-
modeA one of the SourceModes to search for. modeB the other one of the two SourceModes to search for. dataset the dataset number found (or the first dataset number in case a series of datasets was found, resp.) dataset2 the dataset number found (or the last dataset number in case a series of datasets was found, resp.) Hint: You may give the same variable both for dataset and for dataset2, e.g. this makes sense in case you are sure that findDataset will find only one dataset anyway. chart the chart number that the dataset (or this range of datasets, resp.) must have been defined for. If this is missing findDataset assumes you are looking for datasets of the first chart.
- See also:
- findDataset, SourceMode, setChartSourceMode, chartSourceMode
Definition at line 1640 of file KDChartParams.cpp.
uint KDChartParams::maxDatasetSourceMode | ( | ) | const [inline, slot] |
Returns the number of the highest dataset for which a SourceMode has been defined.
- Returns:
- the number of the highest dataset for which a SourceMode has been defined.
- See also:
- setChartSourceMode, chartSourceMode, findDataset
Definition at line 591 of file KDChartParams.h.
void KDChartParams::setDefaultAxesTypes | ( | ) | [slot] |
Set the default axis types for all the axes the user might activate for this chart:.
- Pie charts by default have no axes at all
- Bar/Line/Area charts may have up to 8 axes (up to 2 at each side of the chart)
- charts representing 3-dimensional data may have up to 12 axes
- Note:
- This function also specifies the default way how to calculate the axis labels: abscissa starts with zero and counts by 1, ordinate is calculating the labels automatically based upon the values found in the associated dataset(s).
Definition at line 1971 of file KDChartParams.cpp.
void KDChartParams::activateDefaultAxes | ( | ) | [slot] |
activate the default axis types for this chart:
- Pie charts by default have no axes at all
- Bar/Line/Area by default have 2 axes: the abscissa and the ordinate
- charts representing 3-dimensional data by default have 3 axes
Definition at line 2188 of file KDChartParams.cpp.
void KDChartParams::setNumValues | ( | uint | numValues | ) | [inline, slot] |
Specifies how many of the values should be shown.
-1 means all available values.
- Parameters:
-
numValues the number of values to be shown
- See also:
- numValues
Definition at line 601 of file KDChartParams.h.
int KDChartParams::numValues | ( | ) | const [inline, slot] |
Returns how many of the values should be shown.
-1 means all available values.
- Returns:
- the number of values to be shown
- See also:
- setNumValues
Definition at line 608 of file KDChartParams.h.
void KDChartParams::setDataColor | ( | uint | dataset, | |
QColor | color | |||
) | [slot] |
Specifies a color for a dataset.
Note that if you define a color for a dataset but not for a dataset with a lower number (and there is neither a default value), the color for that dataset with the lower number will be undefined. If you do not want any color, pass an invalid color (i.e. a default-constructed QColor object). This is only useful for chart types that have an outline (like bars or pies), because you would not see anything otherwise.
In charts that can only display one dataset (like pies), the specified colors are used for the different values instead.
- Parameters:
-
dataset the number of the dataset (or value for pies and similar charts) for which the color is specified color the color to use for this dataset/value
Definition at line 1694 of file KDChartParams.cpp.
QColor KDChartParams::dataColor | ( | uint | dataset | ) | const [slot] |
Returns the color for a dataset.
If no color has been defined for this dataset and none for a higher dataset either, the number will be mapped to the range of defined colors. If no color has been defined for this dataset, but at least one for a higher dataset, the return value of this method is undefined.
- Parameters:
-
dataset the number of the dataset for which to return the color
- Returns:
- the color for this dataset
- See also:
- setDataColor, maxDataColor
Definition at line 1860 of file KDChartParams.cpp.
void KDChartParams::setDataDefaultColors | ( | ) | [slot] |
Specifies KD Chart's default colors for the datasets 0.
.11.
This method may be usefull to re-set the colors after changing the colors of the datasets.
Definition at line 1716 of file KDChartParams.cpp.
void KDChartParams::setDataRainbowColors | ( | ) | [slot] |
Specifies a set of eight rainbow-like colors for the datasets 0.
.7 and sets the lighter versions of this colors to datasets 8..15.
This is a convenience method setting colors that look best on a dark gray or black background.
Definition at line 1742 of file KDChartParams.cpp.
void KDChartParams::setDataSubduedColors | ( | bool | ordered = false |
) | [slot] |
Specifies a set of eighteen subdued colors for the datasets 0.
.17.
This is a convenience method setting colors that is ideal for area charts since the dark data value texts can be easily read when printed onto such background colors.
- Parameters:
-
ordered if true all eighteen colors will be set according to their appearance in the color circle, if false they will be arranged in a logical order making it very easy ti distinguish two neighboring colors. Set this parameter to true if you want your neighboring colors look quite similiar, the default is false.
Definition at line 1772 of file KDChartParams.cpp.
void KDChartParams::setShadowBrightnessFactor | ( | double | factor | ) | [inline, slot] |
Specifies a factor to be used to adjust the built-in brightness of shadow colors in 3-dimensional drawings like e.g.
3D Bar charts.
- Parameters:
-
factor a factor that is to be taken into account for internal calculation of shadow colors. By specifying values greater 1.0 you may lighten the shadows until the most intensive brightness is reached, while values smaller than 1.0 will darken the shadows until the respective colors are black.
- See also:
- shadowBrightnessFactor
Definition at line 626 of file KDChartParams.h.
double KDChartParams::shadowBrightnessFactor | ( | ) | const [inline, slot] |
Returns a factor to be used to adjust the built-in brightness of shadow colors in 3-dimensional drawings like e.g.
3D Bar charts.
- Returns:
- a factor that is to be taken into account for internal calculation of shadow colors.
- See also:
- setShadowBrightnessFactor
Definition at line 633 of file KDChartParams.h.
Qt::BrushStyle KDChartParams::shadowPattern | ( | ) | const [inline, slot] |
Returns the filling style used for filling the shadow areas in 3-dimensional drawings like 3D bar charts.
The default is to fill with a solid color, the fill color can be queried with threeDShadowColors().
- Returns:
- the fill style used
- See also:
- setShadowPattern(), setThreeDShadowColors(), threeDShadowColors()
Definition at line 644 of file KDChartParams.h.
void KDChartParams::setOutlineDataColor | ( | QColor | color | ) | [inline, slot] |
Specifies a color for the outlines of data displays.
The default is black.
- Note:
- Use setOutlineDataLineStyle( Qt::NoPen ) to hide the line.
- Parameters:
-
color the color to use for the outlines
Definition at line 649 of file KDChartParams.h.
QColor KDChartParams::outlineDataColor | ( | ) | const [inline, slot] |
Returns the color for the outlines of data displays.
- Returns:
- the outline color
- See also:
- setOutlineDataColor
Definition at line 656 of file KDChartParams.h.
void KDChartParams::setOutlineDataLineWidth | ( | uint | width | ) | [inline, slot] |
Specifies the width of the outlines of data displays.
The default is 1 pixel.
- Note:
- Use setOutlineDataLineStyle( Qt::NoPen ) to hide the line.
- Parameters:
-
width the line width to use for the outlines
Definition at line 662 of file KDChartParams.h.
uint KDChartParams::outlineDataLineWidth | ( | ) | const [inline, slot] |
Returns the width of the outlines of data displays.
- Parameters:
-
style the line width that is used for outlines
- See also:
- setOutlineDataLineWidth
Definition at line 668 of file KDChartParams.h.
void KDChartParams::setOutlineDataLineStyle | ( | PenStyle | style | ) | [inline, slot] |
Specifies the line style of the outlines of data displays.
The default is a solid line. Warning: On Windows 95/98, the style setting (other than NoPen and SolidLine) has no effect for lines with width greater than 1, due to a bug in the operating system.
- Parameters:
-
width the line style to use for the outlines
Definition at line 674 of file KDChartParams.h.
PenStyle KDChartParams::outlineDataLineStyle | ( | ) | const [inline, slot] |
Returns the style of the outlines of data displays.
- Parameters:
-
style the line style that is used for outlines
- See also:
- setOutlineDataLineStyle
Definition at line 680 of file KDChartParams.h.
uint KDChartParams::maxDataColor | ( | ) | const [inline, slot] |
Returns the number of the highest dataset for which a color has been defined.
- Returns:
- the number of the highest dataset for which a color has been defined.
- See also:
- setDataColor, dataColor
Definition at line 686 of file KDChartParams.h.
void KDChartParams::setThreeDShadowColors | ( | bool | shadow | ) | [inline, slot] |
Specifies whether the engine should draw the sides and tops of 3D effects in shadowed versions of the data colors (the default) or in the data colors themselves.
Only used with 3D effects in charts that support these.
- Parameters:
-
shadow true for shadowed colors, false for original colors
- See also:
- threeDShadowColors
Definition at line 692 of file KDChartParams.h.
bool KDChartParams::threeDShadowColors | ( | ) | const [inline, slot] |
Returns whether the engine should draw the sides and tops of 3D effects in shadowed versions of the data colors or in the data colors themselves.
Only used with 3D effects in charts that support these. The default is true.
- Returns:
- true if shadowed colors are used for 3D effects
- See also:
- setThreeDShadowColors
Definition at line 699 of file KDChartParams.h.
int KDChartParams::roundVal | ( | double | d | ) | [inline, static, slot] |
Returns the parameter d
rounded to the nearest integer.
Definition at line 705 of file KDChartParams.h.
void KDChartParams::setPrintDataValues | ( | bool | active, | |
uint | chart = KDCHART_ALL_CHARTS , |
|||
int | divPow10 = 0 , |
|||
int | digitsBehindComma = KDCHART_DATA_VALUE_AUTO_DIGITS , |
|||
QFont * | font = 0 , |
|||
uint | size = UINT_MAX , |
|||
const QColor * | color = KDCHART_DATA_VALUE_AUTO_COLOR , |
|||
KDChartEnums::PositionFlag | negativePosition = KDChartEnums::PosCenter , |
|||
uint | negativeAlign = Qt::AlignCenter , |
|||
int | negativeDeltaX = 0 , |
|||
int | negativeDeltaY = 0 , |
|||
int | negativeRotation = 0 , |
|||
KDChartEnums::PositionFlag | positivePosition = KDChartEnums::PosCenter , |
|||
uint | positiveAlign = Qt::AlignCenter , |
|||
int | positiveDeltaX = 0 , |
|||
int | positiveDeltaY = 0 , |
|||
int | positiveRotation = 0 , |
|||
KDChartEnums::TextLayoutPolicy | policy = KDChartEnums::LayoutPolicyRotate | |||
) | [slot] |
Specifies if and how a chart will print the data value texts near their respective entries.
Data value texts will be printed immediately after drawing all of the chart data points (or bars, lines,...) but before drawing the legend and before drawing any custom boxes. If more than one chart ist to be drawn (sharing the same data area) printing of the data text values will take place after drawing all of the last charts data points, this enables us to see the texts even if their respective data representations are covered by the second charts drawings. The same covering/colliding problem might occur with Area charts if one area is (partially) covering another area. In such cases you might either want to specify an appropriate TextLayoutPolicy for getting a better looking result or specify an other text color for data value texts of the second chart since by default the first chart has black texts while the second chart shows its data value texts in dark blue color.
- Note:
- Only used if chartType() is neither HiLo nor BoxWhisker. To specify printing of data values in a HiLo chart please use setHiLoChartPrintLowValues, setHiLoChartPrintHighValues, setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues. To specify printing of data values in a BoxWhisker chart please use setBWChartPrintStatistics.
Calling setPrintDataValuesWithDefaultFontParams( chart ) will reset the respective font size and colour and position parameters (but not the QFont itself) and activate printing of the values for the chart
speficied (or for all charts by using KDCHART_ALL_CHARTS
, resp.).
- Parameters:
-
active specifies whether the value texts are to be printed or not. chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. Use the special value KDCHART_ALL_CHARTS to specify that your settings are to be taken for both charts. 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. font a Pointer to the font to be used, if zero the default data value texts font will be taken (this is a Times font since small Times digits are clearer than small Helvetica digits).
- Parameters:
-
size (in per mille of the chart width) the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart! You may use setPrintDataValuesFontRelSize to change this parameter setting without affecting the other ones.color the color to be used when printing the values. To have the color calculated automatically - useful when printing inside the bars (or pie slices, areas, ... resp.) - please use KDCHART_DATA_VALUE_AUTO_COLOR
instead of a QColor*. You may use setPrintDataValuesColor to change this parameter setting without affecting the other ones.
- Parameters:
-
negativePosition The anchor position which the text is to be aligned to. negativeAlign The way how the text is to be aligned to the anchor. This must be a reasonable combination of Qt::AlignmentFlags. negativeDeltaX The X distance between the anchor point -- specified by negativePosition
(orpositivePosition
, resp.) -- and the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.). Note: For better compatibility to the dynamic font size this parameter is interpreted as being a per-cent value of the used font height. If greater 0, the X position is increased, if less than 0, it is reduced. Actual font size and thus also this delta value are calculated dynamically before painting based on the size of the chart and the specification made via parametersize
.negativeDeltaY The Y distance between the anchor point -- specified by negativePosition
(orpositivePosition
, resp.) -- and the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.). Note: For better compatibility to the dynamic font size this parameter is interpreted as being a per-cent value of the used font height. If greater 0, the Y position is increased, if less than 0, it is reduced. Actual font size and thus also this delta value are calculated dynamically before painting based on the size of the chart and the specification made via parametersize
.negativeRotation The amount of degrees (using a circle of 360 degrees) taken to rotate the text. Positive values rotate clockwise, negative values rotate counter-clockwise. There are two special values that you might find usefull for Pie charts or for Ring charts: KDCHART_SAGGITAL_ROTATION
andKDCHART_TANGENTIAL_ROTATION
both leading to individual calculation of appropriate rotation for each data value. Rotation will be performed around the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.).
- Parameters:
-
positivePosition The anchor position which the text is to be aligned to. positiveAlign The way how the text is to be aligned to the anchor. This must be a reasonable combination of Qt::AlignmentFlags. negativeDeltaX The X distance between the anchor point -- specified by negativePosition
(orpositivePosition
, resp.) -- and the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.). Note: For better compatibility to the dynamic font size this parameter is interpreted as being a per-cent value of the used font height. If greater 0, the X position is increased, if less than 0, it is reduced. Actual font size and thus also this delta value are calculated dynamically before painting based on the size of the chart and the specification made via parametersize
.positiveDeltaY The Y distance between the anchor point -- specified by negativePosition
(orpositivePosition
, resp.) -- and the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.). Note: For better compatibility to the dynamic font size this parameter is interpreted as being a per-cent value of the used font height. If greater 0, the Y position is increased, if less than 0, it is reduced. Actual font size and thus also this delta value are calculated dynamically before painting based on the size of the chart and the specification made via parametersize
.positiveRotation The amount of degrees (using a circle of 360 degrees) taken to rotate the text. Positive values rotate clockwise, negative values rotate counter-clockwise. There are two special values that you might find usefull for Pie charts or for Ring charts: KDCHART_SAGGITAL_ROTATION
andKDCHART_TANGENTIAL_ROTATION
both leading to individual calculation of appropriate rotation for each data value. Rotation will be performed around the internal alignment point of the text -- specified bynegativeAlign
(orpositiveAlign
, resp.).layoutPolicy The way to handle too narrow space conflicts: what to do if a data text covers a neighboring data text (or a neighboring data area, resp.).
- See also:
- printDataValues
setPrintDataValuesWithDefaultFontParams, printDataValuesWithDefaultFontParams
setPrintDataValuesFontRelSize, setPrintDataValuesColor
dataValuesDivPow10
dataValuesDigitsBehindComma
dataValuesFontUseRelSize
dataValuesFontColor
Definition at line 1063 of file KDChartParams.cpp.
void KDChartParams::setDataValuesCalc | ( | int | divPow10 = 0 , |
|
int | digitsBehindComma = KDCHART_DATA_VALUE_AUTO_DIGITS , |
|||
uint | chart = KDCHART_ALL_CHARTS | |||
) | [slot] |
Specifies how the data value text figures are modified before printing.
This methode is provided for your convenience, to learn how to set the other text parameters please have a look at setPrintDataValues.
- See also:
- printDataValuesWithDefaultFontParams, setPrintDataValues
setPrintDataValuesFontRelSize setPrintDataValuesBackground
Definition at line 3263 of file KDChartParams.cpp.
void KDChartParams::setDataValuesFont | ( | QFont * | font, | |
uint | size = UINT_MAX , |
|||
uint | chart = KDCHART_ALL_CHARTS | |||
) | [slot] |
Specifies the font to be used for printing the data value texts.
This methode is provided for your convenience, to learn how to set the other text parameters please have a look at setPrintDataValues.
- See also:
- printDataValuesWithDefaultFontParams, setPrintDataValues
setPrintDataValuesFontRelSize setPrintDataValuesBackground
Definition at line 3290 of file KDChartParams.cpp.
void KDChartParams::setDataValuesPlacing | ( | KDChartEnums::PositionFlag | position, | |
uint | align, | |||
int | deltaX, | |||
int | deltaY, | |||
int | rotation, | |||
bool | specifyingPositiveValues = true , |
|||
uint | chart = KDCHART_ALL_CHARTS | |||
) | [slot] |
Specifies the position and rotation of the data value texts to be printed.
This methode is provided for your convenience, to learn how to set the other text parameters please have a look at setPrintDataValues.
- See also:
- printDataValuesWithDefaultFontParams, setPrintDataValues
setPrintDataValuesFontRelSize setPrintDataValuesBackground
Definition at line 3322 of file KDChartParams.cpp.
void KDChartParams::setDataValuesColors | ( | const QColor * | color = KDCHART_DATA_VALUE_AUTO_COLOR , |
|
const QBrush & | background = Qt::NoBrush , |
|||
uint | chart = KDCHART_ALL_CHARTS | |||
) | [slot] |
Specifies the text color and background brush to be used for printing the data value texts.
To have the color calculated automatically - useful when printing inside the bars (or pie slices, areas, ... resp.) - please use KDCHART_DATA_VALUE_AUTO_COLOR
instead of a QColor*.
Setting the background is normally not needed since reasonable settings are done by default: Area charts have a white background behind the data value texts while all other chart types use no special background (the value is Qt::NoBrush then).
In case you want to use it to remove the extra background from your Area chart's data value texts you should consider changing the dataset colors as well: an idea might be trying the subdued colorset by calling setSubduedColors()
.
- See also:
- printDataValuesWithDefaultFontParams
Definition at line 3379 of file KDChartParams.cpp.
void KDChartParams::setDataValuesShowInfinite | ( | bool | dataValuesShowInfinite = true , |
|
uint | chart = KDCHART_ALL_CHARTS | |||
) | [slot] |
Specifies whether data value texts should be printed even if the value is KDCHART_POS_INFINITE (or KDCHART_NEG_INFINITE).
Printing of an infinite symbol (lemniskate) is done by default, ou may use this function to disable it.
- See also:
- printDataValuesWithDefaultFontParams
Definition at line 3430 of file KDChartParams.cpp.
void KDChartParams::setPrintDataValuesWithDefaultFontParams | ( | uint | chart = KDCHART_ALL_CHARTS , |
|
bool | callSetPrintDataValues = true | |||
) | [slot] |
Specifies that data value texts are to be printed with default font parameters.
Calling this methode results in resetting the respective font size and colour and position parameters but not the QFont itself. By setting callSetPrintDataValues
to true you select general enabling of text printing, when doing so it is not neccessary to call setPrintDataValues() after calling setPrintDataValuesWithDefaultFontParams().
- Note:
- If you want to call setChartType() after calling setPrintDataValuesWithDefaultFontParams() you should set the
callSetPrintDataValues
parameter to false to prevent setPrintDataValues() from being called twice since it is called internally each time you call setChartType() if the default font params are to be set.
Definition at line 3519 of file KDChartParams.cpp.
void KDChartParams::setAllowOverlappingDataValueTexts | ( | bool | allow | ) | [inline, slot] |
Specifies whether a data value text may be drawn even if it's region intersects with another data value text's region.
By default this is FALSE to prevent ugly mutual overwriting of data value texts and to speed up drawing of cahrts containing thousands of data points.
Definition at line 768 of file KDChartParams.h.
bool KDChartParams::allowOverlappingDataValueTexts | ( | ) | const [inline, slot] |
Returns whether a data value text may be drawn even if it's region intersects with another data value text's region.
By default this is FALSE to prevent ugly mutual overwriting of data value texts and to speed up drawing of cahrts containing thousands of data points.
Definition at line 774 of file KDChartParams.h.
bool KDChartParams::printDataValuesWithDefaultFontParams | ( | uint | chart | ) | const [inline, slot] |
Retrieves whether data value texts are to be printed with non-default font parameters or not - when text printing is active.
- Note:
- You might also want to call printDataValues to see if text printing is active since this default flag remains set in background even when printing has been de-activated.
Definition at line 779 of file KDChartParams.h.
bool KDChartParams::printDataValues | ( | uint | chart | ) | const [inline, slot] |
Returns whether the data values will be printed near their respective entries.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- whether the data values will be printed near their respective entries.
- See also:
- setPrintDataValues
Definition at line 785 of file KDChartParams.h.
QFont KDChartParams::dataValuesFont | ( | uint | chart | ) | const [inline, slot] |
Returns the font to be used for printing the data values.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- the font to be used for printing the data values
- See also:
- setPrintDataValues
Definition at line 806 of file KDChartParams.h.
bool KDChartParams::dataValuesUseFontRelSize | ( | uint | chart | ) | const [inline, slot] |
Returns whether the font size to be used for printing the data values is calculated dynamically.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- whether the font size to be used for printing the data values is calculated dynamically.
Definition at line 813 of file KDChartParams.h.
int KDChartParams::dataValuesFontRelSize | ( | uint | chart | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of font size to be used for printing the data values.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- the relative size (in per mille of the chart width) of font size to be used for printing the data values.
Definition at line 820 of file KDChartParams.h.
QColor KDChartParams::dataValuesColor | ( | uint | chart | ) | const [inline, slot] |
Returns the colour of the font to be used for printing the data values.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- the colour of the font to be used for printing the data values.
- See also:
- setPrintDataValues, setPrintDataValuesColor
Definition at line 827 of file KDChartParams.h.
bool KDChartParams::dataValuesAutoColor | ( | uint | chart | ) | const [inline, slot] |
Returns whether the font to be used for printing the data values texts shall have automatically calculated colors fitting to their respectivs data representations.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- whether the font to be used for printing the data values texts shall have automatically calculated colors fitting to their respectivs data representations.
- See also:
- setPrintDataValues
Definition at line 841 of file KDChartParams.h.
KDChartEnums::PositionFlag KDChartParams::dataValuesAnchorPosition | ( | uint | chart, | |
bool | negative | |||
) | const [slot] |
Returns the anchor position which the text is to be aligned to.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. negative If true the return value is only valid for data values less than zero, if false it applies to data values greater or equal to zero.
- Returns:
- the anchor position which the text is to be aligned to in case of the value being less than zero.
- See also:
- setPrintDataValues
Definition at line 3671 of file KDChartParams.cpp.
uint KDChartParams::dataValuesAnchorAlign | ( | uint | chart, | |
bool | negative | |||
) | const [slot] |
Returns the way how the text is to be aligned to the anchor.
This must be a reasonable combination of Qt::AlignmentFlags.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. negative If true the return value is only valid for data values less than zero, if false it applies to data values greater or equal to zero.
- Returns:
- the way how the text is to be aligned to the anchor in case of the value being less than zero.
- See also:
- setPrintDataValues
Definition at line 3700 of file KDChartParams.cpp.
int KDChartParams::dataValuesAnchorDeltaX | ( | uint | chart, | |
bool | negative | |||
) | const [slot] |
Returns the X distance between the text and its anchor.
- Note:
- For better compatibility to the dynamic font size, this parameter is always interpreted as being a per-mille value of the logical width of the drawing area. If greater 0, the X position is increased, if less than 0, it is reduced, this is calculated dynamically before painting.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. negative If true the return value is only valid for data values less than zero, if false it applies to data values greater or equal to zero.
- Returns:
- the X distance between the text and its anchor.
- See also:
- setPrintDataValues
Definition at line 3732 of file KDChartParams.cpp.
int KDChartParams::dataValuesAnchorDeltaY | ( | uint | chart, | |
bool | negative | |||
) | const [slot] |
Returns the Y distance between the text and its anchor.
- Note:
- For better compatibility to the dynamic font size this parameter is always interpreted as being a per-mille value of the logical width of the drawing area. If greater 0, the Y position is increased, if less than 0, it is reduced, this is calculated dynamically before painting.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. negative If true the return value is only valid for data values less than zero, if false it applies to data values greater or equal to zero.
- Returns:
- the Y distance between the text and its anchor.
- See also:
- setPrintDataValues
Definition at line 3764 of file KDChartParams.cpp.
int KDChartParams::dataValuesRotation | ( | uint | chart, | |
bool | negative | |||
) | const [slot] |
Returns the amount of degrees (using a circle of 360 degrees) taken to rotate the text.
Positive values rotate clockwise, negative values rotate counter-clockwise.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area. negative If true the return value is only valid for data values less than zero, if false it applies to data values greater or equal to zero.
- Returns:
- the amount of degrees (using a circle of 360 degrees) taken to rotate the text.
- See also:
- setPrintDataValues
Definition at line 3792 of file KDChartParams.cpp.
KDChartEnums::TextLayoutPolicy KDChartParams::dataValuesLayoutPolicy | ( | uint | chart | ) | const [inline, slot] |
Returns the way to handle too narrow space conflicts: what to do if a data text covers a neighboring data text (or a neighboring data area, resp.
).
- Note:
- A layout policy different from LayoutJustOverwrite from does not mean that this policy is followed in any case. Rather than giving up when the selected policy does not result in a good layout the program will automatically try the next policy: if LayoutPolicyRotate did not succeed LayoutPolicyShiftVertically will be tried, if this did not succeed either LayoutPolicyShiftHorizontally will be tried.
- Parameters:
-
chart The number of the chart: 0 for the first chart, 1 for the second chart in case there are two charts to be drawn sharing the same data area.
- Returns:
- the way to handle too narrow space conflicts.
- See also:
- setPrintDataValues
Definition at line 855 of file KDChartParams.h.
void KDChartParams::setPrintDataValuesFontRelSize | ( | uint | chart, | |
uint | size | |||
) | [slot] |
Specifies the dynamic font size to be used for printing the data value texts.
To change settings for all charts specify KDCHART_ALL_CHARTS
as parameter.
This methode is provided for your convenience, to learn how to set the other text parameters please have a look at setPrintDataValues.
- See also:
- printDataValuesWithDefaultFontParams, setPrintDataValues
setPrintdataValuesColor, dataValuesFontRelSize
Definition at line 3484 of file KDChartParams.cpp.
void KDChartParams::setBarChartSubType | ( | BarChartSubType | barChartSubType | ) | [inline, slot] |
Specifies the bar chart subtype.
This setting only has an effect in bar charts.
- Parameters:
-
barChartSubType the bar chart subtype
- See also:
- barChartSubType, BarChartSubType, setChartType, chartType
Definition at line 889 of file KDChartParams.h.
KDChartParams::BarChartSubType KDChartParams::barChartSubType | ( | ) | const [inline, slot] |
Returns the bar chart subtype.
This setting only has an effect in bar charts.
- Returns:
- the bar chart sub type
- See also:
- setBarChartSubType, BarChartSubType, setChartType, chartType
Definition at line 895 of file KDChartParams.h.
QString KDChartParams::barChartSubTypeToString | ( | BarChartSubType | type | ) | [static, slot] |
Converts the specified bar chart subtype enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2714 of file KDChartParams_io.cpp.
KDChartParams::BarChartSubType KDChartParams::stringToBarChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a bar chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the bar chart subtype enum value
Definition at line 2737 of file KDChartParams_io.cpp.
void KDChartParams::setThreeDBars | ( | bool | threeDBars | ) | [inline, slot] |
Specifies whether the engine should draw the bars in 3D.
This setting only has an effect in bar charts.
- Parameters:
-
threeDBars true if bars should be drawn with a 3D effect
- See also:
- threeDBars, setThreeDBarAngle, threeDBarAngle
Definition at line 908 of file KDChartParams.h.
bool KDChartParams::threeDBars | ( | ) | const [inline, slot] |
Returns whether the engine should draw any bars in 3D.
This setting only has an effect in bar charts.
- Returns:
- true if bars should be draws with a 3D effect, false otherwise
- See also:
- setThreeDBars, threeDBarAngle, setThreeDBarAngle
Definition at line 914 of file KDChartParams.h.
void KDChartParams::setThreeDBarsShadowColors | ( | bool | shadow | ) | [inline, slot] |
- Deprecated:
- Specifies whether the engine should draw the sides and tops of 3D bars in shadowed versions of the data colors or in the data colors themselves. Only used if threeDBars() == true. The default is true.
This method is obsolete; use setThreeDShadowColors instead
- Parameters:
-
shadow true for shadowed colors, false for original colors
- See also:
- setThreeDShadowColors
Definition at line 920 of file KDChartParams.h.
bool KDChartParams::threeDBarsShadowColors | ( | ) | const [inline, slot] |
- Deprecated:
- Returns whether the engine should draw the sides and tops of 3D bars in shadowed versions of the data colors or in the data colors themselves. Only used if threeDBars() == true. The default is true.
This method is obsolete; use threeDShadowColors instead
- Returns:
- true if bars use shadowed colors for 3D effects
- See also:
- setThreeDBarsShadowColors
Definition at line 927 of file KDChartParams.h.
QColor KDChartParams::dataShadow1Color | ( | uint | dataset | ) | const [slot] |
Returns the first shadow color for a dataset.
This is the color that is used to draw the top bars with 3D effects. It is somewhat darker than the original data color. If no color has been defined for this dataset and none for a higher dataset either, the number will be mapped to the range of defined colors. If no color has been defined for this dataset, but at least one for a higher dataset, the return value of this method is undefined.
- Parameters:
-
dataset the number of the dataset for which to return the color
- Returns:
- the color for this dataset
- See also:
- setDataColor, maxDataColor, dataShadow2Color
Definition at line 1915 of file KDChartParams.cpp.
QColor KDChartParams::dataShadow2Color | ( | uint | dataset | ) | const [slot] |
Returns the second shadow color for a dataset.
This is the color that is used to draw the sides of bars with 3D effects. It is darker than the original data color. If no color has been defined for this dataset and none for a higher dataset either, the number will be mapped to the range of defined colors. If no color has been defined for this dataset, but at least one for a higher dataset, the return value of this method is undefined.
- Parameters:
-
dataset the number of the dataset for which to return the color
- Returns:
- the color for this dataset
- See also:
- setDataColor, maxDataColor, dataShadow1Color
Definition at line 1944 of file KDChartParams.cpp.
void KDChartParams::setThreeDBarAngle | ( | uint | angle | ) | [slot] |
Specifies the angle used for 3D bars.
Only used if threeDBars() == true.
This setting only has an effect in bar charts.
- Parameters:
-
angle the angle in degrees. The default (and most useful value) is 45. Angle can be between 0 and 90, all other values are ignored. Values close to 0 or close to 90 may look strange, depending on the resolution of the output device.
- See also:
- setThreeDBars, threeDBars
Definition at line 4200 of file KDChartParams.cpp.
uint KDChartParams::threeDBarAngle | ( | ) | const [inline, slot] |
Returns the angle in degrees used for 3D bars.
Only used if threeDBars() == true.
This setting only has an effect in bar charts.
- Returns:
- the angle in degrees used for 3D bars, always between 0 and 90.
Definition at line 938 of file KDChartParams.h.
double KDChartParams::cosThreeDBarAngle | ( | ) | const [inline, slot] |
Returns the cosine in rad of the angle used for 3D bars.
Only used if threeDBars() == true.
This setting only has an effect in bar charts.
- Returns:
- the cosine in rad of the angle used for 3D bars, always between 0 and 90.
- See also:
- setThreeDBars, threeDBars
Definition at line 944 of file KDChartParams.h.
void KDChartParams::setThreeDBarDepth | ( | double | depth | ) | [inline, slot] |
Specifies the depth of the 3D Effect used for 3D bars.
Only used if threeDBars() == true.
This setting only has an effect in bar charts.
- Parameters:
-
depth the depth of the 3D Effect in relation to the bar width. The default (and most useful) value of 1.0 may be used to specify bars with square basis.
- See also:
- threeDBarDepth
Definition at line 950 of file KDChartParams.h.
double KDChartParams::threeDBarDepth | ( | ) | const [inline, slot] |
Returns the depth of the 3D Effect used for 3D bars.
Only used if threeDBars() == true.
This setting only has an effect in bar charts.
- Returns:
- the depth of the 3D Effect in relation to the bar width.
- See also:
- setThreeDBarDepth
Definition at line 957 of file KDChartParams.h.
void KDChartParams::setDatasetGap | ( | int | gap | ) | [inline, slot] |
Specifies the number of pixels between two dataset values.
In addition you might want to use setOutlineDataLineStyle( Qt::NoPen )
to hide the line.
Also the method setValueBlockGap
might be usefull, please read the information given there ...
This setting only has an effect in bar charts: if there is more than one dataset shown by your chart.
- Note:
- Use negative values for overlaps, use
setDatasetGapIsRelative
to specify that thegap
value is a per mille value of the chart data area width.
- Parameters:
-
gap the number of pixels between two dataset values.
Definition at line 963 of file KDChartParams.h.
int KDChartParams::datasetGap | ( | ) | const [inline, slot] |
Returns the number of pixels between two dataset values.
This setting only has an effect in bar charts.
- Note:
- Negative values signify overlaps, use
datasetGapIsRelative
to find out if the value is a per mille value of the chart data area width.
- Returns:
- the number of pixels between two dataset values.
Definition at line 969 of file KDChartParams.h.
void KDChartParams::setDatasetGapIsRelative | ( | bool | gapIsRelative | ) | [inline, slot] |
Specifies if the value set by setDatasetGap
is a per mille value of the chart data area width.
This setting only has an effect in bar charts.
- Parameters:
-
gapIsRelative specifies if the value set by setDatasetGap
is a per mille value of the chart data area width.
- See also:
- datasetGapIsRelative, datasetGap, setDatasetGap
Definition at line 975 of file KDChartParams.h.
bool KDChartParams::datasetGapIsRelative | ( | ) | const [inline, slot] |
Returns if the value set by setDatasetGap
is a per mille value of the chart data area width.
This setting only has an effect in bar charts.
- Returns:
- if the value set by
setDatasetGap
is a per mille value of the chart data area width.
- See also:
- setDatasetGap, setDatasetGapIsRelative, datasetGap, setDatasetGap
Definition at line 981 of file KDChartParams.h.
void KDChartParams::setValueBlockGap | ( | int | gap | ) | [inline, slot] |
Specifies the number of pixels between each value block.
If there is only one dataset shown this gap is appearing between each of the bars, otherwise it is appearing between each of the bar blocks. In addition you might want to use setOutlineDataLineStyle( Qt::NoPen )
to hide the line.
Also the method setDatasetGap
might be usefull, please read the information given there ...
This setting only has an effect in bar charts.
Use negative values for overlaps (which might look strange), use setValueBlockGapIsRelative
to specify that the gap
value is a per mille value of the chart data area width.
The default is 15 per mille of the data area of the chart.
- Note:
- Specifying a value block gap width AND a bar width may result in KD Chart not being able to display all bars if the data area is not wide enough. To make your application notice when this happens you should consider connecting the barsDisplayed() signal emitted by your KDChartWidget object to an appropriate slot function. Additionally (or in case you are not using the KDChartWidget class, resp.) you may access the number of actually displayed/not displayed bars by the KDChartParams functions numBarsDisplayed and numBarsLeft, the return value of these functions are not not defined if they are called before drawing is done.
- Parameters:
-
gap the number of pixels between each value block.
- See also:
- setDatasetGap
KDChartWidget::barsDisplayed, KDChart::barsDisplayed
Definition at line 987 of file KDChartParams.h.
int KDChartParams::valueBlockGap | ( | ) | const [inline, slot] |
Returns the number of pixels between each value block.
This setting only has an effect in bar charts.
- Note:
- Negative values signify overlaps, use
valueBlockGapIsRelative
to find out if the value is a per mille value of the chart data area width.
- Returns:
- the number of pixels between each value block.
Definition at line 993 of file KDChartParams.h.
void KDChartParams::setValueBlockGapIsRelative | ( | bool | gapIsRelative | ) | [inline, slot] |
Specifies if the value set by setValueBlockGap
is a per mille value of the chart data area width.
This setting only has an effect in bar charts.
- Parameters:
-
gapIsRelative specifies if the value set by setValueBlockGap
is a per mille value of the chart data area width.
- See also:
- valueBlockGapIsRelative, valueBlockGap, setValueBlockGap
Definition at line 999 of file KDChartParams.h.
bool KDChartParams::valueBlockGapIsRelative | ( | ) | const [inline, slot] |
Returns if the value set by setValueBlockGap
is a per mille value of the chart data area width.
This setting only has an effect in bar charts.
- Returns:
- if the value set by
setValueBlockGap
is a per mille value of the chart data area width.
Definition at line 1005 of file KDChartParams.h.
void KDChartParams::setBarWidth | ( | int | width = KDCHART_AUTO_SIZE |
) | [inline, slot] |
Specifies the width of one bar: makes sure that all of the bars have exactly the same width.
This setting only has an effect in bar charts.
- Note:
- Use negative values for to specify that the
width
value is a per mille value of the chart data area width, use no value or the default KDCHART_AUTO_SIZE to (re)activate normal calculation mode making sure that all bars fit into the available space but might not look so nice if many bars are there.Specifying a bar width AND a value block gap width may result in KD Chart not being able to display all bars if the data area is not wide enough. To make your application notice when this happens you should consider connecting the barsDisplayed() signal emitted by your KDChartWidget object to an appropriate slot function. Additionally (or in case you are not using the KDChartWidget class) you may access the number of actually displayed/not displayed bars by the KDChartParams functions numBarsDisplayed and numBarsLeft, the return value of these functions are not not defined if they are called before drawing is done.
- Parameters:
-
width the width of one bar.
- See also:
- KDChartWidget::barsDisplayed, KDChart::barsDisplayed
Definition at line 1011 of file KDChartParams.h.
int KDChartParams::barWidth | ( | ) | const [inline, slot] |
Returns the width of one bar as set by setBarWidth or KDCHART_AUTO_SIZE if setBarWidth was never called.
This setting only has an effect in bar charts.
- Note:
- Negative values signify that the bar width is a per mille value of the chart data area width.
- Returns:
- the width of one bar as set by setBarWidth or KDCHART_AUTO_SIZE if setBarWidth was never called.
- See also:
- setBarWidth
Definition at line 1024 of file KDChartParams.h.
int KDChartParams::numBarsDisplayed | ( | ) | const [inline, slot] |
Returns the number of bars that were displayed last time your bar chart was drawn.
This setting only has an effect in bar charts.
This can be different from the number of bars you actually wanted to display: by specifying both the bar width and the value block gap width you may controll your chart very well but take the risk of not getting all bars drawn if there is not enough horizontal space to display them with the given width and gap width.
To quickly determine if all bars were drawn just check if the numBarsLeft() function returns a zero value.
- Returns:
- the number of bars that were drawn.
- See also:
- KDChartWidget::barsDisplayed, KDChart::barsDisplayed
Definition at line 1034 of file KDChartParams.h.
int KDChartParams::numBarsLeft | ( | ) | const [inline, slot] |
Returns the number of bars that could NOT be painted last time your bar chart was drawn.
This setting only has an effect in bar charts.
If this value is greater than zero, the bar chart shows less bars than you actually wanted to display: by specifying both the bar width and the value block gap width you may controll your chart very well but take the risk of not getting all bars drawn if there is not enough horizontal space to display them with the given width and gap width.
You may call the numBarsDisplayed() function to see how many bars were drawn.
- Returns:
- the number of bars that could not be drawn.
- See also:
- KDChartWidget::barsDisplayed, KDChart::barsDisplayed
Definition at line 1039 of file KDChartParams.h.
void KDChartParams::setDrawSolidExcessArrows | ( | bool | solidArrows | ) | [inline, slot] |
Specifies whether arrows showing excess values in bar charts should be drawn solidly or split.
This setting only has an effect in bar charts.
If solidArrows is true, the bars with excess values (like infinity, or any other value that exceeds the y-axis labelling) will have an integrated arrow head. If solidArrows is false, they will still have an integrated arrow head at a lower position, but also two flat arrows on top of them to better indicate that there could be a large gap. It is recommended to set this value to false (this is also the default), as this makes the excess value situation much more obvious.
This setting only has an effect in bar charts.
- Parameters:
-
solidArrows whether excess arrows shown be drawn solidly or split
- See also:
- drawSolidExcessArrows
Definition at line 1044 of file KDChartParams.h.
bool KDChartParams::drawSolidExcessArrows | ( | ) | const [inline, slot] |
Returns whether arrows showing excess values in bar charts should be drawn solidly or split.
This setting only has an effect in bar charts.
- Returns:
- true if excess arrows are drawn solidly, false if they are split
- See also:
- setDrawSolidExcessArrows
Definition at line 1049 of file KDChartParams.h.
void KDChartParams::setLineChartSubType | ( | LineChartSubType | lineChartSubType | ) | [inline, slot] |
Specifies the line chart subtype.
Only used if chartType() == Line. The default is LineNormal.
- Parameters:
-
lineChartSubType the line chart subtype
- See also:
- lineChartSubType, LineChartSubType, setChartType, chartType
Definition at line 1061 of file KDChartParams.h.
KDChartParams::LineChartSubType KDChartParams::lineChartSubType | ( | ) | const [inline, slot] |
Returns the line chart subtype.
Only used if chartType() == Line.
- Returns:
- the line chart sub type
- See also:
- setLineChartSubType, LineChartSubType, setChartType, chartType
Definition at line 1067 of file KDChartParams.h.
KDChartParams::LineChartSubType KDChartParams::stringToLineChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a line chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the line chart subtype enum value
Definition at line 2758 of file KDChartParams_io.cpp.
QString KDChartParams::lineChartSubTypeToString | ( | LineChartSubType | type | ) | [static, slot] |
Converts the specified line chart subtype enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2777 of file KDChartParams_io.cpp.
void KDChartParams::setLineMarker | ( | bool | marker | ) | [inline, slot] |
Specifies whether there should be a marker at each data point.
Only used if chartType() == Line and if threeDLines() == false. The default is not to draw markers.
- Note:
- Use the setLineMarkerStyle function to specify the shape of the markers, use the setLineWidth function to set the width of the lines connecting the markers (or to surpress drawing of such lines, resp.)
- Parameters:
-
marker true if markers should be drawn
- See also:
- setLineMarker, setLineMarkerSize
setLineMarkerStyle, setLineColor, setLineWidth, setLineStyle
Definition at line 1077 of file KDChartParams.h.
bool KDChartParams::lineMarker | ( | ) | const [inline, slot] |
Returns whether line markers should be drawn at each data point.
Only used if chartType() == Line and if threeDLines() == false.
- Returns:
- true if markers should be drawn.
Definition at line 1083 of file KDChartParams.h.
void KDChartParams::setLineMarkerStyle | ( | uint | dataset, | |
LineMarkerStyle | style | |||
) | [slot] |
Specifies the line marker to be used for a dataset.
Only used if chartType() == Line and lineMarker() == true. If you specify a marker for a dataset, but not for a dataset with a lower value, then the marker for the dataset with the lower value will be undefined unless it was previously defined. The default is a circle for the first dataset, a square for the second, a diamond for the third and undefined for all subsequent datasets.
- Note:
- Extra marker styles LineMarker1Pixel and LineMarker4Pixels are intended for drawing charts representing large numbers of data cells, when using these styles it might be a good idea to set the line width to zero. This would surpress drawing of the lines resulting in drawing the markers only.
- Parameters:
-
dataset the dataset for which to set the line marker style the style to set for the specified dataset
- See also:
- LineMarkerStyle, lineMarkerStyle, setLineMarkerSize
setLineColor, setLineWidth, setLineStyle
Definition at line 4670 of file KDChartParams.cpp.
void KDChartParams::setLineMarkerStyles | ( | LineMarkerStyleMap | map | ) | [slot] |
Sets a whole map of line marker styles.
You can use this for assigning many line marker styles at the same time, but typically it is better to set them individually with setLineMarkerStyle().
- Parameters:
-
map the map of styles
- See also:
- lineMarkerStyles, setLineMarker, setLineMarkerStyle, setLineMarkerSize
setLineColor, setLineWidth, setLineStyle
Definition at line 4715 of file KDChartParams.cpp.
KDChartParams::LineMarkerStyle KDChartParams::lineMarkerStyle | ( | uint | dataset | ) | const [slot] |
Returns the marker to be used for a dataset.
Only used if chartType() == Line and lineMarker() == true.
- Parameters:
-
dataset the dataset for which to return the line marker
- Returns:
- the line marker for the specified data set
- See also:
- LineMarkerStyle, setLineMarkerStyle
Definition at line 4686 of file KDChartParams.cpp.
QString KDChartParams::lineMarkerStyleToString | ( | LineMarkerStyle | style | ) | [static, slot] |
Converts the specified line marker style enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2799 of file KDChartParams_io.cpp.
QString KDChartParams::lineMarkerStyleToStringTr | ( | LineMarkerStyle | style | ) | [static, slot] |
Converts the specified line marker style enum to a localized string representation that can be used for string output.
- Parameters:
-
type the type enum to convert
- Returns:
- the localized string representation of the type enum
Definition at line 2812 of file KDChartParams_io.cpp.
KDChartParams::LineMarkerStyle KDChartParams::stringToLineMarkerStyle | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a line marker style value.
- Parameters:
-
string the string to convert
- Returns:
- the line marker style enum value
Definition at line 2824 of file KDChartParams_io.cpp.
KDChartParams::LineMarkerStyle KDChartParams::stringToLineMarkerStyleTr | ( | const QString & | string | ) | [static, slot] |
Converts the specified localized string to a line marker style value.
- Parameters:
-
string the string to convert
- Returns:
- the line marker style enum value
Definition at line 2836 of file KDChartParams_io.cpp.
KDChartParams::LineMarkerStyleMap KDChartParams::lineMarkerStyles | ( | ) | const [inline, slot] |
Returns the whole map of line marker styles.
You will typically not need this. You can query individual line marker styles by calling lineMarkerStyle().
- Returns:
- the map of styles
- See also:
- lineMarkerStyle, setLineMarkerStyles
Definition at line 1111 of file KDChartParams.h.
uint KDChartParams::maxDatasetLineMarkerStyle | ( | ) | const [inline, slot] |
Returns the highest dataset for which a line marker style has been defined.
Not all datasets with a lower number necessarily have a defined line marker.
- Returns:
- the highest dataset with a defined line marker
- See also:
- LineMarkerStyle, setLineMarkerStyle, lineMarkerStyle
Definition at line 1116 of file KDChartParams.h.
void KDChartParams::setLineMarkerSize | ( | QSize | size | ) | [inline, slot] |
Specifies the sizes of line markers.
Only used if chartType() == Line and lineMarker() == true. The default is 6x6.
Negative values of size.width()
and/or size.height()
will be interpreted as per-mille value of the chart's drawing area, the true marker width (or height, resp.) will then be calculated dynamically depending on the actual chart size.
- Parameters:
-
size the size of the line marker in pixels
- See also:
- lineMarkerSize, setLineMarker, setLineMarkerStyle
setLineColor, setLineWidth, setLineStyle
Definition at line 1122 of file KDChartParams.h.
QSize KDChartParams::lineMarkerSize | ( | ) | const [inline, slot] |
Returns the sizes of line markers.
Only used if chartType() == Line and lineMarker() == true.
- Returns:
- the size of the line marker in pixels
- See also:
- setLineMarkerSize
Definition at line 1128 of file KDChartParams.h.
void KDChartParams::setLineWidth | ( | int | width | ) | [inline, slot] |
Specifies the width for lines in line charts.
Default is 1. Only used if threeDLines() == false.
If width
is negative it is interpreted as per-mille value of the chart's drawing area, the true line width will then be calculated dynamically depending on the actual chart size.
- Note:
- Set the line width to zero to surpress drawing of the lines but do not forget to call setLineMarker( true ) and specify an appropriate marker style to have the data points drawn.
- Parameters:
-
width the new width
- See also:
- lineWidth, setLineColor, setLineStyle
Definition at line 1133 of file KDChartParams.h.
int KDChartParams::lineWidth | ( | ) | const [inline, slot] |
Returns the line width of the lines in line charts.
- Returns:
- the line width of lines in line charts
- See also:
- lineWidth
Definition at line 1139 of file KDChartParams.h.
void KDChartParams::setLineColor | ( | QColor | color = QColor() |
) | [inline, slot] |
Specifies the color of the lines in line charts.
By default line chart lines are drawn in the color specified by the respective setDataColor function, to reset your chart to this default just call setLineColor() without specifying a parameter.
- Note:
- Setting the line color to a special value is usefull to visualize gaps in a normally very narrow series of data values.
- Parameters:
-
color of the lines in line charts
- See also:
- lineColor, setLineWidth, setLineStyle
Definition at line 1145 of file KDChartParams.h.
QColor KDChartParams::lineColor | ( | ) | const [inline, slot] |
Returns the color of the lines in line charts.
- Returns:
- the color of the lines in line charts
- See also:
- setLineColor
Definition at line 1151 of file KDChartParams.h.
Qt::PenStyle KDChartParams::lineStyle | ( | uint | dataset = KDCHART_GLOBAL_LINE_STYLE |
) | const [slot] |
Returns the line style of one of the lines in a line chart or the global line style if no style was specified for the dataset or if the optional dataset parameter has its default value KDCHART_GLOBAL_LINE_STYLE.
Warning: On Windows 95/98, the style setting (other than NoPen and SolidLine) has no effect for lines with width greater than 1, due to a bug in the operating system.
- Parameters:
-
dataset the dataset for which to return the line style
- Returns:
- the line style for the specified data set
- See also:
- setLineStyle, setLineMarkerStyle
Definition at line 4889 of file KDChartParams.cpp.
void KDChartParams::setThreeDLines | ( | bool | threeD | ) | [inline, slot] |
Specifies whether lines should be drawn three-dimensionally or not.
The default is to draw two-dimensionally. Only used if chartType() == Line.
- Parameters:
-
threeD if true, draw three-dimensionally, otherwise draw two-dimensionally.
- See also:
- threeDLines(), setThreeDLineDepth(), threeDLineDepth(), setThreeDLineXRotation(), threeDLineXRotation(), setThreeDLineYRotation(), threeDLineYRotation()
Definition at line 1161 of file KDChartParams.h.
bool KDChartParams::threeDLines | ( | ) | const [inline, slot] |
Returns whether lines are drawn three-dimensionally or not.
The default is to draw two-dimensionally. Only used if chartType() == Line.
- Returns:
- true if lines are drawn three-dimensionally, false otherwise.
- See also:
- setThreeDLines(), setThreeDLineDepth(), threeDLineDepth(), setThreeDLineXRotation(), threeDLineXRotation(), setThreeDLineYRotation(), threeDLineYRotation()
Definition at line 1167 of file KDChartParams.h.
void KDChartParams::setThreeDLineDepth | ( | int | depth | ) | [inline, slot] |
Specifies the depth of 3D lines (the "width" in Z direction).
Only used if chartType() == Line and threeDLines() == true. The default is 20 pixels.
- Parameters:
-
depth the depth in pixels
- See also:
- setThreeDLines(), threeDLines(), threeDLineDepth()
Definition at line 1172 of file KDChartParams.h.
int KDChartParams::threeDLineDepth | ( | ) | const [inline, slot] |
Returns the depth of 3D lines (the "width" in Z direction).
Only used if chartType() == Line and threeDLines() == true. The default is 20 pixels.
- Returns:
- the depth in pixels
- See also:
- setThreeDLines(), threeDLines(), setThreeDLineDepth()
Definition at line 1178 of file KDChartParams.h.
void KDChartParams::setThreeDLineXRotation | ( | int | degrees | ) | [inline, slot] |
- Deprecated:
- Feature scheduled for future release, at present not implemented.
Definition at line 1186 of file KDChartParams.h.
int KDChartParams::threeDLineXRotation | ( | ) | const [inline, slot] |
- Deprecated:
- Feature scheduled for future release, at present not implemented.
Definition at line 1195 of file KDChartParams.h.
void KDChartParams::setThreeDLineYRotation | ( | int | degrees | ) | [inline, slot] |
- Deprecated:
- Feature scheduled for future release, at present not implemented.
Definition at line 1203 of file KDChartParams.h.
int KDChartParams::threeDLineYRotation | ( | ) | const [inline, slot] |
- Deprecated:
- Feature scheduled for future release, at present not implemented.
Definition at line 1212 of file KDChartParams.h.
void KDChartParams::setAreaChartSubType | ( | AreaChartSubType | areaChartSubType | ) | [inline, slot] |
Specifies the area chart subtype.
Only used if chartType() == Area. The default is AreaNormal.
- Parameters:
-
areaChartSubType the area chart subtype
- See also:
- areaChartSubType, AreaChartSubType, setChartType, chartType
Definition at line 1220 of file KDChartParams.h.
KDChartParams::AreaChartSubType KDChartParams::areaChartSubType | ( | ) | const [inline, slot] |
Returns the area chart subtype.
Only used if chartType() == Area.
- Returns:
- the area chart sub type
- See also:
- setAreaChartSubType, AreaChartSubType, setChartType, chartType
Definition at line 1231 of file KDChartParams.h.
QString KDChartParams::areaChartSubTypeToString | ( | AreaChartSubType | type | ) | [static, slot] |
Converts the specified area chart subtype enum to a string representation.
- Parameters:
-
type the subtype enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2848 of file KDChartParams_io.cpp.
KDChartParams::AreaChartSubType KDChartParams::stringToAreaChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a area chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the area chart subtype enum value
Definition at line 2869 of file KDChartParams_io.cpp.
void KDChartParams::setAreaLocation | ( | AreaLocation | location | ) | [inline, slot] |
Specifies whether the area above or below the value points should be filled.
The default is to fill below the value points.
This setting is not used with percent areas (i.e. areaChartSubType() == AreaPercent), because these always cover the whole chart.
- Parameters:
-
location whether to fill above or below the value points
- See also:
- AreaLocation, areaLocation()
Definition at line 1244 of file KDChartParams.h.
KDChartParams::AreaLocation KDChartParams::areaLocation | ( | ) | const [inline, slot] |
Returns whether the area above or below the value points is filled.
- Returns:
- whether the area above or below the value points is filled.
- See also:
- AreaLocation, setAreaLocation()
Definition at line 1250 of file KDChartParams.h.
QString KDChartParams::areaLocationToString | ( | AreaLocation | type | ) | [static, slot] |
Converts the specified area location enum to a string representation.
- Parameters:
-
type the location enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2887 of file KDChartParams_io.cpp.
KDChartParams::AreaLocation KDChartParams::stringToAreaLocation | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to an area location enum value.
- Parameters:
-
string the string to convert
- Returns:
- the aration location enum value
Definition at line 2906 of file KDChartParams_io.cpp.
void KDChartParams::setPolarChartSubType | ( | PolarChartSubType | polarChartSubType | ) | [inline, slot] |
Specifies the polar chart subtype.
Only used if chartType() == Polar. The default is PolarNormal.
- Parameters:
-
polarChartSubType the polar chart subtype
- See also:
- polarChartSubType, PolarChartSubType, setChartType, chartType
Definition at line 1266 of file KDChartParams.h.
KDChartParams::PolarChartSubType KDChartParams::polarChartSubType | ( | ) | const [inline, slot] |
Returns the polar chart subtype.
Only used if chartType() == Polar.
- Returns:
- the polar chart sub type
- See also:
- setPolarChartSubType, PolarChartSubType, setChartType, chartType
Definition at line 1272 of file KDChartParams.h.
KDChartParams::PolarChartSubType KDChartParams::stringToPolarChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a polar chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the polar chart subtype enum value
Definition at line 2922 of file KDChartParams_io.cpp.
QString KDChartParams::polarChartSubTypeToString | ( | PolarChartSubType | type | ) | [static, slot] |
Converts the specified polar chart subtype enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2940 of file KDChartParams_io.cpp.
void KDChartParams::setPolarMarker | ( | bool | marker | ) | [inline, slot] |
Specifies whether there should be a marker at each data point.
Only used if chartType() == Polar. The default is not to draw markers.
- Parameters:
-
marker true if markers should be drawn
Definition at line 1281 of file KDChartParams.h.
bool KDChartParams::polarMarker | ( | ) | const [inline, slot] |
Returns whether polar markers should be drawn at each data point.
Only used if chartType() == Polar.
- Returns:
- true if markers should be drawn.
Definition at line 1287 of file KDChartParams.h.
void KDChartParams::setPolarMarkerStyle | ( | uint | dataset, | |
PolarMarkerStyle | style | |||
) | [slot] |
Specifies the polar marker to be used for a dataset.
Only used if chartType() == Polar and polarMarker() == true. If you specify a marker for a dataset, but not for a dataset with a lower value, then the marker for the dataset with the lower value will be undefined unless it was previously defined. The default is a circle for the first dataset, a square for the second, a diamond for the third and undefined for all subsequent datasets.
- Parameters:
-
dataset the dataset for which to set the polar marker style the style to set for the specified dataset
- See also:
- PolarMarkerStyle, polarMarkerStyle
Definition at line 5182 of file KDChartParams.cpp.
KDChartParams::PolarMarkerStyle KDChartParams::polarMarkerStyle | ( | uint | dataset | ) | const [slot] |
Returns the marker to be used for a dataset.
Only used if chartType() == Polar and polarMarker() == true.
- Parameters:
-
dataset the dataset for which to return the polar marker
- Returns:
- the polar marker for the specified data set
- See also:
- PolarMarkerStyle, setPolarMarkerStyle
Definition at line 5198 of file KDChartParams.cpp.
QString KDChartParams::polarMarkerStyleToString | ( | PolarMarkerStyle | style | ) | [static, slot] |
Converts the specified polar marker style enum to a string representation.
- Parameters:
-
type the type enum to convert
- Returns:
- the string representation of the type enum
Definition at line 2962 of file KDChartParams_io.cpp.
QString KDChartParams::polarMarkerStyleToStringTr | ( | PolarMarkerStyle | style | ) | [static, slot] |
Converts the specified polar marker style enum to a localized string representation that can be used for string output.
- Parameters:
-
type the type enum to convert
- Returns:
- the localized string representation of the type enum
Definition at line 2975 of file KDChartParams_io.cpp.
KDChartParams::PolarMarkerStyle KDChartParams::stringToPolarMarkerStyle | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a polar marker style value.
- Parameters:
-
string the string to convert
- Returns:
- the polar marker style enum value
Definition at line 2987 of file KDChartParams_io.cpp.
KDChartParams::PolarMarkerStyle KDChartParams::stringToPolarMarkerStyleTr | ( | const QString & | string | ) | [static, slot] |
Converts the specified localized string to a polar marker style value.
- Parameters:
-
string the string to convert
- Returns:
- the polar marker style enum value
Definition at line 3000 of file KDChartParams_io.cpp.
void KDChartParams::setPolarMarkerStyles | ( | PolarMarkerStyleMap | map | ) | [slot] |
Sets a whole map of polar marker styles.
You can use this for assigning many polar marker styles at the same time, but typically it is better to set them individually with setPolarMarkerStyle().
- Parameters:
-
map the map of styles
- See also:
- polarMarkerStyles(), setPolarMarkerStyle()
Definition at line 5225 of file KDChartParams.cpp.
KDChartParams::PolarMarkerStyleMap KDChartParams::polarMarkerStyles | ( | ) | const [inline, slot] |
Returns the whole map of polar marker styles.
You will usually not need this. You can query individual polar marker styles by calling polarMarkerStyle().
- Returns:
- the map of styles
- See also:
- polarMarkerStyle(), setPolarMarkerStyles()
Definition at line 1315 of file KDChartParams.h.
uint KDChartParams::maxDatasetPolarMarkerStyle | ( | ) | const [inline, slot] |
Returns the highest dataset for which a polar marker style has been defined.
Not all datasets with a lower number necessarily have a defined polar marker.
- Returns:
- the highest dataset with a defined polar marker
- See also:
- PolarMarkerStyle, setPolarMarkerStyle, polarMarkerStyle
Definition at line 1319 of file KDChartParams.h.
void KDChartParams::setPolarMarkerSize | ( | QSize | size = QSize( -40, -40 ) |
) | [inline, slot] |
Specifies the sizes of polar markers.
Only used if chartType() == Polar and polarMarker() == true. The default is -40 x -40.
- Parameters:
-
size the size of the polar marker in pixels, if negative this is a per mille value of the chart min. size (the chart width or height, depending what is smaller), if positive the value is taken as absolute number of pixels.
- See also:
- polarMarkerSize
Definition at line 1324 of file KDChartParams.h.
QSize KDChartParams::polarMarkerSize | ( | ) | const [inline, slot] |
Returns the sizes of polar markers.
Only used if chartType() == Polar and polarMarker() == true.
- Returns:
- the size of the polar marker in pixels
- See also:
- setPolarMarkerSize
Definition at line 1330 of file KDChartParams.h.
void KDChartParams::setPolarLineWidth | ( | int | width = -3 |
) | [inline, slot] |
Specifies the width for lines in polar charts.
Default is -3.
- Parameters:
-
width the new width
- See also:
- polarLineWidth
Definition at line 1335 of file KDChartParams.h.
int KDChartParams::polarLineWidth | ( | ) | const [inline, slot] |
Returns the line width of the lines in polar charts.
- Returns:
- the line width of lines in polar charts
- See also:
- setPolarLineWidth
Definition at line 1341 of file KDChartParams.h.
void KDChartParams::setPolarZeroDegreePos | ( | int | degrees | ) | [inline, slot] |
Specifies the zero degree position in polar charts.
Use this function to have the zero degree point on a position different from the right side of the circle. Valid parameters are -359..359.
- See also:
- polarZeroDegreePos
Definition at line 1347 of file KDChartParams.h.
int KDChartParams::polarZeroDegreePos | ( | ) | const [inline, slot] |
Returns the zero degree position in polar charts.
- See also:
- setPolarZeroDegreePos
Definition at line 1352 of file KDChartParams.h.
void KDChartParams::setPolarRotateCircularLabels | ( | bool | rotateCircularLabels | ) | [inline, slot] |
Specifies whether to rotate circular labels in polar charts.
Definition at line 1358 of file KDChartParams.h.
bool KDChartParams::polarRotateCircularLabels | ( | ) | const [inline, slot] |
Returns whether circular labels will be rotated in polar charts.
Definition at line 1363 of file KDChartParams.h.
void KDChartParams::setPolarDelimsAndLabelsAtPos | ( | KDChartEnums::PositionFlag | pos, | |
bool | showDelimiters, | |||
bool | showLabels | |||
) | [slot] |
Specifies whether to show circular delimiters and labels at a given position in polar charts.
- Note:
- Value
KDChartEnums::PosCenter
will be ignored.
Definition at line 5353 of file KDChartParams.cpp.
bool KDChartParams::polarDelimAtPos | ( | KDChartEnums::PositionFlag | pos | ) | const [slot] |
Returns whether to show circular delimiters at a given position in polar charts.
- See also:
- polarRotateCircularLabels, setPolarDelimAndLabelsPos, polarLabelsAtPos
Definition at line 5369 of file KDChartParams.cpp.
bool KDChartParams::polarLabelsAtPos | ( | KDChartEnums::PositionFlag | pos | ) | const [slot] |
Returns whether to show circular labels at a given position in polar charts.
- See also:
- polarRotateCircularLabels, setPolarDelimAndLabelsPos, polarDelimAtPos
Definition at line 5383 of file KDChartParams.cpp.
void KDChartParams::setExplode | ( | bool | explode | ) | [inline, slot] |
Specifies whether the pie chart or ring chart should be exploding (all pies or ring segments are slightly displaced from the center) or not.
The default is not to explode. Only used if chartType() == Pie or chartType() == Ring.
Note that calling this method by passing true turns on exploding for all segments. You can turn exploding on and off for individual segments by calling setExplodeValues() and also change the explode factors by calling setExplodeFactor() or setExplodeFactors().
Note that in ring charts, only the outermost ring is exploded. Also note that exploding rings are only useful if none of the values in the outermost dataset covers more than 1/4 of the ring, otherwise the exploded ring will look funny.
- Parameters:
-
explode true if the pie or ring should be exploding, false otherwise
- See also:
- exploding(), setExplodeFactor(), explodeFactor(), setExplodeFactors(), explodeFactors(), setExplodeValues(), explodeValues()
Definition at line 1385 of file KDChartParams.h.
bool KDChartParams::explode | ( | ) | const [inline, slot] |
Returns whether the pie or ring chart should be exploding or not.
- Returns:
- true if the pie should be exploding
- See also:
- setExplode, setExplodeFactor(), explodeFactor(), setExplodeFactors(), explodeFactors(), setExplodeValues(), explodeValues()
Definition at line 1391 of file KDChartParams.h.
void KDChartParams::setExplodeValues | ( | QValueList< int > | explodeList | ) | [inline, slot] |
Specifies which values to explode.
Explosion of values only happens if setExplode( true ) has been called. Normally, all values are exploded (all values on the outer ring in the case of a ring chart). With this function, you have a finer control about the explosion. You can specify the values that should be exploded by their position. Passing an empty list here turns on explosion for all pies or ring segments (but only if explosion is turned on in general).
To repeat: Setting anything here has no effect if setExplode( true ) is not called. You can, however, set any values here even if explosion is not turned on; they will be saved in case explosion will be turned on in the future and then be valid automatically.
The explode factor, i.e., the amount with which a segment is moved from the center can either be set for all segments with setExplodeFactor() or for individual segments with setExplodeFactors(). The default is 10%.
- Parameters:
-
explodeList the list of positions in the displayed dataset that should be drawn in an exploded position. Pass an empty list here to explode all values.
- See also:
- setExplode(), explode(), setExplodeFactor(), explodeFactor(), explodeValues(), setExplodeFactors(), explodeFactors()
Definition at line 1397 of file KDChartParams.h.
QValueList< int > KDChartParams::explodeValues | ( | ) | const [inline, slot] |
Returns which values are exploded in a pie or ring chart.
For a detailed explanation of this feature, please see setExplodeValues().
- Returns:
- the list of values that are exploded
Definition at line 1404 of file KDChartParams.h.
void KDChartParams::setExplodeFactors | ( | ExplodeFactorsMap | factors | ) | [inline, slot] |
Specifies the explode factors for each segment in percent, i.e.
how much an exploded pie or ring segment is displaced from the center. The factor is given as a double value between 0 and 1; 0.1 means 10%. Only used if chartType() == Pie or chartType() == Ring and explode() == true.
Segments that are not contained in the map specified here will have the default explode factor of 10%, if exploding is turned on for them at all. This also means that passing an empty list to this method does not turn off exploding in general; use setExplode( false ) for that.
Note: This method has no immediate effect if setExplode( true ) has not been called. It is, however, possible to preset explode factors and then turn on exploding later.
Note: Besides giving a segment an explode factor and turning on exploding in general, you also need to specify to explode a certain segment by calling setExplodeValues(). This gives maximum flexibility as it allows you to preset explode factors and then explode or not not explode a segment at leisure - at the expense of one more method call.
- Parameters:
-
factors the list of explode factors
- See also:
- setExplode(), explode(), setExplodeValues(), explodeValues(), setExplodeFactor(), explodeFactor(), explodeFactors()
Definition at line 1412 of file KDChartParams.h.
QMap< int, double > KDChartParams::explodeFactors | ( | ) | const [inline, slot] |
Returns the list of explode factors.
Each explode factor in the list corresponds to the segment at the same position.
- Returns:
- the list of explode factors
- See also:
- setExplode(), explode(), setExplodeValues(), explodeValues(), setExplodeFactor(), explodeFactor(), setExplodeFactors()
Definition at line 1418 of file KDChartParams.h.
void KDChartParams::setExplodeFactor | ( | double | factor | ) | [inline, slot] |
Specifies the explode factor in percent, i.e.
how much an exploded pie or ring segment is displaced from the center. The factor is given as a double value between 0 and 1; 0.1 means 10% and is the default. Only used if chartType() == Pie or chartType() == Ring and explode() == true.
Note that this method sets the explode factor for all segments that are exploded but for which no more specific explode factor has been set with setExplodeFactors(). Thus, to make the value specified here the default value, you can pass an empty list to setExplodeFactors() (which also is the default).
- Parameters:
-
factor the explode factor
- See also:
- setExplode(), explode(), explodeFactor(), setExplodeValues(), explodeValues(), setExplodeFactors(), explodeFactors()
Definition at line 1423 of file KDChartParams.h.
double KDChartParams::explodeFactor | ( | ) | const [inline, slot] |
Returns the default explode factor, i.e., the explode factor used for those segments which should be exploded but for which no more specific explode factor has been set.
See setExplodeFactor() for an explanation of the value.
- Returns:
- the explode factor
- See also:
- setExplodeFactor(), setExplode(), explode()
Definition at line 1429 of file KDChartParams.h.
void KDChartParams::setThreeDPies | ( | bool | threeDPies | ) | [inline, slot] |
Specifies whether the engine should draw the pies in 3D.
Only used if chartType() == Pie.
- Parameters:
-
threeDPies true if pies should be drawn with a 3D effect
- See also:
- threeDPies(), setThreeDPieHeight(), threeDPieHeight()
Definition at line 1435 of file KDChartParams.h.
bool KDChartParams::threeDPies | ( | ) | const [inline, slot] |
Returns whether the engine should draw any pies in 3D.
Only used if chartType() == Pie.
- Returns:
- true if pies should be drawn with a 3D effect, false otherwise
- See also:
- setThreeDPies(), threeDPieHeight(), setThreeDPieHeight()
Definition at line 1441 of file KDChartParams.h.
void KDChartParams::setThreeDPieHeight | ( | int | pixels | ) | [inline, slot] |
Specifies the height of the 3D effect for pies in pixels.
Only used if chartType() == Pie and threeDPies() == true. Negative values are interpreted relative to the height of the pie where -100 means that the 3D effect has the same height as the pie itself; values smaller than -25 are hardly useful. Positive values are interpreted as absolute sizes in pixels. The default is an absolute value of 20 pixels.
- Parameters:
-
height the height of the 3D effect in pixels
- See also:
- threeDHeight(), setThreeDPies(), threeDPies()
Definition at line 1447 of file KDChartParams.h.
int KDChartParams::threeDPieHeight | ( | ) | const [inline, slot] |
Returns the height of the 3D effect for pies in pixels.
See setThreeDPieHeight for the interpretation of the value.
- Returns:
- the height of the 3D effect in pixels
- See also:
- setThreeDPieHeight(), setThreeDPies(), threeDPies()
Definition at line 1453 of file KDChartParams.h.
void KDChartParams::setPieStart | ( | int | degrees | ) | [inline, slot] |
Specifies the starting point of the pie circle.
The default is the 3 o' clock position which equals to 0. Positive values are angles in degrees counterclockwise, negative values are angles in degrees clockwise. All values will be normalized to [0;360[.
- Parameters:
-
degrees the starting point in degrees
- See also:
- pieStart()
Definition at line 1458 of file KDChartParams.h.
int KDChartParams::pieStart | ( | ) | const [inline, slot] |
Returns the starting point of the pie circle.
See setPieStart() for the interpretation of these values. The return value is always in the interval [0;360[
- Returns:
- the starting point of the pie circle in degrees
- See also:
- setPieStart()
Definition at line 1470 of file KDChartParams.h.
void KDChartParams::setRingStart | ( | int | degrees | ) | [inline, slot] |
Specifies the starting point of the ring circle.
The default is the 3 o' clock position which equals to 0. Positive values are angles in degrees counterclockwise, negative values are angles in degrees clockwise. All values will be normalized to [0;360[.
- Parameters:
-
degrees the starting point in degrees
- See also:
- pieStart()
Definition at line 1475 of file KDChartParams.h.
int KDChartParams::ringStart | ( | ) | const [inline, slot] |
Returns the starting point of the ring circle.
See setRingStart() for the interpretation of these values. The return value is always in the interval [0;360[
- Returns:
- the starting point of the ring circle in degrees
- See also:
- setRingStart()
Definition at line 1487 of file KDChartParams.h.
void KDChartParams::setRelativeRingThickness | ( | bool | relativeThickness | ) | [inline, slot] |
Specifies whether the ring thickness should be relative to the sum of the values in the dataset that the ring represents.
The default is to have all the rings with the same thickness which itself depends on the size of the chart and the number of rings.
- Parameters:
-
relativeThickness if true, ring thickness is relative, if false, it is constant.
- See also:
- relativeThickness()
Definition at line 1492 of file KDChartParams.h.
bool KDChartParams::relativeRingThickness | ( | ) | const [inline, slot] |
Returns whether the ring thickness is relative to the sum of values in the dataset that the ring represents, or whether the ring thickness should be constant.
- Returns:
- true if thickness is relative, false if it is constant
- See also:
- setRelativeRingThickness()
Definition at line 1499 of file KDChartParams.h.
void KDChartParams::setHiLoChartSubType | ( | HiLoChartSubType | hiLoChartSubType | ) | [inline, slot] |
Specifies the HiLo chart subtype.
Only used if chartType() == HiLo
- Parameters:
-
hiLoChartSubType the HiLo chart subtype
- See also:
- hiLoChartSubType, HiLoChartSubType, setChartType, chartType
Definition at line 1511 of file KDChartParams.h.
KDChartParams::HiLoChartSubType KDChartParams::hiLoChartSubType | ( | ) | const [inline, slot] |
Returns the HiLo chart subtype.
Only used if chartType() == HiLo.
- Returns:
- the HiLo chart sub type
- See also:
- setHiLoChartSubType, HiLoChartSubType, setChartType, chartType
Definition at line 1517 of file KDChartParams.h.
QString KDChartParams::hiLoChartSubTypeToString | ( | HiLoChartSubType | type | ) | [static, slot] |
Converts the specified HiLo chart subtype enum to a string representation.
- Parameters:
-
type the subtype enum to convert
- Returns:
- the string representation of the type enum
Definition at line 3012 of file KDChartParams_io.cpp.
KDChartParams::HiLoChartSubType KDChartParams::stringToHiLoChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a HiLo chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the HiLo chart subtype enum value
Definition at line 3033 of file KDChartParams_io.cpp.
void KDChartParams::setHiLoChartPrintLowValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
int | size = 14 , |
|||
QColor * | color = 0 | |||
) | [slot] |
Specifies if and how a HiLo chart will print the Low values below their respective entries.
Only used if chartType() == HiLo
- Note:
- setHiLoChartPrintLowValues( false ) will deactivate printing of Low values.
- Parameters:
-
active specifies whether the values are to be printed or not. font a Pointer to the font to be used. size (in per mille of the chart width) the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart!color the color to be used when printing the values.
- See also:
- setChartType, chartType
setHiLoChartSubType, hiLoChartSubType
hiLoChartPrintLowValues, hiLoChartPrintLowValues
hiLoChartLowValuesFontColor, hiLoChartLowValuesFontColor
hiLoChartLowValuesFontUseRelSize, hiLoChartLowValuesFontUseRelSize
hiLoChartLowValuesFontRelSize, hiLoChartLowValuesFontRelSize
hiLoChartPrintHighValues, hiLoChartPrintHighValues
hiLoChartHighValuesFontColor, hiLoChartHighValuesFontColor
hiLoChartHighValuesFontUseRelSize, hiLoChartHighValuesFontUseRelSize
hiLoChartHighValuesFontRelSize, hiLoChartHighValuesFontRelSize
Definition at line 5755 of file KDChartParams.cpp.
bool KDChartParams::hiLoChartPrintLowValues | ( | ) | const [inline, slot] |
Returns whether the low values will be printed under their respective entries.
- Returns:
- whether the low values will be printed under their respective entries.
- See also:
- setHiLoChartPrintLowValues, setHiLoChartPrintHighValues
Definition at line 1529 of file KDChartParams.h.
QFont KDChartParams::hiLoChartLowValuesFont | ( | ) | const [inline, slot] |
Returns the font to be used for printing the low values.
- Returns:
- the font to be used for printing the low values
- See also:
- setHiLoChartPrintLowValues, setHiLoChartPrintHighValues
Definition at line 1535 of file KDChartParams.h.
bool KDChartParams::hiLoChartLowValuesUseFontRelSize | ( | ) | const [inline, slot] |
Returns whether the font size to be used for printing the low values is calculated dynamically.
- Returns:
- whether the font size to be used for printing the low values is calculated dynamically.
- See also:
- setHiLoChartPrintLowValues, setHiLoChartPrintHighValues
Definition at line 1541 of file KDChartParams.h.
int KDChartParams::hiLoChartLowValuesFontRelSize | ( | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of font size to be used for printing the low values.
- Returns:
- the relative size (in per mille of the chart width) of font size to be used for printing the low values.
- See also:
- setHiLoChartPrintLowValues, setHiLoChartPrintHighValues
Definition at line 1547 of file KDChartParams.h.
QColor KDChartParams::hiLoChartLowValuesColor | ( | ) | const [inline, slot] |
Returns the colour of the font size to be used for printing the low values.
- Returns:
- the colour of the font size to be used for printing the low values.
- See also:
- setHiLoChartPrintLowValues, setHiLoChartPrintHighValues
Definition at line 1553 of file KDChartParams.h.
void KDChartParams::setHiLoChartPrintHighValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
int | size = 14 , |
|||
QColor * | color = 0 | |||
) | [slot] |
Specifies if and how a HiLo chart will print the High values below their respective entries.
Only used if chartType() == HiLo
- Note:
- setHiLoChartPrintHighValues( false ) will deactivate printing of High values.
- Parameters:
-
active specifies whether the values are to be printed or not. font specifies a Pointer to the font to be used. size (in per mille of the chart width) specifies the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart!specifies the color the color to be used when printing the values.
- See also:
- setHiLoChartPrintLowValues
setHiLoChartSubType, hiLoChartSubType
hiLoChartPrintHighValues, hiLoChartPrintHighValues
hiLoChartHighValuesFontColor, hiLoChartHighValuesFontColor
hiLoChartHighValuesFontUseRelSize, hiLoChartHighValuesFontUseRelSize
hiLoChartHighValuesFontRelSize, hiLoChartHighValuesFontRelSize
hiLoChartPrintLowValues, hiLoChartPrintLowValues
hiLoChartLowValuesFontColor, hiLoChartLowValuesFontColor
hiLoChartLowValuesFontUseRelSize, hiLoChartLowValuesFontUseRelSize
hiLoChartLowValuesFontRelSize, hiLoChartLowValuesFontRelSize
Definition at line 5878 of file KDChartParams.cpp.
bool KDChartParams::hiLoChartPrintHighValues | ( | ) | const [inline, slot] |
Returns whether the high values will be printed under their respective entries.
- Returns:
- whether the high values will be printed under their respective entries.
- See also:
- setHiLoChartPrintHighValues, setHiLoChartPrintLowValues
Definition at line 1564 of file KDChartParams.h.
QFont KDChartParams::hiLoChartHighValuesFont | ( | ) | const [inline, slot] |
Returns the font to be used for printing the high values.
- Returns:
- the font to be used for printing the high values.
- See also:
- setHiLoChartPrintHighValues, setHiLoChartPrintLowValues
Definition at line 1570 of file KDChartParams.h.
bool KDChartParams::hiLoChartHighValuesUseFontRelSize | ( | ) | const [inline, slot] |
Returns whether the font size to be used for printing the high values is calculated dynamically.
- Returns:
- whether the font size to be used for printing the high values is calculated dynamically.
- See also:
- setHiLoChartPrintHighValues, setHiLoChartPrintLowValues
Definition at line 1576 of file KDChartParams.h.
int KDChartParams::hiLoChartHighValuesFontRelSize | ( | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of font size to be used for printing the high values.
- Returns:
- the relative size (in per mille of the chart width) of font size to be used for printing the high values.
- See also:
- setHiLoChartPrintHighValues, setHiLoChartPrintHighValues
Definition at line 1582 of file KDChartParams.h.
QColor KDChartParams::hiLoChartHighValuesColor | ( | ) | const [inline, slot] |
Returns the colour of the font size to be used for printing the high values.
- Returns:
- the colour of the font size to be used for printing the high values.
- See also:
- setHiLoChartPrintHighValues, setHiLoChartPrintLowValues
Definition at line 1588 of file KDChartParams.h.
void KDChartParams::setHiLoChartPrintOpenValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
uint | size = 14 , |
|||
QColor * | color = 0 | |||
) | [slot] |
Specifies if and how a HiLo chart will print the Open values below their respective entries.
Only used if chartType() == HiLo and if the HiLo chart sub type shows open values.
- Note:
- setHiLoChartPrintOpenValues( false ) will deactivate printing of Open values.
- Parameters:
-
active specifies whether the values are to be printed or not. font a Pointer to the font to be used. size (in per mille of the chart width) the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart!color the color to be used when printing the values.
- See also:
- setHiLoChartPrintCloseValues
setHiLoChartSubType, hiLoChartSubType
hiLoChartPrintOpenValues, hiLoChartPrintOpenValues
hiLoChartOpenValuesFontColor, hiLoChartOpenValuesFontColor
hiLoChartOpenValuesFontUseRelSize, hiLoChartOpenValuesFontUseRelSize
hiLoChartOpenValuesFontRelSize, hiLoChartOpenValuesFontRelSize
hiLoChartPrintCloseValues, hiLoChartPrintCloseValues
hiLoChartCloseValuesFontColor, hiLoChartCloseValuesFontColor
hiLoChartCloseValuesFontUseRelSize, hiLoChartCloseValuesFontUseRelSize
hiLoChartCloseValuesFontRelSize, hiLoChartCloseValuesFontRelSize
Definition at line 6000 of file KDChartParams.cpp.
bool KDChartParams::hiLoChartPrintOpenValues | ( | ) | const [inline, slot] |
Returns whether the open values will be printed under their respective entries.
- Returns:
- whether the open values will be printed under their respective entries.
- See also:
- setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues
Definition at line 1598 of file KDChartParams.h.
QFont KDChartParams::hiLoChartOpenValuesFont | ( | ) | const [inline, slot] |
Returns the font to be used for printing the open values.
- Returns:
- the font to be used for printing the open values.
- See also:
- setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues
Definition at line 1604 of file KDChartParams.h.
bool KDChartParams::hiLoChartOpenValuesUseFontRelSize | ( | ) | const [inline, slot] |
Returns whether the font size to be used for printing the open values is calculated dynamically.
- Returns:
- whether the font size to be used for printing the open values is calculated dynamically.
- See also:
- setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues
Definition at line 1610 of file KDChartParams.h.
int KDChartParams::hiLoChartOpenValuesFontRelSize | ( | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of font size to be used for printing the open values.
- Returns:
- the relative size (in per mille of the chart width) of font size to be used for printing the open values.
- See also:
- setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues
Definition at line 1616 of file KDChartParams.h.
QColor KDChartParams::hiLoChartOpenValuesColor | ( | ) | const [inline, slot] |
Returns the colour of the font size to be used for printing the open values.
- Returns:
- the colour of the font size to be used for printing the open values.
- See also:
- setHiLoChartPrintOpenValues, setHiLoChartPrintCloseValues
Definition at line 1622 of file KDChartParams.h.
void KDChartParams::setHiLoChartPrintCloseValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
int | size = 14 , |
|||
QColor * | color = 0 | |||
) | [slot] |
Specifies if and how a HiLo chart will print the Close values next to their respective entries.
Only used if chartType() == HiLo and the HiLo chart sub type contains Close values.
- Note:
- setHiLoChartPrintCloseValues( false ) will deactivate printing of Close values.
- Parameters:
-
active specifies whether the values are to be printed or not. font specifies a Pointer to the font to be used. size (in per mille of the chart width) specifies the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart!specifies the color the color to be used when printing the values.
- See also:
- setHiLoChartPrintOpenValues
setHiLoChartSubType, hiLoChartSubType
hiLoChartPrintCloseValues, hiLoChartPrintCloseValues
hiLoChartCloseValuesFontColor, hiLoChartCloseValuesFontColor
hiLoChartCloseValuesFontUseRelSize, hiLoChartCloseValuesFontUseRelSize
hiLoChartCloseValuesFontRelSize, hiLoChartCloseValuesFontRelSize
hiLoChartPrintOpenValues, hiLoChartPrintOpenValues
hiLoChartOpenValuesFontColor, hiLoChartOpenValuesFontColor
hiLoChartOpenValuesFontUseRelSize, hiLoChartOpenValuesFontUseRelSize
hiLoChartOpenValuesFontRelSize, hiLoChartOpenValuesFontRelSize
Definition at line 6120 of file KDChartParams.cpp.
bool KDChartParams::hiLoChartPrintCloseValues | ( | ) | const [inline, slot] |
Returns whether the close values will be printed under their respective entries.
- Returns:
- whether the close values will be printed under their respective entries.
- See also:
- setHiLoChartPrintCloseValues, setHiLoChartPrintOpenValues
Definition at line 1632 of file KDChartParams.h.
QFont KDChartParams::hiLoChartCloseValuesFont | ( | ) | const [inline, slot] |
Returns the font to be used for printing the close values.
- Returns:
- the font to be used for printing the close values.
- See also:
- setHiLoChartPrintCloseValues, setHiLoChartPrintOpenValues
Definition at line 1638 of file KDChartParams.h.
bool KDChartParams::hiLoChartCloseValuesUseFontRelSize | ( | ) | const [inline, slot] |
Returns whether the font size to be used for printing the close values is calculated dynamically.
- Returns:
- whether the font size to be used for printing the close values is calculated dynamically.
- See also:
- setHiLoChartPrintCloseValues, setHiLoChartPrintOpenValues
Definition at line 1644 of file KDChartParams.h.
int KDChartParams::hiLoChartCloseValuesFontRelSize | ( | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of font size to be used for printing the close values.
- Returns:
- the relative size (in per mille of the chart width) of font size to be used for printing the close values.
- See also:
- setHiLoChartPrintCloseValues, setHiLoChartPrintOpenValues
Definition at line 1650 of file KDChartParams.h.
QColor KDChartParams::hiLoChartCloseValuesColor | ( | ) | const [inline, slot] |
Returns the colour of the font size to be used for printing the close values.
- Returns:
- the colour of the font size to be used for printing the close values.
- See also:
- setHiLoChartPrintCloseValues, setHiLoChartPrintOpenValues
Definition at line 1656 of file KDChartParams.h.
void KDChartParams::setHiLoChartPrintFirstValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
uint | size = 14 , |
|||
QColor * | color = 0 | |||
) | [inline, slot] |
This method is obsolete; use setHiLoChartPrintOpenValues().
Definition at line 1662 of file KDChartParams.h.
bool KDChartParams::hiLoChartPrintFirstValues | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartPrintOpenValues() instead.
Definition at line 1670 of file KDChartParams.h.
QFont KDChartParams::hiLoChartFirstValuesFont | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartOpenValuesFont() instead.
Definition at line 1676 of file KDChartParams.h.
bool KDChartParams::hiLoChartFirstValuesUseFontRelSize | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartOpenValuesUseFontRelSize() instead.
Definition at line 1682 of file KDChartParams.h.
int KDChartParams::hiLoChartFirstValuesFontRelSize | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartOpenValuesFontRelSize() instead.
Definition at line 1687 of file KDChartParams.h.
QColor KDChartParams::hiLoChartFirstValuesColor | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartOpenValuesColor() instead.
Definition at line 1692 of file KDChartParams.h.
void KDChartParams::setHiLoChartPrintLastValues | ( | bool | active, | |
QFont * | font = 0 , |
|||
int | size = 14 , |
|||
QColor * | color = 0 | |||
) | [inline, slot] |
This method is obsolete; use setHiLoChartPrintCloseValues() instead.
Definition at line 1697 of file KDChartParams.h.
bool KDChartParams::hiLoChartPrintLastValues | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartPrintCloseValues() instead.
Definition at line 1705 of file KDChartParams.h.
QFont KDChartParams::hiLoChartLastValuesFont | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartCloseValuesFont() instead.
Definition at line 1710 of file KDChartParams.h.
bool KDChartParams::hiLoChartLastValuesUseFontRelSize | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartCloseValuesUseFontRelSize() instead.
Definition at line 1715 of file KDChartParams.h.
int KDChartParams::hiLoChartLastValuesFontRelSize | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartCloseValuesFontRelSize() instead.
Definition at line 1720 of file KDChartParams.h.
QColor KDChartParams::hiLoChartLastValuesColor | ( | ) | const [inline, slot] |
This method is obsolete; use hiLoChartCloseValuesColor() instead.
Definition at line 1725 of file KDChartParams.h.
void KDChartParams::setBWChartSubType | ( | BWChartSubType | bWChartSubType | ) | [inline, slot] |
Specifies the BoxWhisker chart subtype.
Only used if chartType() == BoxWhisker
- Parameters:
-
bWChartSubType the BoxWhisker chart subtype
- See also:
- bWChartSubType, BWChartSubType, setChartType, chartType
Definition at line 1756 of file KDChartParams.h.
KDChartParams::BWChartSubType KDChartParams::bWChartSubType | ( | ) | const [inline, slot] |
Returns the BoxWhisker chart subtype.
Only used if chartType() == BoxWhisker.
- Returns:
- the BoxWhisker chart sub type
- See also:
- setBWChartSubType, BWChartSubType, setChartType, chartType
Definition at line 1762 of file KDChartParams.h.
QString KDChartParams::bWChartSubTypeToString | ( | BWChartSubType | type | ) | [static, slot] |
Converts the specified BoxWhisker chart subtype enum to a string representation.
- Parameters:
-
type the subtype enum to convert
- Returns:
- the string representation of the type enum
Definition at line 3324 of file KDChartParams_io.cpp.
KDChartParams::BWChartSubType KDChartParams::stringToBWChartSubType | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a BoxWhisker chart subtype enum value.
- Parameters:
-
string the string to convert
- Returns:
- the BoxWhisker chart subtype enum value
Definition at line 3051 of file KDChartParams_io.cpp.
QString KDChartParams::bWChartStatValToString | ( | BWStatVal | type | ) | [static, slot] |
Converts the specified BWStatVal enum to a string representation.
- Parameters:
-
type the BWStatVal enum to convert
- Returns:
- the string representation of the type BWStatVal
Definition at line 3064 of file KDChartParams_io.cpp.
KDChartParams::BWStatVal KDChartParams::stringToBWChartStatVal | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a BWStatVal enum value.
- Parameters:
-
string the string to convert
- Returns:
- the BWStatVal enum value
Definition at line 3098 of file KDChartParams_io.cpp.
void KDChartParams::setBWChartFences | ( | double | upperInner, | |
double | lowerInner, | |||
double | upperOuter, | |||
double | lowerOuter | |||
) | [slot] |
Specifies the factors to be used to calculate the position of the inner (or outer, resp.
) fences.
Default values for both inner fences are 1.5 times the interquartile range from the corresponding quartile, for both outer fences default is 3.0 times the IQR.
- See also:
- bWChartFences
setBWChartOutValMarkerSize, setBWChartPrintStatistics
Definition at line 6394 of file KDChartParams.cpp.
void KDChartParams::bWChartFences | ( | double & | upperInner, | |
double & | lowerInner, | |||
double & | upperOuter, | |||
double & | lowerOuter | |||
) | const [slot] |
Retrievs the factors to be used to calculate the position of the inner (or outer, resp.
) fences.
- See also:
- setBWChartFences
setBWChartOutValMarkerSize, setBWChartPrintStatistics
Definition at line 6411 of file KDChartParams.cpp.
void KDChartParams::setBWChartBrush | ( | const QBrush & | bWChartBrush | ) | [inline, slot] |
Specifies the brush to be used to fill the BoxWhisker charts.
- Parameters:
-
bWChartBrush the brush to be used
- See also:
- bWChartBrush, setChartType, chartType
Definition at line 1777 of file KDChartParams.h.
QBrush KDChartParams::bWChartBrush | ( | ) | const [inline, slot] |
Returns the brush to be used to fill the BoxWhisker charts.
- Returns:
- the brush to be used
- See also:
- setBWChartBrush, setChartType, chartType
Definition at line 1783 of file KDChartParams.h.
void KDChartParams::setBWChartOutValMarkerSize | ( | int | size | ) | [inline, slot] |
Specifies how big outlier markers (representing the values outside the inner fences) will be drawn.
When specifying a value different from 0 the chart will show the outlier markers in the respective size, use zero to disable showing the outliers, use negative values to have the marker size calculated dynamically (in percent of the current boxes' width). Thus marker sizes will be recalculated after modification of either the number of boxes or the size of the entire chart.
- Note:
- Shapes of the outlier markers depend on their distance to the respective fence: circles are used to represent near outside values while asteriscs indicate far outside values (the ones outside the outer fence), you may use setBWChartFences() to specify the factor to be used to calculate the value of the inner and outer fence.
- See also:
- bWChartOutValMarkerSize
setBWChartFences, setBWChartPrintStatistics
Definition at line 1788 of file KDChartParams.h.
int KDChartParams::bWChartOutValMarkerSize | ( | ) | const [inline, slot] |
Returns how big outlier markers (representing the values outside the inner fences) will be drawn.
- Returns:
- how big outside value markers will be drawn, zero means they will be invisible, negative values indicate that the size is calculated dynamically based upon the current boxes' width.
- See also:
- setBWChartOutValMarkerSize
setBWChartFences, setBWChartPrintStatistics
Definition at line 1794 of file KDChartParams.h.
void KDChartParams::setBWChartPrintStatistics | ( | BWStatVal | statValue, | |
bool | active, | |||
QFont * | font = 0 , |
|||
int | size = 24 , |
|||
QColor * | color = 0 , |
|||
QBrush * | brush = 0 | |||
) | [slot] |
Specifies if and how a BoxWhisker chart will print the respective statistical values near to the drawing.
Only used if chartType() == BoxWhisker
- Note:
- setBWChartPrintStatistics( BWStatVal, false ) will deactivate printing of the respective statistical values.
- Parameters:
-
statValue specifies the statistical value to be set, use BWStatValALL to define equal settings for all of the statistical values. active specifies whether the values are to be printed or not. font a Pointer to the font to be used. size (relative to the boxes' width) the dynamic size of the font to be used. If this parameter is zero the size of the font
is used instead - regardless of the size of the chart and regardless of the number of boxes!color the color to be used when printing the values. brush the brush to be used to fill the text's area before printing
- See also:
- setChartType
bWChartStatisticsFontUseRelSize
Definition at line 6511 of file KDChartParams.cpp.
bool KDChartParams::bWChartPrintStatistics | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns whether the respective statistical values will be printed near to the drawing.
- Returns:
- whether the respective statistical values will be printed near to the drawing.
Definition at line 1806 of file KDChartParams.h.
QFont KDChartParams::bWChartStatisticsFont | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns the font to be used for printing the respective statistical values.
- Returns:
- the font to be used for printing the respective statistical values
Definition at line 1812 of file KDChartParams.h.
bool KDChartParams::bWChartStatisticsUseRelSize | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns whether the font size to be used for printing the respective statistical values is calculated dynamically.
- Returns:
- whether the font size to be used for printing the respective statistical values is calculated dynamically.
Definition at line 1818 of file KDChartParams.h.
int KDChartParams::bWChartStatisticsFontRelSize | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns the relative size (in per mille of the chart width) of the font to be used for printing the respective statistical values.
- Returns:
- the relative size (in per mille of the chart width) of the font to be used for printing the respective statistical values.
Definition at line 1824 of file KDChartParams.h.
QColor KDChartParams::bWChartStatisticsColor | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns the colour of the font to be used for printing the respective statistical values.
- Returns:
- the colour of the font to be used for printing the respective statistical values.
Definition at line 1830 of file KDChartParams.h.
QBrush KDChartParams::bWChartStatisticsBrush | ( | BWStatVal | statValue | ) | const [inline, slot] |
Returns the brush used to fill the text's area before printing the respective statistical values.
- Returns:
- the brush used to fill the text's area before printing the respective statistical values.
Definition at line 1835 of file KDChartParams.h.
void KDChartParams::setLegendPosition | ( | LegendPosition | position | ) | [inline, slot] |
Specifies where the legend should be shown.
NoLegend turns legend display off. The default is LegendRight which positions the legend right to the data display.
- Parameters:
-
the position for the legend
- See also:
- LegendPosition, legendPosition, setLegendOrientation, setLegendShowLines
Definition at line 1861 of file KDChartParams.h.
KDChartParams::LegendPosition KDChartParams::legendPosition | ( | ) | const [inline, slot] |
Returns where the legend will be shown.
- Returns:
- where the legend will be shown
- See also:
- LegendPosition, setLegendPosition, setLegendShowLines
Definition at line 1867 of file KDChartParams.h.
Qt::Orientation KDChartParams::legendOrientation | ( | ) | const [inline, slot] |
Returns how the legend will be printed.
- Returns:
- how the legend will be printed.
- See also:
- setLegendOrientation, setLegendPosition, setLegendShowLines
Definition at line 1878 of file KDChartParams.h.
void KDChartParams::setLegendShowLines | ( | bool | legendShowLines | ) | [inline, slot] |
Specifies whether the legend shall show lines or just show the markers (or squares, resp.
).
- Note:
- By default no lines are drawn but just the markers are shown, for Line charts you might want to set this flag to true.
- Parameters:
-
flag whether lines are drawn or only the markers
- See also:
- legendShowLines, setLegendOrientation, setLegendPosition
Definition at line 1884 of file KDChartParams.h.
bool KDChartParams::legendShowLines | ( | ) | const [inline, slot] |
Returns whether the legend shows lines or just the markers (or squares, resp.
).
- Returns:
- whether the legend shows lines or just the markers (or squares, resp.).
- See also:
- setLegendShowLines, setLegendOrientation, setLegendPosition
Definition at line 1890 of file KDChartParams.h.
QString KDChartParams::legendPositionToString | ( | LegendPosition | pos | ) | [static, slot] |
Converts the specified legend position enum to a string representation.
- Parameters:
-
type the legend position enum to convert
- Returns:
- the string representation of the type enum
Definition at line 3130 of file KDChartParams_io.cpp.
KDChartParams::LegendPosition KDChartParams::stringToLegendPosition | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a legend position enum value.
- Parameters:
-
string the string to convert
- Returns:
- the legend position enum value
Definition at line 3179 of file KDChartParams_io.cpp.
void KDChartParams::setLegendSource | ( | LegendSource | source | ) | [inline, slot] |
Specifies where the legend text is coming from.
See LegendSource for an explanation of the possible values.
- Parameters:
-
source the source of the legend texts
- See also:
- legendSource, LegendSource, setLegendText, legendText
Definition at line 1903 of file KDChartParams.h.
LegendSource KDChartParams::legendSource | ( | ) | const [inline, slot] |
Returns where the legend text is coming from.
See LegendSource for an explanation of the possible return values.
- Returns:
- where the legend text is coming from
- See also:
- LegendSource, setLegendSource, setLegendText, legendText
Definition at line 1909 of file KDChartParams.h.
QString KDChartParams::legendSourceToString | ( | LegendSource | source | ) | [static, slot] |
Converts the specified legend source enum to a string representation.
- Parameters:
-
source the legend source enum to convert
- Returns:
- the string representation of the type enum
Definition at line 3224 of file KDChartParams_io.cpp.
KDChartParams::LegendSource KDChartParams::stringToLegendSource | ( | const QString & | string | ) | [static, slot] |
Converts the specified string to a legend source enum value.
- Parameters:
-
string the string to convert
- Returns:
- the legend source enum value
Definition at line 3245 of file KDChartParams_io.cpp.
void KDChartParams::setLegendText | ( | uint | dataset, | |
const QString & | text | |||
) | [inline, slot] |
Manually specifies a legend text for a certain dataset.
This is only used if legendSource() == Manual or if legendSource() == Automatic and it is not possible to retrieve values from the first column.
- Parameters:
-
dataset the dataset for which to set the legend text the legend text to be set for a given dataset
- See also:
- LegendSource, setLegendSource, legendSource, legendText
Definition at line 1917 of file KDChartParams.h.
QString KDChartParams::legendText | ( | uint | dataset | ) | const [inline, slot] |
Returns the manually specified legend text for a given dataset.
- Returns:
- the manually specified legend text for the specified dataset
- See also:
- setLegendText, LegendSource, setLegendSource, legendSource
Definition at line 1923 of file KDChartParams.h.
void KDChartParams::setLegendTextColor | ( | const QColor & | color | ) | [inline, slot] |
Specifies the color to be used for the legend texts.
The default is black.
- Parameters:
-
color the color to be used for the legend texts
- See also:
- legendTextColor(), setLegendTitleTextColor()
Definition at line 1932 of file KDChartParams.h.
QColor KDChartParams::legendTextColor | ( | ) | const [inline, slot] |
Returns the color in which the legend texts are drawn.
The default is black.
- Returns:
- the color in which the legend texts are drawn
- See also:
- setLegendTextColor(), legendTitleTextColor()
Definition at line 1939 of file KDChartParams.h.
void KDChartParams::setLegendFont | ( | const QFont & | font, | |
bool | useFontSize | |||
) | [inline, slot] |
Specifies the font in which the legend texts are drawn.
The default is a 10pt helvetica 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 setLegendFontRelSize().
- Parameters:
-
font the font to draw the legend texts in
- See also:
- setLegendFontUseRelSize, legendFont
Definition at line 1945 of file KDChartParams.h.
QFont KDChartParams::legendFont | ( | ) | const [inline, slot] |
Returns the font in which the legend texts are drawn.
- Returns:
- the font in which the legend texts are drawn
- See also:
- setLegendFont, setLegendFontUseRelSize
Definition at line 1952 of file KDChartParams.h.
void KDChartParams::setLegendFontUseRelSize | ( | bool | legendFontUseRelSize | ) | [inline, slot] |
Specifies whether the legend shall be drawn using relative font size.
- Parameters:
-
legendFontUseRelSize whether legend shall be drawn using relative font size. If true the absolute value of the value set by setLegendFontRelSize
is per thousand of of the average value of the printable area height and width. This will make the legend look nice even if scaled to very different size.
- See also:
- setLegendFontRelSize, setAxisLabelsFont
Definition at line 1958 of file KDChartParams.h.
bool KDChartParams::legendFontUseRelSize | ( | ) | const [inline, slot] |
Returns whether the legend font size is used.
- Returns:
- whether the fix legend font size is used.
- See also:
- setLegendFontRelSize, setLegendFont
Definition at line 1964 of file KDChartParams.h.
void KDChartParams::setLegendFontRelSize | ( | int | legendFontRelSize | ) | [inline, slot] |
Specifies the legend relative font size.
- Parameters:
-
legendFontRelSize the relative legend size. If this value unequals zero the absolute value is per thousand of of the average value of the printable area height and width. This will make the legend look nice even if scaled to very different size.
- See also:
- setLegendFontUseRelSize, setLegendFont
Definition at line 1969 of file KDChartParams.h.
int KDChartParams::legendFontRelSize | ( | ) | const [inline, slot] |
Returns the relative legend font size.
- Returns:
- the relative legend font size.
- See also:
- setLegendFontRelSize, setLegendFontUseRelSize
Definition at line 1975 of file KDChartParams.h.
void KDChartParams::setLegendTitleText | ( | const QString & | text | ) | [inline, slot] |
Specifies a text to be shown as the title of the legend.
The default is "Legend" (possibly localized). To turn off the legend title completely, pass an empty string.
- Parameters:
-
text the text to use as the legend title
Definition at line 1981 of file KDChartParams.h.
QString KDChartParams::legendTitleText | ( | ) | const [inline, slot] |
Returns the text that is shown as the title of the legend.
- Returns:
- the text that is used as the legend title
Definition at line 1988 of file KDChartParams.h.
void KDChartParams::setLegendTitleTextColor | ( | const QColor & | color | ) | [inline, slot] |
Specifies the color to be used for the legend title.
The default is black. Note that this color is only the default when rich text is used; tags in the rich text might change the color.
- Parameters:
-
color the color to be used for the legend title
- See also:
- legendTitleTextColor(), setLegendTextColor()
Definition at line 1994 of file KDChartParams.h.
QColor KDChartParams::legendTitleTextColor | ( | ) | const [inline, slot] |
Returns the color in which the legend title is drawn.
The default is black.
- Returns:
- the color in which the legend title is drawn
- See also:
- setLegendTitleTextColor(), legendTextColor()
Definition at line 2001 of file KDChartParams.h.
void KDChartParams::setLegendTitleFont | ( | const QFont & | font, | |
bool | useFontSize | |||
) | [inline, slot] |
Specifies the font in which the legend title (if any) is drawn.
The default is a 12pt helvetica 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 setLegendFontRelSize().
- Parameters:
-
font the font to draw the legend texts in
- See also:
- setLegendTitleFontUseRelSize, legendTitleFont
Definition at line 2008 of file KDChartParams.h.
QFont KDChartParams::legendTitleFont | ( | ) | const [inline, slot] |
Returns the font in which the legend title (if any) is drawn.
- Returns:
- the font in which the legend texts are drawn
Definition at line 2015 of file KDChartParams.h.
void KDChartParams::setLegendTitleFontUseRelSize | ( | bool | legendTitleFontUseRelSize | ) | [inline, slot] |
Specifies whether the legend title (if any) shall be drawn using relative font size.
- Parameters:
-
legendTitleFontUseRelSize whether the legend title shall be drawn using relative font size. If true the absolute value of the value set by setLegendTitleFontRelSize
is per thousandth of the average value of the printable area height and width. This will make the legend title look nice even if scaled to a very different size.
- See also:
- setLegendTitleFontRelSize, setAxisLabelsFont
Definition at line 2021 of file KDChartParams.h.
bool KDChartParams::legendTitleFontUseRelSize | ( | ) | const [inline, slot] |
Returns whether the legend title font size is used.
- Returns:
- whether the fixed legend title font size is used.
- See also:
- setLegendTitleFontRelSize, setLegendTitleFont
Definition at line 2027 of file KDChartParams.h.
void KDChartParams::setLegendTitleFontRelSize | ( | int | legendTitleFontRelSize | ) | [inline, slot] |
Specifies the legend title relative font size.
- Parameters:
-
legendTitleFontRelSize the relative legend size. If this value unequals zero the absolute value is per thousand of of the average value of the printable area height and width. This will make the legend title look nice even if scaled to a very different size.
Definition at line 2032 of file KDChartParams.h.
int KDChartParams::legendTitleFontRelSize | ( | ) | const [inline, slot] |
Returns the relative legend title font size.
- Returns:
- the relative legend title font size.
Definition at line 2038 of file KDChartParams.h.
void KDChartParams::setLegendSpacing | ( | uint | space | ) | [inline, slot] |
Specifies how much space in pixels there should be between the legend and the data display.
The default is 20 pixels.
- Parameters:
-
space the space in pixels between the legend and the data display
- See also:
- legendSpacing
Definition at line 2044 of file KDChartParams.h.
uint KDChartParams::legendSpacing | ( | ) | const [inline, slot] |
Returns how much space in pixels there is between the legend and the data display.
- Returns:
- the space in pixels between the legend and the data display
- See also:
- setLegendSpacing
Definition at line 2050 of file KDChartParams.h.
void KDChartParams::setAxisType | ( | uint | n, | |
const KDChartAxisParams::AxisType | axisType | |||
) | [inline, slot] |
Specifies the axis type.
- Parameters:
-
n the number of the axis settings to be modified axisType the type of the axis.
- See also:
- axisVisible
Definition at line 2062 of file KDChartParams.h.
void KDChartParams::setAxisVisible | ( | uint | n, | |
const bool | axisVisible | |||
) | [inline, slot] |
Specifies if the axis will be drawn.
The default is false.
- Parameters:
-
n the number of the axis settings to be modified axisVisible set true to make visible the respective axis.
- See also:
- axisVisible
Definition at line 2070 of file KDChartParams.h.
bool KDChartParams::axisVisible | ( | uint | n | ) | const [inline, slot] |
Returns if the axis will be drawn.
- Returns:
- if the axis is visible or not.
- See also:
- setAxisVisible
Definition at line 2079 of file KDChartParams.h.
void KDChartParams::setAxisShowGrid | ( | uint | n, | |
bool | axisShowGrid | |||
) | [slot] |
Specifies whether a grid should be drawn at the chart data area.
The grid will show a solid line for each delimiter. (or a line with a pattern defined by KDChartAxisParams::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
KDChartAxisParams::setAxisGridSubStyle()
, resp.)
- Parameters:
-
n the number of the axis for which to specify whether a grid should be drawn. axisShowGrid if true a grid will be drawn on the chart data area.
- See also:
- axisShowGrid, setAxisGridStyle, setAxisGridSubStyle
Definition at line 7096 of file KDChartParams.cpp.
bool KDChartParams::showGrid | ( | ) | const [slot] |
Returns if any grid will be drawn at the data area.
- Returns:
- if any grid will be drawn at the data area.
- See also:
- KDChartAxisParams::setAxisShowGrid
Definition at line 7110 of file KDChartParams.cpp.
void KDChartParams::setAxisDatasets | ( | uint | n, | |
uint | dataset, | |||
uint | dataset2 = KDCHART_NO_DATASET , |
|||
uint | chart = 0 | |||
) | [slot] |
Specifies which data are to be represented by a given axis.
If you specify a valid dataset-number for parameter dataset you may use the same number or a greater number for parameter dataset2 to specify a range of contiguous series of datasets.
If you specify KDCHART_ALL_DATASETS for dataset the value of dataset2 does not matter.
By setting the chart
parameter you may specify which chart is represented by the axis, you may use this when displaying more than one chart in the same widget.
Calling setAxisDataset() with a dataset number will automatically set the visability flag of the respective axis (or axes, resp.) while calling it with KDCHART_NO_DATASET will clear the visibility flag so there is no need to explicitely call setAxisVisible()
after calling setAxisDatasets().
- Note:
- If you specify
KDCHART_ALL_DATASETS
the axis will represent all the datasets with SourceMode DataEntry (seesetChartSourceMode
for explanation) that have been specified for this chart.
- Parameters:
-
n the number of the axis for which to specify the dataset(s) dataset the dataset represented by axis n
Definition at line 7147 of file KDChartParams.cpp.
bool KDChartParams::axisDatasets | ( | uint | n, | |
uint & | dataset, | |||
uint & | dataset2, | |||
uint & | chart | |||
) | const [slot] |
Returns which data are to be represented by a given axis.
( see explanation given with setAxisDatasets()
)
- Parameters:
-
n the axis for which to return the dataset number(s) dataset the starting number of the series of datasets represented by axis n
or KDCHART_ALL_DATASETSdataset2 the end number of the series of datasets chart the chart represented by axis n
- Returns:
- true if a valid axis number was specified by parameter n
- See also:
- setAxisDataset, chartAxes
Definition at line 7183 of file KDChartParams.cpp.
bool KDChartParams::chartAxes | ( | uint | chart, | |
uint & | cnt, | |||
AxesArray & | axes | |||
) | const [slot] |
Returns which ORDINATE axis(axes) is(are) representing a given chart.
This will look for the following axes: AxisPosLeft, AxisPosRight, AxisPosLeft2, AxisPosRight2.
It is allowed to specify the same variable as axis1, axis2, axis3, axis4 - when doing this you will get the last axis number that was found for this chart. In case you are sure there is only one axis per chart you may act that way.
- Parameters:
-
chart the chart for which to return the axis number(s) cnt the count of axis numbers returned axes on return, a vector with the numbers of the axes
- Returns:
- true if at least one axis is representing the chart
chart
- See also:
- setAxisDataset, axisDataset
Definition at line 7212 of file KDChartParams.cpp.
void KDChartParams::setAxisArea | ( | const uint | n, | |
const QRect & | areaRect | |||
) | [inline, slot] |
Specifies the true axis area rectangle.
- 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 uponaxisAreaMin
andaxisAreaMax
. Thus the signalchanged()
is not sended here.
- See also:
- axisAreaMax, axisAreaMin, setAxisAreaMode, setAxisAreaMin
Definition at line 2107 of file KDChartParams.h.
void KDChartParams::setAxisLabelsTouchEdges | ( | uint | n, | |
bool | axisLabelsTouchEdges | |||
) | [inline, 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.
)
- Note:
- If you decide to call setAxisLabelsTouchEdges() to override the default settings of abscissa axes (AxisPosBottom, AxisPosTop, AxisPosBottom2, AxisPosTop2) make sure to call it again each time you have called setChartType() since your settings will be overwritten when changing the chart type.
- 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 2115 of file KDChartParams.h.
void KDChartParams::setAxisLabelsVisible | ( | uint | n, | |
bool | axisLabelsVisible | |||
) | [inline, slot] |
Specifies whether the axis labels of an axis are to be shown.
- Parameters:
-
axisLabelsVisible if true the labels of this axis will be drawn.
- See also:
- setAxisLabelsFont
Definition at line 2122 of file KDChartParams.h.
void KDChartParams::setAxisLabelsFont | ( | uint | n, | |
QFont | axisLabelsFont, | |||
int | axisLabelsFontSize = 0 , |
|||
QColor | axisLabelsColor = Qt::black | |||
) | [slot] |
Specifies the axis labels font for one axis.
- Note:
- The font size will be ignored if
axisLabelsFontSize
is not zero, in this case the font size will be calculated dynamically using the value axisLabelsFontSize.
- Parameters:
-
axisLabelsFont the font to be used for the axis' labels. axisLabelsFontSize the (fixed or relative) axis font size. If this value is less than zero the absolute value is per thousand of the average value of the printable area height and width to be used. This will make the axis look the same even if scaled to very different size. axisLabelsColor the axis labels colour.
- See also:
- setAxisLabelsVisible
setAxisLabelsFontUseRelSize, setAxisLabelsFontRelSize
Definition at line 7355 of file KDChartParams.cpp.
void KDChartParams::setAxisLabelStringParams | ( | uint | n, | |
QStringList * | axisLabelStringList, | |||
QStringList * | axisShortLabelStringList, | |||
const QString & | valueStart = QString::null , |
|||
const QString & | valueEnd = QString::null | |||
) | [slot] |
Specifies a QStringList
which the axis label texts for one axis are to be taken from, the optional short-labels parameter (if not zero) may be used to specify 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"; setAxisLabelStringParams( KDChartAxisParams::AxisPosBottom, &names, &shortNames, "Monday", "Friday")
- Parameters:
-
n the ID of the axis 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
Definition at line 7428 of file KDChartParams.cpp.
void KDChartParams::setAxisParams | ( | uint | n, | |
const KDChartAxisParams & | axisParams | |||
) | [slot] |
Specifies the parameters for one axis.
- Parameters:
-
axisParams the axis parameters to be used.
- See also:
- axisParams, AxisParams
Definition at line 7450 of file KDChartParams.cpp.
const KDChartAxisParams & KDChartParams::axisParams | ( | uint | n | ) | const [inline, slot] |
Returns the parameters that are currently defined for axis n.
- Returns:
- all the parameters defined for axis n. If called with invalid value for
n
it returns the default axis parameters.
- See also:
- setAxisParams, AxisParams
Definition at line 2177 of file KDChartParams.h.
bool KDChartParams::findFirstAxisCustomBoxID | ( | uint | n, | |
uint & | boxID | |||
) | const [slot] |
Retrieves the ID of the first KDChartCustomBox that is anchored at axis n
.
By default this box is used for the default axis title text: it is created (or modified, resp.) by calling one of the axis title convenience functions setAxisTitleColor or setAxisTitleFont or setAxisTitleFontUseRelSize or setAxisTitleFontRelSize.
- Note:
- If you have specified another custom box manually that is anchored to this axis before (or instead of, resp.) calling one of the convenience functions mentioned above your custom box will become the default axis title text box: you then can access/modify its properties using these convenience functions.
- Returns:
- TRUE if a KDChartCustomBox was found that is anchored to axis
n
.
- Parameters:
-
n the axis number, this could be KDChartAxisParams::AxisPosLeft or KDChartAxisParams::AxisPosBottom... boxID will obtain the respective KDChartCustomBox's ID if return value is TRUE, otherwise the parameter's value remains unchanged.
- See also:
- setAxisTitle, setAxisTitleColor, setAxisTitleFont, setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
Definition at line 9167 of file KDChartParams.cpp.
void KDChartParams::setAxisTitle | ( | uint | n, | |
const QString & | axisTitle | |||
) | [slot] |
Specifies the default axis title text.
- Note:
- This is a convenience function accessing the first KDChartCustomBox that is anchored at axis
n
.
- Parameters:
-
axisTitle the axis title text
- See also:
- setAxisTitleColor,setAxisTitleFont,setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9276 of file KDChartParams.cpp.
QString KDChartParams::axisTitle | ( | uint | n | ) | const [slot] |
Returns the default axis title text.
- Returns:
- the axis title text.
- See also:
- setAxisTitle
Definition at line 9315 of file KDChartParams.cpp.
void KDChartParams::setAxisTitleColor | ( | uint | n, | |
QColor | axisTitleColor | |||
) | [slot] |
Specifies the color of the default axis title text.
- Parameters:
-
axisTitleColor the color of the axis title text
- See also:
- setAxisTitle, setAxisTitleFont,setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9333 of file KDChartParams.cpp.
QColor KDChartParams::axisTitleColor | ( | uint | n | ) | const [slot] |
Returns the color of the default axis title text.
- Returns:
- the color of the axis title text.
- See also:
- setAxisTitleColor
Definition at line 9359 of file KDChartParams.cpp.
void KDChartParams::setAxisTitleFont | ( | uint | n, | |
QFont | axisTitleFont | |||
) | [slot] |
Specifies the font and the size of the default axis title text.
- Parameters:
-
axisTitleFont the font of the axis title text useFontSize flag indicating whether the font's size is to be used axisTitleFontRelSize the size to be used if useFontSize
is false, this is interpreted as per mil value of the printable area size
- See also:
- setAxisTitle, setAxisTitleColor,setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9379 of file KDChartParams.cpp.
void KDChartParams::setAxisTitleFont | ( | uint | n, | |
QFont | axisTitleFont, | |||
bool | useFixedFontSize | |||
) | [slot] |
Specifies the font and the size of the default axis title text.
- Parameters:
-
axisTitleFont the font of the axis title text - by default the font will be relative useFixedFontSize flag indicating whether the font's size is to be used as fixed or calculated as per mil value. axisTitleFontRelSize the size to be used if useFixedFontSize
is false, this is interpreted as per mil value of the printable area size
- See also:
- setAxisTitle, setAxisTitleColor, setAxisTitleFont, setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9412 of file KDChartParams.cpp.
QFont KDChartParams::axisTitleFont | ( | uint | n | ) | const [slot] |
Returns the font of the default axis title text.
- Returns:
- the axis title's font.
- See also:
- setAxisTitleFont
Definition at line 9452 of file KDChartParams.cpp.
void KDChartParams::setAxisTitleFontUseRelSize | ( | uint | n, | |
bool | axisTitleFontUseRelSize | |||
) | [slot] |
Specifies whether the fixed size of the the default axis title text's font.
- Parameters:
-
axisTitleFontUseRelSize flag indicating whether the font's size is to be used or the size specified via setAxisTitleFontRelSize.
- See also:
- setAxisTitle, setAxisTitleColor,setAxisTitleFont, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9470 of file KDChartParams.cpp.
bool KDChartParams::axisTitleFontUseRelSize | ( | uint | n | ) | const [slot] |
Returns whether the fix font size is used for the default axis title text.
- Returns:
- whether the fix axis title font size is used.
- See also:
- setAxisTitleFontUseRelSize
Definition at line 9505 of file KDChartParams.cpp.
void KDChartParams::setAxisTitleFontRelSize | ( | uint | n, | |
int | axisTitleFontRelSize | |||
) | [slot] |
Specifies whether a relative size to be used for the default axis title text instead of the fixed size of the font.
Calling this function implicitely sets this axis's axisTitleFontUseRelSize
flag to TRUE.
- Parameters:
-
axisTitleFontRelSize the size to be used, this is interpreted as per mil value of the printable area size.
- See also:
- setAxisTitle, setAxisTitleColor,setAxisTitleFont, setAxisTitleFontUseRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize
Definition at line 9525 of file KDChartParams.cpp.
int KDChartParams::axisTitleFontRelSize | ( | uint | n | ) | const [slot] |
Returns the relative size of the default axis title text, should be ignored if axisTitleFontUseRelSize
returns false.
- Returns:
- the axis title's relative font size.
- See also:
- setAxisTitleFontRelSize
Definition at line 9553 of file KDChartParams.cpp.
QRect KDChartParams::axisArea | ( | const uint | n | ) | const [inline, slot] |
Returns the true axis area rectangle as it was was calculate by KD Chart.
- Parameters:
-
n the number of the axis
- Note:
- This special function may be called *after* calling KDChart::setupGeometry(). Normally you don't need to call it at all, its only purpose is to provide you with a way to retrieve the true position and size of an axis area.
- See also:
- dataArea
Definition at line 2199 of file KDChartParams.h.
QRect KDChartParams::dataArea | ( | ) | const [inline, slot] |
Returns the true data area rectangle as it was was calculate by KD Chart.
- Note:
- This special function may be called *after* calling KDChart::setupGeometry(). Normally you don't need to call it at all, its only purpose is to provide you with a way to retrieve the true position and size of the data area.
- See also:
- axisArea
Definition at line 2212 of file KDChartParams.h.
QRect KDChartParams::legendArea | ( | ) | const [inline, slot] |
Returns the true legend area rectangle as it was was calculate by KD Chart.
- Note:
- This special function may be called *after* calling KDChart::setupGeometry(). Normally you don't need to call it at all, its only purpose is to provide you with a way to retrieve the true position and size of an legend area.
- See also:
- dataArea
Definition at line 2213 of file KDChartParams.h.
void KDChartParams::setHeaderFooterText | ( | uint | pos, | |
const QString & | text | |||
) | [slot] |
Specifies the text to be displayed in the header (or footer, resp.
) section specified by pos
. The default is not to display any header text nor footer text.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section in which the text is to be shown text the text to be shown
- See also:
- HdFtPos, headerFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
Definition at line 7734 of file KDChartParams.cpp.
QString KDChartParams::headerFooterText | ( | uint | pos | ) | const [slot] |
Returns the text that is displayed in the header (or footer, resp.
) section specified by pos
.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which to return the text
- Returns:
- the displayed text
- See also:
- HdFtPos, setHeaderFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
Definition at line 7760 of file KDChartParams.cpp.
const QRect & KDChartParams::headerFooterRect | ( | uint | pos | ) | const [slot] |
- Note:
- This methode for internal use. Return the position and size of one header/footer area. Will return valid data only if called after KDChartPainter::setupGeometry()!
Definition at line 7775 of file KDChartParams.cpp.
void KDChartParams::setHeaderFooterColor | ( | uint | pos, | |
const QColor | color | |||
) | [slot] |
Specifies the colour to be used for the header text (or footer text, resp.
) of the header/footer section specified by pos
. The default colour is QColor( Qt::black ).
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which the colour is to be changed color the text colour to be used
- See also:
- HdFtPos, headerFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
Definition at line 7802 of file KDChartParams.cpp.
QColor KDChartParams::headerFooterColor | ( | uint | pos | ) | const [slot] |
Returns the colour used for the header text (or footer text, resp.
) of the header/footer section specified by pos
.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which to return the text colour
- Returns:
- the text colour
- See also:
- HdFtPos, setHeaderFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
Definition at line 7828 of file KDChartParams.cpp.
void KDChartParams::setHeaderFooterFont | ( | uint | pos, | |
const QFont & | font, | |||
bool | fontUseRelSize, | |||
int | fontRelSize | |||
) | [slot] |
Specifies the font to be used in the header (or footer, resp.
) section specified by pos
.. The default is a 14pt Helvetica font.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section in which the font is to be used font the font to use
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setHeader1Text(), header1Text()
Definition at line 7858 of file KDChartParams.cpp.
QFont KDChartParams::headerFooterFont | ( | uint | pos | ) | const [slot] |
Returns the font used in the header (or footer, resp.
) section specified by pos
.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which to return the font
- Returns:
- the used font
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setHeader1Text(), header1Text()
Definition at line 7891 of file KDChartParams.cpp.
bool KDChartParams::headerFooterFontUseRelSize | ( | uint | pos | ) | const [slot] |
Returns is the font size used in the header (or footer, resp.
) section specified by pos
will be calculated dynamically.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which to return the font calculation flag
- Returns:
- the font calculation flag
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setHeader1Text(), header1Text()
Definition at line 7920 of file KDChartParams.cpp.
int KDChartParams::headerFooterFontRelSize | ( | uint | pos | ) | const [slot] |
Returns the factor used for dynamical calculation of the font size of the text in the header (or footer, resp.
) section specified by pos
.
- Note:
- To learn about the different header (or footer, resp.) sections please see information given at
HdFtPos
enum explanation.
- Parameters:
-
pos the section for which to return the font size factor
- Returns:
- the font size factor
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setHeader1Text(), header1Text()
Definition at line 7950 of file KDChartParams.cpp.
void KDChartParams::setHeader1Text | ( | const QString & | text | ) | [inline, slot] |
Specifies the text to be displayed as the first header line.
The default is not to display any header text.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
text the text to display
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
header2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()
Definition at line 2314 of file KDChartParams.h.
QString KDChartParams::header1Text | ( | ) | const [inline, slot] |
Returns the text that is displayed as the first header line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the displayed text
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
Definition at line 2321 of file KDChartParams.h.
void KDChartParams::setHeader1Font | ( | const QFont & | font | ) | [inline, slot] |
Specifies the font to be used for displaying the first header line.
The default is a 14pt Helvetica font.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
font the font to use
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
header2Font(), setHeader2Text(), header2Text()
Definition at line 2326 of file KDChartParams.h.
QFont KDChartParams::header1Font | ( | ) | const [inline, slot] |
Returns the font used for displaying the second header line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the used font
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
setHeader2Font(), setHeader2Text(), header2Text(), setHeader1Font(), header1Font(), setFooterFont(), footerFont()
Definition at line 2333 of file KDChartParams.h.
void KDChartParams::setHeader2Text | ( | const QString & | text | ) | [inline, slot] |
Specifies the text to be displayed as the second header line.
The default is not to display any header text.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
text the text to display
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
header2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()
Definition at line 2338 of file KDChartParams.h.
QString KDChartParams::header2Text | ( | ) | const [inline, slot] |
Returns the text that is displayed as the second header line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the displayed text
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setHeader2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()
Definition at line 2345 of file KDChartParams.h.
void KDChartParams::setHeader2Font | ( | const QFont & | font | ) | [inline, slot] |
Specifies the font to be used for displaying the second header line.
The default is a 12pt Helvetica font.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
font the font to use
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
header2Font(), setHeader2Text(), header2Text(), setHeader1Font(), header1Font(), setFooterFont(), footerFont()
Definition at line 2350 of file KDChartParams.h.
QFont KDChartParams::header2Font | ( | ) | const [inline, slot] |
Returns the font used for displaying the second header line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the used font
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
setHeader2Font(), setHeader2Text(), header2Text(), setHeader1Font(), header1Font(), setFooterFont(), footerFont()
Definition at line 2357 of file KDChartParams.h.
void KDChartParams::setFooterText | ( | const QString & | text | ) | [inline, slot] |
Specifies the text to be displayed as the footer line.
The default is not to display any footer text.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
text the text to display
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
footerText(), setHeader1Text(), header1Text(), setHeader2Text(), header2Text()
Definition at line 2364 of file KDChartParams.h.
QString KDChartParams::footerText | ( | ) | const [inline, slot] |
Returns the text that is displayed as the footer line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the displayed text
- See also:
- HdFtPos, setHeaderFooterText(), headerFooterText()
setFooterText(), setHeader1Text(), header1Text(), setHeader2Text(), header2Text()
Definition at line 2371 of file KDChartParams.h.
void KDChartParams::setFooterFont | ( | const QFont & | font | ) | [inline, slot] |
Specifies the font to be used for displaying the footer line.
The default is a 12pt Helvetica font.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Parameters:
-
font the font to use
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
footerFont(), setFooterText(), footerText(), setHeader1Font(), header1Font(), setHeader2Font(), header2Font()
Definition at line 2376 of file KDChartParams.h.
QFont KDChartParams::footerFont | ( | ) | const [inline, slot] |
Returns the font used for displaying the footer line.
- Note:
- This function provided for convenience only.
To gain the full benefits of the header/footer management please consider learning about the different header (or footer, resp.) sections, see information given atHdFtPos
enum explanation.
The 'better' way to specify content and settings of headers or footers is to callsetHeaderFooterText
( orsetHeaderFooterFont
,setHeaderFooterFontUseRelSize
,setHeaderFooterFontRelSize
, resp.) while specifying the appropriateHdFtPos
.
The canonical way to retrieve settings and content of headers or footers is to callheaderFooterText
(orheaderFooterFont
,headerFooterFontUseRelSize
,headerFooterFontRelSize
, resp.).
- Returns:
- the used font
- See also:
- HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
setFooterFont(), setFooterText(), footerText(), setHeader1Font(), header1Font(), setHeader2Font(), header2Font()
Definition at line 2383 of file KDChartParams.h.
void KDChartParams::loadAxesFormXML | ( | int & | curAxisSettings, | |
QDomElement & | element | |||
) | [slot] |
bool KDChartParams::loadXML | ( | const QDomDocument & | doc | ) | [slot] |
Reads the parameters from an XML document.
- Parameters:
-
doc the XML document to read from
- Returns:
- true if the parameters could be read, false if a file format error occurred
- See also:
- saveXML
Definition at line 1358 of file KDChartParams_io.cpp.
void KDChartParams::saveAxesToXML | ( | QDomDocument & | doc, | |
QDomElement & | docRoot | |||
) | const [slot] |
Helper method saving the axis parameters to an XML file, this is called by saveXML() only.
Definition at line 55 of file KDChartParams_io.cpp.
QDomDocument KDChartParams::saveXML | ( | bool | withPI = true |
) | const [slot] |
Saves the parameters to an XML document.
- Returns:
- the XML document that represents the parameters
- See also:
- loadXML
Definition at line 343 of file KDChartParams_io.cpp.
void KDChartParams::createChartValueNode | ( | QDomDocument & | doc, | |
QDomNode & | parent, | |||
const QString & | elementName, | |||
const QVariant & | valY, | |||
const QVariant & | valX, | |||
const int & | propID | |||
) | [static, slot] |
Creates a DOM element node that represents a chart value for use in a DOM document.
- Parameters:
-
doc the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node data the chart value to be represented
Definition at line 2328 of file KDChartParams_io.cpp.
void KDChartParams::createColorMapNode | ( | QDomDocument & | doc, | |
QDomNode & | parent, | |||
const QString & | elementName, | |||
const QMap< uint, QColor > & | map | |||
) | [static, slot] |
Creates a DOM element node that represents a map of QColor objects for use in a DOM document.
- Parameters:
-
doc the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node map the map of colors to be represented
Definition at line 2254 of file KDChartParams_io.cpp.
void KDChartParams::createDoubleMapNode | ( | QDomDocument & | doc, | |
QDomNode & | parent, | |||
const QString & | elementName, | |||
const QMap< int, double > & | map | |||
) | [static, slot] |
Creates a DOM element node that represents a map of doubles for use in a DOM document.
- Parameters:
-
doc the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node map the map of doubles to be represented
Definition at line 2284 of file KDChartParams_io.cpp.
void KDChartParams::createChartFontNode | ( | QDomDocument & | doc, | |
QDomNode & | parent, | |||
const QString & | elementName, | |||
const QFont & | font, | |||
bool | useRelFont, | |||
int | relFont, | |||
int | minFont = -1 | |||
) | [static, slot] |
Creates a DOM element node that represents a font used in a chart for use in a DOM document.
- Parameters:
-
doc the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node font the font to be resented useRelFont the specification whether the font size is relative relFont the relative font size minFont the minimal font size in points, leave this parameter out if not needed
Definition at line 2357 of file KDChartParams_io.cpp.
bool KDChartParams::readColorMapNode | ( | const QDomElement & | element, | |
QMap< uint, QColor > * | value | |||
) | [static, slot] |
Creates a DOM element node that represents a color map for use in a DOM document.
- Parameters:
-
doc the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node map the color map to be represented
Definition at line 2386 of file KDChartParams_io.cpp.
bool KDChartParams::readDoubleMapNode | ( | const QDomElement & | element, | |
QMap< int, double > * | value | |||
) | [static, slot] |
Reads data from a DOM element node that represents a double map and fills a double map with the data.
- Parameters:
-
element the DOM element to read from map the frame settings object to read the data into
Definition at line 2420 of file KDChartParams_io.cpp.
bool KDChartParams::readChartFontNode | ( | const QDomElement & | element, | |
QFont & | font, | |||
bool & | useRelFont, | |||
int & | relFontSize, | |||
int * | minFontSize = 0 | |||
) | [static, slot] |
Reads data from a DOM element node that represents a font uses in a chart and fills the reference parameters with the data.
- Parameters:
-
element the DOM element to read from font the represented font useRelFont whether the font size is relative relFontSize the relative font size
Definition at line 2458 of file KDChartParams_io.cpp.
bool KDChartParams::readChartValueNode | ( | const QDomElement & | element, | |
QVariant & | valY, | |||
QVariant & | valX, | |||
int & | propID | |||
) | [static, slot] |
Reads data from a DOM element node that represents a chart value and fills a KDChartData object with the data.
- Parameters:
-
element the DOM element to read from value the chart data object to read the data into
Definition at line 2526 of file KDChartParams_io.cpp.
void KDChartParams::changed | ( | ) | [signal] |
This signal is emitted when any of the chart parameters has changed.
The documentation for this class was generated from the following files: