kchart

Classes | Public Types | Public Slots | Public Member Functions | Protected Member Functions | Friends | List of all members
KDChartParams Class Reference

#include <KDChartParams.h>

Inherits TQObject.

Inherited by KChart::KChartParams.

Classes

class  KDChartFrameSettings
 

Public Types

typedef TQMap< int, double > ExplodeFactorsMap
 
typedef TQValueVector< uint > AxesArray
 

Public Slots

static TQString chartTypeToString (ChartType type)
 
static ChartType stringToChartType (const TQString &string)
 
static TQString chartSourceModeToString (const SourceMode &mode)
 
static SourceMode stringToChartSourceMode (const TQString &string)
 
int dataValuesDivPow10 (uint chart) const
 
int dataValuesDigitsBehindComma (uint chart) const
 
TQBrush dataValuesBackground (uint chart) const
 
bool dataValuesShowInfinite (uint chart) const
 
static TQString markerStyleToString (int style)
 
static TQString markerStyleToStringTr (int style)
 
static int stringToMarkerStyle (const TQString &string)
 
static int stringToMarkerStyleTr (const TQString &string)
 
static TQString barChartSubTypeToString (BarChartSubType type)
 
static BarChartSubType stringToBarChartSubType (const TQString &string)
 
int userWidth () const
 
static LineChartSubType stringToLineChartSubType (const TQString &string)
 
static TQString lineChartSubTypeToString (LineChartSubType type)
 
static TQString lineMarkerStyleToString (LineMarkerStyle style)
 
static TQString lineMarkerStyleToStringTr (LineMarkerStyle style)
 
static LineMarkerStyle stringToLineMarkerStyle (const TQString &string)
 
static LineMarkerStyle stringToLineMarkerStyleTr (const TQString &string)
 
static TQString areaChartSubTypeToString (AreaChartSubType type)
 
static AreaChartSubType stringToAreaChartSubType (const TQString &string)
 
static TQString areaLocationToString (AreaLocation type)
 
static AreaLocation stringToAreaLocation (const TQString &string)
 
static PolarChartSubType stringToPolarChartSubType (const TQString &string)
 
static TQString polarChartSubTypeToString (PolarChartSubType type)
 
static TQString polarMarkerStyleToString (PolarMarkerStyle style)
 
static TQString polarMarkerStyleToStringTr (PolarMarkerStyle style)
 
static PolarMarkerStyle stringToPolarMarkerStyle (const TQString &string)
 
static PolarMarkerStyle stringToPolarMarkerStyleTr (const TQString &string)
 
static TQString hiLoChartSubTypeToString (HiLoChartSubType type)
 
static HiLoChartSubType stringToHiLoChartSubType (const TQString &string)
 
static TQString bWChartSubTypeToString (BWChartSubType type)
 
static BWChartSubType stringToBWChartSubType (const TQString &string)
 
static TQString bWChartStatValToString (BWStatVal type)
 
static BWStatVal stringToBWChartStatVal (const TQString &string)
 
static TQString legendPositionToString (LegendPosition pos)
 
static LegendPosition stringToLegendPosition (const TQString &string)
 
static TQString legendSourceToString (LegendSource source)
 
static LegendSource stringToLegendSource (const TQString &string)
 
void __internalStoreHdFtRect (int pos, TQRect rect)
 
void loadAxesFormXML (int &curAxisSettings, TQDomElement &element)
 
bool loadXML (const TQDomDocument &doc)
 
void saveAxesToXML (TQDomDocument &doc, TQDomElement &docRoot) const
 
TQDomDocument saveXML (bool withPI=true) const
 
static void createChartValueNode (TQDomDocument &doc, TQDomNode &parent, const TQString &elementName, const TQVariant &valY, const TQVariant &valX, const int &propID)
 
static void createColorMapNode (TQDomDocument &doc, TQDomNode &parent, const TQString &elementName, const TQMap< uint, TQColor > &map)
 
static void createDoubleMapNode (TQDomDocument &doc, TQDomNode &parent, const TQString &elementName, const TQMap< int, double > &map)
 
static void createChartFontNode (TQDomDocument &doc, TQDomNode &parent, const TQString &elementName, const TQFont &font, bool useRelFont, int relFont, int minFont=-1)
 
static bool readColorMapNode (const TQDomElement &element, TQMap< uint, TQColor > *map)
 
static bool readDoubleMapNode (const TQDomElement &element, TQMap< int, double > *map)
 
static bool readChartFontNode (const TQDomElement &element, TQFont &font, bool &useRelFont, int &relFontSize, int *minFontSize=0)
 
static bool readChartValueNode (const TQDomElement &element, TQVariant &valY, TQVariant &valX, int &propID)
 
void setDataArea (const TQRect &areaRect)
 
void setLegendArea (const TQRect &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 (TQValueList< int > explodeList)
 
TQValueList< 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 TQRect &areaRect)
 
void setAxisLabelsTouchEdges (uint n, bool axisLabelsTouchEdges)
 
void setAxisLabelsVisible (uint n, bool axisLabelsVisible)
 
void setAxisLabelsFont (uint n, TQFont axisLabelsFont, int axisLabelsFontSize=0, TQColor axisLabelsColor=TQt::black)
 
void setAxisLabelTextParams (uint n, bool axisSteadyValueCalc=true, TQVariant axisValueStart=KDCHART_AXIS_LABELS_AUTO_LIMIT, TQVariant 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, TQStringList *axisLabelStringList=0, TQStringList *axisShortLabelsStringList=0, int axisValueLeaveOut=KDCHART_AXIS_LABELS_AUTO_LEAVEOUT, KDChartAxisParams::ValueScale axisValueDeltaScale=KDChartAxisParams::ValueScaleNumerical)
 
void setAxisLabelStringParams (uint n, TQStringList *axisLabelStringList, TQStringList *axisShortLabelStringList, const TQString &valueStart=TQString(), const TQString &valueEnd=TQString())
 
void setAxisParams (uint n, const KDChartAxisParams &axisParams)
 
const KDChartAxisParams & axisParams (uint n) const
 
TQRect axisArea (const uint n) const
 
TQRect dataArea () const
 
TQRect legendArea () const
 

Public Member Functions

 KDChartParams ()
 
virtual ~KDChartParams ()
 

Protected Member Functions

void setBarsDisplayed (int barsDisplayed)
 
void setBarsLeft (int barsLeft)
 

Friends

TQTextStream & operator<< (TQTextStream &s, const KDChartParams &p)
 
TQTextStream & operator>> (TQTextStream &s, KDChartParams &p)
 

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 TQIntDict< 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, TQPen pen=TQPen(), TQBrush background=TQBrush(TQt::NoBrush), const TQPixmap *backPixmap=0, KDFrame::BackPixmapMode backPixmapMode=KDFrame::PixStretched, int shadowWidth=0, KDFrame::CornerName sunPos=KDFrame::CornerTopLeft)
 
bool removeFrame (uint area)
 
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, TQPen pen=TQPen(), int shadowWidth=0, KDFrame::CornerName sunPos=KDFrame::CornerTopLeft)
 
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 (TQColor color, TQColor &shadow1, TQColor &shadow2) const
 
void setDataColor (uint dataset, TQColor color)
 
TQColor dataColor (uint dataset) const
 
void setDataDefaultColors ()
 
void setDataRainbowColors ()
 
void setDataSubduedColors (bool ordered=false)
 
void setShadowBrightnessFactor (double factor)
 
double shadowBrightnessFactor () const
 
void setShadowPattern (TQt::BrushStyle style)
 
TQt::BrushStyle shadowPattern () const
 
void setOutlineDataColor (TQColor color)
 
TQColor outlineDataColor () const
 
void setOutlineDataLineWidth (uint width)
 
uint outlineDataLineWidth () const
 
void setOutlineDataLineStyle (TQt::PenStyle style)
 
TQt::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, TQFont *font=0, uint size=UINT_MAX, const TQColor *color=KDCHART_DATA_VALUE_AUTO_COLOR, KDChartEnums::PositionFlag negativePosition=KDChartEnums::PosCenter, uint negativeAlign=TQt::AlignCenter, int negativeDeltaX=0, int negativeDeltaY=0, int negativeRotation=0, KDChartEnums::PositionFlag positivePosition=KDChartEnums::PosCenter, uint positiveAlign=TQt::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 (TQFont *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 TQColor *color=KDCHART_DATA_VALUE_AUTO_COLOR, const TQBrush &background=TQBrush(TQt::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
 
TQFont dataValuesFont (uint chart) const
 
bool dataValuesUseFontRelSize (uint chart) const
 
int dataValuesFontRelSize (uint chart) const
 
TQColor 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 TQColor *color=KDCHART_DATA_VALUE_AUTO_COLOR)
 
void setPrintDataValuesFontRelSize (uint chart, uint size)
 
TQColor dataShadow1Color (uint dataset) const
 
TQColor 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 TQMap< 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 (TQSize size)
 
TQSize lineMarkerSize () const
 
void setLineWidth (int width)
 
int lineWidth () const
 
void setLineColor (TQColor color=TQColor())
 
TQColor lineColor () const
 
void setLineStyle (TQt::PenStyle style, uint dataset=KDCHART_GLOBAL_LINE_STYLE)
 
TQt::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 TQMap< 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 (TQSize size=TQSize(-40, -40))
 
TQSize 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, TQFont *font=0, int size=14, TQColor *color=0)
 
bool hiLoChartPrintLowValues () const
 
TQFont hiLoChartLowValuesFont () const
 
bool hiLoChartLowValuesUseFontRelSize () const
 
int hiLoChartLowValuesFontRelSize () const
 
TQColor hiLoChartLowValuesColor () const
 
void setHiLoChartPrintHighValues (bool active, TQFont *font=0, int size=14, TQColor *color=0)
 
bool hiLoChartPrintHighValues () const
 
TQFont hiLoChartHighValuesFont () const
 
bool hiLoChartHighValuesUseFontRelSize () const
 
int hiLoChartHighValuesFontRelSize () const
 
TQColor hiLoChartHighValuesColor () const
 
void setHiLoChartPrintOpenValues (bool active, TQFont *font=0, uint size=14, TQColor *color=0)
 
bool hiLoChartPrintOpenValues () const
 
TQFont hiLoChartOpenValuesFont () const
 
bool hiLoChartOpenValuesUseFontRelSize () const
 
int hiLoChartOpenValuesFontRelSize () const
 
TQColor hiLoChartOpenValuesColor () const
 
void setHiLoChartPrintCloseValues (bool active, TQFont *font=0, int size=14, TQColor *color=0)
 
bool hiLoChartPrintCloseValues () const
 
TQFont hiLoChartCloseValuesFont () const
 
bool hiLoChartCloseValuesUseFontRelSize () const
 
int hiLoChartCloseValuesFontRelSize () const
 
TQColor hiLoChartCloseValuesColor () const
 
void setHiLoChartPrintFirstValues (bool active, TQFont *font=0, uint size=14, TQColor *color=0)
 
bool hiLoChartPrintFirstValues () const
 
TQFont hiLoChartFirstValuesFont () const
 
bool hiLoChartFirstValuesUseFontRelSize () const
 
int hiLoChartFirstValuesFontRelSize () const
 
TQColor hiLoChartFirstValuesColor () const
 
void setHiLoChartPrintLastValues (bool active, TQFont *font=0, int size=14, TQColor *color=0)
 
bool hiLoChartPrintLastValues () const
 
TQFont hiLoChartLastValuesFont () const
 
bool hiLoChartLastValuesUseFontRelSize () const
 
int hiLoChartLastValuesFontRelSize () const
 
TQColor 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 TQBrush &bWChartBrush)
 
TQBrush bWChartBrush () const
 
void setBWChartOutValMarkerSize (int size)
 
int bWChartOutValMarkerSize () const
 
void setBWChartPrintStatistics (BWStatVal statValue, bool active, TQFont *font=0, int size=24, TQColor *color=0, TQBrush *brush=0)
 
bool bWChartPrintStatistics (BWStatVal statValue) const
 
TQFont bWChartStatisticsFont (BWStatVal statValue) const
 
bool bWChartStatisticsUseRelSize (BWStatVal statValue) const
 
int bWChartStatisticsFontRelSize (BWStatVal statValue) const
 
TQColor bWChartStatisticsColor (BWStatVal statValue) const
 
TQBrush 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
 
void setLegendOrientation (TQt::Orientation orientation)
 
TQt::Orientation legendOrientation () const
 
void setLegendShowLines (bool legendShowLines)
 
bool legendShowLines () const
 
void setLegendSource (LegendSource source)
 
LegendSource legendSource () const
 
void setLegendText (uint dataset, const TQString &text)
 
TQString legendText (uint dataset) const
 
void setLegendTextColor (const TQColor &color)
 
TQColor legendTextColor () const
 
void setLegendFont (const TQFont &font, bool useFontSize)
 
TQFont legendFont () const
 
void setLegendFontUseRelSize (bool legendFontUseRelSize)
 
bool legendFontUseRelSize () const
 
void setLegendFontRelSize (int legendFontRelSize)
 
int legendFontRelSize () const
 
void setLegendTitleText (const TQString &text)
 
TQString legendTitleText () const
 
void setLegendTitleTextColor (const TQColor &color)
 
TQColor legendTitleTextColor () const
 
void setLegendTitleFont (const TQFont &font, bool useFontSize)
 
TQFont 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.

  • Up to three leading headers ( HdFtPosHeader0 , HdFtPosHeader0L , HdFtPosHeader0R ) may be drawn at the very upper edge of the printable area.
    You might want to use those sections to show some marginal information like department name, print date, page number...
    Note: Those headers share the same area so make sure to specify propper horizontal alignment for each section when using more than one of them. By default HdFtPosHeader0 has centered alignement, HdFtPosHeader0L is aligned to the left and HdFtPosHeader0R to the right side. All of them are vertically aligned to the bottom, you may change this at your own risk: the resulting output might look strange.
    also note: Alignment to bottom here means their baselines are horizontally adjusted to each other when more than one of them is used - it does not mean the lowest pixel positions of their output will be at the very same y coordinate since those might vary depending from the font size and or the font size you have specified for each of the sections.
  • Up to three main headers ( HdFtPosHeader , HdFtPosHeaderL , HdFtPosHeaderR ) may be drawn under the leading header(s).
    You could use this headers to show the main information such as project name, chart title or period of time (e.g. census year).
    Like their counterparts they share the same part of the printable area so the restrictions regarding alignment mentioned above apply also to these three sections.
  • Up to three additional headers ( HdFtPosHeader2 , HdFtPosHeader2L , HdFtPosHeader2R ) may be drawn under the main header(s).
    This headers could show additional information such as project phase, chart sub-title or sub-period of time (e.g. census quarter-year).
    Like their counterparts they share the same part of the printable area so the restrictions regarding alignment mentioned above apply also to these three sections.
  • Up to three main footers ( HdFtPosFooter , HdFtPosFooterL , HdFtPosFooterR ) may be drawn under the chart data area (or the legend that might be shown below that area, resp.).
    You might want to use these footers instead of (or additional to) the main header(s) for showing the main information...
    Like their header-counterparts they share the same part of the printable area so the restrictions regarding alignment mentioned above apply also to these three sections.
  • Up to three additional footers ( HdFtPosFooter2 , HdFtPosFooter2L , HdFtPosHeader2R ) may be drawn under the main footer(s).
    This footers could show additional information instead of (or additional to) the additional header(s).
    Like their counterparts they share the same part of the printable area so the restrictions regarding alignment mentioned above apply also to these three sections.
  • Up to three trailing footers ( HdFtPosFooter0 , HdFtPosFooter0L , HdFtPosFooter0R ) may be drawn at the very lower edge of the printable area: under the other footer sections
    You might want to use those sections to show some marginal information instead of (or additional to) the leading header(s).
    Like their counterparts they share the same part of the printable area so the restrictions regarding alignment mentioned above apply also to these three sections.
