VTK  9.1.0
vtkCategoryLegend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCategoryLegend.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
28 #ifndef vtkCategoryLegend_h
29 #define vtkCategoryLegend_h
30 
31 #include "vtkChartLegend.h"
32 #include "vtkChartsCoreModule.h" // For export macro
33 #include "vtkNew.h" // For vtkNew ivars
34 #include "vtkStdString.h" // For vtkStdString ivars
35 #include "vtkVector.h" // For vtkRectf
36 
37 class vtkScalarsToColors;
38 class vtkTextProperty;
39 class vtkVariantArray;
40 
41 class VTKCHARTSCORE_EXPORT vtkCategoryLegend : public vtkChartLegend
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
48 
52  enum
53  {
54  VERTICAL = 0,
55  HORIZONTAL
56  };
57 
61  bool Paint(vtkContext2D* painter) override;
62 
68 
70 
78 
80 
86  vtkGetMacro(Values, vtkVariantArray*);
87  vtkSetMacro(Values, vtkVariantArray*);
89 
91 
94  virtual void SetTitle(const vtkStdString& title);
97 
99 
102  vtkGetMacro(OutlierLabel, vtkStdString);
103  vtkSetMacro(OutlierLabel, vtkStdString);
105 
106 protected:
108  ~vtkCategoryLegend() override;
109 
117 
118 private:
119  vtkCategoryLegend(const vtkCategoryLegend&) = delete;
120  void operator=(const vtkCategoryLegend&) = delete;
121 };
122 
123 #endif
Legend item to display categorical data.
vtkScalarsToColors * ScalarsToColors
virtual vtkScalarsToColors * GetScalarsToColors()
Get/Set the vtkScalarsToColors used to draw this legend.
virtual vtkStdString GetTitle()
Get/set the title text of the legend.
vtkNew< vtkTextProperty > TitleProperties
~vtkCategoryLegend() override
vtkVariantArray * Values
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool Paint(vtkContext2D *painter) override
Paint the legend into a rectangle defined by the bounds.
vtkStdString OutlierLabel
virtual void SetScalarsToColors(vtkScalarsToColors *stc)
Get/Set the vtkScalarsToColors used to draw this legend.
vtkRectf GetBoundingRect(vtkContext2D *painter) override
Compute and return the lower left corner of this legend, along with its width and height.
virtual void SetTitle(const vtkStdString &title)
Get/set the title text of the legend.
static vtkCategoryLegend * New()
draw the chart legend
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:54
a simple class to control print indentation
Definition: vtkIndent.h:34
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:36
represent text properties.
An array holding vtkVariants.
@ title
Definition: vtkX3D.h:506