Skip to content

Labels

GenericLabelBuilder

Source code in itfit/plot/labels.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
class GenericLabelBuilder:
    def __init__(self, plot_builder: PlotBuilder, label: str):
        """Abstract label builder. Use xLabelBuilder, yLabelBuilder or titleLabelBuilder.

        Args:
            plot_builder (itfit.plot.PlotBuilder): PlotBuilder instance.
            label (str): Label string.
        """
        self._plot_builder_ = plot_builder
        self._label_ = label
        self._dict_: dict[str, object] = {}

    def fontsize(self, size):
        """Sets label fontsize.

        Args:
            size (float): Size of the label.

        Returns:
            (itfit.plot.labels.GenericLabelBuilder): Returns itself.
        """
        self._dict_.update({'fontsize': size})
        return self

    def fontweight(self, weight):
        """TODO:

        Args:
            weight (_type_): _description_

        Returns:
            (itfit.plot.labels.GenericLabelBuilder): Returns itself.
        """
        self._dict_.update({'fontweight': weight})
        return self

    def color(self, color):
        """Sets the color of the label.

        Args:
            color (str|tuple[float]): Color for the label.

        Returns:
            (itfit.plot.labels.GenericLabelBuilder): Returns itself.
        """
        self._dict_.update({'color': color})
        return self

    def verticalalignment(self, loc):
        """TODO:

        Args:
            loc (_type_): _description_

        Returns:
            (itfit.plot.labels.GenericLabelBuilder): Returns itself.
        """
        self._dict_.update({'verticalalignment': loc})
        return self

    def horizontalalignment(self, loc):
        """TODO

        Args:
            loc (_type_): _description_

        Returns:
            (itfit.plot.labels.GenericLabelBuilder): Returns itself.
        """
        self._dict_.update({'horizontalalignment': loc})
        return self

__init__(plot_builder, label)

Abstract label builder. Use xLabelBuilder, yLabelBuilder or titleLabelBuilder.

Parameters:

Name Type Description Default
plot_builder itfit.plot.PlotBuilder

PlotBuilder instance.

 required
label str

Label string.

 required
Source code in itfit/plot/labels.py 
72
73
74
75
76
77
78
79
80
81
def __init__(self, plot_builder: PlotBuilder, label: str):
    """Abstract label builder. Use xLabelBuilder, yLabelBuilder or titleLabelBuilder.

    Args:
        plot_builder (itfit.plot.PlotBuilder): PlotBuilder instance.
        label (str): Label string.
    """
    self._plot_builder_ = plot_builder
    self._label_ = label
    self._dict_: dict[str, object] = {}

color(color)

Sets the color of the label.

Parameters:

Name Type Description Default
color str | tuple[float]

Color for the label.

 required

Returns:

Type Description
itfit.plot.labels.GenericLabelBuilder

Returns itself.
Source code in itfit/plot/labels.py 
107
108
109
110
111
112
113
114
115
116
117
def color(self, color):
    """Sets the color of the label.

    Args:
        color (str|tuple[float]): Color for the label.

    Returns:
        (itfit.plot.labels.GenericLabelBuilder): Returns itself.
    """
    self._dict_.update({'color': color})
    return self

fontsize(size)

Sets label fontsize.

Parameters:

Name Type Description Default
size float

Size of the label.

 required

Returns:

Type Description
itfit.plot.labels.GenericLabelBuilder

Returns itself.
Source code in itfit/plot/labels.py 
83
84
85
86
87
88
89
90
91
92
93
def fontsize(self, size):
    """Sets label fontsize.

    Args:
        size (float): Size of the label.

    Returns:
        (itfit.plot.labels.GenericLabelBuilder): Returns itself.
    """
    self._dict_.update({'fontsize': size})
    return self

fontweight(weight)

TODO:

Parameters:

Name Type Description Default
weight _type_

description

 required

Returns:

Type Description
itfit.plot.labels.GenericLabelBuilder

Returns itself.
Source code in itfit/plot/labels.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
def fontweight(self, weight):
    """TODO:

    Args:
        weight (_type_): _description_

    Returns:
        (itfit.plot.labels.GenericLabelBuilder): Returns itself.
    """
    self._dict_.update({'fontweight': weight})
    return self

