suboptimumg.plotting.heatmap#

suboptimumg.plotting.heatmap.plot_heatmap(x_values, y_values, z_values, title, x_label, y_label, z_label, *, theme=None, font_config=FontConfig(large=24, medium=16, small=12), layout_config=LayoutConfig(width=1000, height=700, grid_width_per_col=400, grid_height_per_row=350, grid_horizontal_spacing=0.08, grid_vertical_spacing=0.12, margin={'l': 70, 'r': 50, 't': 90, 'b': 70}, plot_bgcolor='white', scene_bgcolor='rgba(240, 240, 240, 0.8)', title_x=0.5, title_xanchor='center', title_yanchor='top'), colorbar_config=ColorbarConfig(thickness=15, length=0.7))[source]#

Generic 2D heatmap plotting utility.

Parameters:

  • x_values (numpy.ndarray) – Coordinates along the x axis, one per column of z_values.

  • y_values (numpy.ndarray) – Coordinates along the y axis, one per row of z_values.

  • z_values (numpy.ndarray) – Cell values, shaped (len(y_values), len(x_values)).

  • title (str) – Plot title.

  • x_label (str) – X-axis label.

  • y_label (str) – Y-axis label.

  • z_label (str) – Colorbar label describing the cell values.

  • theme (str, optional) – Color theme name

  • font_config (FontConfig, optional) – FontConfig object for font settings

  • layout_config (LayoutConfig, optional) – LayoutConfig object for layout settings

  • colorbar_config (ColorbarConfig, optional) – ColorbarConfig object for colorbar settings

Returns:

Plotly figure object

Return type:

go.Figure