methylseg.utils.plot_state_labels

methylseg.utils.plot_state_labels(*, df_plot, sample_info, sample_info_removed, chrom, out_dir, label_col, overlay_regions_df=None, overlay_style='state', region_start=None, region_end=None, x_col='CpG_beg', y_col='beta', label_title=None, show_plot=True, max_points=120000, state_colors=None)[source]

Render prepared state labels with consistent overlays and view controls.

This internal helper keeps state-label preparation in the component that owns the labels while sharing the interactive rendering behavior.

Parameters:

  • df_plot (DataFrame)

  • sample_info (SampleInfo | None)

  • sample_info_removed (DataFrame | None)

  • chrom (str | None)

  • out_dir (str | None)

  • label_col (str)

  • overlay_regions_df (DataFrame | None)

  • overlay_style (str)

  • region_start (int | None)

  • region_end (int | None)

  • x_col (str)

  • y_col (str)

  • label_title (str | None)

  • show_plot (bool)

  • max_points (int)

  • state_colors (dict | None)

Return type:

object | None