Legend item to display categorical data. More...

#include <vtkCategoryLegend.h>

Inheritance diagram for vtkCategoryLegend:

Collaboration diagram for vtkCategoryLegend:

Public Types
enum	{ VERTICAL = 0 , HORIZONTAL }
	Enum of legend orientation types. More...

typedef vtkChartLegend	Superclass

Public Types inherited from vtkChartLegend
enum	{ LEFT = 0 , CENTER , RIGHT , TOP , BOTTOM , CUSTOM }

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCategoryLegend *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

bool	Paint (vtkContext2D *painter) override
	Paint the legend into a rectangle defined by the bounds. More...

vtkRectf	GetBoundingRect (vtkContext2D *painter) override
	Compute and return the lower left corner of this legend, along with its width and height. More...


virtual void	SetScalarsToColors (vtkScalarsToColors *stc)
	Get/Set the vtkScalarsToColors used to draw this legend. More...

virtual vtkScalarsToColors *	GetScalarsToColors ()
	Get/Set the vtkScalarsToColors used to draw this legend. More...


virtual vtkVariantArray *	GetValues ()
	Get/Set the array of values that will be represented by this legend. More...

virtual void	SetValues (vtkVariantArray *)
	Get/Set the array of values that will be represented by this legend. More...


virtual void	SetTitle (const vtkStdString &title)
	Get/set the title text of the legend. More...

virtual vtkStdString	GetTitle ()
	Get/set the title text of the legend. More...


virtual vtkStdString	GetOutlierLabel ()
	Get/set the label to use for outlier data. More...

virtual void	SetOutlierLabel (vtkStdString)
	Get/set the label to use for outlier data. More...

Public Member Functions inherited from vtkChartLegend
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkChartLegend *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetPoint (const vtkVector2f &point)
	Set point the legend box is anchored to. More...

const vtkVector2f &	GetPointVector ()
	Get point the legend box is anchored to. More...

virtual void	SetLabelSize (int size)
	Set the point size of the label text. More...

virtual int	GetLabelSize ()
	Get the point size of the label text. More...

void	SetChart (vtkChart *chart)
	Set the chart that the legend belongs to and will draw the legend for. More...

vtkChart *	GetChart ()
	Get the chart that the legend belongs to and will draw the legend for. More...

void	Update () override
	Update the geometry of the axis. More...

bool	Paint (vtkContext2D *painter) override
	Paint event for the axis, called whenever the axis needs to be drawn. More...

virtual vtkRectf	GetBoundingRect (vtkContext2D *painter)
	Request the space the legend requires to be drawn. More...

vtkPen *	GetPen ()
	Get the pen used to draw the legend outline. More...

vtkBrush *	GetBrush ()
	Get the brush used to draw the legend background. More...

vtkTextProperty *	GetLabelProperties ()
	Get the vtkTextProperty for the legend's labels. More...

bool	Hit (const vtkContextMouseEvent &mouse) override
	Return true if the supplied x, y coordinate is inside the item. More...

bool	MouseMoveEvent (const vtkContextMouseEvent &mouse) override
	Mouse move event. More...

bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
	Mouse button down event. More...

bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
	Mouse button release event. More...

virtual void	SetPoint (float, float)
	Set point the legend box is anchored to. More...

void	SetPoint (float[2])
	Set point the legend box is anchored to. More...

virtual float *	GetPoint ()
	Get point the legend box is anchored to. More...

virtual void	GetPoint (float &, float &)
	Get point the legend box is anchored to. More...

virtual void	GetPoint (float[2])
	Get point the legend box is anchored to. More...

virtual void	SetHorizontalAlignment (int)
	Set the horizontal alignment of the legend to the point specified. More...

virtual int	GetHorizontalAlignment ()
	Get the horizontal alignment of the legend to the point specified. More...

virtual void	SetVerticalAlignment (int)
	Set the vertical alignment of the legend to the point specified. More...

virtual int	GetVerticalAlignment ()
	Get the vertical alignment of the legend to the point specified. More...

virtual void	SetPadding (int)
	Set the padding between legend marks, default is 5. More...

virtual int	GetPadding ()
	Get the padding between legend marks. More...

virtual void	SetSymbolWidth (int)
	Set the symbol width, default is 15. More...

virtual int	GetSymbolWidth ()
	Get the legend symbol width. More...

virtual void	SetInline (bool)
	Get/set if the legend should be drawn inline (inside the chart), or not. More...

virtual bool	GetInline ()
	Get/set if the legend should be drawn inline (inside the chart), or not. More...

