gemseo / post / dataset

Hide inherited members

plot_settings module

Data for a plot.

class gemseo.post.dataset.plot_settings.PlotSettings(color='', colormap='rainbow', fig_size=(6.4, 4.8), font_size=10, legend_location='best', linestyle='', marker='', xtick_rotation=0.0, title='', xlabel='', xmin=None, xmax=None, ylabel='', ymin=None, ymax=None, zlabel='', zmin=None, zmax=None, rmin=None, rmax=None, labels=<factory>)[source]

Bases: object

The settings of a plot.

Parameters:
  • color (str | list[str]) –

    By default it is set to “”.

  • colormap (str) –

    By default it is set to “rainbow”.

  • fig_size (FigSizeType) –

    By default it is set to (6.4, 4.8).

  • font_size (int) –

    By default it is set to 10.

  • legend_location (str) –

    By default it is set to “best”.

  • linestyle (str | list[str]) –

    By default it is set to “”.

  • marker (str | list[str]) –

    By default it is set to “”.

  • xtick_rotation (float) –

    By default it is set to 0.0.

  • title (str) –

    By default it is set to “”.

  • xlabel (str) –

    By default it is set to “”.

  • xmin (float | None) –

  • xmax (float | None) –

  • ylabel (str) –

    By default it is set to “”.

  • ymin (float | None) –

  • ymax (float | None) –

  • zlabel (str) –

    By default it is set to “”.

  • zmin (float | None) –

  • zmax (float | None) –

  • rmin (float | None) –

  • rmax (float | None) –

  • labels (dict[str, str]) –

    By default it is set to <factory>.

color: str | list[str] = ''

The color(s) for the series.

If empty, use a default one.

colormap: str = 'rainbow'

The color map.

fig_size: FigSizeType = (6.4, 4.8)

The figure size.

font_size: int = 10

The font size.

labels: dict[str, str]

The labels for the variables.

legend_location: str = 'best'

The location of the legend.

linestyle: str | list[str] = ''

The line style(s) for the series.

If empty, use a default one.

marker: str | list[str] = ''

The marker(s) for the series.

If empty, use a default one.

rmax: float | None = None

The maximum value on the r-axis.

If None, compute it from data.

rmin: float | None = None

The minimum value on the r-axis.

If None, compute it from data.

title: str = ''

The title of the plot.

xlabel: str = ''

The label for the x-axis.

xmax: float | None = None

The maximum value on the x-axis.”.

If None, compute it from data.

xmin: float | None = None

The minimum value on the x-axis.

If None, compute it from data.

xtick_rotation: float = 0.0

The rotation angle in degrees for the x-ticks.

ylabel: str = ''

The label for the y-axis.

ymax: float | None = None

The maximum value on the y-axis.

If None, compute it from data.

ymin: float | None = None

The minimum value on the y-axis.

If None, compute it from data.

zlabel: str = ''

The label for the z-axis.

zmax: float | None = None

The maximum value on the z-axis.

If None, compute it from data.

zmin: float | None = None

The minimum value on the z-axis.

If None, compute it from data.