statsplotly.plot_specifiers.layout package

This subpackage defines objects and utility methods for layout properties.

pydantic model statsplotly.plot_specifiers.layout.AxesSpecifier

Bases: BaseModel

Fields:

  • axis_format (statsplotly.plot_specifiers.layout._core.AxisFormat | None)

  • legend (statsplotly.plot_specifiers.layout._core.LegendSpecifier)

  • traces (list[statsplotly.plot_specifiers.data._core.TraceData])

  • x_range (list[float | str] | None)

  • y_range (list[float | str] | None)

  • z_range (list[float | str] | None)

Validators:

  • validate_axis_range_format » x_range

  • validate_axis_range_format » y_range

  • validate_axis_range_format » z_range

field axis_format: AxisFormat | None = None
field legend: LegendSpecifier [Required]
field traces: list[TraceData] [Required]
field x_range: list[float | str] | None = None
Validated by:

  • validate_axis_range_format

field y_range: list[float | str] | None = None
Validated by:

  • validate_axis_range_format

field z_range: list[float | str] | None = None
Validated by:

  • validate_axis_range_format

get_axes_range() → list[Any] | None
static pad_axis_range(axis_range: list[Any], padding_factor: float) → list[Any]
validator validate_axis_range_format  »  x_range, y_range, z_range
property height: int | None
property scaleanchor: str | None
property scaleratio: float | None
property width: int | None
property xaxis_range: list[Any] | None
property yaxis_range: list[Any] | None
property zaxis_range: list[Any] | None
class statsplotly.plot_specifiers.layout.AxisFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

EQUAL = 'equal'
FIXED_RATIO = 'fixed_ratio'
ID_LINE = 'id_line'
SQUARE = 'square'
class statsplotly.plot_specifiers.layout.AxisType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

THREE_DIMENSIONAL = 'three_dimensional'
TWO_DIMENSIONAL = 'two_dimensional'
class statsplotly.plot_specifiers.layout.BarMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

GROUP = 'group'
OVERLAY = 'overlay'
RELATIVE = 'relative'
STACK = 'stack'
class statsplotly.plot_specifiers.layout.ColoraxisReference(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

MAIN_COLORAXIS = 'coloraxis'
class statsplotly.plot_specifiers.layout.HistogramBarMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

OVERLAY = 'overlay'
STACK = 'stack'
pydantic model statsplotly.plot_specifiers.layout.LegendSpecifier

Bases: BaseModel

Fields:

  • axis_type (statsplotly.plot_specifiers.layout._core.AxisType | None)

  • data_pointer (statsplotly.plot_specifiers.data._core.DataPointer)

  • error_bar (str | None)

  • shaded_error (str | None)

  • title (str | None)

  • x_label (str | None)

  • x_transformation (statsplotly.plot_specifiers.data._core.AggregationType | statsplotly.plot_specifiers.data._core.HistogramNormType | None)

  • y_label (str | None)

  • y_transformation (statsplotly.plot_specifiers.data._core.AggregationType | statsplotly.plot_specifiers.data._core.HistogramNormType | None)

  • z_label (str | None)

field axis_type: AxisType | None = None
field data_pointer: DataPointer [Required]
field error_bar: str | None = None
field shaded_error: str | None = None
field title: str | None = None
field x_label: str | None = None
field x_transformation: AggregationType | HistogramNormType | None = None
field y_label: str | None = None
field y_transformation: AggregationType | HistogramNormType | None = None
field z_label: str | None = None
property figure_title: str
property x_transformation_legend: str | None
property xaxis_title: str
property y_transformation_legend: str | None
property yaxis_title: str
property zaxis_title: str | None
class statsplotly.plot_specifiers.layout.PlotAxis(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

COLORAXIS = 'coloraxis'
XAXIS = 'xaxis'
YAXIS = 'yaxis'
statsplotly.plot_specifiers.layout.add_update_menu(fig: Figure, data_handler: DataHandler, slices_traces: dict[str, Any] | None = None, preplotted_traces: dict[str, Any] | None = None) → Figure
statsplotly.plot_specifiers.layout.adjust_jointplot_legends(jointplot_specifier: JointplotSpecifier, slices_marginal_traces: dict[str, Any]) → None
statsplotly.plot_specifiers.layout.set_horizontal_colorbar(colorbar_dict: dict[str, Any]) → dict[str, Any]