Q3DTheme Class

Q3DTheme class provides a visual style for graphs. More...

Header: #include <Q3DTheme>
CMake: find_package(Qt6 REQUIRED COMPONENTS DataVisualization)
target_link_libraries(mytarget PRIVATE Qt6::DataVisualization)
qmake: QT += datavisualization
Since: QtDataVisualization 1.0
Instantiated By: Theme3D

Public Types

enum ColorStyle { ColorStyleUniform, ColorStyleObjectGradient, ColorStyleRangeGradient }
enum Theme { ThemeQt, ThemePrimaryColors, ThemeDigia, ThemeStoneMoss, ThemeArmyBlue, …, ThemeUserDefined }

Properties

Public Functions

virtual ~Q3DTheme()
float ambientLightStrength() const
QColor backgroundColor() const
QList<QColor> baseColors() const
QList<QLinearGradient> baseGradients() const
ColorStyle colorStyle() const
QFont font() const
QColor gridLineColor() const
float highlightLightStrength() const
bool isBackgroundEnabled() const
bool isGridEnabled() const
bool isLabelBackgroundEnabled() const
bool isLabelBorderEnabled() const
QColor labelBackgroundColor() const
QColor labelTextColor() const
QColor lightColor() const
float lightStrength() const
QColor multiHighlightColor() const
QLinearGradient multiHighlightGradient() const
void setAmbientLightStrength()
void setBackgroundColor()
void setBackgroundEnabled()
void setBaseColors()
void setBaseGradients()
void setColorStyle()
void setFont()
void setGridEnabled()
void setGridLineColor()
void setHighlightLightStrength()
void setLabelBackgroundColor()
void setLabelBackgroundEnabled()
void setLabelBorderEnabled()
void setLabelTextColor()
void setLightColor()
void setLightStrength()
void setMultiHighlightColor()
void setMultiHighlightGradient()
void setSingleHighlightColor()
void setSingleHighlightGradient()
void setType()
void setWindowColor()
QColor singleHighlightColor() const
QLinearGradient singleHighlightGradient() const
Theme type() const
QColor windowColor() const

Signals

Detailed Description

Specifies visual properties that affect the whole graph. There are several built-in themes that can be used as is or modified freely.

The following properties can be overridden by using QAbstract3DSeries properties to set them explicitly in the series: baseColors, baseGradients, and colorStyle.

Themes can be created from scratch using the ThemeUserDefined enum value. Creating a theme using the default constructor produces a new user-defined theme.

Default Theme

The following table lists the properties controlled by themes and the default values for ThemeUserDefined.

PropertyDefault Value
ambientLightStrength0.25
backgroundColorQt::black
backgroundEnabledtrue
baseColorsQt::black
baseGradientsQLinearGradient. Essentially fully black.
colorStyleColorStyleUniform
fontQFont
gridEnabledtrue
gridLineColorQt::white
highlightLightStrength7.5
labelBackgroundColorQt::gray
labelBackgroundEnabledtrue
labelBorderEnabledtrue
labelTextColorQt::white
lightColorQt::white
lightStrength5.0
multiHighlightColorQt::blue
multiHighlightGradientQLinearGradient. Essentially fully black.
singleHighlightColorQt::red
singleHighlightGradientQLinearGradient. Essentially fully black.
windowColorQt::black

Usage Examples

Creating a built-in theme without any modifications:

 Q3DTheme *theme = new Q3DTheme(Q3DTheme::ThemeQt);

Creating a built-in theme and modifying some properties:

 Q3DTheme *theme = new Q3DTheme(Q3DTheme::ThemeQt);
 theme->setBackgroundEnabled(false);
 theme->setLabelBackgroundEnabled(false);

Creating a user-defined theme:

 Q3DTheme *theme = new Q3DTheme();
 theme->setAmbientLightStrength(0.3f);
 theme->setBackgroundColor(QColor(QRgb(0x99ca53)));
 theme->setBackgroundEnabled(true);
 theme->setBaseColor(QColor(QRgb(0x209fdf)));
 theme->setColorStyle(Q3DTheme::ColorStyleUniform);
 theme->setFont(QFont(QStringLiteral("Impact"), 35));
 theme->setGridEnabled(true);
 theme->setGridLineColor(QColor(QRgb(0x99ca53)));
 theme->setHighlightLightStrength(7.0f);
 theme->setLabelBackgroundColor(QColor(0xf6, 0xa6, 0x25, 0xa0));
 theme->setLabelBackgroundEnabled(true);
 theme->setLabelBorderEnabled(true);
 theme->setLabelTextColor(QColor(QRgb(0x404044)));
 theme->setLightColor(Qt::white);
 theme->setLightStrength(6.0f);
 theme->setMultiHighlightColor(QColor(QRgb(0x6d5fd5)));
 theme->setSingleHighlightColor(QColor(QRgb(0xf6a625)));
 theme->setWindowColor(QColor(QRgb(0xffffff)));

