suboptimumg.plotting.plotting_constants#
Configuration objects for plotting module.
This module provides Plotly-style configuration objects to control various aspects of plots without cluttering function interfaces. All magic numbers are centralized here for easy customization.
- class suboptimumg.plotting.plotting_constants.ColorbarConfig[source]#
Bases:
BaseModelColorbar configuration for 3D plots.
- Parameters:
thickness (int)
length (float)
- length: float#
- thickness: int#
- class suboptimumg.plotting.plotting_constants.FontConfig[source]#
Bases:
BaseModelFont configuration for plot elements.
Simplified to three sizes that work across all plot types: - Large: Titles - Medium: Subtitles, axis labels, legend titles - Small: Tick labels, legend items, contour labels
- Parameters:
large (int)
medium (int)
small (int)
- large: int#
- medium: int#
- small: int#
- class suboptimumg.plotting.plotting_constants.LayoutConfig[source]#
Bases:
BaseModelLayout configuration for plot dimensions and spacing.
Unified dimensions that work across all plot types. Users can override when creating custom plots if needed.
Fields# Field
Type
Required
Default
intNo
350floatNo
0.08floatNo
0.12intNo
400intNo
700Dict[str,int]No
factory
strNo
'white'strNo
'rgba(240, 240, 240, 0.8)'floatNo
0.5strNo
'center'strNo
'top'intNo
1000- Parameters:
width (int)
height (int)
grid_width_per_col (int)
grid_height_per_row (int)
grid_horizontal_spacing (float)
grid_vertical_spacing (float)
margin (Dict[str, int])
plot_bgcolor (str)
scene_bgcolor (str)
title_x (float)
title_xanchor (str)
title_yanchor (str)
- grid_height_per_row: int#
- grid_horizontal_spacing: float#
- grid_vertical_spacing: float#
- grid_width_per_col: int#
- height: int#
- margin: Dict[str, int]#
- plot_bgcolor: str#
- scene_bgcolor: str#
- title_x: float#
- title_xanchor: str#
- title_yanchor: str#
- width: int#
- class suboptimumg.plotting.plotting_constants.ReferenceLineConfig[source]#
Bases:
BaseModelConfiguration for reference lines (h_line, v_line).
This class combines the line value, label, and styling into a single object. Pass instances of this class to plotting functions instead of separate parameters.
Fields# Field
Type
Required
Default
strNo
'red'strNo
'dash'str|NoneNo
Nonefloat|NoneNo
NoneintNo
4- Parameters:
value (float | None)
label (str | None)
width (int)
dash (str)
color (str)
- color: str#
- dash: str#
- label: str | None#
- value: float | None#
- width: int#
- class suboptimumg.plotting.plotting_constants.SceneConfig[source]#
Bases:
BaseModel3D scene configuration for surface plots.
Fields# Field
Type
Required
Default
floatNo
1.0floatNo
1.0floatNo
0.8floatNo
2.0floatNo
0floatNo
0floatNo
1floatNo
0.8intNo
-60- Parameters:
aspect_ratio_x (float)
aspect_ratio_y (float)
aspect_ratio_z (float)
camera_distance (float)
camera_z (float)
default_view_angle (int)
camera_up_x (float)
camera_up_y (float)
camera_up_z (float)
- aspect_ratio_x: float#
- aspect_ratio_y: float#
- aspect_ratio_z: float#
- camera_distance: float#
- camera_up_x: float#
- camera_up_y: float#
- camera_up_z: float#
- camera_z: float#
- default_view_angle: int#
- class suboptimumg.plotting.plotting_constants.SmoothingConfig[source]#
Bases:
BaseModelSmoothing and interpolation configuration.
Fields# Field
Type
Required
Default
intNo
5strNo
'linear'floatNo
0- Parameters:
interp_factor (int)
smoothing_sigma (float)
interp_method (str)
- interp_factor: int#
- interp_method: str#
- smoothing_sigma: float#