horizontalalignment(loc)

TODO

Parameters:

Name Type Description Default
loc _type_

description

 required

Returns:

Type Description
itfit.plot.labels.GenericLabelBuilder

Returns itself.
Source code in itfit/plot/labels.py 
131
132
133
134
135
136
137
138
139
140
141
def horizontalalignment(self, loc):
    """TODO

    Args:
        loc (_type_): _description_

    Returns:
        (itfit.plot.labels.GenericLabelBuilder): Returns itself.
    """
    self._dict_.update({'horizontalalignment': loc})
    return self

verticalalignment(loc)

TODO:

Parameters:

Name Type Description Default
loc _type_

description

 required

Returns:

Type Description
itfit.plot.labels.GenericLabelBuilder

Returns itself.
Source code in itfit/plot/labels.py 
119
120
121
122
123
124
125
126
127
128
129
def verticalalignment(self, loc):
    """TODO:

    Args:
        loc (_type_): _description_

    Returns:
        (itfit.plot.labels.GenericLabelBuilder): Returns itself.
    """
    self._dict_.update({'verticalalignment': loc})
    return self

LabelBuilder

Source code in itfit/plot/labels.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class LabelBuilder:
    def __init__(self, plot_builder: PlotBuilder):
        """Starts a LabelBuilder. Used to modify axis labels.

        Args:
            plot_builder (PlotBuilder): PlotBuilder to return when exit.
        """
        self._plot_builder_ = plot_builder


    def start_x_label(self, label):
        """Starts a x label builder.

        Args:
            label (str): x axis label.

        Returns:
            (itfit.plot.labels.xLabelBuilder): x label builder.
        """
        return xLabelBuilder(self._plot_builder_, self,  label)

    def start_y_label(self, label):
        """Starts a y label builder.

        Args:
            label (str): y axis label.

        Returns:
            (itfit.plot.labels.yLabelBuilder): y label builder.
        """
        return yLabelBuilder(self._plot_builder_, self, label)

    def start_title(self, title):
        """Starts a title label builder.

        Args:
            title (str): title label.

        Returns:
            (itfit.plot.labels.titleLabelBuilder): title label builder.
        """
        return titleLabelBuilder(self._plot_builder_, self, title)

    def end_labels(self):
        """Exits labels builder.

        Returns:
            (itft.plot.PlotBuilder): Returns the PlotBuilder.
        """
        return self._plot_builder_

__init__(plot_builder)

Starts a LabelBuilder. Used to modify axis labels.

Parameters:

Name Type Description Default
plot_builder PlotBuilder

PlotBuilder to return when exit.

 required
Source code in itfit/plot/labels.py 
21
22
23
24
25
26
27
def __init__(self, plot_builder: PlotBuilder):
    """Starts a LabelBuilder. Used to modify axis labels.

    Args:
        plot_builder (PlotBuilder): PlotBuilder to return when exit.
    """
    self._plot_builder_ = plot_builder

end_labels()

Exits labels builder.

Returns:

Type Description
itft.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/labels.py 
63
64
65
66
67
68
69
def end_labels(self):
    """Exits labels builder.

    Returns:
        (itft.plot.PlotBuilder): Returns the PlotBuilder.
    """
    return self._plot_builder_

start_title(title)

Starts a title label builder.

Parameters:

Name Type Description Default
title str

title label.

 required

Returns:

Type Description
itfit.plot.labels.titleLabelBuilder

title label builder.
Source code in itfit/plot/labels.py 
52
53
54
55
56
57
58
59
60
61
def start_title(self, title):
    """Starts a title label builder.

    Args:
        title (str): title label.

    Returns:
        (itfit.plot.labels.titleLabelBuilder): title label builder.
    """
    return titleLabelBuilder(self._plot_builder_, self, title)

start_x_label(label)

Starts a x label builder.

Parameters:

Name Type Description Default
label str

x axis label.

 required

Returns:

Type Description
itfit.plot.labels.xLabelBuilder