Note
The names HdFtPosHeader or HdFtPosFooter are the basic names also returned by basicAxisPos.

Usage: Please see example code at setHeaderFooterText function explanation.

See also
setHeaderFooterText, headerFooterText
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
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
}
 
bool findFirstAxisCustomBoxID (uint n, uint &boxID) const
 
void setAxisTitle (uint n, const TQString &axisTitle)
 
TQString axisTitle (uint n) const
 
void setAxisTitleColor (uint n, TQColor axisTitleColor)
 
TQColor axisTitleColor (uint n) const
 
void setAxisTitleFont (uint n, TQFont axisTitleFont)
 
void setAxisTitleFont (uint n, TQFont axisTitleFont, bool useFixedFontSize)
 
TQFont 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 setHeaderFooterText (uint pos, const TQString &text)
 
TQString headerFooterText (uint pos) const
 
const TQRect & headerFooterRect (uint pos) const
 
void setHeaderFooterColor (uint pos, const TQColor color)
 
TQColor headerFooterColor (uint pos) const
 
void setHeaderFooterFont (uint pos, const TQFont &font, bool fontUseRelSize, int fontRelSize)
 
TQFont headerFooterFont (uint pos) const
 
bool headerFooterFontUseRelSize (uint pos) const
 
int headerFooterFontRelSize (uint pos) const
 
void setHeader1Text (const TQString &text)
 
TQString header1Text () const
 
void setHeader1Font (const TQFont &font)
 
TQFont header1Font () const
 
void setHeader2Text (const TQString &text)
 
TQString header2Text () const
 
void setHeader2Font (const TQFont &font)
 
TQFont header2Font () const
 
void setFooterText (const TQString &text)
 
TQString footerText () const
 
void setFooterFont (const TQFont &font)
 
TQFont footerFont () const
 

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 135 of file KDChartParams.h.

Member Typedef Documentation

◆ AxesArray

typedef TQValueVector<uint> KDChartParams::AxesArray

Definition at line 2096 of file KDChartParams.h.

◆ CustomBoxDict

KDChartParams::CustomBoxDict

The type that stores the custom boxes in a chart.

Definition at line 511 of file KDChartParams.h.

◆ ExplodeFactorsMap

typedef TQMap<int,double> KDChartParams::ExplodeFactorsMap

Definition at line 1407 of file KDChartParams.h.

◆ LineMarkerStyleMap

KDChartParams::LineMarkerStyleMap

The type of the storage structure for line marker styles.

You should normally not need to use this.

Definition at line 1097 of file KDChartParams.h.

◆ PolarMarkerStyleMap

KDChartParams::PolarMarkerStyleMap

The type of the storage structure for polar marker styles.

You should normally not need to use this.

Definition at line 1308 of file KDChartParams.h.

Member Enumeration Documentation

◆ AreaChartSubType

enum KDChartParams::AreaChartSubType

The area subtype.

Only used when chartType == Area

See also
setAreaChartSubType, areaChartSubType

Definition at line 1215 of file KDChartParams.h.

◆ AreaLocation

enum KDChartParams::AreaLocation

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 1239 of file KDChartParams.h.

◆ BarChartSubType

enum KDChartParams::BarChartSubType

The bar subtype.

Only used when chartType() == Bar

See also
setBarChartSubType, barChartSubType

Definition at line 884 of file KDChartParams.h.

◆ BWChartSubType

enum KDChartParams::BWChartSubType

The BoxWhisker subtype.

Only used when chartType == BoxWhisker

See also
setBWChartSubType, bWChartSubType

Definition at line 1734 of file KDChartParams.h.

◆ BWStatVal

enum KDChartParams::BWStatVal

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 1736 of file KDChartParams.h.

◆ ChartType

enum KDChartParams::ChartType

The chart type.

Covers only built-in chart types.

See also
setChartType, chartType
setAdditionalChartType, additionalChartType,
setChartSourceMode

Definition at line 530 of file KDChartParams.h.

◆ HdFtPos

enum KDChartParams::HdFtPos

This enum lists the positions that headers and footers can take.

Definition at line 2235 of file KDChartParams.h.

◆ HiLoChartSubType

enum KDChartParams::HiLoChartSubType

The HiLo subtype.

Only used when chartType == HiLo

See also
setHiLoChartSubType, hiLoChartSubType

Definition at line 1505 of file KDChartParams.h.

◆ LegendPosition

enum KDChartParams::LegendPosition

The possible positions for a legend.

NoLegend turns legend display off.

See also
setLegendPosition, legendPosition

Definition at line 1842 of file KDChartParams.h.

◆ LegendSource

enum KDChartParams::LegendSource

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 1898 of file KDChartParams.h.

◆ LineChartSubType

enum KDChartParams::LineChartSubType

The line subtype.

Only used when chartType == Line

See also
setLineChartSubType, lineChartSubType

Definition at line 1056 of file KDChartParams.h.

◆ LineMarkerStyle

enum KDChartParams::LineMarkerStyle

The available line marker styles.

Definition at line 1087 of file KDChartParams.h.

◆ PolarChartSubType

enum KDChartParams::PolarChartSubType

The polar subtype.

Only used when chartType == Polar

See also
setPolarChartSubType, polarChartSubType

Definition at line 1261 of file KDChartParams.h.

◆ PolarMarkerStyle

enum KDChartParams::PolarMarkerStyle

The available polar marker styles.

Definition at line 1291 of file KDChartParams.h.

◆ SourceMode

enum KDChartParams::SourceMode

The chart source mode.

Use setChartSourceMode to specify if and how any data should be taken into account for a given chart.

See also
setChartSourceMode, chartSourceMode, setAdditionalChartType

Definition at line 550 of file KDChartParams.h.

Constructor & Destructor Documentation

◆ KDChartParams()

KDChartParams::KDChartParams ( )

Constructor.

Defines default values.

Definition at line 94 of file KDChartParams.cpp.

◆ ~KDChartParams()

KDChartParams::~KDChartParams ( )
virtual

Destructor.

Only defined to have it virtual.

Definition at line 448 of file KDChartParams.cpp.

Member Function Documentation

◆ __internalStoreHdFtRect

void KDChartParams::__internalStoreHdFtRect ( int  pos,
TQRect  rect 
)
inlineslot

Definition at line 2386 of file KDChartParams.h.

◆ activateDefaultAxes

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 2182 of file KDChartParams.cpp.

◆ additionalChartType

void KDChartParams::ChartType KDChartParams::additionalChartType ( ) const
inlineslot

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

setChartType, ChartType
setBarChartSubType, barChartSubType
setLineChartSubType, lineChartSubType

Definition at line 544 of file KDChartParams.h.

◆ allowOverlappingDataValueTexts

bool KDChartParams::allowOverlappingDataValueTexts ( ) const
inlineslot

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 772 of file KDChartParams.h.

◆ areaChartSubType

KDChartParams::AreaChartSubType KDChartParams::areaChartSubType ( ) const
inlineslot

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 1229 of file KDChartParams.h.

◆ areaChartSubTypeToString

TQString KDChartParams::areaChartSubTypeToString ( AreaChartSubType  type)
staticslot

Converts the specified area chart subtype enum to a string representation.

Parameters
typethe subtype enum to convert
Returns
the string representation of the type enum

Definition at line 2848 of file KDChartParams_io.cpp.

◆ areaLocation

KDChartParams::AreaLocation KDChartParams::areaLocation ( ) const
inlineslot

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 1248 of file KDChartParams.h.

◆ areaLocationToString

TQString KDChartParams::areaLocationToString ( AreaLocation  type)
staticslot

Converts the specified area location enum to a string representation.

Parameters
typethe location enum to convert
Returns
the string representation of the type enum

Definition at line 2887 of file KDChartParams_io.cpp.

◆ axisArea

TQRect KDChartParams::axisArea ( const uint  n) const
inlineslot

Returns the true axis area rectangle as it was was calculate by KD Chart.

Parameters
nthe 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 2193 of file KDChartParams.h.

◆ axisDatasets

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
nthe axis for which to return the dataset number(s)
datasetthe starting number of the series of datasets represented by axis n or KDCHART_ALL_DATASETS
dataset2the end number of the series of datasets
chartthe chart represented by axis n
Returns
true if a valid axis number was specified by parameter n
See also
setAxisDataset, chartAxes

Definition at line 7177 of file KDChartParams.cpp.

◆ axisParams

const KDChartAxisParams & KDChartParams::axisParams ( uint  n) const
inlineslot

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 2171 of file KDChartParams.h.

◆ axisTitle

TQString KDChartParams::axisTitle ( uint  n) const
slot

Returns the default axis title text.

Returns
the axis title text.
See also
setAxisTitle

Definition at line 9309 of file KDChartParams.cpp.

◆ axisTitleColor

TQColor 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 9353 of file KDChartParams.cpp.

◆ axisTitleFont

TQFont 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 9446 of file KDChartParams.cpp.

◆ axisTitleFontRelSize

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 9547 of file KDChartParams.cpp.

◆ axisTitleFontUseRelSize

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 9499 of file KDChartParams.cpp.

◆ axisVisible

bool KDChartParams::axisVisible ( uint  n) const
inlineslot

Returns if the axis will be drawn.

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

Definition at line 2077 of file KDChartParams.h.

◆ barChartSubType

KDChartParams::BarChartSubType KDChartParams::barChartSubType ( ) const
inlineslot

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 893 of file KDChartParams.h.

◆ barChartSubTypeToString

TQString KDChartParams::barChartSubTypeToString ( BarChartSubType  type)
staticslot

Converts the specified bar chart subtype enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2714 of file KDChartParams_io.cpp.

◆ barWidth

int KDChartParams::barWidth ( ) const
inlineslot

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 1022 of file KDChartParams.h.

◆ bWChartBrush

TQBrush KDChartParams::bWChartBrush ( ) const
inlineslot

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 1781 of file KDChartParams.h.

◆ bWChartFences

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
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 6405 of file KDChartParams.cpp.

◆ bWChartOutValMarkerSize

int KDChartParams::bWChartOutValMarkerSize ( ) const
inlineslot

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
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1792 of file KDChartParams.h.

◆ bWChartPrintStatistics

bool KDChartParams::bWChartPrintStatistics ( BWStatVal  statValue) const
inlineslot

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.
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1804 of file KDChartParams.h.

◆ bWChartStatisticsBrush

TQBrush KDChartParams::bWChartStatisticsBrush ( BWStatVal  statValue) const
inlineslot

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.
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1833 of file KDChartParams.h.

◆ bWChartStatisticsColor

TQColor KDChartParams::bWChartStatisticsColor ( BWStatVal  statValue) const
inlineslot

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.
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1828 of file KDChartParams.h.

◆ bWChartStatisticsFont

TQFont KDChartParams::bWChartStatisticsFont ( BWStatVal  statValue) const
inlineslot

Returns the font to be used for printing the respective statistical values.

Returns
the font to be used for printing the respective statistical values
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1810 of file KDChartParams.h.

◆ bWChartStatisticsFontRelSize

int KDChartParams::bWChartStatisticsFontRelSize ( BWStatVal  statValue) const
inlineslot

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.
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1822 of file KDChartParams.h.

◆ bWChartStatisticsUseRelSize

bool KDChartParams::bWChartStatisticsUseRelSize ( BWStatVal  statValue) const
inlineslot

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.
See also
setBWChartPrintStatistics
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1816 of file KDChartParams.h.

◆ bWChartStatValToString

TQString KDChartParams::bWChartStatValToString ( BWStatVal  type)
staticslot

Converts the specified BWStatVal enum to a string representation.

Parameters
typethe BWStatVal enum to convert
Returns
the string representation of the type BWStatVal

Definition at line 3064 of file KDChartParams_io.cpp.

◆ bWChartSubType

KDChartParams::BWChartSubType KDChartParams::bWChartSubType ( ) const
inlineslot

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 1760 of file KDChartParams.h.

◆ bWChartSubTypeToString

TQString KDChartParams::bWChartSubTypeToString ( BWChartSubType  type)
staticslot

Converts the specified BoxWhisker chart subtype enum to a string representation.

Parameters
typethe subtype enum to convert
Returns
the string representation of the type enum

Definition at line 3324 of file KDChartParams_io.cpp.

◆ calculateProperties

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.
See also
registerProperties, KDChartData::setPropertySet

Definition at line 618 of file KDChartParams.cpp.

◆ calculateShadowColors

void KDChartParams::calculateShadowColors ( TQColor  color,
TQColor &  shadow1,
TQColor &  shadow2 
) const
slot

Definition at line 1815 of file KDChartParams.cpp.

◆ changed

void KDChartParams::changed ( )
signal

This signal is emitted when any of the chart parameters has changed.

◆ chartAxes

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
chartthe chart for which to return the axis number(s)
cntthe count of axis numbers returned
axeson 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 7206 of file KDChartParams.cpp.

◆ chartSourceMode

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 be DontUse. 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.

Also note: If setChartSourceMode() was not used at all chartSourceMode() will return DataEntry no matter what dataset number is specified.

Parameters
datasetthe dataset number to be looked at. Use KDCHART_ALL_DATASETS to find out if all of the datasets share the very same SourceMode.
dataset2a second dataset number. Use this one together with the \dataset param to look at a range of datasets and find out if all of them share the very same SourceMode.
chartIf 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.
See also
SourceMode, setChartSourceMode, setAdditionalChartType
maxDatasetSourceMode, findDataset

Definition at line 1488 of file KDChartParams.cpp.

◆ chartSourceModeToString

TQString KDChartParams::chartSourceModeToString ( const SourceMode &  mode)
staticslot

Converts the specified chart source mode enum value to a string.

Parameters
modethe chart source mode enum value to convert
Returns
the string

Definition at line 3263 of file KDChartParams_io.cpp.

◆ chartType

KDChartParams::ChartType KDChartParams::chartType ( ) const
inlineslot

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
setPolarChartSubType, polarChartSubType
setChartSourceMode, chartSourceMode

Definition at line 534 of file KDChartParams.h.

◆ chartTypeToString

TQString KDChartParams::chartTypeToString ( ChartType  type)
staticslot

Converts the specified chart type enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2556 of file KDChartParams_io.cpp.

◆ cosThreeDBarAngle

double KDChartParams::cosThreeDBarAngle ( ) const
inlineslot

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
setThreeDBarAngle, threeDBarAngle
setThreeDBarDepth, threeDBarDepth

Definition at line 942 of file KDChartParams.h.

◆ createChartFontNode

void KDChartParams::createChartFontNode ( TQDomDocument &  doc,
TQDomNode &  parent,
const TQString &  elementName,
const TQFont &  font,
bool  useRelFont,
int  relFont,
int  minFont = -1 
)
staticslot

Creates a DOM element node that represents a font used in a chart for use in a DOM document.

Parameters
docthe DOM document to which the node will belong
parentthe parent node to which the new node will be appended
elementNamethe name of the new node
fontthe font to be resented
useRelFontthe specification whether the font size is relative
relFontthe relative font size
minFontthe minimal font size in points, leave this parameter out if not needed

Definition at line 2357 of file KDChartParams_io.cpp.

◆ createChartValueNode

void KDChartParams::createChartValueNode ( TQDomDocument &  doc,
TQDomNode &  parent,
const TQString &  elementName,
const TQVariant &  valY,
const TQVariant &  valX,
const int &  propID 
)
staticslot

Creates a DOM element node that represents a chart value for use in a DOM document.

Parameters
docthe DOM document to which the node will belong
parentthe parent node to which the new node will be appended
elementNamethe name of the new node
datathe chart value to be represented

Definition at line 2328 of file KDChartParams_io.cpp.

◆ createColorMapNode

void KDChartParams::createColorMapNode ( TQDomDocument &  doc,
TQDomNode &  parent,
const TQString &  elementName,
const TQMap< uint, TQColor > &  map 
)
staticslot

