QmitkChartWidget.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/
#ifndef QmitkC3jsWidget_h
#define QmitkC3jsWidget_h

#include <map>
#include <memory>
#include <QWidget>

#include <MitkChartExports.h>

class QmitkChartxyData;

class MITKCHART_EXPORT QmitkChartWidget : public QWidget
{
  Q_OBJECT

public:
  enum class ChartType {
    bar, 
    line, 
    spline, 
    pie, 
    area, 
    area_spline, 
    scatter 
  };
  enum class ColorTheme {
    darkstyle, 
    lightstyle 
  };
  enum class LineStyle {
    solid,
    dashed
  };
  enum class MarkerSymbol {
    circle,
    diamond,
    cross,
    square,
    pentagon,
    star,
    x,
    diamond_tall,
    star_diamond,
    star_triangle_up,
    star_triangle_down,
    asterisk,
    cross_thin,
    x_thin
  };
  enum class ChartColor {
    red,
    orange,
    yellow,
    green,
    blue,
    purple,
    brown,
    magenta,
    tan,
    cyan,
    olive,
    maroon,
    navy,
    aquamarine,
    turqouise,
    silver,
    lime,
    teal,
    indigo,
    violet,
    pink,
    black,
    white,
    grey
  };
  enum class AxisScale {
    linear,
    log
  };

  enum class LegendPosition {
    bottomMiddle,
    bottomRight,
    topRight,
    topLeft,
    middleRight
  };

  explicit QmitkChartWidget(QWidget* parent = nullptr);
  //for UnitTests
  explicit QmitkChartWidget(QWidget *parent, bool unitTest);
  ~QmitkChartWidget() override;

  void AddData1D(const std::vector<double>& data1D, const std::string& label, ChartType chartType = ChartType::bar);

  void UpdateData1D(const std::vector<double> &data1D, const std::string &label);

  void UpdateData2D(const std::vector< std::pair<double, double> > &data2D, const std::string &label);

  void UpdateChartExampleData(const std::vector< std::pair<double, double> >& data2D,
                              const std::string& label,
                              const std::string& type,
                              const std::string& color,
                              const std::string& lineStyle,
                              const std::string& pieLabelsData = 0);

  void AddData2D(const std::vector< std::pair<double, double> > &data2D,
                 const std::string &label,
                 ChartType chartType = ChartType::bar);

  //Add Function for the ChartExample
  void AddChartExampleData(const std::vector< std::pair<double, double> >& data2D,
                           const std::string& label,
                           const std::string& type,
                           const std::string& color,
                           const std::string& style,
                           const std::string& pieLabelsData = 0);

  void RemoveData(const std::string& label);

  void UpdateLabel(const std::string& existingLabel, const std::string& newLabel);

  QmitkChartxyData *GetDataElementByLabel(const std::string& label) const;

  void SetColor(const std::string& label, const std::string& colorName);

  void SetLineStyle(const std::string& label, LineStyle style);

  void SetMarkerSymbol(const std::string &label, MarkerSymbol symbol);

  void SetYAxisScale(AxisScale scale);

  void SetXAxisLabel(const std::string& label);

  void SetYAxisLabel(const std::string& label);

  void SetPieLabels(const std::vector<std::string> &pieLabels, const std::string &label);
  void SetTitle(const std::string &title);

  void SetChartType(const std::string& label, ChartType type);
  void SetXErrorBars(const std::string &label, const std::vector<double> &errorPlus, const std::vector<double>& errorMinus = std::vector<double>());

  void SetYErrorBars(const std::string &label, const std::vector<double> &errorPlus, const std::vector<double> &errorMinus = std::vector<double>());

  void SetLegendPosition(LegendPosition position);

  void SetShowLegend(bool show);

  void SetStackedData(bool stacked);

  void Show(bool showSubChart=false);

  void SetShowDataPoints(bool showDataPoints);

  void Clear();

  void SetTheme(ColorTheme themeEnabled);

  void SetShowSubchart(bool showSubChart);

  void SetShowErrorBars(bool showErrorBars);

  void SetMinMaxValueXView(double minValueX,double maxValueX);
  void SetMinMaxValueYView(double minValueY, double maxValueY);

  void Reload();

  QSize sizeHint() const override;

  void SavePlotAsImage();

public slots:
  void OnLoadFinished(bool isLoadSuccessful);
  void OnPageSuccessfullyLoaded();

signals:
  void PageSuccessfullyLoaded();

private:
  std::string convertBooleanValue(bool value) const;

  class Impl;
  std::unique_ptr<Impl> m_Impl;
};

#endif