te::map::Chart Class Reference

This class represents the informations needed to build map charts. More...

#include <Chart.h>

Public Member Functions

 Chart (ChartType type, const std::vector< std::string > &properties)
 It constructs a new Chart instance. More...
 
 Chart (ChartType type, const std::vector< std::string > &properties, const std::vector< te::color::RGBAColor > &colors)
 It constructs a new Chart instance. More...
 
Chartclone ()
 
bool getAvoidConflicts () const
 
std::size_t getBarWidth () const
 
const te::color::RGBAColorgetColor (std::size_t i) const
 
const te::color::RGBAColorgetContourColor () const
 
std::size_t getContourWidth () const
 
std::size_t getHeight () const
 
double getMaxValue () const
 
const std::vector< std::string > & getProperties () const
 
const std::vector< size_t > & getPropertiesPos () const
 
std::string getSummary () const
 It gets the grouping summary. It is used only in case 1 to n. More...
 
ChartType getType () const
 
std::size_t getWidth () const
 
bool isVisible () const
 It gets the chart visibility. More...
 
void setAvoidConflicts (bool on)
 
void setBarWidth (std::size_t width)
 
void setColor (std::size_t i, const te::color::RGBAColor &color)
 
void setContourColor (const te::color::RGBAColor &color)
 
void setContourWidth (std::size_t width)
 
void setHeight (std::size_t height)
 
void setMaxValue (double value)
 
void setPropertiesPos (const std::vector< size_t > &propPos)
 
void setSummary (const std::string &summary)
 It gets the grouping summary. It is used only in case 1 to n. More...
 
void setVisibility (bool visible)
 It sets the chart visibility. More...
 
 ~Chart ()
 Destructor. More...
 

Private Attributes

bool m_avoidConflicts
 A flag that indicates if conflicts must be avoided. More...
 
std::size_t m_barWidth
 The bar width for char Bar type (in pixels). More...
 
std::vector< te::color::RGBAColorm_colors
 The color used to each property. More...
 
te::color::RGBAColor m_contourColor
 The chart contour color. More...
 
std::size_t m_contourWidth
 The chart contour width (in pixels). More...
 
std::size_t m_height
 The chart height (in pixels). More...
 
bool m_isVisible
 A flag that indicates if the chart is visible. More...
 
double m_maxValue
 The max value of the chart. More...
 
std::vector< std::string > m_properties
 The property names that will be used to generate the chart. More...
 
std::vector< size_t > m_propertiesPos
 The properties position. More...
 
std::string m_summary
 The summary used in case 1 to n. More...
 
ChartType m_type
 The chart type. More...
 

Detailed Description

This class represents the informations needed to build map charts.

See also
AbstractLayer

Definition at line 51 of file Chart.h.

Constructor & Destructor Documentation

◆ Chart() [1/2]

te::map::Chart::Chart ( ChartType  type,
const std::vector< std::string > &  properties 
)

It constructs a new Chart instance.

Parameters
typeThe chart type.
propertiesThe property names that will be used to generate the chart.

◆ Chart() [2/2]

te::map::Chart::Chart ( ChartType  type,
const std::vector< std::string > &  properties,
const std::vector< te::color::RGBAColor > &  colors 
)

It constructs a new Chart instance.

Parameters
typeThe chart type.
propertiesThe property names that will be used to generate the chart.
colorsThe colors that will be used to represent each property.

◆ ~Chart()

te::map::Chart::~Chart ( )

Destructor.

Member Function Documentation

◆ clone()

Chart* te::map::Chart::clone ( )

◆ getAvoidConflicts()

bool te::map::Chart::getAvoidConflicts ( ) const

◆ getBarWidth()

std::size_t te::map::Chart::getBarWidth ( ) const

◆ getColor()

const te::color::RGBAColor& te::map::Chart::getColor ( std::size_t  i) const

◆ getContourColor()

const te::color::RGBAColor& te::map::Chart::getContourColor ( ) const