Creates a DOM element node that represents a map of TQColor objects for use in a DOM document.

Parameters
docthe DOM document to which the node will belong
parentthe parent node to which the new node will be appended
elementNamethe name of the new node
mapthe map of colors to be represented

Definition at line 2254 of file KDChartParams_io.cpp.

◆ createDoubleMapNode

void KDChartParams::createDoubleMapNode ( TQDomDocument &  doc,
TQDomNode &  parent,
const TQString &  elementName,
const TQMap< int, double > &  map 
)
staticslot

Creates a DOM element node that represents a map of doubles for use in a DOM document.

Parameters
docthe DOM document to which the node will belong
parentthe parent node to which the new node will be appended
elementNamethe name of the new node
mapthe map of doubles to be represented

Definition at line 2284 of file KDChartParams_io.cpp.

◆ customBox

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.
See also
insertCustomBox customBoxRef, removeCustomBox, removeAllCustomBoxes, maxCustomBoxIdx

Definition at line 2753 of file KDChartParams.cpp.

◆ customBoxRef

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.
See also
insertCustomBox customBox, removeCustomBox, removeAllCustomBoxes, maxCustomBoxIdx

Definition at line 2771 of file KDChartParams.cpp.

◆ dataArea

TQRect KDChartParams::dataArea ( ) const
inlineslot

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 2206 of file KDChartParams.h.

◆ dataColor

TQColor 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
datasetthe number of the dataset for which to return the color
Returns
the color for this dataset
See also
setDataColor, maxDataColor

Definition at line 1854 of file KDChartParams.cpp.

◆ datasetGap

int KDChartParams::datasetGap ( ) const
inlineslot

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 \datasetGap value is a per mille value of the chart data area width.
Returns
the number of pixels between two dataset values.
See also
setDatasetGap
datasetGapIsRelative, setDatasetGapIsRelative

Definition at line 967 of file KDChartParams.h.

◆ datasetGapIsRelative

bool KDChartParams::datasetGapIsRelative ( ) const
inlineslot

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 979 of file KDChartParams.h.

◆ dataShadow1Color

TQColor 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
datasetthe number of the dataset for which to return the color
Returns
the color for this dataset
See also
setDataColor, maxDataColor, dataShadow2Color

Definition at line 1909 of file KDChartParams.cpp.

◆ dataShadow2Color

TQColor 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
datasetthe number of the dataset for which to return the color
Returns
the color for this dataset
See also
setDataColor, maxDataColor, dataShadow1Color

Definition at line 1938 of file KDChartParams.cpp.

◆ dataValuesAnchorAlign

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 TQt::AlignmentFlags.

Parameters
chartThe 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.
negativeIf 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 3694 of file KDChartParams.cpp.

◆ dataValuesAnchorDeltaX

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
chartThe 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.
negativeIf 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 3726 of file KDChartParams.cpp.

◆ dataValuesAnchorDeltaY

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
chartThe 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.
negativeIf 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 3758 of file KDChartParams.cpp.

◆ dataValuesAnchorPosition

KDChartEnums::PositionFlag KDChartParams::dataValuesAnchorPosition ( uint  chart,
bool  negative 
) const
slot

Returns the anchor position which the text is to be aligned to.

Parameters
chartThe 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.
negativeIf 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 3665 of file KDChartParams.cpp.

◆ dataValuesAutoColor

bool KDChartParams::dataValuesAutoColor ( uint  chart) const
inlineslot

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
chartThe 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 839 of file KDChartParams.h.

◆ dataValuesBackground

TQBrush KDChartParams::dataValuesBackground ( uint  chart) const
inlineslot

Definition at line 832 of file KDChartParams.h.

◆ dataValuesColor

TQColor KDChartParams::dataValuesColor ( uint  chart) const
inlineslot

Returns the colour of the font to be used for printing the data values.

Parameters
chartThe 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 825 of file KDChartParams.h.

◆ dataValuesDigitsBehindComma

int KDChartParams::dataValuesDigitsBehindComma ( uint  chart) const
inlineslot

Definition at line 797 of file KDChartParams.h.

◆ dataValuesDivPow10

int KDChartParams::dataValuesDivPow10 ( uint  chart) const
inlineslot

Definition at line 790 of file KDChartParams.h.

◆ dataValuesFont

TQFont KDChartParams::dataValuesFont ( uint  chart) const
inlineslot

Returns the font to be used for printing the data values.

Parameters
chartThe 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 804 of file KDChartParams.h.

◆ dataValuesFontRelSize

int KDChartParams::dataValuesFontRelSize ( uint  chart) const
inlineslot

Returns the relative size (in per mille of the chart width) of font size to be used for printing the data values.

Parameters
chartThe 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.
See also
setPrintDataValues, setPrintDataValuesFontRelSize

Definition at line 818 of file KDChartParams.h.

◆ dataValuesLayoutPolicy

KDChartEnums::TextLayoutPolicy KDChartParams::dataValuesLayoutPolicy ( uint  chart) const
inlineslot

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
chartThe 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 853 of file KDChartParams.h.

◆ dataValuesRotation

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
chartThe 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.
negativeIf 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 3786 of file KDChartParams.cpp.

◆ dataValuesShowInfinite

bool KDChartParams::dataValuesShowInfinite ( uint  chart) const
inlineslot

Definition at line 860 of file KDChartParams.h.

◆ dataValuesUseFontRelSize

bool KDChartParams::dataValuesUseFontRelSize ( uint  chart) const
inlineslot

Returns whether the font size to be used for printing the data values is calculated dynamically.

Parameters
chartThe 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.
See also
setPrintDataValues, setPrintDataValuesFontRelSize

Definition at line 811 of file KDChartParams.h.

◆ drawSolidExcessArrows

bool KDChartParams::drawSolidExcessArrows ( ) const
inlineslot

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 1047 of file KDChartParams.h.

◆ explode

bool KDChartParams::explode ( ) const
inlineslot

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 1389 of file KDChartParams.h.

◆ explodeFactor

double KDChartParams::explodeFactor ( ) const
inlineslot

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 1427 of file KDChartParams.h.

◆ explodeFactors

TQMap< int, double > KDChartParams::explodeFactors ( ) const
inlineslot

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 1416 of file KDChartParams.h.

◆ explodeValues

TQValueList< int > KDChartParams::explodeValues ( ) const
inlineslot

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
See also
setExplode(), explode(), setExplodeFactor(), explodeFactor(), setExplodeValues()

Definition at line 1402 of file KDChartParams.h.

◆ findDataset

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
modethe SourceMode to search for.
datasetthe dataset number found (or the first dataset number in case a series of datasets was found, resp.)
dataset2the 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.
chartthe 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
maxDatasetSourceMode, setAdditionalChartType

Definition at line 1564 of file KDChartParams.cpp.

◆ findDatasets

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
modeAone of the SourceModes to search for.
modeBthe other one of the two SourceModes to search for.
datasetthe dataset number found (or the first dataset number in case a series of datasets was found, resp.)
dataset2the 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.
chartthe 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
maxDatasetSourceMode, setAdditionalChartType

Definition at line 1634 of file KDChartParams.cpp.

◆ findFirstAxisCustomBoxID

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
nthe axis number, this could be KDChartAxisParams::AxisPosLeft or KDChartAxisParams::AxisPosBottom...
boxIDwill 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 9161 of file KDChartParams.cpp.

◆ footerFont

TQFont KDChartParams::footerFont ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , 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 2377 of file KDChartParams.h.

◆ footerText

TQString KDChartParams::footerText ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Returns
the displayed text
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setFooterText(), setHeader1Text(), header1Text(), setHeader2Text(), header2Text()

Definition at line 2365 of file KDChartParams.h.

◆ frameSettings

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 2600 of file KDChartParams.cpp.

◆ globalLeadingBottom

int KDChartParams::globalLeadingBottom ( ) const
inlineslot

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
globalLeadingLeft, globalLeadingTop, globalLeadingRight

Definition at line 208 of file KDChartParams.h.

◆ globalLeadingLeft

int KDChartParams::globalLeadingLeft ( ) const
inlineslot

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
globalLeadingTop, globalLeadingRight, globalLeadingBottom

Definition at line 196 of file KDChartParams.h.

◆ globalLeadingRight

KDChartParams::globalLeadingRight ( ) const
inlineslot

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
globalLeadingLeft, globalLeadingTop, globalLeadingBottom

Definition at line 204 of file KDChartParams.h.

◆ globalLeadingTop

KDChartParams::globalLeadingTop ( ) const
inlineslot

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
globalLeadingLeft, globalLeadingRight, globalLeadingBottom

Definition at line 200 of file KDChartParams.h.

◆ header1Font

TQFont KDChartParams::header1Font ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , 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 2327 of file KDChartParams.h.

◆ header1Text

TQString KDChartParams::header1Text ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Returns
the displayed text
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setHeader2Text(), setHeader1Text(), header1Text()
setFooterText(), footerText()

Definition at line 2315 of file KDChartParams.h.

◆ header2Font

TQFont KDChartParams::header2Font ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , 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 2351 of file KDChartParams.h.

◆ header2Text

TQString KDChartParams::header2Text ( ) const
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Returns
the displayed text
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setHeader2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()

Definition at line 2339 of file KDChartParams.h.

◆ headerFooterColor

TQColor 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
posthe section for which to return the text colour
Returns
the text colour
See also
HdFtPos, setHeaderFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7822 of file KDChartParams.cpp.

◆ headerFooterFont

TQFont 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
posthe section for which to return the font
Returns
the used font
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFont()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setFooterFont(), footerFont()
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7885 of file KDChartParams.cpp.

◆ headerFooterFontRelSize

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
posthe section for which to return the font size factor
Returns
the font size factor
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFont()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setFooterFont(), footerFont()
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7944 of file KDChartParams.cpp.

◆ headerFooterFontUseRelSize

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
posthe section for which to return the font calculation flag
Returns
the font calculation flag
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
setHeaderFooterFont()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setFooterFont(), footerFont()
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7914 of file KDChartParams.cpp.

◆ headerFooterRect

const TQRect & 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 7769 of file KDChartParams.cpp.

◆ headerFooterText

TQString 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
posthe section for which to return the text
Returns
the displayed text
See also
HdFtPos, setHeaderFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7754 of file KDChartParams.cpp.

◆ hiLoChartCloseValuesColor

TQColor KDChartParams::hiLoChartCloseValuesColor ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1654 of file KDChartParams.h.

◆ hiLoChartCloseValuesFont

TQFont KDChartParams::hiLoChartCloseValuesFont ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1636 of file KDChartParams.h.

◆ hiLoChartCloseValuesFontRelSize

int KDChartParams::hiLoChartCloseValuesFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1648 of file KDChartParams.h.

◆ hiLoChartCloseValuesUseFontRelSize

bool KDChartParams::hiLoChartCloseValuesUseFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1642 of file KDChartParams.h.

◆ hiLoChartFirstValuesColor

TQColor KDChartParams::hiLoChartFirstValuesColor ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartOpenValuesColor() instead.

Definition at line 1690 of file KDChartParams.h.

◆ hiLoChartFirstValuesFont

TQFont KDChartParams::hiLoChartFirstValuesFont ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartOpenValuesFont() instead.

Definition at line 1674 of file KDChartParams.h.

◆ hiLoChartFirstValuesFontRelSize

int KDChartParams::hiLoChartFirstValuesFontRelSize ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartOpenValuesFontRelSize() instead.

Definition at line 1685 of file KDChartParams.h.

◆ hiLoChartFirstValuesUseFontRelSize

bool KDChartParams::hiLoChartFirstValuesUseFontRelSize ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartOpenValuesUseFontRelSize() instead.

Definition at line 1680 of file KDChartParams.h.

◆ hiLoChartHighValuesColor

TQColor KDChartParams::hiLoChartHighValuesColor ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1586 of file KDChartParams.h.

◆ hiLoChartHighValuesFont

TQFont KDChartParams::hiLoChartHighValuesFont ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1568 of file KDChartParams.h.

◆ hiLoChartHighValuesFontRelSize

int KDChartParams::hiLoChartHighValuesFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1580 of file KDChartParams.h.

◆ hiLoChartHighValuesUseFontRelSize

bool KDChartParams::hiLoChartHighValuesUseFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1574 of file KDChartParams.h.

◆ hiLoChartLastValuesColor

TQColor KDChartParams::hiLoChartLastValuesColor ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartCloseValuesColor() instead.

Definition at line 1723 of file KDChartParams.h.

◆ hiLoChartLastValuesFont

TQFont KDChartParams::hiLoChartLastValuesFont ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartCloseValuesFont() instead.

Definition at line 1708 of file KDChartParams.h.

◆ hiLoChartLastValuesFontRelSize

int KDChartParams::hiLoChartLastValuesFontRelSize ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartCloseValuesFontRelSize() instead.

Definition at line 1718 of file KDChartParams.h.

◆ hiLoChartLastValuesUseFontRelSize

bool KDChartParams::hiLoChartLastValuesUseFontRelSize ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartCloseValuesUseFontRelSize() instead.

Definition at line 1713 of file KDChartParams.h.

◆ hiLoChartLowValuesColor

TQColor KDChartParams::hiLoChartLowValuesColor ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1551 of file KDChartParams.h.

◆ hiLoChartLowValuesFont

TQFont KDChartParams::hiLoChartLowValuesFont ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1533 of file KDChartParams.h.

◆ hiLoChartLowValuesFontRelSize

int KDChartParams::hiLoChartLowValuesFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1545 of file KDChartParams.h.

◆ hiLoChartLowValuesUseFontRelSize

bool KDChartParams::hiLoChartLowValuesUseFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1539 of file KDChartParams.h.

◆ hiLoChartOpenValuesColor

TQColor KDChartParams::hiLoChartOpenValuesColor ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1620 of file KDChartParams.h.

◆ hiLoChartOpenValuesFont

TQFont KDChartParams::hiLoChartOpenValuesFont ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1602 of file KDChartParams.h.

◆ hiLoChartOpenValuesFontRelSize

int KDChartParams::hiLoChartOpenValuesFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1614 of file KDChartParams.h.

◆ hiLoChartOpenValuesUseFontRelSize

bool KDChartParams::hiLoChartOpenValuesUseFontRelSize ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1608 of file KDChartParams.h.

◆ hiLoChartPrintCloseValues

bool KDChartParams::hiLoChartPrintCloseValues ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1630 of file KDChartParams.h.

◆ hiLoChartPrintFirstValues

bool KDChartParams::hiLoChartPrintFirstValues ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartPrintOpenValues() instead.

Definition at line 1668 of file KDChartParams.h.

◆ hiLoChartPrintHighValues

bool KDChartParams::hiLoChartPrintHighValues ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1562 of file KDChartParams.h.

◆ hiLoChartPrintLastValues

bool KDChartParams::hiLoChartPrintLastValues ( ) const
inlineslot
Deprecated:

This method is obsolete; use hiLoChartPrintCloseValues() instead.

Definition at line 1703 of file KDChartParams.h.

◆ hiLoChartPrintLowValues

bool KDChartParams::hiLoChartPrintLowValues ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1527 of file KDChartParams.h.

◆ hiLoChartPrintOpenValues

bool KDChartParams::hiLoChartPrintOpenValues ( ) const
inlineslot

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
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType

Definition at line 1596 of file KDChartParams.h.

◆ hiLoChartSubType

KDChartParams::HiLoChartSubType KDChartParams::hiLoChartSubType ( ) const
inlineslot

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 1515 of file KDChartParams.h.

◆ hiLoChartSubTypeToString

TQString KDChartParams::hiLoChartSubTypeToString ( HiLoChartSubType  type)
staticslot

Converts the specified HiLo chart subtype enum to a string representation.

Parameters
typethe subtype enum to convert
Returns
the string representation of the type enum

Definition at line 3012 of file KDChartParams_io.cpp.

◆ insertCustomBox

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 2686 of file KDChartParams.cpp.

