HeatMapChart

class qf_lib.plotting.charts.heatmap_chart.HeatMapChart(data: QFDataFrame, color_map=None, min_value: Optional[float] = None, max_value: Optional[float] = None, start_x: Optional[Any] = None, end_x: Optional[Any] = None, annotations: bool = True, cbar: bool = False)[source]

Bases: Chart

Creates a Heatmap chart.

Parameters:

  • data (QFDataFrame) – QFDataFrame containing data that should be plotted using heat map

  • color_map – color map to use for coloring the heat map

  • min_value (float) – min possible value (used for adjusting colors on the heatmap)

  • max_value (float) – max possible value (used for adjusting colors on the heatmap)

  • start_x (Any) – see: Chart__init__#start_x

  • end_x (Any) – see: Chart__init__#end_x

  • annotations (bool) – If True, write the data value in each cell.

  • cbar (bool) – Whether to draw a colorbar, by default equal to False.

Attributes:

color_mesh_

Mesh generated during plotting.

Methods:

plot([figsize])

Plots the chart.
color_mesh_

Mesh generated during plotting.

plot(figsize: Optional[Tuple[float, float]] = None)[source]

Plots the chart. The underlying figure stays hidden until the show() method is called.

Parameters:

figsize (Tuple[float, float]) – The figure size to draw the chart at in inches. This is a tuple of (width, height) passed directly to matplotlib’s plot function. The values are expressed in inches.