Creating a built-in theme and modifying some properties after it has been set:

 Q3DBars *graph = new Q3DBars();
 graph->activeTheme()->setType(Q3DTheme::ThemePrimaryColors);
 graph->activeTheme()->setBaseColor(Qt::red);
 graph->activeTheme()->setSingleHighlightColor(Qt::yellow);

Member Type Documentation

enum Q3DTheme::ColorStyle

Color styles.

ConstantValueDescription
Q3DTheme::ColorStyleUniform0Objects are rendered in a single color. The color used is specified in baseColors, singleHighlightColor and multiHighlightColor properties.
Q3DTheme::ColorStyleObjectGradient1Objects are colored using a full gradient for each object regardless of object height. The gradient used is specified in baseGradients, singleHighlightGradient and multiHighlightGradient properties.
Q3DTheme::ColorStyleRangeGradient2Objects are colored using a portion of the full gradient determined by the object's height and its position on the Y-axis. The gradient used is specified in baseGradients, singleHighlightGradient and multiHighlightGradient properties.

enum Q3DTheme::Theme

Built-in themes.

ConstantValueDescription
Q3DTheme::ThemeQt0A light theme with green as the base color.
Q3DTheme::ThemePrimaryColors1A light theme with yellow as the base color.
Q3DTheme::ThemeDigia2A light theme with gray as the base color.
Q3DTheme::ThemeStoneMoss3A medium dark theme with yellow as the base color.
Q3DTheme::ThemeArmyBlue4A medium light theme with blue as the base color.
Q3DTheme::ThemeRetro5A medium light theme with brown as the base color.
Q3DTheme::ThemeEbony6A dark theme with white as the base color.
Q3DTheme::ThemeIsabelle7A dark theme with yellow as the base color.
Q3DTheme::ThemeUserDefined8A user-defined theme. For more information, see Default Theme.

Property Documentation

ambientLightStrength : float

This property holds the ambient light strength for the whole graph.

This value determines how evenly and brightly the colors are shown throughout the graph regardless of the light position.

The value must be between 0.0f and 1.0f.

Access functions:

float ambientLightStrength() const
void setAmbientLightStrength()

Notifier signal:

void ambientLightStrengthChanged()

backgroundColor : QColor

This property holds the color of the graph background.

Access functions:

QColor backgroundColor() const
void setBackgroundColor()

Notifier signal:

void backgroundColorChanged()

backgroundEnabled : bool

This property holds whether the background is visible.

The background is drawn by using the value of backgroundColor.

Access functions:

bool isBackgroundEnabled() const
void setBackgroundEnabled()

Notifier signal:

void backgroundEnabledChanged()

baseColors : QList<QColor>

This property holds the list of base colors to be used for all the objects in the graph, series by series.

If there are more series than colors, the color list wraps and starts again with the first color in the list.

Has no immediate effect if colorStyle is not ColorStyleUniform.

This value can be overridden by setting the baseColor explicitly in the series.

Access functions:

QList<QColor> baseColors() const
void setBaseColors()

Notifier signal:

void baseColorsChanged()

baseGradients : QList<QLinearGradient>

This property holds the list of base gradients to be used for all the objects in the graph, series by series.

If there are more series than gradients, the gradient list wraps and starts again with the first gradient in the list

Has no immediate effect if colorStyle is ColorStyleUniform.

This value can be overridden by setting the baseGradient explicitly in the series.

Access functions:

QList<QLinearGradient> baseGradients() const
void setBaseGradients()

Notifier signal:

void baseGradientsChanged()

colorStyle : ColorStyle

This property holds the style of the graph colors.

One of the ColorStyle enum values.

This value can be overridden by setting colorStyle explicitly in the series.

Access functions:

ColorStyle colorStyle() const
void setColorStyle()

Notifier signal:

void colorStyleChanged()

font : QFont

This property holds the font to be used for labels.

Access functions:

QFont font() const
void setFont()

