DefineColourList Class Reference

Inheritance diagram for DefineColourList:

Public Member Functions
def	__init__ (self)

Static Public Attributes
list	colours = ["red", "green", "blue", "orange", "cyan", "purple"]
	6 default colours used for the bargraph

Detailed Description

Defines the colourlist latex-command, which draws a bargraph with relative
fractions indicated by colours using tikz.
After including this object in you latex code the command \\bargraph is available.
You should include only one of these objects in your latex code.

Definition at line 228 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Calls super-class init, adds definition of colourlist to latex code.

Reimplemented from LatexObject.

Definition at line 239 of file b2latex.py.

    def __init__(self):
        """
        Calls super-class init, adds definition of colourlist to latex code.
        """
        super().__init__()
        self.output += r"\def\colourlist{{" + ', '.join(f'"{c}"' for c in self.colours) + r"}}" + '\n'
        self.output += r"""
            \tikzset{nodeStyle/.style={text height=\heightof{A},text depth=\depthof{g}, inner sep = 0pt, node distance = -0.15mm}}
            \newcount\colourindex \colourindex=-1
            \newcommand{\plotbar}[1]{
            \begin{tikzpicture}[start chain=going right, nodes = {font=\sffamily}]
              \global\colourindex=-1
              \foreach \percent/\name in {
                #1
              } {
                \ifx\percent\empty\else               % If \percent is empty, do nothing
                  \global\advance\colourindex by 1
                  \ifnum"""
        self.output += str(len(self.colours) - 1)
        self.output += r"""5<\colourindex  %back to first colour if we run out
                    \global\colourindex=0
                  \fi
                  \pgfmathparse{\colourlist[\the\colourindex]} % Get color from cycle list
                  \edef\color{\pgfmathresult}         %   and store as \color
                  \node[nodeStyle, draw, on chain, fill={\color!40}, minimum width=\percent*1.0, minimum height=12] {\name};
                \fi
              };
            \end{tikzpicture}
            }
            """
 
 

Member Data Documentation

colours

list colours = ["red", "green", "blue", "orange", "cyan", "purple"]

static

6 default colours used for the bargraph

Definition at line 237 of file b2latex.py.

---

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

• framework/scripts/B2Tools/b2latex.py