virtual void	SetDragEnabled (bool)
	Get/set if the legend can be dragged with the mouse button, or not. More...

virtual bool	GetDragEnabled ()
	Get/set if the legend can be dragged with the mouse button, or not. More...

virtual void	SetCacheBounds (bool)
	Toggle whether or not this legend should attempt to cache its position and size. More...

virtual bool	GetCacheBounds ()
	Toggle whether or not this legend should attempt to cache its position and size. More...

virtual void	CacheBoundsOn ()
	Toggle whether or not this legend should attempt to cache its position and size. More...

virtual void	CacheBoundsOff ()
	Toggle whether or not this legend should attempt to cache its position and size. More...

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item. More...

virtual double	GetOpacity ()
	Get the opacity of the item. More...

virtual void	SetOpacity (double)
	Set the opacity of the item. More...

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering. More...

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn. More...

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered. More...

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item. More...

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item. More...

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item. More...

bool	RemoveItem (vtkIdType index)
	Remove child item from this item. More...

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index. More...

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex. More...

vtkIdType	GetNumberOfItems ()
	Get the number of child items. More...

void	ClearItems ()
	Remove all child items from this item. More...

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack. More...

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling. More...

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack. More...

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling. More...

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item. More...

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse. More...

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event. More...

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event. More...

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event. More...

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event. More...

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event. More...

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel. More...

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event. More...

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event. More...

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene. More...

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene. More...

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item. More...

vtkAbstractContextItem *	GetParent ()
	Get the parent item. More...

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system. More...

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system. More...

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system. More...

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system. More...

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn). More...

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn). More...

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events). More...

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events). More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCategoryLegend *	SafeDownCast (vtkObjectBase *o)

static vtkCategoryLegend *	New ()

Static Public Member Functions inherited from vtkChartLegend
static vtkTypeBool	IsTypeOf (const char *type)

static vtkChartLegend *	SafeDownCast (vtkObjectBase *o)

static vtkChartLegend *	New ()
	Creates a 2D Chart object. More...

Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCategoryLegend ()

	~vtkCategoryLegend () override

Protected Member Functions inherited from vtkChartLegend
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkChartLegend ()

	~vtkChartLegend () override

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override=default

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	HasOutliers

float	TitleWidthOffset

vtkScalarsToColors *	ScalarsToColors

vtkStdString	OutlierLabel

vtkStdString	Title

vtkNew< vtkTextProperty >	TitleProperties

vtkVariantArray *	Values

Protected Attributes inherited from vtkChartLegend
float *	Point

int	HorizontalAlignment

int	VerticalAlignment

vtkNew< vtkPen >	Pen
	The pen used to draw the legend box. More...

vtkNew< vtkBrush >	Brush
	The brush used to render the background of the legend. More...

vtkNew< vtkTextProperty >	LabelProperties
	The text properties of the labels used in the legend. More...

bool	DragEnabled
	Should we move the legend box around in response to the mouse drag? More...

bool	CacheBounds
	Should the legend attempt to avoid recalculating its position & bounds unnecessarily? More...

int	Button
	Last button to be pressed. More...

vtkTimeStamp	PlotTime

vtkTimeStamp	RectTime

vtkRectf	Rect

int	Padding
	Padding between symbol and text. More...

int	SymbolWidth
	Width of the symbols in pixels in the legend. More...

bool	Inline
	Should the legend be drawn inline in its chart? More...

Private *	Storage

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null. More...

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null. More...

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc. More...

bool	Visible
	Store the visibility of the item (default is true). More...

bool	Interactive
	Store whether the item should respond to interactions (default is true). More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Legend item to display categorical data.

vtkCategoryLegend will display a label and color patch for each value in a categorical data set. To use this class, you must first populate a vtkScalarsToColors by using the SetAnnotation() method. The other input to this class is a vtkVariantArray. This should contain the annotated values from the vtkScalarsToColors that you wish to include within the legend.

Online Examples:

ReadLegacyUnstructuredGrid

Definition at line 60 of file vtkCategoryLegend.h.

Member Typedef Documentation

◆ Superclass

typedef vtkChartLegend vtkCategoryLegend::Superclass

Definition at line 63 of file vtkCategoryLegend.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of legend orientation types.

Enumerator
VERTICAL
HORIZONTAL

Definition at line 71 of file vtkCategoryLegend.h.

Constructor & Destructor Documentation

◆ vtkCategoryLegend()

vtkCategoryLegend::vtkCategoryLegend ( )

protected

◆ ~vtkCategoryLegend()