Notifier signal:

void fontChanged()

gridEnabled : bool

This property holds whether the grid lines are drawn.

This value affects all grid lines.

Access functions:

bool isGridEnabled() const
void setGridEnabled()

Notifier signal:

void gridEnabledChanged()

gridLineColor : QColor

This property holds the color of the grid lines.

Note: Transparency is not supported and will result in undefined behavior.

Access functions:

QColor gridLineColor() const
void setGridLineColor()

Notifier signal:

void gridLineColorChanged()

highlightLightStrength : float

This property holds the specular light strength for selected objects.

The value must be between 0.0f and 10.0f.

Access functions:

float highlightLightStrength() const
void setHighlightLightStrength()

Notifier signal:

void highlightLightStrengthChanged()

labelBackgroundColor : QColor

This property holds the color of the label backgrounds.

Has no effect if labelBackgroundEnabled is false.

Access functions:

QColor labelBackgroundColor() const
void setLabelBackgroundColor()

Notifier signal:

void labelBackgroundColorChanged()

labelBackgroundEnabled : bool

This property holds whether the label is drawn with a color background or with a fully transparent background.

The labelBackgroundColor value (including alpha) is used for drawing the background.

Labels with a background are drawn to equal sizes per axis based on the longest label, and the text is centered in them. Labels without a background are drawn as is and are left or right aligned based on their position in the graph.

Access functions:

bool isLabelBackgroundEnabled() const
void setLabelBackgroundEnabled()

Notifier signal:

void labelBackgroundEnabledChanged()

labelBorderEnabled : bool

This property holds whether label borders are drawn for labels that have a background.

Has no effect if labelBackgroundEnabled is false.

Access functions:

bool isLabelBorderEnabled() const
void setLabelBorderEnabled()

Notifier signal:

void labelBorderEnabledChanged()

labelTextColor : QColor

This property holds the color of the font used for labels.

Access functions:

QColor labelTextColor() const
void setLabelTextColor()

Notifier signal:

void labelTextColorChanged()

lightColor : QColor

This property holds the color for the ambient and specular light.

This value affects the light specified in Q3DScene.

Access functions:

QColor lightColor() const
void setLightColor()

Notifier signal:

void lightColorChanged()

lightStrength : float

This property holds the specular light strength for the whole graph.

The value must be between 0.0f and 10.0f.

This value affects the light specified in Q3DScene.

Access functions:

float lightStrength() const
void setLightStrength()

Notifier signal:

void lightStrengthChanged()

multiHighlightColor : QColor

This property holds the highlight color for selected objects.

Used if selectionMode has the QAbstract3DGraph::SelectionRow or QAbstract3DGraph::SelectionColumn flag set.

Access functions:

QColor multiHighlightColor() const
void setMultiHighlightColor()

Notifier signal:

void multiHighlightColorChanged()

multiHighlightGradient : QLinearGradient

This property holds the highlight gradient for selected objects.

Used if selectionMode has the QAbstract3DGraph::SelectionRow or QAbstract3DGraph::SelectionColumn flag set.

Access functions:

QLinearGradient multiHighlightGradient() const
void setMultiHighlightGradient()

Notifier signal:

void multiHighlightGradientChanged()

singleHighlightColor : QColor

This property holds the highlight color for a selected object.

Used if selectionMode has the QAbstract3DGraph::SelectionItem flag set.

Access functions:

QColor singleHighlightColor() const
void setSingleHighlightColor()

Notifier signal:

void singleHighlightColorChanged()

singleHighlightGradient : QLinearGradient

This property holds the highlight gradient for a selected object.

Used if selectionMode has the QAbstract3DGraph::SelectionItem flag set.

Access functions:

QLinearGradient singleHighlightGradient() const
void setSingleHighlightGradient()

Notifier signal:

void singleHighlightGradientChanged()

type : Theme

This property holds the type of the theme.

The type is automatically set when constructing a theme, but can also be changed later. Changing the theme type will change all other properties of the theme to what the predefined theme specifies. Changing the theme type of the active theme of the graph will also reset all attached series to use the new theme.

Access functions:

Theme type() const
void setType()

Notifier signal:

void typeChanged()

windowColor : QColor

This property holds the color of the application window the graph is drawn into.

Access functions:

QColor windowColor() const
void setWindowColor()

Notifier signal:

void windowColorChanged()

Member Function Documentation

[virtual] Q3DTheme::~Q3DTheme()

Destroys the theme.