Source code for plotnine.geoms.geom_hline
from __future__ import annotations
import typing
from warnings import warn
import numpy as np
import pandas as pd
from ..doctools import document
from ..exceptions import PlotnineWarning
from ..mapping import aes
from ..utils import order_as_data_mapping
from .geom import geom
from .geom_path import geom_path
from .geom_segment import geom_segment
if typing.TYPE_CHECKING:
from typing import Any
from plotnine.iapi import panel_view
from plotnine.typing import (
Aes,
Axes,
Coord,
DataLike,
)
[docs]@document
class geom_hline(geom):
"""
Horizontal line
{usage}
Parameters
----------
{common_parameters}
"""
DEFAULT_AES = {
"color": "black",
"linetype": "solid",
"size": 0.5,
"alpha": 1,
}
REQUIRED_AES = {"yintercept"}
DEFAULT_PARAMS = {
"stat": "identity",
"position": "identity",
"na_rm": False,
"inherit_aes": False,
}
draw_legend = staticmethod(geom_path.draw_legend)
def __init__(
self,
mapping: Aes | None = None,
data: DataLike | None = None,
**kwargs: Any,
):
data, mapping = order_as_data_mapping(data, mapping)
yintercept = kwargs.pop("yintercept", None)
if yintercept is not None:
if mapping:
warn(
"The 'yintercept' parameter has overridden "
"the aes() mapping.",
PlotnineWarning,
)
data = pd.DataFrame({"yintercept": np.repeat(yintercept, 1)})
mapping = aes(yintercept="yintercept")
kwargs["show_legend"] = False
geom.__init__(self, mapping, data, **kwargs)
def draw_panel(
self,
data: pd.DataFrame,
panel_params: panel_view,
coord: Coord,
ax: Axes,
**params: Any,
):
"""
Plot all groups
"""
ranges = coord.backtransform_range(panel_params)
data["y"] = data["yintercept"]
data["yend"] = data["yintercept"]
data["x"] = ranges.x[0]
data["xend"] = ranges.x[1]
data = data.drop_duplicates()
for _, gdata in data.groupby("group"):
gdata.reset_index(inplace=True)
geom_segment.draw_group(gdata, panel_params, coord, ax, **params)