◆ getContourWidth()

std::size_t te::map::Chart::getContourWidth ( ) const

◆ getHeight()

std::size_t te::map::Chart::getHeight ( ) const

◆ getMaxValue()

double te::map::Chart::getMaxValue ( ) const

◆ getProperties()

const std::vector<std::string>& te::map::Chart::getProperties ( ) const

◆ getPropertiesPos()

const std::vector<size_t>& te::map::Chart::getPropertiesPos ( ) const

◆ getSummary()

std::string te::map::Chart::getSummary ( ) const

It gets the grouping summary. It is used only in case 1 to n.

◆ getType()

ChartType te::map::Chart::getType ( ) const

◆ getWidth()

std::size_t te::map::Chart::getWidth ( ) const

◆ isVisible()

bool te::map::Chart::isVisible ( ) const

It gets the chart visibility.

◆ setAvoidConflicts()

void te::map::Chart::setAvoidConflicts ( bool  on)

◆ setBarWidth()

void te::map::Chart::setBarWidth ( std::size_t  width)

◆ setColor()

void te::map::Chart::setColor ( std::size_t  i,
const te::color::RGBAColor color 
)

◆ setContourColor()

void te::map::Chart::setContourColor ( const te::color::RGBAColor color)

◆ setContourWidth()

void te::map::Chart::setContourWidth ( std::size_t  width)

◆ setHeight()

void te::map::Chart::setHeight ( std::size_t  height)

◆ setMaxValue()

void te::map::Chart::setMaxValue ( double  value)

◆ setPropertiesPos()

void te::map::Chart::setPropertiesPos ( const std::vector< size_t > &  propPos)

◆ setSummary()

void te::map::Chart::setSummary ( const std::string &  summary)

It gets the grouping summary. It is used only in case 1 to n.

Parameters
summaryThe summary mode. It can be: "MIN", "MAX", "SUM", "AVERAGE", "MEDIAN", "STDDEV" or "VARIANCE"

◆ setVisibility()

void te::map::Chart::setVisibility ( bool  visible)

It sets the chart visibility.

Parameters
visibleThe visibility value.

Member Data Documentation

◆ m_avoidConflicts

bool te::map::Chart::m_avoidConflicts
private

A flag that indicates if conflicts must be avoided.

Definition at line 148 of file Chart.h.

◆ m_barWidth

std::size_t te::map::Chart::m_barWidth
private

The bar width for char Bar type (in pixels).

Definition at line 145 of file Chart.h.

◆ m_colors

std::vector<te::color::RGBAColor> te::map::Chart::m_colors
private

The color used to each property.

Definition at line 141 of file Chart.h.

◆ m_contourColor

te::color::RGBAColor te::map::Chart::m_contourColor
private

The chart contour color.

Definition at line 142 of file Chart.h.

◆ m_contourWidth

std::size_t te::map::Chart::m_contourWidth
private

The chart contour width (in pixels).

Definition at line 143 of file Chart.h.

◆ m_height

std::size_t te::map::Chart::m_height
private

The chart height (in pixels).

Definition at line 144 of file Chart.h.

◆ m_isVisible

bool te::map::Chart::m_isVisible
private

A flag that indicates if the chart is visible.

Definition at line 146 of file Chart.h.

◆ m_maxValue

double te::map::Chart::m_maxValue
private

The max value of the chart.

Definition at line 147 of file Chart.h.

◆ m_properties

std::vector<std::string> te::map::Chart::m_properties
private

The property names that will be used to generate the chart.

Definition at line 139 of file Chart.h.

◆ m_propertiesPos

std::vector<size_t> te::map::Chart::m_propertiesPos
private

The properties position.

Definition at line 140 of file Chart.h.

◆ m_summary

std::string te::map::Chart::m_summary
private

The summary used in case 1 to n.

Definition at line 149 of file Chart.h.

◆ m_type

ChartType te::map::Chart::m_type
private

The chart type.

Definition at line 138 of file Chart.h.


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