![]() |
KD Chart API Documentation
3.1
|
A chart with one or more diagrams. More...
#include <KDChartChart>
Signals | |
void | finishedDrawing () |
void | propertiesChanged () |
Public Member Functions | |
Chart (QWidget *parent=nullptr) | |
~Chart () override | |
void | addCoordinatePlane (AbstractCoordinatePlane *plane) |
void | addHeaderFooter (HeaderFooter *headerFooter) |
void | addLegend (Legend *legend) |
BackgroundAttributes | backgroundAttributes () const |
AbstractCoordinatePlane * | coordinatePlane () |
QLayout * | coordinatePlaneLayout () |
CoordinatePlaneList | coordinatePlanes () |
FrameAttributes | frameAttributes () const |
int | globalLeadingBottom () const |
int | globalLeadingLeft () const |
int | globalLeadingRight () const |
int | globalLeadingTop () const |
HeaderFooter * | headerFooter () |
HeaderFooterList | headerFooters () |
void | insertCoordinatePlane (int index, AbstractCoordinatePlane *plane) |
Legend * | legend () |
LegendList | legends () const |
void | paint (QPainter *painter, const QRect &target) |
void | reLayoutFloatingLegends () |
void | replaceCoordinatePlane (AbstractCoordinatePlane *plane, AbstractCoordinatePlane *oldPlane=nullptr) |
void | replaceHeaderFooter (HeaderFooter *headerFooter, HeaderFooter *oldHeaderFooter=nullptr) |
void | replaceLegend (Legend *legend, Legend *oldLegend=nullptr) |
void | setBackgroundAttributes (const BackgroundAttributes &a) |
Specify the background attributes to be used, by default there is no background. More... | |
void | setCoordinatePlaneLayout (QLayout *layout) |
void | setFrameAttributes (const FrameAttributes &a) |
Specify the frame attributes to be used, by default is it a thin black line. More... | |
void | setGlobalLeading (int left, int top, int right, int bottom) |
void | setGlobalLeadingBottom (int leading) |
void | setGlobalLeadingLeft (int leading) |
void | setGlobalLeadingRight (int leading) |
void | setGlobalLeadingTop (int leading) |
void | setUseNewLayoutSystem (bool value) |
void | takeCoordinatePlane (AbstractCoordinatePlane *plane) |
void | takeHeaderFooter (HeaderFooter *headerFooter) |
void | takeLegend (Legend *legend) |
bool | useNewLayoutSystem () const |
useNewLayoutSystem Be very careful activating the new layout system, its still experimental and works only if the user knows what he is doing. The reason is that the system does not prevent the user from creating sharing graphs that are not layoutable in a plane and still needs assistance from the user. More... | |
Protected Member Functions | |
bool | event (QEvent *event) override |
void | mouseDoubleClickEvent (QMouseEvent *event) override |
void | mouseMoveEvent (QMouseEvent *event) override |
void | mousePressEvent (QMouseEvent *event) override |
void | mouseReleaseEvent (QMouseEvent *event) override |
void | paintEvent (QPaintEvent *event) override |
Draws the background and frame, then calls paint(). More... | |
void | resizeEvent (QResizeEvent *event) override |
Properties | |
int | globalLeadingBottom |
int | globalLeadingLeft |
int | globalLeadingRight |
int | globalLeadingTop |
bool | useNewLayoutSystem |
A chart with one or more diagrams.
The Chart class represents a drawing consisting of one or more diagrams and various optional elements such as legends, axes, text boxes, headers or footers. It takes ownership of all these elements when they are assigned to it. Each diagram is associated with a coordinate plane, of which the chart can have more than one. The coordinate planes (and thus the associated diagrams) can be laid out in various ways.
The Chart class makes heavy use of the Qt Interview framework for model/view programming, and thus requires data to be presented to it in a QAbstractItemModel compatible way. For many simple charts, especially if the visualized data is static, KDChart::Widget provides an abstracted interface, that hides the complexity of Interview to a large extent.
Definition at line 83 of file KDChartChart.h.
|
explicit |
Definition at line 1119 of file KDChartChart.cpp.
References addCoordinatePlane(), d, setFrameAttributes(), KDChart::FrameAttributes::setPadding(), and KDChart::FrameAttributes::setPen().
|
override |
Definition at line 1139 of file KDChartChart.cpp.
References d.
void Chart::addCoordinatePlane | ( | AbstractCoordinatePlane * | plane | ) |
Adds a coordinate plane to the chart. The chart takes ownership.
plane | The coordinate plane to add. |
Definition at line 1201 of file KDChartChart.cpp.
References d, and insertCoordinatePlane().
Referenced by Chart(), and replaceCoordinatePlane().
void Chart::addHeaderFooter | ( | HeaderFooter * | headerFooter | ) |
Adds a header or a footer to the chart. The chart takes ownership.
headerFooter | The header (or footer, resp.) to add. |
Definition at line 1422 of file KDChartChart.cpp.
References d, KDChart::HeaderFooter::destroyedHeaderFooter(), KDChart::TextAttributes::fontSize(), KDChart::HeaderFooter::Footer, getRowAndColumnForPosition(), KDChart::HeaderFooter::Header, KDChartEnums::MeasureOrientationMinimum, KDChart::HeaderFooter::position(), KDChart::HeaderFooter::positionChanged(), s_gridAlignments, KDChart::TextAttributes::setFontSize(), KDChart::AbstractLayoutItem::setParentLayout(), KDChart::Measure::setRelativeMode(), KDChart::TextLayoutItem::setTextAttributes(), KDChart::Measure::setValue(), KDChart::TextLayoutItem::textAttributes(), KDChart::HeaderFooter::type(), and KDChart::Position::value().
Referenced by replaceHeaderFooter().
void Chart::addLegend | ( | Legend * | legend | ) |
Add the given legend to the chart. The chart takes ownership.
legend | The legend to add. |
Definition at line 1524 of file KDChartChart.cpp.
References legend(), and propertiesChanged().
Referenced by replaceLegend().
BackgroundAttributes Chart::backgroundAttributes | ( | ) | const |
Definition at line 1159 of file KDChartChart.cpp.
References d.
AbstractCoordinatePlane * Chart::coordinatePlane | ( | ) |
Each chart must have at least one coordinate plane. Initially a default CartesianCoordinatePlane is created. Use replaceCoordinatePlane() to replace it with a different one, such as a PolarCoordinatePlane.
Definition at line 1186 of file KDChartChart.cpp.
References d.
QLayout * Chart::coordinatePlaneLayout | ( | ) |
Definition at line 1181 of file KDChartChart.cpp.
References d.
CoordinatePlaneList Chart::coordinatePlanes | ( | ) |
The list of coordinate planes.
Definition at line 1196 of file KDChartChart.cpp.
References d.
|
overrideprotected |
reimp
Definition at line 1747 of file KDChartChart.cpp.
References d.
Referenced by mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and resizeEvent().
|
signal |
Referenced by paintEvent().
FrameAttributes Chart::frameAttributes | ( | ) | const |
Definition at line 1149 of file KDChartChart.cpp.
References d.
int Chart::globalLeadingBottom | ( | ) | const |
The padding between the start of the widget and the start of the area that is used for drawing at the bottom.
Definition at line 1310 of file KDChartChart.cpp.
References d.
int Chart::globalLeadingLeft | ( | ) | const |
The padding between the start of the widget and the start of the area that is used for drawing on the left.
Definition at line 1274 of file KDChartChart.cpp.
References d.
int Chart::globalLeadingRight | ( | ) | const |
The padding between the start of the widget and the start of the area that is used for drawing on the right.
Definition at line 1298 of file KDChartChart.cpp.
References d.
int Chart::globalLeadingTop | ( | ) | const |
The padding between the start of the widget and the start of the area that is used for drawing at the top.
Definition at line 1286 of file KDChartChart.cpp.
References d.
HeaderFooter * Chart::headerFooter | ( | ) |
The first header or footer of the chart. By default there is none.
Definition at line 1502 of file KDChartChart.cpp.
References d.
Referenced by replaceHeaderFooter(), and takeHeaderFooter().
HeaderFooterList Chart::headerFooters | ( | ) |
The list of headers and footers associated with the chart.
Definition at line 1511 of file KDChartChart.cpp.
References d.
void Chart::insertCoordinatePlane | ( | int | index, |
AbstractCoordinatePlane * | plane | ||
) |
Inserts a coordinate plane to the chart at index index
. The chart takes ownership.
index | The index where to add the plane |
plane | The coordinate plane to add. |
Definition at line 1207 of file KDChartChart.cpp.
References d, KDChart::AbstractCoordinatePlane::destroyedCoordinatePlane(), KDChart::AbstractCoordinatePlane::needLayoutPlanes(), KDChart::AbstractCoordinatePlane::needRelayout(), KDChart::AbstractCoordinatePlane::needUpdate(), KDChart::AbstractCoordinatePlane::propertiesChanged(), propertiesChanged(), and KDChart::AbstractCoordinatePlane::setParent().
Referenced by addCoordinatePlane().
Legend * Chart::legend | ( | ) |
The first legend of the chart or 0 if there was none added to the chart.
Definition at line 1660 of file KDChartChart.cpp.
References d.
Referenced by addLegend(), reLayoutFloatingLegends(), replaceLegend(), and takeLegend().
LegendList Chart::legends | ( | ) | const |
The list of all legends associated with the chart.
Definition at line 1665 of file KDChartChart.cpp.
References d.
|
overrideprotected |
|
overrideprotected |
|
overrideprotected |
|
overrideprotected |
void Chart::paint | ( | QPainter * | painter, |
const QRect & | target | ||
) |
Paints all the contents of the chart. Use this method to make KDChart draw into your QPainter.
painter | The painter to be drawn into. |
target | The rectangle to be filled by the Chart's drawing. |
Definition at line 1315 of file KDChartChart.cpp.
References d, KDChart::GlobalMeasureScaling::instance(), invalidateLayoutTree(), KDChart::GlobalMeasureScaling::paintDevice(), KDChart::GlobalMeasureScaling::resetFactors(), KDChart::PrintingParameters::resetScaleFactor(), KDChart::GlobalMeasureScaling::setFactors(), KDChart::GlobalMeasureScaling::setPaintDevice(), and KDChart::PrintingParameters::setScaleFactor().
|
overrideprotected |
Draws the background and frame, then calls paint().
In most cases there is no need to override this method in a derived class, but if you do, do not forget to call paint().
Definition at line 1415 of file KDChartChart.cpp.
References d, and finishedDrawing().
|
signal |
Emitted upon change of a property of the Chart or any of its components.
Referenced by addLegend(), insertCoordinatePlane(), takeCoordinatePlane(), and takeLegend().
void Chart::reLayoutFloatingLegends | ( | ) |
Definition at line 1384 of file KDChartChart.cpp.
References KDChart::RelativePosition::alignment(), KDChart::RelativePosition::calculatedPoint(), d, KDChart::Legend::floatingPosition(), KDChart::Position::isFloating(), legend(), KDChart::Legend::position(), and KDChart::Legend::sizeHint().
void Chart::replaceCoordinatePlane | ( | AbstractCoordinatePlane * | plane, |
AbstractCoordinatePlane * | oldPlane = nullptr |
||
) |
Replaces the old coordinate plane, or appends the plane, it there is none yet.
plane | The coordinate plane to be used instead of the old plane. This parameter must not be zero, or the method will do nothing. |
oldPlane | The coordinate plane to be removed by the new plane. This plane will be deleted automatically. If the parameter is omitted, the very first coordinate plane will be replaced. In case, there was no plane yet, the new plane will just be added. |
Definition at line 1224 of file KDChartChart.cpp.
References addCoordinatePlane(), d, and takeCoordinatePlane().
void Chart::replaceHeaderFooter | ( | HeaderFooter * | headerFooter, |
HeaderFooter * | oldHeaderFooter = nullptr |
||
) |
Replaces the old header (or footer, resp.), or appends the new header or footer, it there is none yet.
headerFooter | The header or footer to be used instead of the old one. This parameter must not be zero, or the method will do nothing. |
oldHeaderFooter | The header or footer to be removed by the new one. This header or footer will be deleted automatically. If the parameter is omitted, the very first header or footer will be replaced. In case, there was no header and no footer yet, the new header or footer will just be added. |
Definition at line 1461 of file KDChartChart.cpp.
References addHeaderFooter(), d, headerFooter(), and takeHeaderFooter().
Replaces the old legend, or appends the new legend, it there is none yet.
legend | The legend to be used instead of the old one. This parameter must not be zero, or the method will do nothing. |
oldLegend | The legend to be removed by the new one. This legend will be deleted automatically. If the parameter is omitted, the very first legend will be replaced. In case, there was no legend yet, the new legend will just be added. |
If you want to re-use the old legend, call takeLegend and addLegend, instead of using replaceLegend.
Definition at line 1626 of file KDChartChart.cpp.
References addLegend(), d, legend(), and takeLegend().
|
overrideprotected |
Adjusts the internal layout when the chart is resized.
Definition at line 1377 of file KDChartChart.cpp.
void Chart::setBackgroundAttributes | ( | const BackgroundAttributes & | a | ) |
Specify the background attributes to be used, by default there is no background.
To set a light blue background, you could do something like this:
KDChart::BackgroundAttributes backgroundAttrs( my_chart->backgroundAttributes() ); backgroundAttrs.setVisible( true ); backgroundAttrs.setBrush( QColor(0xd0,0xd0,0xff) ); my_chart->setBackgroundAttributes( backgroundAttrs );
Definition at line 1154 of file KDChartChart.cpp.
References d.
void Chart::setCoordinatePlaneLayout | ( | QLayout * | layout | ) |
Set the coordinate plane layout that should be used as model for the internal used layout. The layout needs to be an instance of QHBoxLayout or QVBoxLayout.
Definition at line 1165 of file KDChartChart.cpp.
References d.
void Chart::setFrameAttributes | ( | const FrameAttributes & | a | ) |
Specify the frame attributes to be used, by default is it a thin black line.
To hide the frame line, you could do something like this:
KDChart::FrameAttributes frameAttrs( my_chart->frameAttributes() ); frameAttrs.setVisible( false ); my_chart->setFrameAttributes( frameAttrs );
Definition at line 1144 of file KDChartChart.cpp.
References d.
Referenced by Chart().
void Chart::setGlobalLeading | ( | int | left, |
int | top, | ||
int | right, | ||
int | bottom | ||
) |
Set the padding between the margin of the widget and the area that the contents are drawn into.
left | The padding on the left side. |
top | The padding at the top. |
right | The padding on the left hand side. |
bottom | The padding on the bottom. |
Definition at line 1259 of file KDChartChart.cpp.
References setGlobalLeadingBottom(), setGlobalLeadingLeft(), setGlobalLeadingRight(), and setGlobalLeadingTop().
void Chart::setGlobalLeadingBottom | ( | int | leading | ) |
Set the padding between the start of the widget and the start of the area that is used for drawing on the bottom.
leading | The padding value. |
Definition at line 1303 of file KDChartChart.cpp.
References d.
Referenced by setGlobalLeading().
void Chart::setGlobalLeadingLeft | ( | int | leading | ) |
Set the padding between the start of the widget and the start of the area that is used for drawing on the left.
leading | The padding value. |
Definition at line 1267 of file KDChartChart.cpp.
References d.
Referenced by setGlobalLeading().
void Chart::setGlobalLeadingRight | ( | int | leading | ) |
Set the padding between the start of the widget and the start of the area that is used for drawing on the right.
leading | The padding value. |
Definition at line 1291 of file KDChartChart.cpp.
References d.
Referenced by setGlobalLeading().
void Chart::setGlobalLeadingTop | ( | int | leading | ) |
Set the padding between the start of the widget and the start of the area that is used for drawing at the top.
leading | The padding value. |
Definition at line 1279 of file KDChartChart.cpp.
References d.
Referenced by setGlobalLeading().
void Chart::setUseNewLayoutSystem | ( | bool | value | ) |
Definition at line 1784 of file KDChartChart.cpp.
References useNewLayoutSystem.
void Chart::takeCoordinatePlane | ( | AbstractCoordinatePlane * | plane | ) |
Removes the coordinate plane from the chart, without deleting it.
The chart no longer owns the plane, so it is the caller's responsibility to delete the plane.
Definition at line 1242 of file KDChartChart.cpp.
References d, propertiesChanged(), KDChart::AbstractLayoutItem::removeFromParentLayout(), and KDChart::AbstractCoordinatePlane::setParent().
Referenced by replaceCoordinatePlane().
void Chart::takeHeaderFooter | ( | HeaderFooter * | headerFooter | ) |
Removes the header (or footer, resp.) from the chart, without deleting it.
The chart no longer owns the header or footer, so it is the caller's responsibility to delete the header or footer.
Definition at line 1479 of file KDChartChart.cpp.
References d, KDChart::HeaderFooter::destroyedHeaderFooter(), headerFooter(), KDChart::AbstractLayoutItem::removeFromParentLayout(), and KDChart::AbstractLayoutItem::setParentLayout().
Referenced by replaceHeaderFooter().
void Chart::takeLegend | ( | Legend * | legend | ) |
Removes the legend from the chart, without deleting it.
The chart no longer owns the legend, so it is the caller's responsibility to delete the legend.
Definition at line 1643 of file KDChartChart.cpp.
References d, legend(), and propertiesChanged().
Referenced by replaceLegend().
bool Chart::useNewLayoutSystem | ( | ) | const |
useNewLayoutSystem Be very careful activating the new layout system, its still experimental and works only if the user knows what he is doing. The reason is that the system does not prevent the user from creating sharing graphs that are not layoutable in a plane and still needs assistance from the user.
Definition at line 1780 of file KDChartChart.cpp.
|
readwrite |
Definition at line 64 of file KDChartChart.h.
|
readwrite |
Definition at line 64 of file KDChartChart.h.
|
readwrite |
Definition at line 64 of file KDChartChart.h.
|
readwrite |
Definition at line 64 of file KDChartChart.h.
|
readwrite |
Definition at line 64 of file KDChartChart.h.
Referenced by setUseNewLayoutSystem().