◆ legendArea

TQRect KDChartParams::legendArea ( ) const
inlineslot

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 2207 of file KDChartParams.h.

◆ legendFont

TQFont KDChartParams::legendFont ( ) const
inlineslot

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 1950 of file KDChartParams.h.

◆ legendFontRelSize

int KDChartParams::legendFontRelSize ( ) const
inlineslot

Returns the relative legend font size.

Returns
the relative legend font size.
See also
setLegendFontRelSize, setLegendFontUseRelSize

Definition at line 1973 of file KDChartParams.h.

◆ legendFontUseRelSize

bool KDChartParams::legendFontUseRelSize ( ) const
inlineslot

Returns whether the legend font size is used.

Returns
whether the fix legend font size is used.
See also
setLegendFontRelSize, setLegendFont

Definition at line 1962 of file KDChartParams.h.

◆ legendOrientation

TQt::Orientation KDChartParams::legendOrientation ( ) const
inlineslot

Returns how the legend will be printed.

Returns
how the legend will be printed.
See also
setLegendOrientation, setLegendPosition, setLegendShowLines

Definition at line 1876 of file KDChartParams.h.

◆ legendPosition

KDChartParams::LegendPosition KDChartParams::legendPosition ( ) const
inlineslot

Returns where the legend will be shown.

Returns
where the legend will be shown
See also
LegendPosition, setLegendPosition, setLegendShowLines

Definition at line 1865 of file KDChartParams.h.

◆ legendPositionToString

TQString KDChartParams::legendPositionToString ( LegendPosition  pos)
staticslot

Converts the specified legend position enum to a string representation.

Parameters
typethe legend position enum to convert
Returns
the string representation of the type enum

Definition at line 3130 of file KDChartParams_io.cpp.

◆ legendShowLines

bool KDChartParams::legendShowLines ( ) const
inlineslot

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 1888 of file KDChartParams.h.

◆ legendSource

LegendSource KDChartParams::legendSource ( ) const
inlineslot

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 1907 of file KDChartParams.h.

◆ legendSourceToString

TQString KDChartParams::legendSourceToString ( LegendSource  source)
staticslot

Converts the specified legend source enum to a string representation.

Parameters
sourcethe legend source enum to convert
Returns
the string representation of the type enum

Definition at line 3224 of file KDChartParams_io.cpp.

◆ legendSpacing

uint KDChartParams::legendSpacing ( ) const
inlineslot

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 2048 of file KDChartParams.h.

◆ legendText

TQString KDChartParams::legendText ( uint  dataset) const
inlineslot

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 1921 of file KDChartParams.h.

◆ legendTextColor

TQColor KDChartParams::legendTextColor ( ) const
inlineslot

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 1937 of file KDChartParams.h.

◆ legendTitleFont

TQFont KDChartParams::legendTitleFont ( ) const
inlineslot

Returns the font in which the legend title (if any) is drawn.

Returns
the font in which the legend texts are drawn
See also
setLegendTitleFont, setLegendTitleFontUseRelSize

Definition at line 2013 of file KDChartParams.h.

◆ legendTitleFontRelSize

int KDChartParams::legendTitleFontRelSize ( ) const
inlineslot

Returns the relative legend title font size.

Returns
the relative legend title font size.
See also
setLegendTitleFontRelSize, setLegendTitleFontUseRelSize

Definition at line 2036 of file KDChartParams.h.

◆ legendTitleFontUseRelSize

bool KDChartParams::legendTitleFontUseRelSize ( ) const
inlineslot

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 2025 of file KDChartParams.h.

◆ legendTitleText

TQString KDChartParams::legendTitleText ( ) const
inlineslot

Returns the text that is shown as the title of the legend.

Returns
the text that is used as the legend title
See also
setLegendTitleText(), legendTitleFont(), legendTitleFontUseRelSize()

Definition at line 1986 of file KDChartParams.h.

◆ legendTitleTextColor

TQColor KDChartParams::legendTitleTextColor ( ) const
inlineslot

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 1999 of file KDChartParams.h.

◆ lineChartSubType

KDChartParams::LineChartSubType KDChartParams::lineChartSubType ( ) const
inlineslot

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 1065 of file KDChartParams.h.

◆ lineChartSubTypeToString

TQString KDChartParams::lineChartSubTypeToString ( LineChartSubType  type)
staticslot

Converts the specified line chart subtype enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2777 of file KDChartParams_io.cpp.

◆ lineColor

TQColor KDChartParams::lineColor ( ) const
inlineslot

Returns the color of the lines in line charts.

Returns
the color of the lines in line charts
See also
setLineColor

Definition at line 1149 of file KDChartParams.h.

◆ lineMarker

bool KDChartParams::lineMarker ( ) const
inlineslot

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 1081 of file KDChartParams.h.

◆ lineMarkerSize

TQSize KDChartParams::lineMarkerSize ( ) const
inlineslot

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 1126 of file KDChartParams.h.

◆ lineMarkerStyle

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
datasetthe dataset for which to return the line marker
Returns
the line marker for the specified data set
See also
LineMarkerStyle, setLineMarkerStyle

Definition at line 4680 of file KDChartParams.cpp.

◆ lineMarkerStyles

KDChartParams::LineMarkerStyleMap KDChartParams::lineMarkerStyles ( ) const
inlineslot

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 1109 of file KDChartParams.h.

◆ lineMarkerStyleToString

TQString KDChartParams::lineMarkerStyleToString ( LineMarkerStyle  style)
staticslot

Converts the specified line marker style enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2799 of file KDChartParams_io.cpp.

◆ lineMarkerStyleToStringTr

TQString KDChartParams::lineMarkerStyleToStringTr ( LineMarkerStyle  style)
staticslot

Converts the specified line marker style enum to a localized string representation that can be used for string output.

Parameters
typethe type enum to convert
Returns
the localized string representation of the type enum

Definition at line 2812 of file KDChartParams_io.cpp.

◆ lineStyle

TQt::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
datasetthe dataset for which to return the line style
Returns
the line style for the specified data set
See also
setLineStyle, setLineMarkerStyle

Definition at line 4883 of file KDChartParams.cpp.

◆ lineWidth

int KDChartParams::lineWidth ( ) const
inlineslot

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 1137 of file KDChartParams.h.

◆ loadAxesFormXML

void KDChartParams::loadAxesFormXML ( int &  curAxisSettings,
TQDomElement &  element 
)
slot

Helper method called by loadXML() only.

Definition at line 1060 of file KDChartParams_io.cpp.

◆ loadXML

bool KDChartParams::loadXML ( const TQDomDocument &  doc)
slot

Reads the parameters from an XML document.

Parameters
docthe 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.

◆ markerStyleToString

TQString KDChartParams::markerStyleToString ( int  style)
staticslot

Definition at line 2615 of file KDChartParams_io.cpp.

◆ markerStyleToStringTr

TQString KDChartParams::markerStyleToStringTr ( int  style)
staticslot

Definition at line 2639 of file KDChartParams_io.cpp.

◆ maxCustomBoxIdx

uint KDChartParams::maxCustomBoxIdx ( ) const
slot

Retrieve the biggest custom boxes ID used.

See also
insertCustomBox, removeCustomBox, removeAllCustomBoxes, customBox

Definition at line 2781 of file KDChartParams.cpp.

◆ maxDataColor

uint KDChartParams::maxDataColor ( ) const
inlineslot

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 684 of file KDChartParams.h.

◆ maxDatasetLineMarkerStyle

uint KDChartParams::maxDatasetLineMarkerStyle ( ) const
inlineslot

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 1114 of file KDChartParams.h.

◆ maxDatasetPolarMarkerStyle

uint KDChartParams::maxDatasetPolarMarkerStyle ( ) const
inlineslot

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 1317 of file KDChartParams.h.

◆ maxDatasetSourceMode

uint KDChartParams::maxDatasetSourceMode ( ) const
inlineslot

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 589 of file KDChartParams.h.

◆ moveDataRegionFrame

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
oldDataRowThe table row of the frame to be removed.
oldDataColThe table column of the frame to be removed.
oldData3rdThe third table coordinate of the old cell (parameter not used, its value will be ignored, set to 0, reserved for future use).
newDataRowThe 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.
newDataColThe table column of the cell to be framed instead.
newData3rdThe 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 2560 of file KDChartParams.cpp.

◆ neverUsedSetChartSourceMode

bool KDChartParams::neverUsedSetChartSourceMode ( ) const
inlineslot

Retrieves whether setChartSourceMode() was called or not.

Definition at line 569 of file KDChartParams.h.

◆ nextFrameSettings

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 2651 of file KDChartParams.cpp.

◆ numBarsDisplayed

int KDChartParams::numBarsDisplayed ( ) const
inlineslot

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
numBarsLeft
setBarWidth, setValueBlockGap

Definition at line 1032 of file KDChartParams.h.

◆ numBarsLeft

int KDChartParams::numBarsLeft ( ) const
inlineslot

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
numBarsDisplayed
setBarWidth, setValueBlockGap

Definition at line 1037 of file KDChartParams.h.

◆ numValues

int KDChartParams::numValues ( ) const
inlineslot

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 606 of file KDChartParams.h.

◆ optimizeOutputForScreen

bool KDChartParams::optimizeOutputForScreen ( ) const
inlineslot

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 169 of file KDChartParams.h.

◆ outlineDataColor

TQColor KDChartParams::outlineDataColor ( ) const
inlineslot

Returns the color for the outlines of data displays.

Returns
the outline color
See also
setOutlineDataColor

Definition at line 654 of file KDChartParams.h.

◆ outlineDataLineStyle

PenStyle KDChartParams::outlineDataLineStyle ( ) const
inlineslot

Returns the style of the outlines of data displays.

Parameters
stylethe line style that is used for outlines
See also
setOutlineDataLineStyle

Definition at line 678 of file KDChartParams.h.

◆ outlineDataLineWidth

uint KDChartParams::outlineDataLineWidth ( ) const
inlineslot

Returns the width of the outlines of data displays.

Parameters
stylethe line width that is used for outlines
See also
setOutlineDataLineWidth

Definition at line 666 of file KDChartParams.h.

◆ pieStart

int KDChartParams::pieStart ( ) const
inlineslot

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 1468 of file KDChartParams.h.

◆ polarChartSubType

KDChartParams::PolarChartSubType KDChartParams::polarChartSubType ( ) const
inlineslot

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 1270 of file KDChartParams.h.

◆ polarChartSubTypeToString

TQString KDChartParams::polarChartSubTypeToString ( PolarChartSubType  type)
staticslot

Converts the specified polar chart subtype enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2940 of file KDChartParams_io.cpp.

◆ polarDelimAtPos

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 5363 of file KDChartParams.cpp.

◆ polarLabelsAtPos

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 5377 of file KDChartParams.cpp.

◆ polarLineWidth

int KDChartParams::polarLineWidth ( ) const
inlineslot

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 1339 of file KDChartParams.h.

◆ polarMarker

bool KDChartParams::polarMarker ( ) const
inlineslot

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 1285 of file KDChartParams.h.

◆ polarMarkerSize

TQSize KDChartParams::polarMarkerSize ( ) const
inlineslot

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 1328 of file KDChartParams.h.

◆ polarMarkerStyle

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
datasetthe dataset for which to return the polar marker
Returns
the polar marker for the specified data set
See also
PolarMarkerStyle, setPolarMarkerStyle

Definition at line 5192 of file KDChartParams.cpp.

◆ polarMarkerStyles

KDChartParams::PolarMarkerStyleMap KDChartParams::polarMarkerStyles ( ) const
inlineslot

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 1313 of file KDChartParams.h.

◆ polarMarkerStyleToString

TQString KDChartParams::polarMarkerStyleToString ( PolarMarkerStyle  style)
staticslot

Converts the specified polar marker style enum to a string representation.

Parameters
typethe type enum to convert
Returns
the string representation of the type enum

Definition at line 2962 of file KDChartParams_io.cpp.

◆ polarMarkerStyleToStringTr

TQString KDChartParams::polarMarkerStyleToStringTr ( PolarMarkerStyle  style)
staticslot

Converts the specified polar marker style enum to a localized string representation that can be used for string output.

Parameters
typethe type enum to convert
Returns
the localized string representation of the type enum

Definition at line 2975 of file KDChartParams_io.cpp.

◆ polarRotateCircularLabels

bool KDChartParams::polarRotateCircularLabels ( ) const
inlineslot

Returns whether circular labels will be rotated in polar charts.

See also
setPolarRotateCircularLabels, polarDelimAtPos, polarLabelsAtPos

Definition at line 1361 of file KDChartParams.h.

◆ polarZeroDegreePos

int KDChartParams::polarZeroDegreePos ( ) const
inlineslot

Returns the zero degree position in polar charts.

See also
setPolarZeroDegreePos

Definition at line 1350 of file KDChartParams.h.

◆ printDataValues

bool KDChartParams::printDataValues ( uint  chart) const
inlineslot

Returns whether the data values will be printed near their respective entries.

Parameters
chartThe 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 783 of file KDChartParams.h.

◆ printDataValuesWithDefaultFontParams

bool KDChartParams::printDataValuesWithDefaultFontParams ( uint  chart) const
inlineslot

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.
See also
setPrintDataValuesWithDefaultFontParams, printDataValues

Definition at line 777 of file KDChartParams.h.

◆ properties [1/2]

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.
See also
registerProperties, removeProperties, KDChartData::setPropertySet

Definition at line 595 of file KDChartParams.cpp.

◆ properties [2/2]

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.
See also
registerProperties, KDChartData::setPropertySet

Definition at line 563 of file KDChartParams.cpp.

◆ readChartFontNode

bool KDChartParams::readChartFontNode ( const TQDomElement &  element,
TQFont &  font,
bool &  useRelFont,
int &  relFontSize,
int *  minFontSize = 0 
)
staticslot

Reads data from a DOM element node that represents a font uses in a chart and fills the reference parameters with the data.

Parameters
elementthe DOM element to read from
fontthe represented font
useRelFontwhether the font size is relative
relFontSizethe relative font size

Definition at line 2458 of file KDChartParams_io.cpp.

◆ readChartValueNode

bool KDChartParams::readChartValueNode ( const TQDomElement &  element,
TQVariant &  valY,
TQVariant &  valX,
int &  propID 
)
staticslot

Reads data from a DOM element node that represents a chart value and fills a KDChartData object with the data.

Parameters
elementthe DOM element to read from
valuethe chart data object to read the data into

Definition at line 2526 of file KDChartParams_io.cpp.

◆ readColorMapNode

bool KDChartParams::readColorMapNode ( const TQDomElement &  element,
TQMap< uint, TQColor > *  value 
)
staticslot

Creates a DOM element node that represents a color map for use in a DOM document.

Parameters
docthe DOM document to which the node will belong
parentthe parent node to which the new node will be appended
elementNamethe name of the new node
mapthe color map to be represented

Definition at line 2386 of file KDChartParams_io.cpp.

◆ readDoubleMapNode

bool KDChartParams::readDoubleMapNode ( const TQDomElement &  element,
TQMap< int, double > *  value 
)
staticslot

Reads data from a DOM element node that represents a double map and fills a double map with the data.

Parameters
elementthe DOM element to read from
mapthe frame settings object to read the data into

Definition at line 2420 of file KDChartParams_io.cpp.

◆ registerProperties

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
KDCHART_PROPSET_HORI_LINE, KDCHART_PROPSET_VERT_LINE
KDChartData::setPropertySet
removeProperties

Definition at line 485 of file KDChartParams.cpp.

◆ relativeRingThickness

bool KDChartParams::relativeRingThickness ( ) const
inlineslot

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 1497 of file KDChartParams.h.

◆ removeAllCustomBoxes

void KDChartParams::removeAllCustomBoxes ( )
inlineslot

Remove all custom boxes from the list of boxes.

