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
47#ifndef vtkCategoryLegend_h
48#define vtkCategoryLegend_h
49
50#include "vtkChartLegend.h"
51#include "vtkChartsCoreModule.h" // For export macro
52#include "vtkNew.h" // For vtkNew ivars
53#include "vtkStdString.h" // For vtkStdString ivars
54#include "vtkVector.h" // For vtkRectf
55
57class vtkTextProperty;
58class vtkVariantArray;
59
60class VTKCHARTSCORE_EXPORT vtkCategoryLegend : public vtkChartLegend
61{
62public:
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
71 enum
72 {
73 VERTICAL = 0,
74 HORIZONTAL
75 };
76
80 bool Paint(vtkContext2D* painter) override;
81
87
89
97
99
105 vtkGetMacro(Values, vtkVariantArray*);
106 vtkSetMacro(Values, vtkVariantArray*);
108
110
113 virtual void SetTitle(const vtkStdString& title);
116
118
121 vtkGetMacro(OutlierLabel, vtkStdString);
122 vtkSetMacro(OutlierLabel, vtkStdString);
124
125protected:
128
136
137private:
138 vtkCategoryLegend(const vtkCategoryLegend&) = delete;
139 void operator=(const vtkCategoryLegend&) = delete;
140};
141
142#endif
Legend item to display categorical data.
vtkScalarsToColors * ScalarsToColors
virtual vtkStdString GetTitle()
Get/set the title text of the legend.
vtkNew< vtkTextProperty > TitleProperties
~vtkCategoryLegend() override
virtual vtkScalarsToColors * GetScalarsToColors()
Get/Set the vtkScalarsToColors used to draw this legend.
static vtkCategoryLegend * New()
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.
draw the chart legend
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:73
a simple class to control print indentation
Definition: vtkIndent.h:113
Allocate and hold a VTK object.
Definition: vtkNew.h:165
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
represent text properties.
An array holding vtkVariants.