vuecore.schemas.plotly_base module

class vuecore.schemas.plotly_base.PlotlyBaseConfig(*, x: str | None = None, y: str | None = None, color: str | None = None, hover_name: str | None = None, hover_data: List[str] = [], facet_row: str | None = None, facet_col: str | None = None, labels: Dict[str, str] | None = None, color_discrete_map: Dict[str, str] | None = None, category_orders: Dict[str, List[str]] | None = None, log_x: bool = False, log_y: bool = False, range_x: List[float] | None = None, range_y: List[float] | None = None, title: str = 'Plotly Plot', x_title: str | None = None, y_title: str | None = None, subtitle: str | None = None, template: str = 'plotly_white', width: int | None = 800, height: int | None = 600, **extra_data: Any)

Bases: BaseModel

Pydantic model for common Plotly configurations.

This model serves as a curated API for common parameters of Plotly plots, closely aligned with the plotly.express API (https://plotly.com/python-api-reference/plotly.express.html).

This base class includes parameters shared across multiple plot types to ensure consistency and reduce code repetition. It uses a validator to enforce that at least one of the x or y axes is provided. Plot-specific schemas should inherit from this model.

attribute x: str | None = None

Column for x-axis values.

attribute y: str | None = None

Column for y-axis values.

attribute color: str | None = None

Column to assign color to plot elements.

attribute hover_name: str | None = None

Column to appear in bold in the hover tooltip.

attribute hover_data: List[str] = []

Additional columns for the hover tooltip.

attribute facet_row: str | None = None

Column to create vertical subplots (facets).

attribute facet_col: str | None = None

Column to create horizontal subplots (facets).

attribute labels: Dict[str, str] | None = None

Dictionary to override column names for titles, legends, etc.

attribute color_discrete_map: Dict[str, str] | None = None

Specific color mappings for values in the color column.

attribute category_orders: Dict[str, List[str]] | None = None

Dictionary to specify the order of categorical values.

attribute log_x: bool = False

If True, use a logarithmic x-axis.

attribute log_y: bool = False

If True, use a logarithmic y-axis.

attribute range_x: List[float] | None = None

Range for the x-axis, e.g., [0, 100].

attribute range_y: List[float] | None = None

Range for the y-axis, e.g., [0, 100].

attribute title: str = 'Plotly Plot'

The main title of the plot.

attribute x_title: str | None = None

Custom title for the x-axis.

attribute y_title: str | None = None

Custom title for the y-axis.

attribute subtitle: str | None = None

The subtitle of the plot.

attribute template: str = 'plotly_white'

Plotly template for styling.

attribute width: int | None = 800

Width of the plot in pixels.

attribute height: int | None = 600

Height of the plot in pixels.

validator validate_x_or_y_provided  »  all fields

Ensure at least one of x or y is provided for the plot.