Figures

Defines base figure classes used in the plots.

class qimchi.components.figures.QimchiFigure(sess_id: str, data: Dataset | ndarray, independents: list, dependents: list, num_axes: int, colors=None, theme: dict = None)[source]

Bases: ABC

Qimchi Figure Base Class

Parameters:

  • sess_id (str) – Session ID to load the state for

  • data (Dataset | np.ndarray) – Data to be plotted

  • independents (list) – Independent variables

  • dependents (list) – Dependent variables

  • num_axes (int) – Number of axes in the figure

  • colors (list, optional) – Colors for the plot. Defaults to None.

  • theme (dict, optional) – Theme dict for the plot. Defaults to None.

Raises:

ValueError – If the number of independent variables is greater than the number of axes.

abstractmethod plot() → Figure[source]

Abstract method to plot the figure.

Returns:

Plotly Figure object

Return type:

go.Figure

class qimchi.components.figures.Line(sess_id: str, data: Dataset, independents: list, dependents: list, theme: dict)[source]

Bases: QimchiFigure

Qimchi Line Plot Class

Qimchi Figure Base Class

Parameters:

  • sess_id (str) – Session ID to load the state for

  • data (Dataset | np.ndarray) – Data to be plotted

  • independents (list) – Independent variables

  • dependents (list) – Dependent variables

  • num_axes (int) – Number of axes in the figure

  • colors (list, optional) – Colors for the plot. Defaults to None.

  • theme (dict, optional) – Theme dict for the plot. Defaults to None.

Raises:

ValueError – If the number of independent variables is greater than the number of axes.

plot() → Figure[source]

Abstract method to plot the figure.

Returns:

Plotly Figure object

Return type:

go.Figure

class qimchi.components.figures.HeatMap(sess_id: str, data: Dataset, independents: list, dependents: list, theme: dict)[source]

Bases: QimchiFigure

Qimchi HeatMap Plot Class

Qimchi Figure Base Class

Parameters:

  • sess_id (str) – Session ID to load the state for

  • data (Dataset | np.ndarray) – Data to be plotted

  • independents (list) – Independent variables

  • dependents (list) – Dependent variables

  • num_axes (int) – Number of axes in the figure

  • colors (list, optional) – Colors for the plot. Defaults to None.

  • theme (dict, optional) – Theme dict for the plot. Defaults to None.

Raises:

ValueError – If the number of independent variables is greater than the number of axes.

plot() → Figure[source]

Abstract method to plot the figure.

Returns:

Plotly Figure object

Return type:

go.Figure