Skip to content

Spines

GenericSpineBuilder

Source code in itfit/plot/spines.py 
 70
 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
142
143
144
145
146
147
148
149
class GenericSpineBuilder:
    def __init__(self, plot_builder: PlotBuilder, spine_builder: SpineBuilder):
        """Spine builder. Used to modify plot spines.

        Args:
            plot_builder (itfit.plot.spines.GenericSpineBuilder): GenericSpineBuilder instance.
        """
        self._plot_builder_ = plot_builder
        self._spine_builder_ = spine_builder
        self._dict_: dict[str, object] = {}

    def alpha(self, alpha: float):
        """Sets spines alpha.

        Args:
            alpha (float): alpha value

        Returns:
            (itfit.plot.spines.GenericSpineBuilder): Returns itself.
        """
        self._dict_.update({'alpha':alpha})
        return self

    def visible(self):
        """Sets spine visible.

        Returns:
            (itfit.plot.spines.GenericSpineBuilder): Returns itself.
        """
        self._dict_.update({'visible':True})
        return self

    def invisible(self):
        """Sets spine invisible.

        Returns:
            (itfit.plot.spines.GenericSpineBuilder): Returns itself.
        """
        self._dict_.update({'visible':False})
        return self

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

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

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

    def linestyle(self, linestyle):
        """Changes spine linestyle.

        Args:
            linestyle (str): Spine linestyle.

        Returns:
            (itfit.plot.spines.GenericSpineBuilder): Returns itself.
        """
        self._dict_.update({'linestyle': linestyle})
        return self

    def linewidth(self, linewidth):
        """Changes spine linewidth.

        Args:
            linewidth (float): Spine linewidth.

        Returns:
            (itfit.plot.spines.GenericSpineBuilder): Returns itself.
        """
        self._dict_.update({'linewidth': linewidth})
        return self

    def _end_spine_builder(self, spine):
        self._plot_builder_.ax.spines[spine].set(**self._dict_)
        return self._spine_builder_

__init__(plot_builder, spine_builder)

Spine builder. Used to modify plot spines.

Parameters:

Name Type Description Default
plot_builder itfit.plot.spines.GenericSpineBuilder

GenericSpineBuilder instance.

 required
Source code in itfit/plot/spines.py 
71
72
73
74
75
76
77
78
79
def __init__(self, plot_builder: PlotBuilder, spine_builder: SpineBuilder):
    """Spine builder. Used to modify plot spines.

    Args:
        plot_builder (itfit.plot.spines.GenericSpineBuilder): GenericSpineBuilder instance.
    """
    self._plot_builder_ = plot_builder
    self._spine_builder_ = spine_builder
    self._dict_: dict[str, object] = {}

alpha(alpha)

Sets spines alpha.

Parameters:

Name Type Description Default
alpha float

alpha value

 required

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
81
82
83
84
85
86
87
88
89
90
91
def alpha(self, alpha: float):
    """Sets spines alpha.

    Args:
        alpha (float): alpha value

    Returns:
        (itfit.plot.spines.GenericSpineBuilder): Returns itself.
    """
    self._dict_.update({'alpha':alpha})
    return self

color(color)

Sets the color of the spine.

Parameters:

Name Type Description Default
color str | tuple[float]