See also
removeCustomBox, insertCustomBox, customBox, maxCustomBoxIdx

Definition at line 517 of file KDChartParams.h.

◆ removeCustomBox

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 2722 of file KDChartParams.cpp.

◆ removeFrame

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 2638 of file KDChartParams.cpp.

◆ removeProperties

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 532 of file KDChartParams.cpp.

◆ ringStart

int KDChartParams::ringStart ( ) const
inlineslot

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 1485 of file KDChartParams.h.

◆ roundVal

int KDChartParams::roundVal ( double  d)
inlinestaticslot

Returns the parameter d rounded to the nearest integer.

Definition at line 703 of file KDChartParams.h.

◆ saveAxesToXML

void KDChartParams::saveAxesToXML ( TQDomDocument &  doc,
TQDomElement &  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.

◆ saveXML

TQDomDocument 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.

◆ setAdditionalChartType

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 );

or 

  setChartType( KDChartParams::Line );
  setAdditionalChartType( KDChartParams::HiLo );

or 

  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 calling setAdditionalChartType(), also it is recommended to call setAxisDatasets() 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
chartTypethe additional chart type to use
See also
additionalChartType, setChartSourceMode, setAxisDatasets

chartType, ChartType
setBarChartSubType, barChartSubType
setLineChartSubType, lineChartSubType

Definition at line 2984 of file KDChartParams.cpp.

◆ setAllowOverlappingDataValueTexts

void KDChartParams::setAllowOverlappingDataValueTexts ( bool  allow)
inlineslot

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 766 of file KDChartParams.h.

◆ setAreaChartSubType

void KDChartParams::setAreaChartSubType ( AreaChartSubType  areaChartSubType)
inlineslot

Specifies the area chart subtype.

Only used if chartType() == Area. The default is AreaNormal.

Parameters
areaChartSubTypethe area chart subtype
See also
areaChartSubType, AreaChartSubType, setChartType, chartType

Definition at line 1218 of file KDChartParams.h.

◆ setAreaLocation

void KDChartParams::setAreaLocation ( AreaLocation  location)
inlineslot

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
locationwhether to fill above or below the value points
See also
AreaLocation, areaLocation()

Definition at line 1242 of file KDChartParams.h.

◆ setAxisArea

void KDChartParams::setAxisArea ( const uint  n,
const TQRect &  areaRect 
)
inlineslot

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 upon axisAreaMin and axisAreaMax. Thus the signal changed() is not sended here.
See also
axisAreaMax, axisAreaMin, setAxisAreaMode, setAxisAreaMin
setAxisArea

Definition at line 2101 of file KDChartParams.h.

◆ setAxisDatasets

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 (see setChartSourceMode for explanation) that have been specified for this chart.
Parameters
nthe number of the axis for which to specify the dataset(s)
datasetthe dataset represented by axis n
See also
axisDatasets, chartAxes, setChartSourceMode, setAdditionalChartType

Definition at line 7141 of file KDChartParams.cpp.

◆ setAxisLabelsFont

