VTK  9.2.5
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 
50 #ifndef vtkCategoryLegend_h
51 #define vtkCategoryLegend_h
52 
53 #include "vtkChartLegend.h"
54 #include "vtkChartsCoreModule.h" // For export macro
55 #include "vtkNew.h" // For vtkNew ivars
56 #include "vtkStdString.h" // For vtkStdString ivars
57 #include "vtkVector.h" // For vtkRectf
58 
59 class vtkScalarsToColors;
60 class vtkTextProperty;
61 class vtkVariantArray;
62 
63 class VTKCHARTSCORE_EXPORT vtkCategoryLegend : public vtkChartLegend
64 {
65 public:
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
70 
74  enum
75  {
76  VERTICAL = 0,
77  HORIZONTAL
78  };
79 
83  bool Paint(vtkContext2D* painter) override;
84 
90 
92 
100 
102 
108  vtkGetObjectMacro(Values, vtkVariantArray);
109  virtual void SetValues(vtkVariantArray*);
111 
113 
116  virtual void SetTitle(const vtkStdString& title);
119 
121 
124  vtkGetMacro(OutlierLabel, vtkStdString);
125  vtkSetMacro(OutlierLabel, vtkStdString);
127 
128 protected:
130  ~vtkCategoryLegend() override;
131 
139 
140 private:
141  vtkCategoryLegend(const vtkCategoryLegend&) = delete;
142  void operator=(const vtkCategoryLegend&) = delete;
143 };
144 
145 #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
virtual void SetValues(vtkVariantArray *)
Get/Set the array of values that will be represented by this legend.
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:77
a simple class to control print indentation
Definition: vtkIndent.h:119
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:108
represent text properties.
An array holding vtkVariants.
@ title
Definition: vtkX3D.h:506