vtkCategoryLegend::~vtkCategoryLegend ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCategoryLegend::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkCategoryLegend::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkChartLegend.

◆ SafeDownCast()

static vtkCategoryLegend * vtkCategoryLegend::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCategoryLegend::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkChartLegend.

◆ NewInstance()

vtkCategoryLegend * vtkCategoryLegend::NewInstance ( ) const

◆ PrintSelf()

void vtkCategoryLegend::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

◆ New()

static vtkCategoryLegend * vtkCategoryLegend::New ( )

static

◆ Paint()

bool vtkCategoryLegend::Paint ( vtkContext2D * painter )

overridevirtual

Paint the legend into a rectangle defined by the bounds.

Reimplemented from vtkAbstractContextItem.

◆ GetBoundingRect()

vtkRectf vtkCategoryLegend::GetBoundingRect ( vtkContext2D * painter )

overridevirtual

Compute and return the lower left corner of this legend, along with its width and height.

Reimplemented from vtkChartLegend.

◆ SetScalarsToColors()

virtual void vtkCategoryLegend::SetScalarsToColors ( vtkScalarsToColors * stc )

virtual

Get/Set the vtkScalarsToColors used to draw this legend.

Since this legend represents categorical data, this vtkScalarsToColors must have been populated using SetAnnotation().

◆ GetScalarsToColors()

virtual vtkScalarsToColors * vtkCategoryLegend::GetScalarsToColors ( )

virtual

Get/Set the vtkScalarsToColors used to draw this legend.

Since this legend represents categorical data, this vtkScalarsToColors must have been populated using SetAnnotation().

◆ GetValues()

virtual vtkVariantArray * vtkCategoryLegend::GetValues ( )

virtual

Get/Set the array of values that will be represented by this legend.

This array must contain distinct annotated values from the ScalarsToColors. Each value in this array will be drawn as a separate entry within this legend.

◆ SetValues()

virtual void vtkCategoryLegend::SetValues ( vtkVariantArray * )

virtual

Get/Set the array of values that will be represented by this legend.

This array must contain distinct annotated values from the ScalarsToColors. Each value in this array will be drawn as a separate entry within this legend.

◆ SetTitle()

virtual void vtkCategoryLegend::SetTitle ( const vtkStdString & title )

virtual

Get/set the title text of the legend.

◆ GetTitle()

virtual vtkStdString vtkCategoryLegend::GetTitle ( )

virtual

Get/set the title text of the legend.

◆ GetOutlierLabel()

virtual vtkStdString vtkCategoryLegend::GetOutlierLabel ( )

virtual

Get/set the label to use for outlier data.

◆ SetOutlierLabel()

virtual void vtkCategoryLegend::SetOutlierLabel ( vtkStdString )

virtual

Get/set the label to use for outlier data.

Member Data Documentation

◆ HasOutliers

bool vtkCategoryLegend::HasOutliers

protected

Definition at line 129 of file vtkCategoryLegend.h.

◆ TitleWidthOffset

float vtkCategoryLegend::TitleWidthOffset

protected

Definition at line 130 of file vtkCategoryLegend.h.

◆ ScalarsToColors

vtkScalarsToColors* vtkCategoryLegend::ScalarsToColors

protected

Definition at line 131 of file vtkCategoryLegend.h.

◆ OutlierLabel

vtkStdString vtkCategoryLegend::OutlierLabel

protected

Definition at line 132 of file vtkCategoryLegend.h.

◆ Title

vtkStdString vtkCategoryLegend::Title

protected

Definition at line 133 of file vtkCategoryLegend.h.

◆ TitleProperties

vtkNew<vtkTextProperty> vtkCategoryLegend::TitleProperties

protected

Definition at line 134 of file vtkCategoryLegend.h.

◆ Values

vtkVariantArray* vtkCategoryLegend::Values

protected

Definition at line 135 of file vtkCategoryLegend.h.

The documentation for this class was generated from the following file:

Charts/Core/vtkCategoryLegend.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkCategoryLegend()

◆ ~vtkCategoryLegend()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Paint()

◆ GetBoundingRect()

◆ SetScalarsToColors()

◆ GetScalarsToColors()

◆ GetValues()

◆ SetValues()

◆ SetTitle()

◆ GetTitle()

◆ GetOutlierLabel()

◆ SetOutlierLabel()

Member Data Documentation

◆ HasOutliers

◆ TitleWidthOffset

◆ ScalarsToColors

◆ OutlierLabel

◆ Title

◆ TitleProperties

◆ Values