bsxplorer.HeatMap.draw_plotly

HeatMap.draw_plotly(figure: Figure | None = None, title: str | None = None, vmin: float | None = None, vmax: float | None = None, color_scale='Viridis', tick_labels: list[str] | None = None, show_border: bool = True, row: int | list | None = None, col: int | list | None = None, facet_cols: int = 4)[source]

Draws heat-map plot on given plotly figure.

Parameters:

  • figure – Plotly Figure, where to plot HeatMap

  • title – Title for axis

  • vmin – Set minimum value for colorbar explicitly.

  • vmax – Set maximum value for colorbar explicitly.

  • color_scale – Name of color scale.

  • tick_labels – Labels for upstream, body region start and end, downstream (e.g. TSS, TES). Exactly 5 need to be provided. Set None to disable.

  • show_border – Whether to draw dotted vertical line on body region borders or not.

  • row – Row, where heatmap will be plotted.

  • col – Column, where heatmap will be plotted.

  • facet_cols – Maximum number of plots on the same row.

Return type:

plotly.graph_objects.Figure

See also

Plotly color scales: For possible colormap color_scale arguments.

plotly.graph_objects.Figure