Color for the spine.

 required

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
111
112
113
114
115
116
117
118
119
120
121
def color(self, color):
    """Sets the color of the spine.

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

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

invisible()

Sets spine invisible.

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
102
103
104
105
106
107
108
109
def invisible(self):
    """Sets spine invisible.

    Returns:
        (itfit.plot.spines.GenericSpineBuilder): Returns itself.
    """
    self._dict_.update({'visible':False})
    return self

linestyle(linestyle)

Changes spine linestyle.

Parameters:

Name Type Description Default
linestyle str

Spine linestyle.

 required

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
123
124
125
126
127
128
129
130
131
132
133
def linestyle(self, linestyle):
    """Changes spine linestyle.

    Args:
        linestyle (str): Spine linestyle.

    Returns:
        (itfit.plot.spines.GenericSpineBuilder): Returns itself.
    """
    self._dict_.update({'linestyle': linestyle})
    return self

linewidth(linewidth)

Changes spine linewidth.

Parameters:

Name Type Description Default
linewidth float

Spine linewidth.

 required

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
135
136
137
138
139
140
141
142
143
144
145
def linewidth(self, linewidth):
    """Changes spine linewidth.

    Args:
        linewidth (float): Spine linewidth.

    Returns:
        (itfit.plot.spines.GenericSpineBuilder): Returns itself.
    """
    self._dict_.update({'linewidth': linewidth})
    return self

visible()

Sets spine visible.

Returns:

Type Description
itfit.plot.spines.GenericSpineBuilder

Returns itself.
Source code in itfit/plot/spines.py 
 93
 94
 95
 96
 97
 98
 99
100
def visible(self):
    """Sets spine visible.

    Returns:
        (itfit.plot.spines.GenericSpineBuilder): Returns itself.
    """
    self._dict_.update({'visible':True})
    return self

SpineBuilder

Source code in itfit/plot/spines.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
class SpineBuilder:
    def __init__(self, plot_builder: PlotBuilder):
        """Spine builder. Used to modify plot spines.

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

    def start_left_spine(self):
        """Starts a left spine builder.

        Returns:
            (itift.plot.spines.leftSpineBuilder): left spine builder.
        """
        return leftSpineBuilder(self._plot_builder_, self)

    def start_right_spine(self):
        """Starts a right spine builder.

        Returns:
            (itift.plot.spines.rightSpineBuilder): right spine builder.
        """
        return rightSpineBuilder(self._plot_builder_, self)

    def start_top_spine(self):
        """Starts a top spine builder.

        Returns:
            (itift.plot.spines.topSpineBuilder): top spine builder.
        """
        return topSpineBuilder(self._plot_builder_, self)

    def start_bottom_spine(self):
        """Starts a bottom spine builder.

        Returns:
            (itift.plot.spines.bottomSpineBuilder): bottom spine builder.
        """
        return bottomSpineBuilder(self._plot_builder_, self)

    def end_spines(self):
        """Ends spine builder.

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

__init__(plot_builder)

Spine builder. Used to modify plot spines.

Parameters:

Name Type Description Default
plot_builder itfit.plot.PlotBuilder

PlotBuilder instance.

 required
Source code in itfit/plot/spines.py 
21
22
23
24
25
26
27
28
def __init__(self, plot_builder: PlotBuilder):
    """Spine builder. Used to modify plot spines.

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

end_spines()

Ends spine builder.

Returns:

Type Description
itfit.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/spines.py 
62
63
64
65
66
67
68
def end_spines(self):
    """Ends spine builder.

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

start_bottom_spine()

Starts a bottom spine builder.

Returns:

Type Description
itift.plot.spines.bottomSpineBuilder

bottom spine builder.
Source code in itfit/plot/spines.py 
54
55
56
57
58
59
60
def start_bottom_spine(self):
    """Starts a bottom spine builder.

    Returns:
        (itift.plot.spines.bottomSpineBuilder): bottom spine builder.
    """
    return bottomSpineBuilder(self._plot_builder_, self)

start_left_spine()

Starts a left spine builder.

Returns:

Type Description
itift.plot.spines.leftSpineBuilder

left spine builder.
Source code in itfit/plot/spines.py 
30
31
32
33
34
35
36
def start_left_spine(self):
    """Starts a left spine builder.

    Returns:
        (itift.plot.spines.leftSpineBuilder): left spine builder.
    """
    return leftSpineBuilder(self._plot_builder_, self)

start_right_spine()

Starts a right spine builder.

Returns:

Type Description
itift.plot.spines.rightSpineBuilder

right spine builder.
Source code in itfit/plot/spines.py 
38
39
40
41
42
43
44
def start_right_spine(self):
    """Starts a right spine builder.

    Returns:
        (itift.plot.spines.rightSpineBuilder): right spine builder.
    """
    return rightSpineBuilder(self._plot_builder_, self)

start_top_spine()

Starts a top spine builder.

Returns:

Type Description
itift.plot.spines.topSpineBuilder

top spine builder.
Source code in itfit/plot/spines.py 
46
47
48
49
50
51
52
def start_top_spine(self):
    """Starts a top spine builder.

    Returns:
        (itift.plot.spines.topSpineBuilder): top spine builder.
    """
    return topSpineBuilder(self._plot_builder_, self)

bottomSpineBuilder

Bases: GenericSpineBuilder

Source code in itfit/plot/spines.py 
194
195
196
197
198
199
200
201
202
203
204
205
class bottomSpineBuilder(GenericSpineBuilder):
    def __init__(self, plot_builder, spine_builder):
        super().__init__(plot_builder, spine_builder)
        self._spine = "bottom"

    def end_bottom_spine(self):
        """Ends bottom spine builder.

        Returns:
            (itfit.plot.PlotBuilder): Returns the PlotBuilder.
        """
        return self._end_spine_builder(self._spine)

end_bottom_spine()

Ends bottom spine builder.

Returns:

Type Description
itfit.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/spines.py 
199
200
201
202
203
204
205
def end_bottom_spine(self):
    """Ends bottom spine builder.

    Returns:
        (itfit.plot.PlotBuilder): Returns the PlotBuilder.
    """
    return self._end_spine_builder(self._spine)

leftSpineBuilder

Bases: GenericSpineBuilder

Source code in itfit/plot/spines.py 
152
153
154
155
156
157
158
159
160
161
162
163
class leftSpineBuilder(GenericSpineBuilder):
    def __init__(self, plot_builder, spine_builder):
        super().__init__(plot_builder, spine_builder)
        self._spine = "left"

    def end_left_spine(self):
        """Ends left spine builder.

        Returns:
            (itfit.plot.PlotBuilder): Returns the PlotBuilder.
        """
        return self._end_spine_builder(self._spine)

end_left_spine()

Ends left spine builder.

Returns:

Type Description
itfit.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/spines.py 
157
158
159
160
161
162
163
def end_left_spine(self):
    """Ends left spine builder.

    Returns:
        (itfit.plot.PlotBuilder): Returns the PlotBuilder.
    """
    return self._end_spine_builder(self._spine)

rightSpineBuilder

Bases: GenericSpineBuilder

Source code in itfit/plot/spines.py 
166
167
168
169
170
171
172
173
174
175
176
177
class rightSpineBuilder(GenericSpineBuilder):
    def __init__(self, plot_builder, spine_builder):
        super().__init__(plot_builder, spine_builder)
        self._spine = "right"

    def end_right_spine(self):
        """Ends right spine builder.

        Returns:
            (itfit.plot.PlotBuilder): Returns the PlotBuilder.
        """
        return self._end_spine_builder(self._spine)

end_right_spine()

Ends right spine builder.

Returns:

Type Description
itfit.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/spines.py 
171
172
173
174
175
176
177
def end_right_spine(self):
    """Ends right spine builder.

    Returns:
        (itfit.plot.PlotBuilder): Returns the PlotBuilder.
    """
    return self._end_spine_builder(self._spine)

topSpineBuilder

Bases: GenericSpineBuilder

Source code in itfit/plot/spines.py 
180
181
182
183
184
185
186
187
188
189
190
191
class topSpineBuilder(GenericSpineBuilder):
    def __init__(self, plot_builder, spine_builder):
        super().__init__(plot_builder, spine_builder)
        self._spine = "top"

    def end_top_spine(self):
        """Ends top spne builder.

        Returns:
            (itfit.plot.PlotBuilder): Returns the PlotBuilder.
        """
        return self._end_spine_builder(self._spine)

end_top_spine()

Ends top spne builder.

Returns:

Type Description
itfit.plot.PlotBuilder

Returns the PlotBuilder.
Source code in itfit/plot/spines.py 
185
186
187
188
189
190
191
def end_top_spine(self):
    """Ends top spne builder.

    Returns:
        (itfit.plot.PlotBuilder): Returns the PlotBuilder.
    """
    return self._end_spine_builder(self._spine)