x label builder.
Source code in itfit/plot/labels.py 
30
31
32
33
34
35
36
37
38
39
def start_x_label(self, label):
    """Starts a x label builder.

    Args:
        label (str): x axis label.

    Returns:
        (itfit.plot.labels.xLabelBuilder): x label builder.
    """
    return xLabelBuilder(self._plot_builder_, self,  label)

start_y_label(label)

Starts a y label builder.

Parameters:

Name Type Description Default
label str

y axis label.

 required

Returns:

Type Description
itfit.plot.labels.yLabelBuilder

y label builder.
Source code in itfit/plot/labels.py 
41
42
43
44
45
46
47
48
49
50
def start_y_label(self, label):
    """Starts a y label builder.

    Args:
        label (str): y axis label.

    Returns:
        (itfit.plot.labels.yLabelBuilder): y label builder.
    """
    return yLabelBuilder(self._plot_builder_, self, label)

titleLabelBuilder

Bases: GenericLabelBuilder

Specific implementation of GenericLabelBuilder for the title label.

Source code in itfit/plot/labels.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class titleLabelBuilder(GenericLabelBuilder):
    """Specific implementation of GenericLabelBuilder for the title label.
    """
    def __init__(self, plot_builder, label_builder: LabelBuilder, label: str):
        super().__init__(plot_builder, label)
        self._label_builder_ = label_builder

    def end_title(self):
        """Ends title label builder.

        Returns:
            (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
        """
        self._plot_builder_.ax.set_title(self._label_, self._dict_)
        return self._label_builder_

end_title()

Ends title label builder.

Returns:

Type Description
itfit.plot.labels.LabelBuilder

Returns the LabelBuilder.
Source code in itfit/plot/labels.py 
182
183
184
185
186
187
188
189
def end_title(self):
    """Ends title label builder.

    Returns:
        (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
    """
    self._plot_builder_.ax.set_title(self._label_, self._dict_)
    return self._label_builder_

xLabelBuilder

Bases: GenericLabelBuilder

Specific implementation of GenericLabelBuilder for x label.

Source code in itfit/plot/labels.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
class xLabelBuilder(GenericLabelBuilder):
    """Specific implementation of GenericLabelBuilder for x label.
    """
    def __init__(self, plot_builder: PlotBuilder, label_builder: LabelBuilder, label: str):
        super().__init__(plot_builder, label)
        self._label_builder_ = label_builder

    def end_xlabel(self):
        """Ends x label builder.

        Returns:
            (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
        """
        self._plot_builder_.ax.set_xlabel(self._label_, self._dict_)
        return self._label_builder_

end_xlabel()

Ends x label builder.

Returns:

Type Description
itfit.plot.labels.LabelBuilder

Returns the LabelBuilder.
Source code in itfit/plot/labels.py 
150
151
152
153
154
155
156
157
def end_xlabel(self):
    """Ends x label builder.

    Returns:
        (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
    """
    self._plot_builder_.ax.set_xlabel(self._label_, self._dict_)
    return self._label_builder_

yLabelBuilder

Bases: GenericLabelBuilder

Specific implementation of GenericLabelBuilder for y label.

Source code in itfit/plot/labels.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
class yLabelBuilder(GenericLabelBuilder):
    """Specific implementation of GenericLabelBuilder for y label.
    """
    def __init__(self, plot_builder, label_builder: LabelBuilder, label: str):
        super().__init__(plot_builder, label)
        self._label_builder_ = label_builder

    def end_ylabel(self):
        """Ends y label builder.

        Returns:
            (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
        """
        self._plot_builder_.ax.set_ylabel(self._label_, self._dict_)
        return self._label_builder_

end_ylabel()

Ends y label builder.

Returns:

Type Description
itfit.plot.labels.LabelBuilder

Returns the LabelBuilder.
Source code in itfit/plot/labels.py 
166
167
168
169
170
171
172
173
def end_ylabel(self):
    """Ends y label builder.

    Returns:
        (itfit.plot.labels.LabelBuilder): Returns the LabelBuilder.
    """
    self._plot_builder_.ax.set_ylabel(self._label_, self._dict_)
    return self._label_builder_