statsplotly.plot_specifiers package

This subpackage defines objects and methods to specify plot properties.

Subpackages

Submodules

statsplotly.plot_specifiers.common module

statsplotly.plot_specifiers.common.register_statsplotly_template() → None
statsplotly.plot_specifiers.common.smart_legend(legend_string: str) → str

Cleans and capitalizes axis legends for figure.

statsplotly.plot_specifiers.common.smart_title(title_string: str) → str

Split string at _, capitalizes words, and joins with space.

statsplotly.plot_specifiers.trace module

pydantic model statsplotly.plot_specifiers.trace.CategoricalPlotSpecifier

Bases: OrientedPlotSpecifier, _TraceSpecifier, _XYTraceValidator

Fields:
Validators:
field plot_type: CategoricalPlotType [Required]
Validated by:
get_category_strip_map(data_handler: DataHandler) → dict[DataDimension, dict[str, Any]] | None
validator validate_model  »  all fields
validator validate_plot_type  »  plot_type
class statsplotly.plot_specifiers.trace.CategoricalPlotType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

BOX = 'boxplot'
STRIP = 'stripplot'
VIOLIN = 'violinplot'
pydantic model statsplotly.plot_specifiers.trace.HistogramSpecifier

Bases: _TraceSpecifier

Fields:
Validators:
field bin_edges: NDArray[Any] | None = None
Validated by:
field bins: str | list[float] | int [Required]
Validated by:
field central_tendency: CentralTendencyType | None = None
Validated by:
field cumulative: bool | None = None
Validated by:
field data_type: np.dtype[Any] [Required]
Validated by:
field dimension: DataDimension [Required]
Validated by:
field ecdf: bool | None = None
Validated by:
field hist: bool | None = None
Validated by:
field histnorm: HistogramNormType [Required]
Validated by:
field kde: bool | None = None
Validated by:
field rug: bool | None = None
Validated by:
field step: bool | None = None
Validated by:
validator check_bins  »  bins
validator check_cumulative  »  cumulative
validator check_dimension  »  dimension
validator check_histnorm  »  histnorm
validator check_parameter_consistency  »  all fields
compute_ecdf(data: Series) → tuple[Series, ndarray[tuple[int, ...], dtype[Any]]]
compute_histogram(data: Series) → tuple[Series, ndarray[tuple[int, ...], dtype[Any]], float]
get_distribution_max_value(data: Series) → float
get_histogram_bin_edges(data: Series) → tuple[ndarray[tuple[int, ...], dtype[Any]], float]
property density: bool
pydantic model statsplotly.plot_specifiers.trace.JointplotSpecifier

Bases: _TraceSpecifier

Fields:
Validators:
field histogram_specifier: dict[DataDimension, HistogramSpecifier] | None = None
field marginal_plot: MarginalPlotDimension | None = None
field plot_type: JointplotType [Required]
field scatter_specifier: ScatterSpecifier [Required]
Validated by:
validator check_scatter_specifier  »  scatter_specifier
compute_histmap(trace_data: TraceData) → tuple[Series, Series, ndarray[tuple[int, ...], dtype[Any]]]
histogram2d(data: DataFrame) → tuple[Series, tuple[ndarray[tuple[int, ...], dtype[Any]], ndarray[tuple[int, ...], dtype[Any]]], tuple[float, float]]
property plot_kde: bool
property plot_scatter: bool
property plot_x_distribution: bool
property plot_y_distribution: bool
class statsplotly.plot_specifiers.trace.JointplotType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

HISTOGRAM = 'histogram'
KDE = 'kde'
SCATTER = 'scatter'
SCATTER_KDE = 'scatter+kde'
X_HISTMAP = 'x_histmap'
Y_HISTMAP = 'y_histmap'
class statsplotly.plot_specifiers.trace.MarginalPlotDimension(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

ALL = 'all'
X = 'x'
Y = 'y'
pydantic model statsplotly.plot_specifiers.trace.OrientedPlotSpecifier

Bases: BaseModel

Fields:
field data_types: DataTypes [Required]
field prefered_orientation: PlotOrientation | None = None
property anchor_dimension: DataDimension
property anchored_dimension: DataDimension | None
property orientation: PlotOrientation
class statsplotly.plot_specifiers.trace.PlotOrientation(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

HORIZONTAL = 'horizontal'
VERTICAL = 'vertical'
pydantic model statsplotly.plot_specifiers.trace.ScatterSpecifier

Bases: _TraceSpecifier, _XYTraceValidator

Fields:
Validators:
field mode: TraceMode | None = None
Validated by:
field regression_type: RegressionType | None = None
Validated by:

  • validate_model

validator validate_mode  »  mode
class statsplotly.plot_specifiers.trace.TraceMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

LINES = 'lines'
LINES_TEXT = 'lines+text'
MARKERS = 'markers'
MARKERS_LINES = 'markers+lines'