mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2025-01-12 17:00:32 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
jkriege2 2015-08-02 13:39:26 +02:00
parent c4a217a500
commit c922e59d90
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -9,7 +9,7 @@ This section assembles some simple examples of usage. You can find more (complex
###Very simple line-graph ###Very simple line-graph
This project (see `./test/jkqtplotter_simpletest/`) simply creates a JKQtPlotter widget (as a new window) and adds a single line-graph (a sine-wave). This project (see `./test/jkqtplotter_simpletest/`) simply creates a JKQtPlotter widget (as a new window) and adds a single line-graph (a sine-wave).
The QMake project looks like this: The QMake project looks like this (see `./test/jkqtplotter_simpletest/jkqtplotter_simpletest.pro`):
```qmake ```qmake
# source code for this simple demo # source code for this simple demo
SOURCES = jkqtplotter_simpletest.cpp SOURCES = jkqtplotter_simpletest.cpp
@ -25,7 +25,7 @@ TARGET = jkqtplotter_simpletest
# include JKQtPlotter source code # include JKQtPlotter source code
include(../../jkqtplotter.pri) include(../../jkqtplotter.pri)
``` ```
And the soruce code of the main application is: And the soruce code of the main application is (see `./test/jkqtplotter_simpletest/jkqtplotter_simpletest.cpp`):
```c++ ```c++
#include <QApplication> #include <QApplication>
#include "jkqtplotter.h" #include "jkqtplotter.h"
@ -35,7 +35,8 @@ int main(int argc, char* argv[])
{ {
QApplication app(argc, argv); QApplication app(argc, argv);
// 1. create a plotter window and get a pointer to the internal datastore (for convenience) // 1. create a plotter window and get a pointer to the internal datastore
// (for convenience)
JKQtPlotter plot; JKQtPlotter plot;
JKQTPdatastore* ds=plot.getDatastore(); JKQTPdatastore* ds=plot.getDatastore();
@ -48,11 +49,13 @@ int main(int argc, char* argv[])
Y<<sin(x); Y<<sin(x);
} }
// 3. make data available to JKQtPlotter by adding it to the internal datastore. // 3. make data available to JKQtPlotter by adding it to the internal
// Note: In this step the data is copied (of not specified otherwise), so you can // datastore.
// reuse X and Y afterwards! // Note: In this step the data is copied (of not specified otherwise), so
// the variables columnX and columnY will contain the internal column ID of the newly // you can reuse X and Y afterwards!
// created columns with names "x" and "y" and the (copied) data from X and Y. // The variables columnX and columnY will contain the internal column ID
// of the newlycreated columns with names "x" and "y" and the (copied)
// data from X and Y.
size_t columnX=ds->addCopiedColumn(X, "x"); size_t columnX=ds->addCopiedColumn(X, "x");
size_t columnY=ds->addCopiedColumn(Y, "y"); size_t columnY=ds->addCopiedColumn(Y, "y");