Skip to content

vayu.plotly_utils

Requires the vayulib[data] extra.

plotly_utils

line 

line(
    series: Series,
    index: Series = None,
    name: str = None,
    width: float = 1,
    color: str = None,
    dash: str = None,
    shape: str = None,
    gl: bool = True,
    **kwargs
)

Helper function to create line plots from a pandas series.

Source code in vayu/plotly_utils.py 
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
def line(
    series: pd.Series,
    index: pd.Series = None,
    name: str = None,
    width: float = 1,
    color: str = None,
    dash: str = None,
    shape: str = None,
    gl: bool = True,
    **kwargs,
):
    """Helper function to create line plots from a pandas series."""
    _validate_libraries()
    if index is not None:
        assert len(series) == len(index), "Series length should be equal to index length"

    line_dict = dict(width=width)
    if color is not None:
        line_dict["color"] = color
    if dash:
        line_dict["dash"] = dash
    if shape:
        line_dict["shape"] = shape
    kwargs = kwargs | dict(
        x=index if index is not None else series.index,
        y=series,
        mode=kwargs.get("mode", "lines"),
        name=name or series.name,
        line=line_dict if line_dict else None,
    )

    return go.Scattergl(**kwargs) if gl else go.Scatter(**kwargs)

scatter 

scatter(
    series: Series,
    index: Series = None,
    name: str = None,
    color: str = None,
    size: int = 10,
    symbol: str = "circle",
    gl: bool = True,
    **kwargs
)

Helper function to create scatter plots from a pandas series.

Source code in vayu/plotly_utils.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def scatter(
    series: pd.Series,
    index: pd.Series = None,
    name: str = None,
    color: str = None,
    size: int = 10,
    symbol: str = "circle",
    gl: bool = True,
    **kwargs,
):
    """Helper function to create scatter plots from a pandas series."""
    _validate_libraries()
    dikt = dict(
        x=index if index is not None else series.index,
        y=series,
        mode="markers",
        name=name or series.name,
        marker_symbol=symbol,
        marker_size=size,
        marker_color=color,
    )
    kwargs = dikt | kwargs
    return go.Scattergl(**kwargs) if gl else go.Scatter(**kwargs)

subplot 

subplot(
    columns: int = 1,
    rows: int = 1,
    secondary: bool = True,
    shared_xaxes: bool = None,
    vertical_spacing: float = None,
    **kwargs
)

Helper function to create subplots with secondary y-axis support.

Source code in vayu/plotly_utils.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def subplot(
    columns: int = 1,
    rows: int = 1,
    secondary: bool = True,
    shared_xaxes: bool = None,
    vertical_spacing: float = None,
    **kwargs,
):
    """Helper function to create subplots with secondary y-axis support."""
    _validate_libraries()
    return make_subplots(
        cols=columns,
        rows=rows,
        specs=[[{"secondary_y": secondary} for _ in range(columns)] for _ in range(rows)],
        shared_xaxes=shared_xaxes,
        vertical_spacing=vertical_spacing,
        **kwargs,
    )

insert_title 

insert_title(
    fig,
    title,
    x=0.01,
    y=0.99,
    center: bool = False,
    size: int = 20,
    bgcolor: str = "rgba(255, 255, 255, 0.7)",
    color: str = "black",
    font_family: str = "Courier New, monospace",
)

Insert title in the figure.

Source code in vayu/plotly_utils.py 
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
def insert_title(
    fig,
    title,
    x=0.01,
    y=0.99,
    center: bool = False,
    size: int = 20,
    bgcolor: str = "rgba(255, 255, 255, 0.7)",
    color: str = "black",
    font_family: str = "Courier New, monospace",
):
    """Insert title in the figure."""

    _validate_libraries()
    fig.add_annotation(
        x=x,
        y=y,
        xref="paper",
        yref="paper",
        showarrow=False,
        text=title,
        font=dict(size=size, color=color, family=font_family),
        bgcolor=bgcolor,
        borderpad=2,
    )
    return fig