aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
gum::dot::DotStyle Class Reference

The look shared by all the graphs: size, direction, layout, colors of the arcs and of the nodes. More...

#include <agrum/base/core/dot/dotStyle.h>

Inheritance diagram for gum::dot::DotStyle:
[legend]

Static Public Member Functions

static DotStyle read ()
 the style of the graphs of the section notebook
static DotStyle readCredalNet ()
 the style of the credal networks : the colors of the nodes are the ones of the section credalnet

Public Attributes

std::string size
 graphviz size of the graph, in inches (5, or 12! for an exact size)
std::string rankDir
 direction of the layout : TB (top-bottom) or LR (left-right)
std::string layout
 graphviz layout engine (dot, neato...)
std::string arcColor
 color of the arcs and edges, and of the border of the nodes
std::string nodeBgColor
 background color of the nodes
std::string nodeFgColor
 font color of the nodes

Detailed Description

The look shared by all the graphs: size, direction, layout, colors of the arcs and of the nodes.

read() gives the style of the graphs drawn in a notebook (keys of the section notebook).

Definition at line 76 of file dotStyle.h.

Member Function Documentation

◆ read()

DotStyle gum::dot::DotStyle::read ( )
static

the style of the graphs of the section notebook

Definition at line 89 of file dotStyle.cpp.

89{ return _notebook_(); }

Referenced by gum::BayesNetFragment< GUM_SCALAR >::toDot(), gum::DiGraph::toDot(), gum::EssentialGraph::toDot(), gum::IMarkovRandomField< GUM_SCALAR >::toDot(), gum::MarkovBlanket::toDot(), gum::MixedGraph::toDot(), gum::PAG::toDot(), gum::PDAG::toDot(), and gum::UndiGraph::toDot().

Here is the caller graph for this function:

◆ readCredalNet()

DotStyle gum::dot::DotStyle::readCredalNet ( )
static

the style of the credal networks : the colors of the nodes are the ones of the section credalnet

Definition at line 91 of file dotStyle.cpp.

91 {
92 DotStyle style = _notebook_();
93 style.nodeBgColor = _str_("credalnet", "nodeBgColor");
94 style.nodeFgColor = configFgColor("credalnet", "nodeFgColor");
95 return style;
96 }
std::string configFgColor(std::string_view section, std::string_view key)
A font color of the configuration, resolved against the background color which goes with it.
Definition dotStyle.cpp:78

References gum::dot::configFgColor(), nodeBgColor, and nodeFgColor.

Referenced by gum::credal::CredalNet< GUM_SCALAR >::toDot().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ arcColor

std::string gum::dot::DotStyle::arcColor

color of the arcs and edges, and of the border of the nodes

Definition at line 84 of file dotStyle.h.

Referenced by gum::CausalModel< GUM_SCALAR >::_toDot_(), gum::dot::nodeAttributes(), gum::dot::FactorGraphDotStyle::read(), and gum::dot::writePreamble().

◆ layout

std::string gum::dot::DotStyle::layout

graphviz layout engine (dot, neato...)

Definition at line 82 of file dotStyle.h.

Referenced by gum::dot::FactorGraphDotStyle::read(), and gum::dot::writePreamble().

◆ nodeBgColor

◆ nodeFgColor

std::string gum::dot::DotStyle::nodeFgColor

font color of the nodes

Definition at line 88 of file dotStyle.h.

Referenced by gum::dot::CausalDotStyle::read(), gum::dot::FactorGraphDotStyle::read(), readCredalNet(), and gum::dot::writePreamble().

◆ rankDir

std::string gum::dot::DotStyle::rankDir

direction of the layout : TB (top-bottom) or LR (left-right)

Definition at line 80 of file dotStyle.h.

Referenced by gum::dot::writePreamble().

◆ size

std::string gum::dot::DotStyle::size

graphviz size of the graph, in inches (5, or 12! for an exact size)

Definition at line 78 of file dotStyle.h.

Referenced by gum::dot::CausalDotStyle::read(), gum::dot::DynamicBNDotStyle::read(), gum::dot::InfluenceDiagramDotStyle::read(), gum::dot::JunctionTreeDotStyle::read(), and gum::dot::writePreamble().


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