vuecore.plots.plot_factory module

Contents

vuecore.plots.plot_factory module#

vuecore.plots.plot_factory.create_plot(data: DataFrame, config: Type[BaseModel], plot_type: PlotType, engine: EngineType = EngineType.PLOTLY, file_path: str = None, **kwargs) → Any[source]#

Factory function to create, style, and optionally save plots.

This function handles the common workflow for creating plots: 1. Validate configuration using the provided Pydantic model 2. Get the appropriate builder function from the engine registry 3. Build the figure using the builder 4. Optionally save the plot if a file path is provided

Parameters:

  • data (pd.DataFrame) – The DataFrame containing the data to be plotted.

  • config (Type[BaseModel]) – The Pydantic config class for validation.

  • plot_type (PlotType) – The plot type from the PlotType enum (e.g., PlotType.BAR, PlotType.BOX, etc).

  • engine (EngineType, optional) – The plotting engine to use for rendering the plot. Defaults to EngineType.PLOTLY.

  • file_path (str, optional) – If provided, the path where the final plot will be saved.

  • **kwargs – Keyword arguments for plot configuration.

Returns:

The final plot object returned by the selected engine.

Return type:

Any

Contents