void KDChartParams::setAxisLabelsFont ( uint  n,
TQFont  axisLabelsFont,
int  axisLabelsFontSize = 0,
TQColor  axisLabelsColor = TQt::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
axisLabelsFontthe font to be used for the axis' labels.
axisLabelsFontSizethe (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.
axisLabelsColorthe axis labels colour.
See also
setAxisLabelsVisible
setAxisLabelsFontUseRelSize, setAxisLabelsFontRelSize
KDChartAxisParams::setAxisLabelsFontMinSize

Definition at line 7349 of file KDChartParams.cpp.

◆ setAxisLabelsTouchEdges

void KDChartParams::setAxisLabelsTouchEdges ( uint  n,
bool  axisLabelsTouchEdges 
)
inlineslot

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
axisLabelsTouchEdgesif 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 2109 of file KDChartParams.h.

◆ setAxisLabelStringParams

void KDChartParams::setAxisLabelStringParams ( uint  n,
TQStringList *  axisLabelStringList,
TQStringList *  axisShortLabelStringList,
const TQString &  valueStart = TQString(),
const TQString &  valueEnd = TQString() 
)
slot

Specifies a TQStringList 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:
TQStringList abscissaNames;
abscissaNames << "Sunday" << "Monday" << "Tuesday" << "Wednesday"
<< "Thursday" << "Friday" << "Saturday";
TQStringList abscissaShortNames;
abscissaShortNames << "Sun" << "Mon" << "Tue" << "Wed"
<< "Thu" << "Fri" << "Sat";

setAxisLabelStringParams( KDChartAxisParams::AxisPosBottom,
&names, &shortNames,
"Monday", "Friday")
Parameters
nthe ID of the axis
TQStringList*axisLabelStringList points to the list of labels to be displayed
TQStringList*axisShortLabelStringList points to an alternative list of short names to be displayed if the long labels take too much place
TQStringvalueStart ( default null ) the label to begin with
TQStringvalueEnd ( default null ) the label to end with
See also
KDChartAxisParams::setAxisLabelStringLists

Definition at line 7422 of file KDChartParams.cpp.

◆ setAxisLabelsVisible

void KDChartParams::setAxisLabelsVisible ( uint  n,
bool  axisLabelsVisible 
)
inlineslot

Specifies whether the axis labels of an axis are to be shown.

Parameters
axisLabelsVisibleif true the labels of this axis will be drawn.
See also
setAxisLabelsFont

Definition at line 2116 of file KDChartParams.h.

◆ setAxisLabelTextParams

void KDChartParams::setAxisLabelTextParams ( uint  n,
bool  axisSteadyValueCalc = true,
TQVariant  axisValueStart = KDCHART_AXIS_LABELS_AUTO_LIMIT,
TQVariant  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,
TQStringList *  axisLabelStringList = 0,
TQStringList *  axisShortLabelsStringList = 0,
int  axisValueLeaveOut = KDCHART_AXIS_LABELS_AUTO_LEAVEOUT,
KDChartAxisParams::ValueScale  axisValueDeltaScale = KDChartAxisParams::ValueScaleNumerical 
)
inlineslot

Specifies the label text parameters for one axis.

See also
KDChartAxisParams::setAxisLabelTextParams

Definition at line 2129 of file KDChartParams.h.

◆ setAxisParams

void KDChartParams::setAxisParams ( uint  n,
const KDChartAxisParams &  axisParams 
)
slot

Specifies the parameters for one axis.

Parameters
axisParamsthe axis parameters to be used.
See also
axisParams, AxisParams

Definition at line 7444 of file KDChartParams.cpp.

◆ setAxisShowGrid

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
nthe number of the axis for which to specify whether a grid should be drawn.
axisShowGridif true a grid will be drawn on the chart data area.
See also
axisShowGrid, setAxisGridStyle, setAxisGridSubStyle

Definition at line 7090 of file KDChartParams.cpp.

◆ setAxisTitle

void KDChartParams::setAxisTitle ( uint  n,
const TQString &  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
axisTitlethe axis title text
See also
setAxisTitleColor,setAxisTitleFont,setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize

Definition at line 9270 of file KDChartParams.cpp.

◆ setAxisTitleColor

void KDChartParams::setAxisTitleColor ( uint  n,
TQColor  axisTitleColor 
)
slot

Specifies the color of the default axis title text.

Parameters
axisTitleColorthe color of the axis title text
See also
setAxisTitle, setAxisTitleFont,setAxisTitleFontUseRelSize, setAxisTitleFontRelSize
axisTitle, axisTitleColor, axisTitleFont, axisTitleFontUseRelSize, axisTitleFontRelSize

Definition at line 9327 of file KDChartParams.cpp.

◆ setAxisTitleFont [1/2]

void KDChartParams::setAxisTitleFont ( uint  n,
TQFont  axisTitleFont 
)
slot

Specifies the font and the size of the default axis title text.

Parameters
axisTitleFontthe font of the axis title text
useFontSizeflag indicating whether the font's size is to be used
axisTitleFontRelSizethe 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 9373 of file KDChartParams.cpp.

◆ setAxisTitleFont [2/2]

void KDChartParams::setAxisTitleFont ( uint  n,
TQFont  axisTitleFont,
bool  useFixedFontSize 
)
slot

Specifies the font and the size of the default axis title text.

Parameters
axisTitleFontthe font of the axis title text - by default the font will be relative
useFixedFontSizeflag indicating whether the font's size is to be used as fixed or calculated as per mil value.
axisTitleFontRelSizethe 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 9406 of file KDChartParams.cpp.

◆ setAxisTitleFontRelSize

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
axisTitleFontRelSizethe 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 9519 of file KDChartParams.cpp.

◆ setAxisTitleFontUseRelSize

void KDChartParams::setAxisTitleFontUseRelSize ( uint  n,
bool  axisTitleFontUseRelSize 
)
slot

Specifies whether the fixed size of the the default axis title text's font.

Parameters
axisTitleFontUseRelSizeflag 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 9464 of file KDChartParams.cpp.

◆ setAxisType

void KDChartParams::setAxisType ( uint  n,
const KDChartAxisParams::AxisType  axisType 
)
inlineslot

Specifies the axis type.

Parameters
nthe number of the axis settings to be modified
axisTypethe type of the axis.
See also
axisVisible

Definition at line 2060 of file KDChartParams.h.

◆ setAxisVisible

void KDChartParams::setAxisVisible ( uint  n,
const bool  axisVisible 
)
inlineslot

Specifies if the axis will be drawn.

The default is false.

Parameters
nthe number of the axis settings to be modified
axisVisibleset true to make visible the respective axis.
See also
axisVisible

Definition at line 2068 of file KDChartParams.h.

◆ setBarChartSubType

void KDChartParams::setBarChartSubType ( BarChartSubType  barChartSubType)
inlineslot

Specifies the bar chart subtype.

This setting only has an effect in bar charts.

Parameters
barChartSubTypethe bar chart subtype
See also
barChartSubType, BarChartSubType, setChartType, chartType

Definition at line 887 of file KDChartParams.h.

◆ setBarsDisplayed()

void KDChartParams::setBarsDisplayed ( int  barsDisplayed)
inlineprotected

Definition at line 2461 of file KDChartParams.h.

◆ setBarsLeft()

void KDChartParams::setBarsLeft ( int  barsLeft)
inlineprotected

Definition at line 2465 of file KDChartParams.h.

◆ setBarWidth

void KDChartParams::setBarWidth ( int  width = KDCHART_AUTO_SIZE)
inlineslot

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
widththe width of one bar.
See also
KDChartWidget::barsDisplayed, KDChart::barsDisplayed
numBarsDisplayed, numBarsLeft
setValueBlockGap

Definition at line 1009 of file KDChartParams.h.

◆ setBWChartBrush

void KDChartParams::setBWChartBrush ( const TQBrush &  bWChartBrush)
inlineslot

Specifies the brush to be used to fill the BoxWhisker charts.

Parameters
bWChartBrushthe brush to be used
See also
bWChartBrush, setChartType, chartType

Definition at line 1775 of file KDChartParams.h.

◆ setBWChartFences

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
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 6388 of file KDChartParams.cpp.

◆ setBWChartOutValMarkerSize

void KDChartParams::setBWChartOutValMarkerSize ( int  size)
inlineslot

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
setBWChartSubType, bWChartSubType
setChartType, chartType

Definition at line 1786 of file KDChartParams.h.

◆ setBWChartPrintStatistics

void KDChartParams::setBWChartPrintStatistics ( BWStatVal  statValue,
bool  active,
TQFont *  font = 0,
int  size = 24,
TQColor *  color = 0,
TQBrush *  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
statValuespecifies the statistical value to be set, use BWStatValALL to define equal settings for all of the statistical values.
activespecifies whether the values are to be printed or not.
fonta 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!
colorthe color to be used when printing the values.
brushthe brush to be used to fill the text's area before printing
See also
setChartType
setBWChartSubType
bWChartPrintStatistics
bWChartStatisticsColor,
bWChartStatisticsBrush,
bWChartStatisticsFontUseRelSize
bWChartStatisticsFontRelSize

Definition at line 6505 of file KDChartParams.cpp.

◆ setBWChartSubType

void KDChartParams::setBWChartSubType ( BWChartSubType  bWChartSubType)
inlineslot

Specifies the BoxWhisker chart subtype.

Only used if chartType() == BoxWhisker

Parameters
bWChartSubTypethe BoxWhisker chart subtype
See also
bWChartSubType, BWChartSubType, setChartType, chartType

Definition at line 1754 of file KDChartParams.h.

◆ setChartSourceMode

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.

Also note:
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 );

This would specify a simple chart obtaining its values from dataset 2.

  setChartSourceMode( DataEntry, 0, 0, 0 );
  setChartSourceMode( DataEntry, 3, 3, 1 );

This would specify a two chart widget - the 1st obtaining its values from dataset 0 and the 2nd taking the values from dataset 3.

  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 );

This would specify a two chart widget - the 1st obtaining its values from datasets 3..6 and the 2nd taking the values from datasets 10..13. Their respective legends and axes would take their values from datasets 1 and 2 (or 8 and 9, resp.). Additionally the 1st chart would use dataset 7 to determine the horizontal (or vertical, resp.) position of any extra lines that might be specified by KDChartPropertySet IDs assigned to the cells in dataset 7.

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.

When specifying 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
modethe way how to use information stored in this dataset.
datasetthe dataset number to be used (or ignored, resp.). Use KDCHART_ALL_DATASETS to indicate that information given applies to all of the datasets.
dataset2a second dataset number to be taken into account (or ignored, resp.). Use this one together with the \dataset param to specify a range of datasets.
chartthe 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.
See also
SourceMode, chartSourceMode, findDataset
maxDatasetSourceMode, setAdditionalChartType

Definition at line 1434 of file KDChartParams.cpp.

◆ setChartType

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 TQFont 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().
Parameters
chartTypethe chart type to use
See also
chartType, ChartType
setAdditionalChartType, additionalChartType,
setBarChartSubType, barChartSubType
setLineChartSubType, lineChartSubType
setPolarChartSubType, polarChartSubType
setChartSourceMode, chartSourceMode
setAxisLabelsTouchEdges

Definition at line 2841 of file KDChartParams.cpp.

◆ setDataArea

void KDChartParams::setDataArea ( const TQRect &  areaRect)
inlineslot

Definition at line 2443 of file KDChartParams.h.

◆ setDataColor

void KDChartParams::setDataColor ( uint  dataset,
TQColor  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 TQColor 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
datasetthe number of the dataset (or value for pies and similar charts) for which the color is specified
colorthe color to use for this dataset/value
See also
setDataDefaultColors, setDataRainbowColors, setDataSubduedColors
dataColor, maxDataColor

Definition at line 1688 of file KDChartParams.cpp.

◆ setDataDefaultColors

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.

See also
setDataColor, setDataRainbowColors, setDataSubduedColors
dataColor, maxDataColor

Definition at line 1710 of file KDChartParams.cpp.

◆ setDataRainbowColors

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.

See also
setDataColor, setDataDefaultColors, setDataSubduedColors
dataColor, maxDataColor

Definition at line 1736 of file KDChartParams.cpp.

◆ setDataRegionFrame

void KDChartParams::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,
TQPen  pen = TQPen(),
int  shadowWidth = 0,
KDFrame::CornerName  sunPos = KDFrame::CornerTopLeft 
)
inlineslot

Select a pre-defined frame setting to be used for one of the data representations (e.g.

to have the frame surrounding one of the bars in a Bar chart).

Note
KDChart currently supports specifying data frames without background only, it is not possible to draw a special background behind a data representation.
Parameters
dataRowThe table row of the cell to be surrounded by a frame.
dataColThe table column of the cell.
data3rdThe third table coordinate of the cell (parameter not used, its value will be ignored, set to 0, reserved for future use).
innerGapThe distance between the frame and the inner area.
addFrameWidthToLayoutFor internal use - must be true.
addFrameHeightToLayoutFor internal use - must be true.
simpleFrameFor internal use - must be KDFrame::FrameFlat.
lineWidthFor internal use - must be 1.
midLineWidthFor internal use - must be 0.
penThe pen to be used for drawing the four frame border lines.
shadowWidthFor internal use - do not set this parameter or set it to 0.
sunPosFor internal use - do not set this parameter or set it to KDFrame::CornerTopLeft.

Definition at line 450 of file KDChartParams.h.

◆ setDatasetGap

void KDChartParams::setDatasetGap ( int  gap)
inlineslot

Specifies the number of pixels between two dataset values.

In addition you might want to use setOutlineDataLineStyle( TQt::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 the gap value is a per mille value of the chart data area width.

The default is 6 per mille of the data area of the chart.

Parameters
gapthe number of pixels between two dataset values.
See also
setValueBlockGap
datasetGap
datasetGapIsRelative, setDatasetGapIsRelative
setOutlineDataLineStyle

Definition at line 961 of file KDChartParams.h.

◆ setDatasetGapIsRelative

void KDChartParams::setDatasetGapIsRelative ( bool  gapIsRelative)
inlineslot

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
gapIsRelativespecifies 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 973 of file KDChartParams.h.

◆ setDataSubduedColors

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
orderedif 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.
See also
setDataColor, setDataDefaultColors, setDataRainbowColors
dataColor, maxDataColor

Definition at line 1766 of file KDChartParams.cpp.

◆ setDataValuesCalc

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
dataValuesColor
setPrintDataValuesFontRelSize setPrintDataValuesBackground

Definition at line 3257 of file KDChartParams.cpp.

◆ setDataValuesColors

void KDChartParams::setDataValuesColors ( const TQColor *  color = KDCHART_DATA_VALUE_AUTO_COLOR,
const TQBrush &  background = TQBrush(TQt::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 TQColor*.

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 TQt::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
setPrintDataValues
dataValuesColor
setPrintDataValuesFontRelSize

Definition at line 3373 of file KDChartParams.cpp.

◆ setDataValuesFont

void KDChartParams::setDataValuesFont ( TQFont *  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
dataValuesColor
setPrintDataValuesFontRelSize setPrintDataValuesBackground

Definition at line 3284 of file KDChartParams.cpp.

◆ setDataValuesPlacing

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
dataValuesColor
setPrintDataValuesFontRelSize setPrintDataValuesBackground

Definition at line 3316 of file KDChartParams.cpp.

◆ setDataValuesPolicy

void KDChartParams::setDataValuesPolicy ( KDChartEnums::TextLayoutPolicy  policy = KDChartEnums::LayoutPolicyRotate,
uint  chart = KDCHART_ALL_CHARTS 
)
slot

Definition at line 3395 of file KDChartParams.cpp.

◆ setDataValuesShowInfinite

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
setPrintDataValues
dataValuesColor
setPrintDataValuesFontRelSize

Definition at line 3424 of file KDChartParams.cpp.

◆ setDefaultAxesTypes

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 1965 of file KDChartParams.cpp.

◆ setDrawSolidExcessArrows

void KDChartParams::setDrawSolidExcessArrows ( bool  solidArrows)
inlineslot

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
solidArrowswhether excess arrows shown be drawn solidly or split
See also
drawSolidExcessArrows

Definition at line 1042 of file KDChartParams.h.

◆ setExplode

void KDChartParams::setExplode ( bool  explode)
inlineslot

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
explodetrue if the pie or ring should be exploding, false otherwise
See also
exploding(), setExplodeFactor(), explodeFactor(), setExplodeFactors(), explodeFactors(), setExplodeValues(), explodeValues()

Definition at line 1383 of file KDChartParams.h.

◆ setExplodeFactor

void KDChartParams::setExplodeFactor ( double  factor)
inlineslot

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
factorthe explode factor
See also
setExplode(), explode(), explodeFactor(), setExplodeValues(), explodeValues(), setExplodeFactors(), explodeFactors()

Definition at line 1421 of file KDChartParams.h.

◆ setExplodeFactors

void KDChartParams::setExplodeFactors ( ExplodeFactorsMap  factors)
inlineslot

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
factorsthe list of explode factors
See also
setExplode(), explode(), setExplodeValues(), explodeValues(), setExplodeFactor(), explodeFactor(), explodeFactors()

Definition at line 1410 of file KDChartParams.h.

◆ setExplodeValues

void KDChartParams::setExplodeValues ( TQValueList< int >  explodeList)
inlineslot

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
explodeListthe 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 1395 of file KDChartParams.h.

◆ setFooterFont

void KDChartParams::setFooterFont ( const TQFont &  font)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
fontthe font to use
See also
HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
footerFont(), setFooterText(), footerText(), setHeader1Font(), header1Font(), setHeader2Font(), header2Font()

Definition at line 2370 of file KDChartParams.h.

◆ setFooterText

void KDChartParams::setFooterText ( const TQString &  text)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
textthe text to display
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
footerText(), setHeader1Text(), header1Text(), setHeader2Text(), header2Text()

Definition at line 2358 of file KDChartParams.h.

◆ setFrame

void KDChartParams::setFrame ( uint  area,
const KDFrame &  frame,
int  outerGapX,
int  outerGapY,
int  innerGapX,
int  innerGapY,
bool  addFrameWidthToLayout = true,
bool  addFrameHeightToLayout = true 
)
inlineslot

Deprecated:
Feature scheduled for future release, at present not implemented.

Definition at line 382 of file KDChartParams.h.

◆ setGlobalLeading

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 2290 of file KDChartParams.cpp.

◆ setGlobalLeadingBottom

void KDChartParams::setGlobalLeadingBottom ( int  leading)
inlineslot

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 191 of file KDChartParams.h.

◆ setGlobalLeadingLeft

void KDChartParams::setGlobalLeadingLeft ( int  leading)
inlineslot

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 176 of file KDChartParams.h.

◆ setGlobalLeadingRight

void KDChartParams::setGlobalLeadingRight ( int  leading)
inlineslot

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 186 of file KDChartParams.h.

◆ setGlobalLeadingTop

void KDChartParams::setGlobalLeadingTop ( int  leading)
inlineslot

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 181 of file KDChartParams.h.

◆ setHeader1Font

void KDChartParams::setHeader1Font ( const TQFont &  font)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
fontthe font to use
See also
HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
header2Font(), setHeader2Text(), header2Text()
setHeader1Font(), header1Font()
setFooterFont(), footerFont()

Definition at line 2320 of file KDChartParams.h.

◆ setHeader1Text

void KDChartParams::setHeader1Text ( const TQString &  text)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
textthe text to display
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
header2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()

Definition at line 2308 of file KDChartParams.h.

◆ setHeader2Font

void KDChartParams::setHeader2Font ( const TQFont &  font)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
fontthe font to use
See also
HdFtPos, setHeaderFooterFont(), headerFooterFont()
setHeaderFooterFontUseRelSize(), headerFooterFontUseRelSize()
setHeaderFooterFontRelSize(), headerFooterFontRelSize()
header2Font(), setHeader2Text(), header2Text(), setHeader1Font(), header1Font(), setFooterFont(), footerFont()

Definition at line 2344 of file KDChartParams.h.

◆ setHeader2Text

void KDChartParams::setHeader2Text ( const TQString &  text)
inlineslot

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 at HdFtPos enum explanation.
The 'better' way to specify content and settings of headers or footers is to call setHeaderFooterText ( or setHeaderFooterFont , setHeaderFooterFontUseRelSize , setHeaderFooterFontRelSize , resp.) while specifying the appropriate HdFtPos.
The canonical way to retrieve settings and content of headers or footers is to call headerFooterText (or headerFooterFont , headerFooterFontUseRelSize , headerFooterFontRelSize, resp.).
Parameters
textthe text to display
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
header2Text(), setHeader1Text(), header1Text(), setFooterText(), footerText()

Definition at line 2332 of file KDChartParams.h.

◆ setHeaderFooterColor

void KDChartParams::setHeaderFooterColor ( uint  pos,
const TQColor  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 TQColor( TQt::black ).

Note
To learn about the different header (or footer, resp.) sections please see information given at HdFtPos enum explanation.
Parameters
posthe section for which the colour is to be changed
colorthe text colour to be used
See also
HdFtPos, headerFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7796 of file KDChartParams.cpp.

◆ setHeaderFooterFont

void KDChartParams::setHeaderFooterFont ( uint  pos,
const TQFont &  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
posthe section in which the font is to be used
fontthe font to use
See also
HdFtPos, setHeaderFooterText(), headerFooterText()
headerFooterFont()
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Font(), header1Font()
setHeader2Font(), header2Font()
setFooterFont(), footerFont()
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7852 of file KDChartParams.cpp.

◆ setHeaderFooterText

void KDChartParams::setHeaderFooterText ( uint  pos,
const TQString &  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
posthe section in which the text is to be shown
textthe text to be shown
See also
HdFtPos, headerFooterText()
setHeaderFooterFont, headerFooterFont
setHeaderFooterFontUseRelSize, headerFooterFontUseRelSize
setHeaderFooterFontRelSize, headerFooterFontRelSize
setHeader1Text(), header1Text()
setHeader2Text(), header2Text()
setFooterText(), footerText()

Definition at line 7728 of file KDChartParams.cpp.

◆ setHiLoChartPrintCloseValues

void KDChartParams::setHiLoChartPrintCloseValues ( bool  active,
TQFont *  font = 0,
int  size = 14,
TQColor *  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
activespecifies whether the values are to be printed or not.
fontspecifies 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!
specifiesthe color the color to be used when printing the values.
See also
setHiLoChartPrintOpenValues
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType
hiLoChartPrintCloseValues, hiLoChartPrintCloseValues
hiLoChartCloseValuesFontColor, hiLoChartCloseValuesFontColor
hiLoChartCloseValuesFontUseRelSize, hiLoChartCloseValuesFontUseRelSize
hiLoChartCloseValuesFontRelSize, hiLoChartCloseValuesFontRelSize
hiLoChartPrintOpenValues, hiLoChartPrintOpenValues
hiLoChartOpenValuesFontColor, hiLoChartOpenValuesFontColor
hiLoChartOpenValuesFontUseRelSize, hiLoChartOpenValuesFontUseRelSize
hiLoChartOpenValuesFontRelSize, hiLoChartOpenValuesFontRelSize

Definition at line 6114 of file KDChartParams.cpp.

◆ setHiLoChartPrintFirstValues

void KDChartParams::setHiLoChartPrintFirstValues ( bool  active,
TQFont *  font = 0,
uint  size = 14,
TQColor *  color = 0 
)
inlineslot
Deprecated:

This method is obsolete; use setHiLoChartPrintOpenValues().

Definition at line 1660 of file KDChartParams.h.

◆ setHiLoChartPrintHighValues

void KDChartParams::setHiLoChartPrintHighValues ( bool  active,
TQFont *  font = 0,
int  size = 14,
TQColor *  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
activespecifies whether the values are to be printed or not.
fontspecifies 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!
specifiesthe color the color to be used when printing the values.
See also
setHiLoChartPrintLowValues
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType
hiLoChartPrintHighValues, hiLoChartPrintHighValues
hiLoChartHighValuesFontColor, hiLoChartHighValuesFontColor
hiLoChartHighValuesFontUseRelSize, hiLoChartHighValuesFontUseRelSize
hiLoChartHighValuesFontRelSize, hiLoChartHighValuesFontRelSize
hiLoChartPrintLowValues, hiLoChartPrintLowValues
hiLoChartLowValuesFontColor, hiLoChartLowValuesFontColor
hiLoChartLowValuesFontUseRelSize, hiLoChartLowValuesFontUseRelSize
hiLoChartLowValuesFontRelSize, hiLoChartLowValuesFontRelSize

Definition at line 5872 of file KDChartParams.cpp.

◆ setHiLoChartPrintLastValues

void KDChartParams::setHiLoChartPrintLastValues ( bool  active,
TQFont *  font = 0,
int  size = 14,
TQColor *  color = 0 
)
inlineslot
Deprecated:

This method is obsolete; use setHiLoChartPrintCloseValues() instead.

Definition at line 1695 of file KDChartParams.h.

◆ setHiLoChartPrintLowValues

void KDChartParams::setHiLoChartPrintLowValues ( bool  active,
TQFont *  font = 0,
int  size = 14,
TQColor *  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
activespecifies whether the values are to be printed or not.
fonta 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!
colorthe color to be used when printing the values.
See also
setChartType, chartType
setHiLoChartSubType, hiLoChartSubType
setHiLoChartPrintHighValues
hiLoChartPrintLowValues, hiLoChartPrintLowValues
hiLoChartLowValuesFontColor, hiLoChartLowValuesFontColor
hiLoChartLowValuesFontUseRelSize, hiLoChartLowValuesFontUseRelSize
hiLoChartLowValuesFontRelSize, hiLoChartLowValuesFontRelSize
hiLoChartPrintHighValues, hiLoChartPrintHighValues
hiLoChartHighValuesFontColor, hiLoChartHighValuesFontColor
hiLoChartHighValuesFontUseRelSize, hiLoChartHighValuesFontUseRelSize
hiLoChartHighValuesFontRelSize, hiLoChartHighValuesFontRelSize

Definition at line 5749 of file KDChartParams.cpp.

◆ setHiLoChartPrintOpenValues

void KDChartParams::setHiLoChartPrintOpenValues ( bool  active,
TQFont *  font = 0,
uint  size = 14,
TQColor *  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
activespecifies whether the values are to be printed or not.
fonta 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!
colorthe color to be used when printing the values.
See also
setHiLoChartPrintCloseValues
setHiLoChartSubType, hiLoChartSubType
setChartType, chartType
hiLoChartPrintOpenValues, hiLoChartPrintOpenValues
hiLoChartOpenValuesFontColor, hiLoChartOpenValuesFontColor
hiLoChartOpenValuesFontUseRelSize, hiLoChartOpenValuesFontUseRelSize
hiLoChartOpenValuesFontRelSize, hiLoChartOpenValuesFontRelSize
hiLoChartPrintCloseValues, hiLoChartPrintCloseValues
hiLoChartCloseValuesFontColor, hiLoChartCloseValuesFontColor
hiLoChartCloseValuesFontUseRelSize, hiLoChartCloseValuesFontUseRelSize
hiLoChartCloseValuesFontRelSize, hiLoChartCloseValuesFontRelSize

Definition at line 5994 of file KDChartParams.cpp.

◆ setHiLoChartSubType

void KDChartParams::setHiLoChartSubType ( HiLoChartSubType  hiLoChartSubType)
inlineslot

Specifies the HiLo chart subtype.

Only used if chartType() == HiLo

Parameters
hiLoChartSubTypethe HiLo chart subtype
See also
hiLoChartSubType, HiLoChartSubType, setChartType, chartType

Definition at line 1509 of file KDChartParams.h.

◆ setLegendArea

void KDChartParams::setLegendArea ( const TQRect &  areaRect)
inlineslot

Definition at line 2449 of file KDChartParams.h.

◆ setLegendFont

void KDChartParams::setLegendFont ( const TQFont &  font,
bool  useFontSize 
)
inlineslot

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
fontthe font to draw the legend texts in
See also
setLegendFontUseRelSize, legendFont

Definition at line 1943 of file KDChartParams.h.

◆ setLegendFontRelSize

void KDChartParams::setLegendFontRelSize ( int  legendFontRelSize)
inlineslot

Specifies the legend relative font size.

Parameters
legendFontRelSizethe 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 1967 of file KDChartParams.h.

◆ setLegendFontUseRelSize

void KDChartParams::setLegendFontUseRelSize ( bool  legendFontUseRelSize)
inlineslot

Specifies whether the legend shall be drawn using relative font size.

Parameters
legendFontUseRelSizewhether 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 1956 of file KDChartParams.h.

◆ setLegendOrientation

void KDChartParams::setLegendOrientation ( TQt::Orientation  orientation)
inlineslot

Specifies how the legend should be printed.

vertical (the default) prints the legend entries below each other, horizontal prints them aside each other.

Note
Horizontal orientation is only possible if the chart is NOT making room in horizontal direction, this means you may specify horizontal orientation if the legend position in one of the following values only: LegendTop, LegendBottom, LegendTopLeftTop, LegendTopRightTop, LegendBottomLeftBottom, LegendBottomRightBottom
Parameters
theorientation for the legend
See also
legendOrientation, setLegendPosition, setLegendShowLines

Definition at line 1870 of file KDChartParams.h.

◆ setLegendPosition

void KDChartParams::setLegendPosition ( LegendPosition  position)
inlineslot

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
theposition for the legend
See also
LegendPosition, legendPosition, setLegendOrientation, setLegendShowLines

Definition at line 1859 of file KDChartParams.h.

◆ setLegendShowLines

void KDChartParams::setLegendShowLines ( bool  legendShowLines)
inlineslot

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
flagwhether lines are drawn or only the markers
See also
legendShowLines, setLegendOrientation, setLegendPosition

Definition at line 1882 of file KDChartParams.h.

◆ setLegendSource

void KDChartParams::setLegendSource ( LegendSource  source)
inlineslot

Specifies where the legend text is coming from.

See LegendSource for an explanation of the possible values.

Parameters
sourcethe source of the legend texts
See also
legendSource, LegendSource, setLegendText, legendText

Definition at line 1901 of file KDChartParams.h.

◆ setLegendSpacing

void KDChartParams::setLegendSpacing ( uint  space)
inlineslot

Specifies how much space in pixels there should be between the legend and the data display.

The default is 20 pixels.

Parameters
spacethe space in pixels between the legend and the data display
See also
legendSpacing

Definition at line 2042 of file KDChartParams.h.

◆ setLegendText

void KDChartParams::setLegendText ( uint  dataset,
const TQString &  text 
)
inlineslot

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
datasetthe dataset for which to set the legend text
thelegend text to be set for a given dataset
See also
LegendSource, setLegendSource, legendSource, legendText

Definition at line 1915 of file KDChartParams.h.

◆ setLegendTextColor

void KDChartParams::setLegendTextColor ( const TQColor &  color)
inlineslot

Specifies the color to be used for the legend texts.

The default is black.

Parameters
colorthe color to be used for the legend texts
See also
legendTextColor(), setLegendTitleTextColor()

Definition at line 1930 of file KDChartParams.h.

◆ setLegendTitleFont

void KDChartParams::setLegendTitleFont ( const TQFont &  font,
bool  useFontSize 
)
inlineslot

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
fontthe font to draw the legend texts in
See also
setLegendTitleFontUseRelSize, legendTitleFont

Definition at line 2006 of file KDChartParams.h.

◆ setLegendTitleFontRelSize

void KDChartParams::setLegendTitleFontRelSize ( int  legendTitleFontRelSize)
inlineslot

Specifies the legend title relative font size.

Parameters
legendTitleFontRelSizethe 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.
See also
setLegendTitleFontUseRelSize, setLegendTitleFont

Definition at line 2030 of file KDChartParams.h.

◆ setLegendTitleFontUseRelSize

void KDChartParams::setLegendTitleFontUseRelSize ( bool  legendTitleFontUseRelSize)
inlineslot

Specifies whether the legend title (if any) shall be drawn using relative font size.

Parameters
legendTitleFontUseRelSizewhether 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 2019 of file KDChartParams.h.

◆ setLegendTitleText

void KDChartParams::setLegendTitleText ( const TQString &  text)
inlineslot

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
textthe text to use as the legend title
See also
legendTitleText(), setLegendTitleFont(), setLegendTitleFontUseRelSize()

Definition at line 1979 of file KDChartParams.h.

◆ setLegendTitleTextColor

void KDChartParams::setLegendTitleTextColor ( const TQColor &  color)
inlineslot

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
colorthe color to be used for the legend title
See also
legendTitleTextColor(), setLegendTextColor()

Definition at line 1992 of file KDChartParams.h.

◆ setLineChartSubType

void KDChartParams::setLineChartSubType ( LineChartSubType  lineChartSubType)
inlineslot

Specifies the line chart subtype.

Only used if chartType() == Line. The default is LineNormal.

Parameters
lineChartSubTypethe line chart subtype
See also
lineChartSubType, LineChartSubType, setChartType, chartType

Definition at line 1059 of file KDChartParams.h.

◆ setLineColor

void KDChartParams::setLineColor ( TQColor  color = TQColor())
inlineslot

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.

e.g. You might want to specify setLineMarkerStyle( i, LineMarker4Pixels ) or even setLineMarkerStyle( i, LineMarker1Pixel ) and have your marker dots normally form a contiguous line without the need of any connecting lines except at the places where missing data values would interrupt the 'line'. Using setLineColor( TQt::darkGray) could make your chart more readable in such cases.

Parameters
colorof the lines in line charts
See also
lineColor, setLineWidth, setLineStyle
setLineMarker, setLineMarkerSize, setLineMarkerStyle

Definition at line 1143 of file KDChartParams.h.

◆ setLineMarker

void KDChartParams::setLineMarker ( bool  marker)
inlineslot

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
markertrue if markers should be drawn
See also
setLineMarker, setLineMarkerSize
setLineMarkerStyle, setLineColor, setLineWidth, setLineStyle

Definition at line 1075 of file KDChartParams.h.

◆ setLineMarkerSize

void KDChartParams::setLineMarkerSize ( TQSize  size)
inlineslot

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
sizethe size of the line marker in pixels
See also
lineMarkerSize, setLineMarker, setLineMarkerStyle
setLineColor, setLineWidth, setLineStyle

Definition at line 1120 of file KDChartParams.h.

◆ setLineMarkerStyle

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
datasetthe dataset for which to set the line marker
stylethe style to set for the specified dataset
See also
LineMarkerStyle, lineMarkerStyle, setLineMarkerSize
setLineColor, setLineWidth, setLineStyle

Definition at line 4664 of file KDChartParams.cpp.

◆ setLineMarkerStyles

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
mapthe map of styles
See also
lineMarkerStyles, setLineMarker, setLineMarkerStyle, setLineMarkerSize
setLineColor, setLineWidth, setLineStyle

Definition at line 4709 of file KDChartParams.cpp.

◆ setLineStyle

void KDChartParams::setLineStyle ( TQt::PenStyle  style,
uint  dataset = KDCHART_GLOBAL_LINE_STYLE 
)
slot

Specifies a line style to be used for line charts.

The dataset parameter is optional, by default saying KDCHART_GLOBAL_LINE_STYLE, you may use it to set a dataset specific line style for one the lines.

Global and dataset specific line styles may be used simultaneously: If no dataset specific style is defined the global style is used which by default is TQt::SolidLine.

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
stylethe line style of the line
datasetthe number of the dataset controlling the respective line
See also
lineStyle, setLineWidth, setLineColor
setLineMarker, setLineMarkerSize, setLineMarkerStyle

Definition at line 4860 of file KDChartParams.cpp.

◆ setLineWidth

void KDChartParams::setLineWidth ( int  width)
inlineslot

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
widththe new width
See also
lineWidth, setLineColor, setLineStyle
setLineMarker, setLineMarkerSize, setLineMarkerStyle

Definition at line 1131 of file KDChartParams.h.

◆ setNumValues

void KDChartParams::setNumValues ( uint  numValues)
inlineslot

Specifies how many of the values should be shown.

-1 means all available values.

Parameters
numValuesthe number of values to be shown
See also
numValues

Definition at line 599 of file KDChartParams.h.

◆ setOptimizeOutputForScreen

KDChartParams::setOptimizeOutputForScreen ( bool  screenOutput)
inlineslot

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 TQPrinter 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 163 of file KDChartParams.h.

◆ setOutlineDataColor

void KDChartParams::setOutlineDataColor ( TQColor  color)
inlineslot

Specifies a color for the outlines of data displays.

The default is black.

Note
Use setOutlineDataLineStyle( TQt::NoPen ) to hide the line.
Parameters
colorthe color to use for the outlines
See also
outlineDataColor, setOutlineDataLineStyle, setOutlineDataLineWidth

Definition at line 647 of file KDChartParams.h.

◆ setOutlineDataLineStyle

void KDChartParams::setOutlineDataLineStyle ( TQt::PenStyle  style)
inlineslot

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
widththe line style to use for the outlines
See also
outlineDataLineStyle, setOutlineDataColor, setOutlineDataLineWidth

Definition at line 672 of file KDChartParams.h.

◆ setOutlineDataLineWidth

void KDChartParams::setOutlineDataLineWidth ( uint  width)
inlineslot

Specifies the width of the outlines of data displays.

The default is 1 pixel.

Note
Use setOutlineDataLineStyle( TQt::NoPen ) to hide the line.
Parameters
widththe line width to use for the outlines
See also
outlineDataLineWidth, setOutlineDataLineStyle, setOutlineDataColor

Definition at line 660 of file KDChartParams.h.

◆ setPieStart

void KDChartParams::setPieStart ( int  degrees)
inlineslot

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
degreesthe starting point in degrees
See also
pieStart()

Definition at line 1456 of file KDChartParams.h.

◆ setPolarChartSubType

void KDChartParams::setPolarChartSubType ( PolarChartSubType  polarChartSubType)
inlineslot

Specifies the polar chart subtype.

Only used if chartType() == Polar. The default is PolarNormal.

Parameters
polarChartSubTypethe polar chart subtype
See also
polarChartSubType, PolarChartSubType, setChartType, chartType

Definition at line 1264 of file KDChartParams.h.

◆ setPolarDelimsAndLabelsAtPos

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.
See also
setPolarRotateCircularLabels, polarDelimAtPos, polarLabelsAtPos

Definition at line 5347 of file KDChartParams.cpp.

◆ setPolarLineWidth

void KDChartParams::setPolarLineWidth ( int  width = -3)
inlineslot

Specifies the width for lines in polar charts.

Default is -3.

Parameters
widththe new width
See also
polarLineWidth

Definition at line 1333 of file KDChartParams.h.

◆ setPolarMarker

void KDChartParams::setPolarMarker ( bool  marker)
inlineslot

Specifies whether there should be a marker at each data point.

Only used if chartType() == Polar. The default is not to draw markers.

Parameters
markertrue if markers should be drawn

Definition at line 1279 of file KDChartParams.h.

◆ setPolarMarkerSize

void KDChartParams::setPolarMarkerSize ( TQSize  size = TQSize( -40, -40 ))
inlineslot

Specifies the sizes of polar markers.

Only used if chartType() == Polar and polarMarker() == true. The default is -40 x -40.

Parameters
sizethe 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 1322 of file KDChartParams.h.

◆ setPolarMarkerStyle

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
datasetthe dataset for which to set the polar marker
stylethe style to set for the specified dataset
See also
PolarMarkerStyle, polarMarkerStyle

Definition at line 5176 of file KDChartParams.cpp.

◆ setPolarMarkerStyles

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
mapthe map of styles
See also
polarMarkerStyles(), setPolarMarkerStyle()

Definition at line 5219 of file KDChartParams.cpp.

◆ setPolarRotateCircularLabels

void KDChartParams::setPolarRotateCircularLabels ( bool  rotateCircularLabels)
inlineslot

Specifies whether to rotate circular labels in polar charts.

See also
polarRotateCircularLabels, setPolarDelimsAndLabelsAtPos

Definition at line 1356 of file KDChartParams.h.

◆ setPolarZeroDegreePos

void KDChartParams::setPolarZeroDegreePos ( int  degrees)
inlineslot

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 1345 of file KDChartParams.h.

◆ setPrintDataValues

void KDChartParams::setPrintDataValues ( bool  active,
uint  chart = KDCHART_ALL_CHARTS,
int  divPow10 = 0,
int  digitsBehindComma = KDCHART_DATA_VALUE_AUTO_DIGITS,
TQFont *  font = 0,
uint  size = UINT_MAX,
const TQColor *  color = KDCHART_DATA_VALUE_AUTO_COLOR,
KDChartEnums::PositionFlag  negativePosition = KDChartEnums::PosCenter,
uint  negativeAlign = TQt::AlignCenter,
int  negativeDeltaX = 0,
int  negativeDeltaY = 0,
int  negativeRotation = 0,
KDChartEnums::PositionFlag  positivePosition = KDChartEnums::PosCenter,
uint  positiveAlign = TQt::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 setPrintDataValues( false ) will deactivate printing of the values.

Calling setPrintDataValuesWithDefaultFontParams( chart ) will reset the respective font size and colour and position parameters (but not the TQFont itself) and activate printing of the values for the chart speficied (or for all charts by using KDCHART_ALL_CHARTS, resp.).

Parameters
activespecifies whether the value texts are to be printed or not.
chartThe 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.
divPow10The 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.
digitsBehindCommaThe number of digits to show behind the comma, to have this calculated automatically just use the default value KDCHART_DATA_VALUE_AUTO_DIGITS.
fonta 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).

Changing of one or more of the following parameters automatically de-activates all future font parameter adjustments that would otherwise take place after each call of setChartType (or setAdditionalChartType, resp.). To re-enable this usefull feature you may call setPrintDataValuesWithDefaultFontParams at any time afterwards.

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.
colorthe 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 TQColor*. You may use setPrintDataValuesColor to change this parameter setting without affecting the other ones.

The following parameters apply to values less than zero only:

Parameters
negativePositionThe anchor position which the text is to be aligned to.
negativeAlignThe way how the text is to be aligned to the anchor. This must be a reasonable combination of TQt::AlignmentFlags.
negativeDeltaXThe X distance between the anchor point – specified by negativePosition (or positivePosition, resp.) – and the internal alignment point of the text – specified by negativeAlign (or positiveAlign, 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 parameter size.
negativeDeltaYThe Y distance between the anchor point – specified by negativePosition (or positivePosition, resp.) – and the internal alignment point of the text – specified by negativeAlign (or positiveAlign, 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 parameter size.
negativeRotationThe 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 and KDCHART_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 by negativeAlign (or positiveAlign, resp.).

The following parameters apply to values greater than zero or equal zero:

Parameters
positivePositionThe anchor position which the text is to be aligned to.
positiveAlignThe way how the text is to be aligned to the anchor. This must be a reasonable combination of TQt::AlignmentFlags.
negativeDeltaXThe X distance between the anchor point – specified by negativePosition (or positivePosition, resp.) – and the internal alignment point of the text – specified by negativeAlign (or positiveAlign, 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 parameter size.
positiveDeltaYThe Y distance between the anchor point – specified by negativePosition (or positivePosition, resp.) – and the internal alignment point of the text – specified by negativeAlign (or positiveAlign, 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 parameter size.
positiveRotationThe 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 and KDCHART_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 by negativeAlign (or positiveAlign, resp.).
layoutPolicyThe 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
dataValuesFontRelSize
dataValuesFontColor
dataValuesAnchorPosition
dataValuesAnchorAlign
dataValuesAnchorDeltaX
dataValuesAnchorDeltaY
dataValuesRotation
dataValuesLayoutPolicy

Definition at line 1057 of file KDChartParams.cpp.

◆ setPrintDataValuesColor

void KDChartParams::setPrintDataValuesColor ( uint  chart = KDCHART_ALL_CHARTS,
const TQColor *  color = KDCHART_DATA_VALUE_AUTO_COLOR 
)
slot

Definition at line 3441 of file KDChartParams.cpp.

◆ setPrintDataValuesFontRelSize

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 \chart 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 3478 of file KDChartParams.cpp.

◆ setPrintDataValuesWithDefaultFontParams

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 TQFont 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.
See also
printDataValuesWithDefaultFontParams, setPrintDataValues

Definition at line 3513 of file KDChartParams.cpp.

◆ setProperties

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.
See also
KDCHART_PROPSET_TRANSPARENT_DATA
KDCHART_PROPSET_HORI_LINE, KDCHART_PROPSET_VERT_LINE
KDChartData::setPropertySet
removeProperties

Definition at line 511 of file KDChartParams.cpp.

◆ setRelativeRingThickness

void KDChartParams::setRelativeRingThickness ( bool  relativeThickness)
inlineslot

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
relativeThicknessif true, ring thickness is relative, if false, it is constant.
See also
relativeThickness()

Definition at line 1490 of file KDChartParams.h.

◆ setRingStart

void KDChartParams::setRingStart ( int  degrees)
inlineslot

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
degreesthe starting point in degrees
See also
pieStart()

Definition at line 1473 of file KDChartParams.h.

◆ setShadowBrightnessFactor

void KDChartParams::setShadowBrightnessFactor ( double  factor)
inlineslot

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
factora 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 624 of file KDChartParams.h.

◆ setShadowPattern

void KDChartParams::setShadowPattern ( TQt::BrushStyle  style)
inlineslot

Specifies a filling style for filling the shadow areas in 3-dimensional drawings like 3D bar charts.

The default is to fill with a solid color, the color is determined with setThreeDShadowColors.

Parameters
stylethe fill style to use
See also
shadowPattern(), setThreeDShadowColors(), threeDShadowColors()

Definition at line 637 of file KDChartParams.h.

◆ setSimpleFrame

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,
TQPen  pen = TQPen(),
TQBrush  background = TQBrush( TQt::NoBrush ),
const TQPixmap *  backPixmap = 0,
KDFrame::BackPixmapMode  backPixmapMode = KDFrame::PixStretched,
int  shadowWidth = 0,
KDFrame::CornerName  sunPos = KDFrame::CornerTopLeft 
)
inlineslot

Select a pre-defined frame setting to be used for one of the chart areas.

Parameters
areaThe area to be surrounded by a frame.
outerGapThe distance between the frame and the surrounding parts of the chart.
innerGapThe distance between the frame and the inner area.
addFrameWidthToLayoutFor internal use - must be true.
addFrameHeightToLayoutFor internal use - must be true.
simpleFrameFor internal use - must be KDFrame::FrameFlat.
lineWidthFor internal use - must be 1.
midLineWidthFor internal use - must be 0.
penThe pen to be used for drawing the four frame border lines.
backgroundThe brush to be used for painting the frame background.
backPixmapThe picture to be displayed as background image of the frame.
backPixmapModeThe 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.
shadowWidthFor internal use - do not set this parameter or set it to 0.
sunPosFor internal use - do not set this parameter or set it to KDFrame::CornerTopLeft.
See also
removeFrame

Definition at line 406 of file KDChartParams.h.

◆ setThreeDBarAngle

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
anglethe 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
threeDBarAngle, cosThreeDBarAngle
setThreeDBarDepth, threeDBarDepth

Definition at line 4194 of file KDChartParams.cpp.

◆ setThreeDBarDepth

void KDChartParams::setThreeDBarDepth ( double  depth)
inlineslot

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
depththe 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
setThreeDBars, threeDBars
setThreeDBarAngle, threeDBarAngle, cosThreeDBarAngle

Definition at line 948 of file KDChartParams.h.

◆ setThreeDBars

void KDChartParams::setThreeDBars ( bool  threeDBars)
inlineslot

Specifies whether the engine should draw the bars in 3D.

This setting only has an effect in bar charts.

Parameters
threeDBarstrue if bars should be drawn with a 3D effect
See also
threeDBars, setThreeDBarAngle, threeDBarAngle

Definition at line 906 of file KDChartParams.h.

◆ setThreeDBarsShadowColors

void KDChartParams::setThreeDBarsShadowColors ( bool  shadow)
inlineslot
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 setting only has an effect in bar charts.

This method is obsolete; use setThreeDShadowColors instead

Parameters
shadowtrue for shadowed colors, false for original colors
See also
setThreeDShadowColors

Definition at line 918 of file KDChartParams.h.

◆ setThreeDLineDepth

void KDChartParams::setThreeDLineDepth ( int  depth)
inlineslot

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
depththe depth in pixels
See also
setThreeDLines(), threeDLines(), threeDLineDepth()

Definition at line 1170 of file KDChartParams.h.

◆ setThreeDLines

void KDChartParams::setThreeDLines ( bool  threeD)
inlineslot

Specifies whether lines should be drawn three-dimensionally or not.

The default is to draw two-dimensionally. Only used if chartType() == Line.

Parameters
threeDif true, draw three-dimensionally, otherwise draw two-dimensionally.
See also
threeDLines(), setThreeDLineDepth(), threeDLineDepth(), setThreeDLineXRotation(), threeDLineXRotation(), setThreeDLineYRotation(), threeDLineYRotation()

Definition at line 1159 of file KDChartParams.h.

◆ setThreeDLineXRotation

void KDChartParams::setThreeDLineXRotation ( int  degrees)
inlineslot
Deprecated:
Feature scheduled for future release, at present not implemented.

Definition at line 1184 of file KDChartParams.h.

◆ setThreeDLineYRotation

void KDChartParams::setThreeDLineYRotation ( int  degrees)
inlineslot
Deprecated:
Feature scheduled for future release, at present not implemented.

Definition at line 1201 of file KDChartParams.h.

◆ setThreeDPieHeight

void KDChartParams::setThreeDPieHeight ( int  pixels)
inlineslot

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
heightthe height of the 3D effect in pixels
See also
threeDHeight(), setThreeDPies(), threeDPies()

Definition at line 1445 of file KDChartParams.h.

◆ setThreeDPies

void KDChartParams::setThreeDPies ( bool  threeDPies)
inlineslot

Specifies whether the engine should draw the pies in 3D.

Only used if chartType() == Pie.

Parameters
threeDPiestrue if pies should be drawn with a 3D effect
See also
threeDPies(), setThreeDPieHeight(), threeDPieHeight()

Definition at line 1433 of file KDChartParams.h.

◆ setThreeDShadowColors

void KDChartParams::setThreeDShadowColors ( bool  shadow)
inlineslot

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
shadowtrue for shadowed colors, false for original colors
See also
threeDShadowColors

Definition at line 690 of file KDChartParams.h.

◆ setValueBlockGap

void KDChartParams::setValueBlockGap ( int  gap)
inlineslot

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( TQt::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
gapthe number of pixels between each value block.
See also
setDatasetGap
setBarWidth, valueBlockGap
KDChartWidget::barsDisplayed, KDChart::barsDisplayed
numBarsDisplayed, numBarsLeft
valueBlockGapIsRelative, setValueBlockGapIsRelative
setOutlineDataLineStyle

Definition at line 985 of file KDChartParams.h.

◆ setValueBlockGapIsRelative

void KDChartParams::setValueBlockGapIsRelative ( bool  gapIsRelative)
inlineslot

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
gapIsRelativespecifies 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 997 of file KDChartParams.h.

◆ shadowBrightnessFactor

double KDChartParams::shadowBrightnessFactor ( ) const
inlineslot

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 631 of file KDChartParams.h.

◆ shadowPattern

TQt::BrushStyle KDChartParams::shadowPattern ( ) const
inlineslot

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 642 of file KDChartParams.h.

◆ showGrid

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 7104 of file KDChartParams.cpp.

◆ stringToAreaChartSubType

KDChartParams::AreaChartSubType KDChartParams::stringToAreaChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a area chart subtype enum value.

Parameters
stringthe string to convert
Returns
the area chart subtype enum value

Definition at line 2869 of file KDChartParams_io.cpp.

◆ stringToAreaLocation

KDChartParams::AreaLocation KDChartParams::stringToAreaLocation ( const TQString &  string)
staticslot

Converts the specified string to an area location enum value.

Parameters
stringthe string to convert
Returns
the aration location enum value

Definition at line 2906 of file KDChartParams_io.cpp.

◆ stringToBarChartSubType

KDChartParams::BarChartSubType KDChartParams::stringToBarChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a bar chart subtype enum value.

Parameters
stringthe string to convert
Returns
the bar chart subtype enum value

Definition at line 2737 of file KDChartParams_io.cpp.

◆ stringToBWChartStatVal

KDChartParams::BWStatVal KDChartParams::stringToBWChartStatVal ( const TQString &  string)
staticslot

Converts the specified string to a BWStatVal enum value.

Parameters
stringthe string to convert
Returns
the BWStatVal enum value

Definition at line 3098 of file KDChartParams_io.cpp.

◆ stringToBWChartSubType

KDChartParams::BWChartSubType KDChartParams::stringToBWChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a BoxWhisker chart subtype enum value.

Parameters
stringthe string to convert
Returns
the BoxWhisker chart subtype enum value

Definition at line 3051 of file KDChartParams_io.cpp.

◆ stringToChartSourceMode

KDChartParams::SourceMode KDChartParams::stringToChartSourceMode ( const TQString &  string)
staticslot

Converts the specified string to a chart source mode enum value.

Parameters
stringthe string to convert
Returns
the chart source mode enum value

Definition at line 3290 of file KDChartParams_io.cpp.

◆ stringToChartType

KDChartParams::ChartType KDChartParams::stringToChartType ( const TQString &  string)
staticslot

Converts the specified string to a chart type enum value.

Parameters
stringthe string to convert
Returns
the chart type enum value

Definition at line 2589 of file KDChartParams_io.cpp.

◆ stringToHiLoChartSubType

KDChartParams::HiLoChartSubType KDChartParams::stringToHiLoChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a HiLo chart subtype enum value.

Parameters
stringthe string to convert
Returns
the HiLo chart subtype enum value

Definition at line 3033 of file KDChartParams_io.cpp.

◆ stringToLegendPosition

KDChartParams::LegendPosition KDChartParams::stringToLegendPosition ( const TQString &  string)
staticslot

Converts the specified string to a legend position enum value.

Parameters
stringthe string to convert
Returns
the legend position enum value

Definition at line 3179 of file KDChartParams_io.cpp.

◆ stringToLegendSource

KDChartParams::LegendSource KDChartParams::stringToLegendSource ( const TQString &  string)
staticslot

Converts the specified string to a legend source enum value.

Parameters
stringthe string to convert
Returns
the legend source enum value

Definition at line 3245 of file KDChartParams_io.cpp.

◆ stringToLineChartSubType

KDChartParams::LineChartSubType KDChartParams::stringToLineChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a line chart subtype enum value.

Parameters
stringthe string to convert
Returns
the line chart subtype enum value

Definition at line 2758 of file KDChartParams_io.cpp.

◆ stringToLineMarkerStyle

KDChartParams::LineMarkerStyle KDChartParams::stringToLineMarkerStyle ( const TQString &  string)
staticslot

Converts the specified string to a line marker style value.

Parameters
stringthe string to convert
Returns
the line marker style enum value

Definition at line 2824 of file KDChartParams_io.cpp.

◆ stringToLineMarkerStyleTr

KDChartParams::LineMarkerStyle KDChartParams::stringToLineMarkerStyleTr ( const TQString &  string)
staticslot

Converts the specified localized string to a line marker style value.

Parameters
stringthe string to convert
Returns
the line marker style enum value

Definition at line 2836 of file KDChartParams_io.cpp.

◆ stringToMarkerStyle

int KDChartParams::stringToMarkerStyle ( const TQString &  string)
staticslot

Definition at line 2663 of file KDChartParams_io.cpp.

◆ stringToMarkerStyleTr

int KDChartParams::stringToMarkerStyleTr ( const TQString &  string)
staticslot

Definition at line 2684 of file KDChartParams_io.cpp.

◆ stringToPolarChartSubType

KDChartParams::PolarChartSubType KDChartParams::stringToPolarChartSubType ( const TQString &  string)
staticslot

Converts the specified string to a polar chart subtype enum value.

Parameters
stringthe string to convert
Returns
the polar chart subtype enum value

Definition at line 2922 of file KDChartParams_io.cpp.

◆ stringToPolarMarkerStyle

KDChartParams::PolarMarkerStyle KDChartParams::stringToPolarMarkerStyle ( const TQString &  string)
staticslot

Converts the specified string to a polar marker style value.

Parameters
stringthe string to convert
Returns
the polar marker style enum value

Definition at line 2987 of file KDChartParams_io.cpp.

◆ stringToPolarMarkerStyleTr

KDChartParams::PolarMarkerStyle KDChartParams::stringToPolarMarkerStyleTr ( const TQString &  string)
staticslot

Converts the specified localized string to a polar marker style value.

Parameters
stringthe string to convert
Returns
the polar marker style enum value

Definition at line 3000 of file KDChartParams_io.cpp.

◆ threeDBarAngle

uint KDChartParams::threeDBarAngle ( ) const
inlineslot

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.
See also
setThreeDBars, threeDBars
setThreeDBarAngle, cosThreeDBarAngle
setThreeDBarDepth, threeDBarDepth

Definition at line 936 of file KDChartParams.h.

◆ threeDBarDepth

double KDChartParams::threeDBarDepth ( ) const
inlineslot

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
setThreeDBars, threeDBars
setThreeDBarAngle, threeDBarAngle, cosThreeDBarAngle

Definition at line 955 of file KDChartParams.h.

◆ threeDBars

bool KDChartParams::threeDBars ( ) const
inlineslot

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 912 of file KDChartParams.h.

◆ threeDBarsShadowColors

bool KDChartParams::threeDBarsShadowColors ( ) const
inlineslot
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 setting only has an effect in bar charts.

This method is obsolete; use threeDShadowColors instead

Returns
true if bars use shadowed colors for 3D effects
See also
setThreeDBarsShadowColors

Definition at line 925 of file KDChartParams.h.

◆ threeDLineDepth

int KDChartParams::threeDLineDepth ( ) const
inlineslot

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 1176 of file KDChartParams.h.

◆ threeDLines

bool KDChartParams::threeDLines ( ) const
inlineslot

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 1165 of file KDChartParams.h.

◆ threeDLineXRotation

int KDChartParams::threeDLineXRotation ( ) const
inlineslot
Deprecated:
Feature scheduled for future release, at present not implemented.

Definition at line 1193 of file KDChartParams.h.

◆ threeDLineYRotation

int KDChartParams::threeDLineYRotation ( ) const
inlineslot
Deprecated:
Feature scheduled for future release, at present not implemented.

Definition at line 1210 of file KDChartParams.h.

◆ threeDPieHeight

int KDChartParams::threeDPieHeight ( ) const
inlineslot

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 1451 of file KDChartParams.h.

◆ threeDPies

bool KDChartParams::threeDPies ( ) const
inlineslot

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 1439 of file KDChartParams.h.

◆ threeDShadowColors

bool KDChartParams::threeDShadowColors ( ) const
inlineslot

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 697 of file KDChartParams.h.

◆ userWidth

int KDChartParams::userWidth ( ) const
inlineslot

Definition at line 1027 of file KDChartParams.h.

◆ valueBlockGap

int KDChartParams::valueBlockGap ( ) const
inlineslot

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 \valueBlockGap value is a per mille value of the chart data area width.
Returns
the number of pixels between each value block.
See also
valueBlockGap
valueBlockGapIsRelative, setValueBlockGapIsRelative

Definition at line 991 of file KDChartParams.h.

◆ valueBlockGapIsRelative

bool KDChartParams::valueBlockGapIsRelative ( ) const
inlineslot

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.
See also
setValueBlockGapIsRelative, setValueBlockGap, valueBlockGap
setValueBlockGap

Definition at line 1003 of file KDChartParams.h.

Friends And Related Symbol Documentation

◆ operator<<

TQTextStream & operator<< ( TQTextStream &  s,
const KDChartParams &  p 
)
friend

Definition at line 43 of file KDChartParams_io.cpp.

◆ operator>>

TQTextStream & operator>> ( TQTextStream &  s,
KDChartParams &  p 
)
friend

Definition at line 1044 of file KDChartParams_io.cpp.

The documentation for this class was generated from the following files: